glitch-javascript-sdk 0.0.3 → 0.0.4

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

@@ -49,5 +49,210 @@ declare class Events {
      * @returns promise
      */
     static delete<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static updateInvirtuEvent<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static addRTMPSource<T>(event_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static updateRTMPSource<T>(event_id: string, stream_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static removeRTMPSource<T>(event_id: string, stream_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static syncAsLive<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+         * 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
+         */
+    static uploadMainImageFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static uploadMainImageBlob<T>(event_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#/Event%20Route/uploadBannerEventImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static uploadBannerImageFile<T>(event_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#/Event%20Route/uploadBannerEventImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    static uploadBannerImageBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static enableBroadcastMode<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static enableLivestreamMode<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static sendOnScreenContent<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static addOverlayAsFile<T>(event_id: string, file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static removeOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static enableOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static disableOverlay<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static enableDonations<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Disable the donations and remove from the screen.
+     *
+     * @param event_id
+     * @returns
+     */
+    static disableDonations<T>(event_id: string): AxiosPromise<Response<T>>;
+    static sendInvite<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
+    static acceptInvite<T>(event_id: string, token: string): AxiosPromise<Response<T>>;
 }
 export default Events;

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/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,6 +3,7 @@ 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 api: {
@@ -10,6 +11,7 @@ declare class Glitch {
         Competitions: typeof Competitions;
         Users: typeof Users;
         Events: typeof Events;
+        Teams: typeof Teams;
     };
 }
 export { Glitch };

package/dist/esm/index.js

@@ -29845,15 +29845,21 @@ var Requests = /** @class */ (function () {
     Requests.setAuthToken = function (token) {
         this.authToken = token;
     };
-    Requests.request = function (method, url, data) {
+    Requests.request = function (method, url, data, fileData) {
+        var headers = {
+            'Content-Type': 'application/json',
+        };
+        if (this.authToken) {
+            headers['Authorization'] = "Bearer ".concat(this.authToken);
+        }
+        if (fileData) {
+            headers['Content-Type'] = 'multipart/form-data';
+        }
         var axiosPromise = axios({
             method: method,
             url: "".concat(this.baseUrl).concat(url),
-            data: data,
-            headers: {
-                Authorization: "Bearer ".concat(this.authToken),
-                'Content-Type': 'application/json',
-            },
+            data: fileData || data,
+            headers: headers,
         });
         return axiosPromise;
     };
@@ -29875,6 +29881,22 @@ var Requests = /** @class */ (function () {
     Requests.delete = function (url) {
         return this.request('DELETE', url);
     };
+    Requests.uploadFile = function (url, filename, file, data) {
+        var formData = new FormData();
+        formData.append(filename, file);
+        for (var key in data) {
+            formData.append(key, data[key]);
+        }
+        return this.request('POST', url, data, formData);
+    };
+    Requests.uploadBlob = function (url, filename, blob, data) {
+        var formData = new FormData();
+        formData.append(filename, blob);
+        for (var key in data) {
+            formData.append(key, data[key]);
+        }
+        return this.request('POST', url, data, formData);
+    };
     /**
      *  The Route class contains the method and url, thereforce items can be
      *  automatically routed depending on the configuration.