glitch-javascript-sdk 1.6.4 → 1.6.6

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

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

package/dist/index.d.ts

@@ -1223,6 +1223,19 @@ declare class Communities {
     * @param params Optional date-range filter (start_date, end_date, etc.)
     */
     static newsletterSubscriberTrend<T>(community_id: string, newsletter_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Export subscribers for a specific newsletter.
+     * The file is generated asynchronously on the server and
+     * the user is emailed a link to download the file.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param data Export options (format: 'csv' or 'xlsx').
+     * @returns Promise
+     */
+    static exportNewsletterSubscribers<T>(community_id: string, newsletter_id: string, data: {
+        format: 'csv' | 'xlsx';
+    }, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Users {
@@ -2943,6 +2956,17 @@ declare class Titles {
      * Revoke a specific token by ID.
      */
     static revokeTitleToken<T>(title_id: string, token_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Search for Titles using Meilisearch or fallback based on the query and filters.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Titles/searchTitles
+     *
+     * @param params Object of query params:
+     *   - q?: string, filters?: string,
+     *   - sort_by?: string, sort_order?: 'asc'|'desc',
+     *   - page?: number, per_page?: number
+     */
+    static search<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Campaigns {
@@ -4491,6 +4515,23 @@ declare class SocialStats {
     static view<T>(id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Hashtags {
+    /**
+     * List all the hashtags
+     *
+     *
+     * @returns A promise
+     */
+    static list<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get the top hashtags for a title, campaign, or schedule.
+     *
+     * @param params - e.g. { title_id: '...', limit: 10, sort: 'sum_views', start_date: 'YYYY-MM-DD', end_date: 'YYYY-MM-DD' }
+     * @returns AxiosPromise of an array of aggregated hashtags
+     */
+    static top<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -4798,6 +4839,7 @@ declare class Glitch {
         Events: typeof Events;
         Games: typeof Games;
         GameShows: typeof GameShows;
+        Hashtags: typeof Hashtags;
         Feedback: typeof Feedback;
         Influencers: typeof Influencers;
         Teams: typeof Teams;

package/package.json

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

package/src/api/Communities.ts

@@ -850,7 +850,29 @@ class Communities {
         );
     }
 
-
+    /**
+     * Export subscribers for a specific newsletter.
+     * The file is generated asynchronously on the server and
+     * the user is emailed a link to download the file.
+     *
+     * @param community_id The ID of the community.
+     * @param newsletter_id The ID of the newsletter.
+     * @param data Export options (format: 'csv' or 'xlsx').
+     * @returns Promise
+     */
+        public static exportNewsletterSubscribers<T>(
+            community_id: string,
+            newsletter_id: string,
+            data: { format: 'csv' | 'xlsx' },
+            params?: Record<string, any>
+        ): AxiosPromise<Response<T>> {
+            return Requests.processRoute(
+                CommunitiesRoute.routes.exportNewsletterSubscribers,
+                data,
+                { community_id, newsletter_id },
+                params
+            );
+        }
 
 
 }

package/src/api/Hashtags.ts

@@ -0,0 +1,31 @@
+import AuthRoutes from "../routes/AuthRoute";
+import HashtagRoute from "../routes/HashtagRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Hashtags {
+
+    /**
+     * List all the hashtags
+     * 
+     * 
+     * @returns A promise
+     */
+    public static list<T>(data? : object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(HashtagRoute.routes.list, data, {}, params);
+    }
+
+    /**
+     * Get the top hashtags for a title, campaign, or schedule.
+     * 
+     * @param params - e.g. { title_id: '...', limit: 10, sort: 'sum_views', start_date: 'YYYY-MM-DD', end_date: 'YYYY-MM-DD' }
+     * @returns AxiosPromise of an array of aggregated hashtags
+     */
+    public static top<T>(data? : object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(HashtagRoute.routes.list, data, {}, params);
+    }
+
+}
+
+export default Hashtags;

package/src/api/Titles.ts

@@ -238,7 +238,7 @@ class Titles {
      * @returns AxiosPromise
      */
     public static importWishlist<T>(
-        title_id: string, 
+        title_id: string,
         file: File | Blob,
         data?: Record<string, any>,
         params?: Record<string, any>
@@ -255,7 +255,7 @@ class Titles {
      * @returns AxiosPromise
      */
     public static getWishlist<T>(
-        title_id: string, 
+        title_id: string,
         params?: Record<string, any>
     ): AxiosPromise<Response<T>> {
         let url = TitlesRoute.routes.getWishlist.url.replace('{title_id}', title_id);
@@ -266,43 +266,57 @@ class Titles {
    * Create a new API token for a title.
    * Returns { full_token: string, token: TitleToken }.
    */
-  public static createTitleToken<T>(
-    title_id: string,
-    data?: { expires_at?: string }
-  ): AxiosPromise<Response<T>> {
-    return Requests.processRoute(
-      TitlesRoute.routes.createToken,
-      data,
-      { title_id }
-    );
-  }
-
-  /**
-   * List all tokens for a title.
-   */
-  public static listTitleTokens<T>(
-    title_id: string
-  ): AxiosPromise<Response<T>> {
-    return Requests.processRoute(
-      TitlesRoute.routes.listTokens,
-      {},
-      { title_id }
-    );
-  }
-
-  /**
-   * Revoke a specific token by ID.
-   */
-  public static revokeTitleToken<T>(
-    title_id: string,
-    token_id: string
-  ): AxiosPromise<Response<T>> {
-    return Requests.processRoute(
-      TitlesRoute.routes.revokeToken,
-      {},
-      { title_id, token_id }
-    );
-  }
+    public static createTitleToken<T>(
+        title_id: string,
+        data?: { expires_at?: string }
+    ): AxiosPromise<Response<T>> {
+        return Requests.processRoute(
+            TitlesRoute.routes.createToken,
+            data,
+            { title_id }
+        );
+    }
+
+    /**
+     * List all tokens for a title.
+     */
+    public static listTitleTokens<T>(
+        title_id: string
+    ): AxiosPromise<Response<T>> {
+        return Requests.processRoute(
+            TitlesRoute.routes.listTokens,
+            {},
+            { title_id }
+        );
+    }
+
+    /**
+     * Revoke a specific token by ID.
+     */
+    public static revokeTitleToken<T>(
+        title_id: string,
+        token_id: string
+    ): AxiosPromise<Response<T>> {
+        return Requests.processRoute(
+            TitlesRoute.routes.revokeToken,
+            {},
+            { title_id, token_id }
+        );
+    }
+
+    /**
+     * Search for Titles using Meilisearch or fallback based on the query and filters.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Titles/searchTitles
+     * 
+     * @param params Object of query params:
+     *   - q?: string, filters?: string,
+     *   - sort_by?: string, sort_order?: 'asc'|'desc',
+     *   - page?: number, per_page?: number
+     */
+    public static search<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TitlesRoute.routes.search, {}, undefined, params);
+    }
 
 }
 

package/src/api/index.ts

@@ -29,6 +29,7 @@ import Media from "./Media";
 import Scheduler from "./Scheduler";
 import Funnel from "./Funnel";
 import SocialStats from "./SocialStats";
+import Hashtags from "./Hashtags";
 
 export {Auth};
 export {Competitions};
@@ -60,4 +61,5 @@ export {PlayTests};
 export {Media};
 export {Scheduler};
 export {Funnel};
-export {SocialStats};
+export {SocialStats};
+export {Hashtags};

package/src/index.ts

@@ -33,6 +33,7 @@ import {Media} from "./api";
 import {Scheduler} from "./api";
 import {Funnel} from "./api";
 import {SocialStats} from "./api";
+import {Hashtags} from "./api";
 
 
 
@@ -74,6 +75,7 @@ class Glitch {
         Events: Events,
         Games : Games,
         GameShows : GameShows,
+        Hashtags: Hashtags,
         Feedback : Feedback,
         Influencers : Influencers,
         Teams: Teams,

package/src/routes/CommunitiesRoute.ts

@@ -59,6 +59,11 @@ class CommunitiesRoute {
       method: HTTP_METHODS.GET
     },
 
+    exportNewsletterSubscribers: { 
+      url: '/communities/{community_id}/newsletters/{newsletter_id}/subscribers/export', 
+      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 },

package/src/routes/HashtagRoute.ts

@@ -0,0 +1,13 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class HashtagRoute {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/hashtags', method: HTTP_METHODS.GET },
+      top: { url: '/hashtags/top', method: HTTP_METHODS.GET },
+    };
+
+  }
+
+  export default HashtagRoute;

package/src/routes/TitlesRoute.ts

@@ -23,6 +23,7 @@ class TitlesRoute {
     createToken: { url: '/titles/{title_id}/tokens', method: HTTP_METHODS.POST },
     listTokens: { url: '/titles/{title_id}/tokens', method: HTTP_METHODS.GET },
     revokeToken: { url: '/titles/{title_id}/tokens/{token_id}', method: HTTP_METHODS.DELETE },
+    search: { url: '/titles/search', method: HTTP_METHODS.GET },
   };
 
 }