glitch-javascript-sdk 1.2.9 → 1.3.1

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

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

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

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

package/dist/index.d.ts

@@ -3707,6 +3707,112 @@ declare class GameShows {
     static deleteTitle<T>(show_id: string, title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Newsletters {
+    /**
+     * Download the list of publictions, podcasts and blogs.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Newsletters/downloadMarketingChecklists
+     *
+     * @param data The data to be passed when creating a team.
+     *
+     * @returns Promise
+     */
+    static downloadMarketingChecklist<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
+declare class PlayTests {
+    /**
+     * Get a list of play tests associated with a title.
+     *
+     * @param title_id The ID of the title.
+     * @param params Optional query parameters.
+     * @returns Promise
+     */
+    static index<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * User requests to test a title.
+     *
+     * @param title_id The ID of the title.
+     * @param data Optional data for the request.
+     * @returns Promise
+     */
+    static requestPlayTest<T>(title_id: string, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Title administrator invites a user to test a title.
+     *
+     * @param title_id The ID of the title.
+     * @param data The data containing user_id and other optional fields.
+     * @returns Promise
+     */
+    static invitePlayTester<T>(title_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * User submits or updates their answers for a play test.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @param data The answers data.
+     * @returns Promise
+     */
+    static submitAnswers<T>(title_id: string, playtest_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Title admin updates test questions for a play test.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @param data The questions data.
+     * @returns Promise
+     */
+    static updateQuestions<T>(title_id: string, playtest_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * User accepts an invite to a play test.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static acceptInvite<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+    /**
+     * User rejects an invite to a play test.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static rejectInvite<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Title admin approves a user's play test request.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static approveRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Title admin declines a user's play test request.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static declineRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+    /**
+     * User cancels their own play test request.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static cancelRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single play test.
+     *
+     * @param title_id The ID of the title.
+     * @param playtest_id The ID of the play test.
+     * @returns Promise
+     */
+    static show<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -4031,6 +4137,8 @@ declare class Glitch {
         TipEmojis: typeof TipEmojis;
         TipPackagePurchases: typeof TipPackagePurchases;
         Publications: typeof Publications;
+        Newsletters: typeof Newsletters;
+        PlayTests: typeof PlayTests;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

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

package/src/api/Newsletters.ts

@@ -0,0 +1,28 @@
+import NewslettersRoutes from "../routes/NewslettersRoutes";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Newsletters {
+
+
+    /**
+     * Download the list of publictions, podcasts and blogs.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Newsletters/downloadMarketingChecklists
+     * 
+     * @param data The data to be passed when creating a team.
+     * 
+     * @returns Promise
+     */
+    public static downloadMarketingChecklist<T>(data : object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(NewslettersRoutes.routes.downloadMarketingChecklist, data, undefined, params);
+    }
+
+   
+
+
+}
+
+export default Newsletters;

package/src/api/PlayTests.ts

@@ -0,0 +1,131 @@
+import PlayTestsRoute from "../routes/PlayTestsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class PlayTests {
+  /**
+   * Get a list of play tests associated with a title.
+   *
+   * @param title_id The ID of the title.
+   * @param params Optional query parameters.
+   * @returns Promise
+   */
+  public static index<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.index, undefined, { title_id }, params);
+  }
+
+  /**
+   * User requests to test a title.
+   *
+   * @param title_id The ID of the title.
+   * @param data Optional data for the request.
+   * @returns Promise
+   */
+  public static requestPlayTest<T>(title_id: string, data?: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.request, data, { title_id });
+  }
+
+  /**
+   * Title administrator invites a user to test a title.
+   *
+   * @param title_id The ID of the title.
+   * @param data The data containing user_id and other optional fields.
+   * @returns Promise
+   */
+  public static invitePlayTester<T>(title_id: string, data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.invite, data, { title_id });
+  }
+
+  /**
+   * User submits or updates their answers for a play test.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @param data The answers data.
+   * @returns Promise
+   */
+  public static submitAnswers<T>(title_id: string, playtest_id: string, data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.submitAnswers, data, { title_id, playtest_id });
+  }
+
+  /**
+   * Title admin updates test questions for a play test.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @param data The questions data.
+   * @returns Promise
+   */
+  public static updateQuestions<T>(title_id: string, playtest_id: string, data: object): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.updateQuestions, data, { title_id, playtest_id });
+  }
+
+  /**
+   * User accepts an invite to a play test.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static acceptInvite<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.acceptInvite, {}, { title_id, playtest_id });
+  }
+
+  /**
+   * User rejects an invite to a play test.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static rejectInvite<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.rejectInvite, {}, { title_id, playtest_id });
+  }
+
+  /**
+   * Title admin approves a user's play test request.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static approveRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.approveRequest, {}, { title_id, playtest_id });
+  }
+
+  /**
+   * Title admin declines a user's play test request.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static declineRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.declineRequest, {}, { title_id, playtest_id });
+  }
+
+  /**
+   * User cancels their own play test request.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static cancelRequest<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.cancelRequest, {}, { title_id, playtest_id });
+  }
+
+  /**
+   * Retrieve a single play test.
+   *
+   * @param title_id The ID of the title.
+   * @param playtest_id The ID of the play test.
+   * @returns Promise
+   */
+  public static show<T>(title_id: string, playtest_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(PlayTestsRoute.routes.show, {}, { title_id, playtest_id });
+  }
+}
+
+export default PlayTests;

package/src/api/index.ts

@@ -23,6 +23,8 @@ import Influencers from "./Influencers";
 import Games from "./Games";
 import Publications from "./Publications";
 import GameShows from "./GameShows";
+import Newsletters from "./Newsletters"
+import PlayTests from "./PlayTests";
 
 export {Auth};
 export {Competitions};
@@ -48,4 +50,6 @@ export {Feedback};
 export {Influencers};
 export {Games};
 export {Publications};
-export {GameShows};
+export {GameShows};
+export {Newsletters};
+export {PlayTests};

package/src/index.ts

@@ -27,6 +27,8 @@ import {Influencers} from "./api";
 import {Games} from "./api";
 import {Publications} from "./api";
 import {GameShows} from "./api";
+import {Newsletters} from "./api";
+import {PlayTests} from "./api";
 
 
 
@@ -84,7 +86,9 @@ class Glitch {
         TipPackages : TipPackages,
         TipEmojis : TipEmojis ,
         TipPackagePurchases: TipPackagePurchases,
-        Publications : Publications
+        Publications : Publications,
+        Newsletters : Newsletters,
+        PlayTests : PlayTests
     }
 
     public static util = {

package/src/routes/NewslettersRoutes.ts

@@ -0,0 +1,12 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class NewslettersRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      downloadMarketingChecklist: { url: '/newsletters/downloadMarketingChecklist', method: HTTP_METHODS.POST },
+    };
+
+  }
+
+  export default NewslettersRoutes;

package/src/routes/PlayTestsRoute.ts

@@ -0,0 +1,20 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class PlayTestsRoute {
+  public static routes: { [key: string]: Route } = {
+    index: { url: '/playtests/{title_id}', method: HTTP_METHODS.GET },
+    request: { url: '/playtests/{title_id}/request', method: HTTP_METHODS.POST },
+    invite: { url: '/playtests/{title_id}/invite', method: HTTP_METHODS.POST },
+    submitAnswers: { url: '/playtests/{title_id}/answers/{playtest_id}', method: HTTP_METHODS.PUT },
+    updateQuestions: { url: '/playtests/{title_id}/questions/{playtest_id}', method: HTTP_METHODS.PUT },
+    acceptInvite: { url: '/playtests/{title_id}/accept/{playtest_id}', method: HTTP_METHODS.POST },
+    rejectInvite: { url: '/playtests/{title_id}/reject/{playtest_id}', method: HTTP_METHODS.POST },
+    approveRequest: { url: '/playtests/{title_id}/approve/{playtest_id}', method: HTTP_METHODS.POST },
+    declineRequest: { url: '/playtests/{title_id}/decline/{playtest_id}', method: HTTP_METHODS.POST },
+    cancelRequest: { url: '/playtests/{title_id}/cancel/{playtest_id}', method: HTTP_METHODS.POST },
+    show: { url: '/playtests/{title_id}/view/{playtest_id}', method: HTTP_METHODS.GET },
+  };
+}
+
+export default PlayTestsRoute;