glitch-javascript-sdk 1.2.6 → 1.2.8

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

@@ -348,5 +348,202 @@ declare class Communities {
      * @returns Promise
      */
     static populateEmailTemplate<T>(community_id: string, template_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+   * List all newsletters for a community.
+   *
+   * @param community_id The ID of the community.
+   * @param params Query parameters.
+   * @returns Promise
+   */
+    static listNewsletters<T>(community_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static createNewsletter<T>(community_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static viewNewsletter<T>(community_id: string, newsletter_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static updateNewsletter<T>(community_id: string, newsletter_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete a specific newsletter.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @returns Promise
+     */
+    static deleteNewsletter<T>(community_id: string, newsletter_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static importNewsletterSubscribers<T>(community_id: string, newsletter_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+    */
+    static uploadNewsletterBannerImageFile<T>(community_id: string, newsletter_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static uploadNewsletterBannerImageBlob<T>(community_id: string, newsletter_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static listCampaigns<T>(community_id: string, newsletter_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static createCampaign<T>(community_id: string, newsletter_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static viewCampaign<T>(community_id: string, newsletter_id: string, campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static updateCampaign<T>(community_id: string, newsletter_id: string, campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static deleteCampaign<T>(community_id: string, newsletter_id: string, campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static sendCampaign<T>(community_id: string, newsletter_id: string, campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static scheduleCampaign<T>(community_id: string, newsletter_id: string, campaign_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static listCampaignEmails<T>(community_id: string, newsletter_id: string, campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static listNewsletterSubscribers<T>(community_id: string, newsletter_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static viewNewsletterSubscriber<T>(community_id: string, newsletter_id: string, subscriber_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static updateNewsletterSubscriber<T>(community_id: string, newsletter_id: string, subscriber_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static deleteNewsletterSubscriber<T>(community_id: string, newsletter_id: string, subscriber_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static registerNewsletterSubscriber<T>(community_id: string, newsletter_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Communities;

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

@@ -0,0 +1,121 @@
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+declare class GameShows {
+    /**
+     * List all the GameShows.
+     *
+     * @see https://api.glitch.fun/api/documentation#/GameShows/getGameShows
+     *
+     * @returns promise
+     */
+    static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static update<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static view<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static delete<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+       * 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
+       */
+    static uploadLogoFile<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static uploadLogoBlob<T>(show_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static uploadBannerImageFile<T>(show_id: string, file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * 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
+     */
+    static uploadBannerImageBlob<T>(show_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Register a title to a game show.
+     */
+    static registerTitle<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Add a title to a game show by admin.
+     */
+    static addTitle<T>(show_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List all titles for a game show.
+     */
+    static listTitles<T>(show_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get details of a specific title in a game show.
+     */
+    static getTitle<T>(show_id: string, title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update a specific title in a game show.
+     */
+    static updateTitle<T>(show_id: string, title_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete a specific title from a game show.
+     */
+    static deleteTitle<T>(show_id: string, title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+export default GameShows;

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

@@ -81,5 +81,13 @@ declare class Influencers {
     * @returns promise
     */
     static listContracts<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Download the influencer work
+     *
+     * @see https://api.glitch.fun/api/documentation#/Influencers/downloadInfluencersWorkbook
+     *
+     * @returns promise
+     */
+    static workbook<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Influencers;

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

@@ -18,6 +18,6 @@ declare class Publications {
      *
      * @returns Promise
      */
-    static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static download<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 export default Publications;

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

@@ -22,6 +22,7 @@ import Feedback from "./Feedback";
 import Influencers from "./Influencers";
 import Games from "./Games";
 import Publications from "./Publications";
+import GameShows from "./GameShows";
 export { Auth };
 export { Competitions };
 export { Communities };
@@ -46,3 +47,4 @@ export { Feedback };
 export { Influencers };
 export { Games };
 export { Publications };
+export { GameShows };

package/dist/esm/index.d.ts

@@ -22,6 +22,7 @@ import { Feedback } from "./api";
 import { Influencers } from "./api";
 import { Games } from "./api";
 import { Publications } from "./api";
+import { GameShows } from "./api";
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
 import Session from "./util/Session";
@@ -48,6 +49,7 @@ declare class Glitch {
         Users: typeof Users;
         Events: typeof Events;
         Games: typeof Games;
+        GameShows: typeof GameShows;
         Feedback: typeof Feedback;
         Influencers: typeof Influencers;
         Teams: typeof Teams;