glitch-javascript-sdk 1.6.4 → 1.6.5

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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "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/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 },