glitch-javascript-sdk 1.2.6 → 1.2.8

package/dist/esm/index.js

@@ -6582,6 +6582,31 @@ var CommunitiesRoute = /** @class */ (function () {
         updateEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}', method: HTTP_METHODS.PUT },
         deleteEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}', method: HTTP_METHODS.DELETE },
         populateEmailTemplate: { url: '/communities/{community_id}/emails/templates/{template_id}/populate', method: HTTP_METHODS.POST },
+        // Newsletters
+        listNewsletters: { url: '/communities/{community_id}/newsletters', method: HTTP_METHODS.GET },
+        createNewsletter: { url: '/communities/{community_id}/newsletters', method: HTTP_METHODS.POST },
+        viewNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.GET },
+        updateNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.PUT },
+        deleteNewsletter: { url: '/communities/{community_id}/newsletters/{newsletter_id}', method: HTTP_METHODS.DELETE },
+        importNewsletterSubscribers: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/import', method: HTTP_METHODS.POST },
+        uploadNewsletterBannerImage: { url: '/communities/{community_id}/newsletters/{newsletter_id}/uploadBannerImage', method: HTTP_METHODS.POST },
+        // Campaigns
+        listCampaigns: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns', method: HTTP_METHODS.GET },
+        createCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns', method: HTTP_METHODS.POST },
+        viewCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.GET },
+        updateCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.PUT },
+        deleteCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}', method: HTTP_METHODS.DELETE },
+        sendCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/send', method: HTTP_METHODS.POST },
+        scheduleCampaign: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/schedule', method: HTTP_METHODS.POST },
+        // Emails
+        listCampaignEmails: { url: '/communities/{community_id}/newsletters/{newsletter_id}/campaigns/{campaign_id}/emails', method: HTTP_METHODS.GET },
+        // Subscribers (admin routes)
+        listNewsletterSubscribers: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers', method: HTTP_METHODS.GET },
+        viewNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.GET },
+        updateNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.PUT },
+        deleteNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/{subscriber_id}', method: HTTP_METHODS.DELETE },
+        // Subscriber registration (open route)
+        registerNewsletterSubscriber: { url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers', method: HTTP_METHODS.POST },
     };
     return CommunitiesRoute;
 }());
@@ -7012,6 +7037,258 @@ var Communities = /** @class */ (function () {
     Communities.populateEmailTemplate = function (community_id, template_id, data, params) {
         return Requests.processRoute(CommunitiesRoute.routes.populateEmailTemplate, data, { community_id: community_id, template_id: template_id }, params);
     };
+    /**
+   * List all newsletters for a community.
+   *
+   * @param community_id The ID of the community.
+   * @param params Query parameters.
+   * @returns Promise
+   */
+    Communities.listNewsletters = function (community_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.listNewsletters, undefined, { community_id: community_id }, params);
+    };
+    /**
+     * Create a new newsletter for a community.
+     *
+     * @param community_id The ID of the community.
+     * @param data The data for the new newsletter.
+     * @returns Promise
+     */
+    Communities.createNewsletter = function (community_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.createNewsletter, data, { community_id: community_id }, params);
+    };
+    /**
+     * Get a specific newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.viewNewsletter = function (community_id, newsletter_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.viewNewsletter, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Update a specific newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param data The data to update.
+     * @returns Promise
+     */
+    Communities.updateNewsletter = function (community_id, newsletter_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.updateNewsletter, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Delete a specific newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @returns Promise
+     */
+    Communities.deleteNewsletter = function (community_id, newsletter_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.deleteNewsletter, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Import subscribers from a CSV or XLS file into a newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param file The CSV or XLS file.
+     * @param params Additional parameters.
+     * @returns Promise
+     */
+    Communities.importNewsletterSubscribers = function (community_id, newsletter_id, file, data, params) {
+        var url = CommunitiesRoute.routes.importNewsletterSubscribers.url
+            .replace('{community_id}', community_id)
+            .replace('{newsletter_id}', newsletter_id);
+        return Requests.uploadFile(url, 'file', file, data, params);
+    };
+    /**
+     * Updates the banner image for the game show using a File object.
+    *
+    * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
+    *
+    * @param file The file object to upload.
+    * @param data Any additional data to pass along to the upload.
+    *
+    * @returns promise
+    */
+    Communities.uploadNewsletterBannerImageFile = function (community_id, newsletter_id, file, data, params) {
+        var url = CommunitiesRoute.routes.uploadNewsletterBannerImage.url
+            .replace('{community_id}', community_id)
+            .replace('{newsletter_id}', newsletter_id);
+        return Requests.uploadFile(url, 'image', file, data);
+    };
+    /**
+     * Updates the banner image for the game show using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    Communities.uploadNewsletterBannerImageBlob = function (community_id, newsletter_id, blob, data, params) {
+        var url = CommunitiesRoute.routes.uploadNewsletterBannerImage.url
+            .replace('{community_id}', community_id)
+            .replace('{newsletter_id}', newsletter_id);
+        return Requests.uploadBlob(url, 'image', blob, data);
+    };
+    // Campaigns
+    /**
+     * List all campaigns for a newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.listCampaigns = function (community_id, newsletter_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.listCampaigns, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Create a new campaign for a newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param data The data for the new campaign.
+     * @returns Promise
+     */
+    Communities.createCampaign = function (community_id, newsletter_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.createCampaign, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Get a specific campaign.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.viewCampaign = function (community_id, newsletter_id, campaign_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.viewCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    /**
+     * Update a specific campaign.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @param data The data to update.
+     * @returns Promise
+     */
+    Communities.updateCampaign = function (community_id, newsletter_id, campaign_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.updateCampaign, data, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    /**
+     * Delete a specific campaign.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @returns Promise
+     */
+    Communities.deleteCampaign = function (community_id, newsletter_id, campaign_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.deleteCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    /**
+     * Send a campaign immediately.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @returns Promise
+     */
+    Communities.sendCampaign = function (community_id, newsletter_id, campaign_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.sendCampaign, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    /**
+     * Schedule a campaign to be sent later.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @param data The scheduling data (e.g., scheduled_at).
+     * @returns Promise
+     */
+    Communities.scheduleCampaign = function (community_id, newsletter_id, campaign_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.scheduleCampaign, data, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    // Emails
+    /**
+     * List all emails sent in a campaign.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param campaign_id The ID of the campaign.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.listCampaignEmails = function (community_id, newsletter_id, campaign_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.listCampaignEmails, undefined, { community_id: community_id, newsletter_id: newsletter_id, campaign_id: campaign_id }, params);
+    };
+    // Subscribers (admin routes)
+    /**
+     * List all subscribers of a newsletter (admin only).
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.listNewsletterSubscribers = function (community_id, newsletter_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.listNewsletterSubscribers, undefined, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
+    /**
+     * Get a specific subscriber of a newsletter (admin only).
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param subscriber_id The ID of the subscriber.
+     * @param params Query parameters.
+     * @returns Promise
+     */
+    Communities.viewNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.viewNewsletterSubscriber, undefined, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
+    };
+    /**
+     * Update a specific subscriber of a newsletter (admin only).
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param subscriber_id The ID of the subscriber.
+     * @param data The data to update.
+     * @returns Promise
+     */
+    Communities.updateNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.updateNewsletterSubscriber, data, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
+    };
+    /**
+     * Delete a specific subscriber from a newsletter (admin only).
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param subscriber_id The ID of the subscriber.
+     * @returns Promise
+     */
+    Communities.deleteNewsletterSubscriber = function (community_id, newsletter_id, subscriber_id, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.deleteNewsletterSubscriber, undefined, { community_id: community_id, newsletter_id: newsletter_id, subscriber_id: subscriber_id }, params);
+    };
+    // Subscriber registration (open route)
+    /**
+     * Register a new subscriber to a newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param data The subscriber data.
+     * @returns Promise
+     */
+    Communities.registerNewsletterSubscriber = function (community_id, newsletter_id, data, params) {
+        return Requests.processRoute(CommunitiesRoute.routes.registerNewsletterSubscriber, data, { community_id: community_id, newsletter_id: newsletter_id }, params);
+    };
     return Communities;
 }());
 
@@ -10247,6 +10524,7 @@ var InfluencerRoutes = /** @class */ (function () {
         updateNote: { url: '/influencers/{influencer_id}/notes/{note_id}', method: HTTP_METHODS.PUT },
         deleteNote: { url: '/influencers/{influencer_id}/notes/{note_id}', method: HTTP_METHODS.DELETE },
         listContracts: { url: '/influencers/contracts', method: HTTP_METHODS.GET },
+        workbook: { url: '/influencers/workbook', method: HTTP_METHODS.POST },
     };
     return InfluencerRoutes;
 }());
@@ -10354,6 +10632,16 @@ var Influencers = /** @class */ (function () {
     Influencers.listContracts = function (params) {
         return Requests.processRoute(InfluencerRoutes.routes.listContracts, undefined, undefined, params);
     };
+    /**
+     * Download the influencer work
+     *
+     * @see https://api.glitch.fun/api/documentation#/Influencers/downloadInfluencersWorkbook
+     *
+     * @returns promise
+     */
+    Influencers.workbook = function (data, params) {
+        return Requests.processRoute(InfluencerRoutes.routes.workbook, data, {}, params);
+    };
     return Influencers;
 }());
 
@@ -10436,12 +10724,189 @@ var Publications = /** @class */ (function () {
      *
      * @returns Promise
      */
-    Publications.create = function (data, params) {
+    Publications.download = function (data, params) {
         return Requests.processRoute(PublicationsRoutes.routes.download, data, undefined, params);
     };
     return Publications;
 }());
 
+var GameShowsRoute = /** @class */ (function () {
+    function GameShowsRoute() {
+    }
+    GameShowsRoute.routes = {
+        list: { url: '/gameshows', method: HTTP_METHODS.GET },
+        create: { url: '/gameshows', method: HTTP_METHODS.POST },
+        view: { url: '/gameshows/{show_id}', method: HTTP_METHODS.GET },
+        update: { url: '/gameshows/{show_id}', method: HTTP_METHODS.PUT },
+        delete: { url: '/gameshows/{show_id}', method: HTTP_METHODS.DELETE },
+        uploadLogo: { url: '/gameshows/{show_id}/uploadLogo', method: HTTP_METHODS.POST },
+        uploadBannerImage: { url: '/gameshows/{show_id}/uploadBannerImage', method: HTTP_METHODS.POST },
+        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 },
+        viewTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.GET },
+        updateTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.PUT },
+        deleteTitle: { url: '/gameshows/{show_id}/titles/{title_id}', method: HTTP_METHODS.DELETE },
+    };
+    return GameShowsRoute;
+}());
+
+var GameShows = /** @class */ (function () {
+    function GameShows() {
+    }
+    /**
+     * List all the GameShows.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/getGameShows
+     *
+     * @returns promise
+     */
+    GameShows.list = function (params) {
+        return Requests.processRoute(GameShowsRoute.routes.list, undefined, undefined, params);
+    };
+    /**
+     * Create a new game show.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/createGameShow
+     *
+     * @param data The data to be passed when creating a game show.
+     *
+     * @returns Promise
+     */
+    GameShows.create = function (data, params) {
+        return Requests.processRoute(GameShowsRoute.routes.create, data, undefined, params);
+    };
+    /**
+     * Update a game show.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/updateGameShow
+     *
+     * @param show_id The id of the game show to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    GameShows.update = function (show_id, data, params) {
+        return Requests.processRoute(GameShowsRoute.routes.update, data, { show_id: show_id }, params);
+    };
+    /**
+     * Retrieve the information for a single game show.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/getGameShowByUuid
+     *
+     * @param show_id The id fo the game show to retrieve.
+     *
+     * @returns promise
+     */
+    GameShows.view = function (show_id, params) {
+        return Requests.processRoute(GameShowsRoute.routes.view, {}, { show_id: show_id }, params);
+    };
+    /**
+     * Deletes a game show.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/deleteGameShow
+     *
+     * @param show_id The id of the game show to delete.
+     * @returns promise
+     */
+    GameShows.delete = function (show_id, params) {
+        return Requests.processRoute(GameShowsRoute.routes.delete, {}, { show_id: show_id }, params);
+    };
+    /**
+       * Updates the main image for the game show using a File object.
+       *
+       * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowLogo
+       *
+       * @param file The file object to upload.
+       * @param data Any additional data to pass along to the upload.
+       *
+       * @returns promise
+       */
+    GameShows.uploadLogoFile = function (show_id, file, data, params) {
+        var url = GameShowsRoute.routes.uploadLogo.url.replace('{show_id}', show_id);
+        return Requests.uploadFile(url, 'image', file, data);
+    };
+    /**
+     * Updates the main image for the game show using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowLogo
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    GameShows.uploadLogoBlob = function (show_id, blob, data, params) {
+        var url = GameShowsRoute.routes.uploadLogo.url.replace('{show_id}', show_id);
+        return Requests.uploadBlob(url, 'image', blob, data);
+    };
+    /**
+     * Updates the banner image for the game show using a File object.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
+     *
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    GameShows.uploadBannerImageFile = function (show_id, file, data, params) {
+        var url = GameShowsRoute.routes.uploadBannerImage.url.replace('{show_id}', show_id);
+        return Requests.uploadFile(url, 'image', file, data);
+    };
+    /**
+     * Updates the banner image for the game show using a Blob.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/uploadGameShowBannerImage
+     *
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     *
+     * @returns promise
+     */
+    GameShows.uploadBannerImageBlob = function (show_id, blob, data, params) {
+        var url = GameShowsRoute.routes.uploadBannerImage.url.replace('{show_id}', show_id);
+        return Requests.uploadBlob(url, 'image', blob, data);
+    };
+    /**
+     * Register a title to a game show.
+     */
+    GameShows.registerTitle = function (show_id, data, params) {
+        return Requests.processRoute(GameShowsRoute.routes.registerTitle, data, { show_id: show_id }, params);
+    };
+    /**
+     * Add a title to a game show by admin.
+     */
+    GameShows.addTitle = function (show_id, data, params) {
+        return Requests.processRoute(GameShowsRoute.routes.addTitle, data, { show_id: show_id }, params);
+    };
+    /**
+     * List all titles for a game show.
+     */
+    GameShows.listTitles = function (show_id, params) {
+        return Requests.processRoute(GameShowsRoute.routes.listTitles, {}, { show_id: show_id }, params);
+    };
+    /**
+     * Get details of a specific title in a game show.
+     */
+    GameShows.getTitle = function (show_id, title_id, params) {
+        return Requests.processRoute(GameShowsRoute.routes.getTitle, {}, { show_id: show_id, title_id: title_id }, params);
+    };
+    /**
+     * Update a specific title in a game show.
+     */
+    GameShows.updateTitle = function (show_id, title_id, data, params) {
+        return Requests.processRoute(GameShowsRoute.routes.updateTitle, data, { show_id: show_id, title_id: title_id }, params);
+    };
+    /**
+     * Delete a specific title from a game show.
+     */
+    GameShows.deleteTitle = function (show_id, title_id, params) {
+        return Requests.processRoute(GameShowsRoute.routes.deleteTitle, {}, { show_id: show_id, title_id: title_id }, params);
+    };
+    return GameShows;
+}());
+
 var Parser = /** @class */ (function () {
     function Parser() {
     }
@@ -10846,6 +11311,7 @@ var Glitch = /** @class */ (function () {
         Users: Users,
         Events: Events,
         Games: Games,
+        GameShows: GameShows,
         Feedback: Feedback,
         Influencers: Influencers,
         Teams: Teams,