glitch-javascript-sdk 0.3.8 → 0.3.9

package/dist/index.d.ts

@@ -577,6 +577,51 @@ declare class Competitions {
      * @returns promise
      */
     static uploadVenueMainImageBlob<T>(competition_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a users points.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static userPointsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a users wins.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static userWinsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a teams points.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static teamPointsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a teams wins.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static teamWinsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get all leaderboards.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static allLeaderboards<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Communities {

package/package.json

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

package/src/api/Competitions.ts

@@ -620,6 +620,66 @@ class Competitions {
 
         return Requests.uploadBlob(url, 'image', blob, data);
     }
+
+    /**
+     * Get a leaderboard by a users points.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static userPointsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.userPointsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a users wins.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static userWinsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.userWinsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a teams points.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static teamPointsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.teamPointsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a teams wins.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static teamWinsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.teamWinsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get all leaderboards.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static allLeaderboards<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.allLeaderboards, {}, {competition_id : competition_id}, params);
+    }
 }
 
 export default Competitions;

package/src/routes/CompetitionRoute.ts

@@ -47,6 +47,11 @@ class CompetitionRoutes {
       updateVenue : { url: '/competitions/{competition_id}/venues/{venue_id}', method: HTTP_METHODS.PUT },
       destroyVenue : { url: '/competitions/{competition_id}/venues/{venue_id}', method: HTTP_METHODS.DELETE },
       uploadVenueMainImage : { url: '/competitions/{competition_id}/venues/{venue_id}/uploadMainImage', method: HTTP_METHODS.POST },
+      userPointsLeaderboard : { url: '/competitions/{competition_id}/userPointsLeaderboard', method: HTTP_METHODS.GET },
+      teamPointsLeaderboard : { url: '/competitions/{competition_id}/teamPointsLeaderboard', method: HTTP_METHODS.GET },
+      userWinsLeaderboard : { url: '/competitions/{competition_id}/userWinsLeaderboard', method: HTTP_METHODS.GET },
+      teamWinsLeaderboard : { url: '/competitions/{competition_id}/teamWinsLeaderboard', method: HTTP_METHODS.GET },
+      allLeaderboards : { url: '/competitions/{competition_id}/allLeaderboards', method: HTTP_METHODS.GET },
     };