glitch-javascript-sdk 0.0.3 → 0.0.6

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

@@ -49,5 +49,377 @@ declare class Competitions {
      * @returns promise
      */
     static delete<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Add a team
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/addTeam
+     *
+     * @param competition_id
+     * @param team_id
+     * @returns promise
+     */
+    static addTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Adds participant
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/addParticipant
+     *
+     * @param competition_id
+     * @param user_id
+     * @returns promise
+     */
+    static addParticipant<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Register a team
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/registerTeam
+     *
+     * @param competition_id
+     * @param team_id
+     * @returns promise
+     */
+    static registerTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Register a user
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/registerParticipant
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static registerUser<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Sync rounds
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/syncRounds
+     *
+     * @param competition_id
+     * @param number_of_competitors
+     * @param competitors_per_bracket
+     * @returns promise
+     */
+    static syncRounds<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * auto generate team brackets
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/autoGenerateTeamBrackets
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static autoGenerate<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * auto generate user brackets
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/autoGenerateUserBrackets
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static autoGenerateUserBrackets<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Upload main image
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/uploadMainImage
+     *
+     * @param competition_id
+     * @param image
+     * @returns promise
+     */
+    static uploadMainImage<T>(competition_id: string, image: string): AxiosPromise<Response<T>>;
+    /**
+     * Upload banner image
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/uploadBannerImage
+     *
+     * @param competition_id
+     * @param image
+     * @returns promise
+     */
+    static uploadBannerImage<T>(competition_id: string, image: string): AxiosPromise<Response<T>>;
+    /**
+     * Invites
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserInviteList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static invites<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Sends invite
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionSendInvite
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static sendInvite<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Accept invite
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionAcceptInvite
+     *
+     * @param competition_id
+     * @param token
+     * @returns promise
+     */
+    static acceptInvite<T>(competition_id: string, token: string): AxiosPromise<Response<T>>;
+    /**
+     * Round brackets
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundBracketList1
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static brackets<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Store round brackets
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundBracketStorage
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static bracketStore<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Show round bracket
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundBracketShow
+     *
+     * @param competition_id
+     * @param round_id
+     * @param bracket_id
+     * @returns promise
+     */
+    static showBracket<T>(competition_id: string, round_id: number, bracket_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Update bracket
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateRoundBracket
+     *
+     * @param competition_id
+     * @param round_id
+     * @param bracket_id
+     * @returns promise
+     */
+    static updateBracket<T>(competition_id: string, round_id: number, bracket_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Delete bracket
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryRoundBracket
+     *
+     * @param competition_id
+     * @param round_id
+     * @param bracket_id
+     * @returns promise
+     */
+    static destroyBracket<T>(competition_id: string, round_id: number, bracket_id: number): AxiosPromise<Response<T>>;
+    /**
+     * List round
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static rounds<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Create a new round for competition
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundStorage
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static roundStore<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single round.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceRoundShow
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static showRound<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Updating resource in storage with new information.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateRound
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static updateRound<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Deletes the round for the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryRound
+     *
+     * @param competition_id
+     * @param round_id
+     * @returns promise
+     */
+    static destroyRound<T>(competition_id: string, round_id: number): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a list of teams associated with the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceCompetitionTeamList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static team<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Associate a new team with the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceCompetitionTeamStorage
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static teamStore<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Display the contents of a single team associated with the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceTeamShow
+     *
+     * @param competition_id
+     * @param team
+     * @returns promise
+     */
+    static showTeam<T>(competition_id: string, team: string): AxiosPromise<Response<T>>;
+    /**
+     * Update the team information associated with the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateTeam
+     *
+     * @param competition_id
+     * @param team_id
+     * @returns promise
+     */
+    static updateTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Removes the team from the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryTeam
+     *
+     * @param competition_id
+     * @param team_id
+     * @returns promise
+     */
+    static destroyTeam<T>(competition_id: string, team_id: string): AxiosPromise<Response<T>>;
+    /**
+     * List all the users associated with a competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static users<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Associate a new users with the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/createCompetitionUser
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static competitionUser<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Show a single user by its ID.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/showCompetitionUser
+     *
+     * @param competition_id
+     * @param user_id
+     * @returns promise
+     */
+    static showCompetitionUser<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Update the user associated with competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateCompetitionUser
+     *
+     * @param competition_id
+     * @param user_id
+     * @returns promise
+     */
+    static updateCompetitionUser<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Remove the associated user from the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/removeCompetitionUser
+     *
+     * @param competition_id
+     * @param user_id
+     * @returns promise
+     */
+    static destroyCompetitionUser<T>(competition_id: string, user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * List all the venues associated with a competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/venueList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static venues<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Creating a new venue.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/createVenue
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static newVenue<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Show a single venue by its ID.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/showVenue
+     *
+     * @param competition_id
+     * @param venue_id
+     * @returns promise
+     */
+    static showVenue<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Update the venue.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateVenue
+     *
+     * @param competition_id
+     * @param venue_id
+     * @returns promise
+     */
+    static updateVenue<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes the venue from the competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/removeCompetitionVenue
+     *
+     * @param competition_id
+     * @param venue_id
+     * @returns promise
+     */
+    static destroyVenue<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Upload venue main image to storage.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/uploadVenueMainImage
+     *
+     * @param competition_id
+     * @param venue_id
+     * @returns promise
+     */
+    static uploadVenueMainImage<T>(competition_id: string, venue_id: string): AxiosPromise<Response<T>>;
 }
 export default Competitions;

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;