glitch-javascript-sdk 3.4.0 → 3.4.1

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

@@ -1,5 +1,9 @@
 import Route from "./interface";
 declare class GameShowsRoute {
+    /**
+     * Canonical API route templates. JSON routes are substituted by
+     * Requests.processRoute; multipart methods replace tokens before upload.
+     */
     static routes: {
         [key: string]: Route;
     };

package/dist/index.d.ts

@@ -6205,7 +6205,9 @@ declare class GameShows {
      * Add a title to a game show by admin.
      */
     static addTitle<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Preview CSV/TSV/TXT/ZIP registrations without writing showcase data. */
     static previewExternalTitles<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Import valid external registrations after organizer preview. */
     static importExternalTitles<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * List all titles for a game show.
@@ -6283,20 +6285,35 @@ declare class GameShows {
      * List public game shows that include a title. Useful for game-page festival banners.
      */
     static listForTitle<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** List private sponsor workflow, contact, billing, media, and placements. */
     static listSponsors<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Create a manual sponsor or send a self-service invitation. */
     static createSponsor<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Retrieve one organizer-authorized festival sponsor. */
     static getSponsor<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Update sponsor workflow, creative metadata, schedule, or billing terms. */
     static updateSponsor<T>(show_id: string, sponsor_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Delete an unpaid sponsor and its placements. */
     static deleteSponsor<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Replace the private token and resend the sponsor invitation. */
     static resendSponsorInvitation<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Add another festival, game, session, or event placement. */
     static createSponsorPlacement<T>(show_id: string, sponsor_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Partially update an existing sponsor placement. */
     static updateSponsorPlacement<T>(show_id: string, sponsor_id: string, placement_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Delete one placement without deleting the sponsor creative. */
     static deleteSponsorPlacement<T>(show_id: string, sponsor_id: string, placement_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** List privacy-limited, publicly eligible creatives and placements. */
     static listPublicSponsors<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Open a token-protected sponsor portal without a user session. */
     static sponsorInvitation<T>(token: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Upload sponsor image/video through the shared Media pipeline. */
     static uploadSponsorInvitationMedia<T>(token: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Submit sponsor identity, destination, and accessibility metadata. */
     static submitSponsorInvitation<T>(token: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Create/confirm a destination PaymentIntent from a PaymentMethod ID. */
     static paySponsorInvitation<T>(token: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /** Synchronize the same intent after Stripe.js completes required 3DS. */
     static confirmSponsorInvitationPayment<T>(token: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Javascript SDK for Glitch",
   "publishConfig": {
     "access": "public"

package/src/api/GameShows.ts

@@ -154,11 +154,14 @@ class GameShows {
         return Requests.processRoute(GameShowsRoute.routes.addTitle, data, { show_id: show_id }, params);
     }
 
+    /** Preview CSV/TSV/TXT/ZIP registrations without writing showcase data. */
     public static previewExternalTitles<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        // Multipart helpers require the concrete URL before uploading.
         const url = GameShowsRoute.routes.previewExternalTitles.url.replace('{show_id}', show_id);
         return Requests.uploadFile(url, 'file', file, data, params);
     }
 
+    /** Import valid external registrations after organizer preview. */
     public static importExternalTitles<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         const url = GameShowsRoute.routes.importExternalTitles.url.replace('{show_id}', show_id);
         return Requests.uploadFile(url, 'file', file, data, params);
@@ -297,63 +300,79 @@ class GameShows {
         return Requests.processRoute(GameShowsRoute.routes.listForTitle, {}, { title_id: title_id }, params);
     }
 
+    /** List private sponsor workflow, contact, billing, media, and placements. */
     public static listSponsors<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.listSponsors, {}, { show_id }, params);
     }
 
+    /** Create a manual sponsor or send a self-service invitation. */
     public static createSponsor<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.createSponsor, data, { show_id }, params);
     }
 
+    /** Retrieve one organizer-authorized festival sponsor. */
     public static getSponsor<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.getSponsor, {}, { show_id, sponsor_id }, params);
     }
 
+    /** Update sponsor workflow, creative metadata, schedule, or billing terms. */
     public static updateSponsor<T>(show_id: string, sponsor_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.updateSponsor, data, { show_id, sponsor_id }, params);
     }
 
+    /** Delete an unpaid sponsor and its placements. */
     public static deleteSponsor<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.deleteSponsor, {}, { show_id, sponsor_id }, params);
     }
 
+    /** Replace the private token and resend the sponsor invitation. */
     public static resendSponsorInvitation<T>(show_id: string, sponsor_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.resendSponsorInvitation, {}, { show_id, sponsor_id }, params);
     }
 
+    /** Add another festival, game, session, or event placement. */
     public static createSponsorPlacement<T>(show_id: string, sponsor_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.createSponsorPlacement, data, { show_id, sponsor_id }, params);
     }
 
+    /** Partially update an existing sponsor placement. */
     public static updateSponsorPlacement<T>(show_id: string, sponsor_id: string, placement_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.updateSponsorPlacement, data, { show_id, sponsor_id, placement_id }, params);
     }
 
+    /** Delete one placement without deleting the sponsor creative. */
     public static deleteSponsorPlacement<T>(show_id: string, sponsor_id: string, placement_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.deleteSponsorPlacement, {}, { show_id, sponsor_id, placement_id }, params);
     }
 
+    /** List privacy-limited, publicly eligible creatives and placements. */
     public static listPublicSponsors<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.listPublicSponsors, {}, { show_id }, params);
     }
 
+    /** Open a token-protected sponsor portal without a user session. */
     public static sponsorInvitation<T>(token: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.sponsorInvitation, {}, { token }, params);
     }
 
+    /** Upload sponsor image/video through the shared Media pipeline. */
     public static uploadSponsorInvitationMedia<T>(token: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        // Sponsor uploads use the `media` multipart field documented by API.
         const url = GameShowsRoute.routes.sponsorInvitationUpload.url.replace('{token}', token);
         return Requests.uploadFile(url, 'media', file, data, params);
     }
 
+    /** Submit sponsor identity, destination, and accessibility metadata. */
     public static submitSponsorInvitation<T>(token: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.sponsorInvitationSubmit, data, { token }, params);
     }
 
+    /** Create/confirm a destination PaymentIntent from a PaymentMethod ID. */
     public static paySponsorInvitation<T>(token: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.sponsorInvitationPayment, data, { token }, params);
     }
 
+    /** Synchronize the same intent after Stripe.js completes required 3DS. */
     public static confirmSponsorInvitationPayment<T>(token: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GameShowsRoute.routes.sponsorInvitationConfirmPayment, {}, { token }, params);
     }

package/src/routes/GameShowsRoute.ts

@@ -2,7 +2,10 @@ import Route from "./interface";
 import HTTP_METHODS from "../constants/HttpMethods";
 
 class GameShowsRoute {
-    
+    /**
+     * Canonical API route templates. JSON routes are substituted by
+     * Requests.processRoute; multipart methods replace tokens before upload.
+     */
     public static routes: { [key: string]: Route } = {
       list: { url: '/gameshows', method: HTTP_METHODS.GET },
       create: { url: '/gameshows', method: HTTP_METHODS.POST  },
@@ -14,6 +17,7 @@ class GameShowsRoute {
       registerTitle: { url: '/gameshows/{show_id}/registerTitle', method: HTTP_METHODS.POST },
         listTitles: { url: '/gameshows/{show_id}/titles', method: HTTP_METHODS.GET },
         addTitle: { url: '/gameshows/{show_id}/addTitle', method: HTTP_METHODS.POST },
+        // External registration file preview/import endpoints.
         previewExternalTitles: { url: '/gameshows/{show_id}/external-titles/preview', method: HTTP_METHODS.POST },
         importExternalTitles: { url: '/gameshows/{show_id}/external-titles/import', method: HTTP_METHODS.POST },
         viewTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.GET },
@@ -34,6 +38,7 @@ class GameShowsRoute {
         joinWishlist: { url: '/gameshows/{show_id}/wishlist', method: HTTP_METHODS.POST },
         listWishlist: { url: '/gameshows/{show_id}/wishlist', method: HTTP_METHODS.GET },
         listForTitle: { url: '/titles/{title_id}/gameshows', method: HTTP_METHODS.GET },
+        // Organizer sponsor lifecycle and placement administration.
         listSponsors: { url: '/gameshows/{show_id}/sponsors', method: HTTP_METHODS.GET },
         createSponsor: { url: '/gameshows/{show_id}/sponsors', method: HTTP_METHODS.POST },
         getSponsor: { url: '/gameshows/{show_id}/sponsors/{sponsor_id}', method: HTTP_METHODS.GET },
@@ -43,7 +48,9 @@ class GameShowsRoute {
         createSponsorPlacement: { url: '/gameshows/{show_id}/sponsors/{sponsor_id}/placements', method: HTTP_METHODS.POST },
         updateSponsorPlacement: { url: '/gameshows/{show_id}/sponsors/{sponsor_id}/placements/{placement_id}', method: HTTP_METHODS.PUT },
         deleteSponsorPlacement: { url: '/gameshows/{show_id}/sponsors/{sponsor_id}/placements/{placement_id}', method: HTTP_METHODS.DELETE },
+        // Privacy-limited anonymous sponsor inventory.
         listPublicSponsors: { url: '/gameshows/{show_id}/sponsors/public', method: HTTP_METHODS.GET },
+        // Token-protected sponsor self-service; backend applies per-route limits.
         sponsorInvitation: { url: '/gameshow-sponsor-invitations/{token}', method: HTTP_METHODS.GET },
         sponsorInvitationUpload: { url: '/gameshow-sponsor-invitations/{token}/media', method: HTTP_METHODS.POST },
         sponsorInvitationSubmit: { url: '/gameshow-sponsor-invitations/{token}/submit', method: HTTP_METHODS.POST },