glitch-javascript-sdk 2.6.2 → 2.6.3

package/dist/index.d.ts

@@ -5430,6 +5430,90 @@ declare class Newsletters {
      * @param data { name, email, game, categories[] }
      */
     static joinDiscordMarketplaceWaitlist<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List all newsletter campaigns (Admin only).
+     *
+     * @param params Query parameters for pagination and filtering.
+     * @returns Promise
+     */
+    static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new newsletter campaign draft (Admin only).
+     *
+     * @param data { subject, content_html, content_json }
+     * @returns Promise
+     */
+    static createCampaign<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a specific newsletter campaign (Admin only).
+     *
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    static viewCampaign<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Update a newsletter campaign draft (Admin only).
+     *
+     * @param id The UUID of the campaign.
+     * @param data The updated campaign data.
+     * @returns Promise
+     */
+    static updateCampaign<T>(id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Get analytics for a specific campaign (Admin only).
+     * Returns open rates, click rates, and human vs proxy metrics.
+     *
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    static getCampaignStats<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
+     *
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    static sendCampaign<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * List all newsletter subscribers (Admin only).
+     *
+     * @param params Query parameters for pagination and filtering.
+     * @returns Promise
+     */
+    static listSubscribers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Delete a newsletter campaign (Admin only).
+     */
+    static deleteCampaign<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Send a test email of a campaign to a specific address (Admin only).
+     */
+    static sendTestEmail<T>(id: string, email: string): AxiosPromise<Response<T>>;
+    /**
+     * Get detailed delivery and open logs for a campaign (Admin only).
+     */
+    static getDetailedLogs<T>(id: string, params?: object): AxiosPromise<Response<T>>;
+    /**
+     * Manually create a new subscriber (Admin only).
+     */
+    static createSubscriber<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a subscriber's details or status (Admin only).
+     */
+    static updateSubscriber<T>(id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Delete a subscriber (Admin only).
+     */
+    static deleteSubscriber<T>(id: string): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a specific subscriber's details (Admin only).
+     *
+     * @see https://api.glitch.fun/api/documentation#/Newsletter%20Admin/showNewsletterSubscriber
+     *
+     * @param id The UUID of the subscriber.
+     * @returns Promise
+     */
+    static viewSubscriber<T>(id: string): AxiosPromise<Response<T>>;
 }
 
 declare class PlayTests {

package/package.json

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

package/src/api/Newsletters.ts

@@ -49,6 +49,134 @@ class Newsletters {
         return Requests.processRoute(NewslettersRoutes.routes.joinDiscordMarketplaceWaitlist, data, undefined, params);
     }
 
+    /**
+     * List all newsletter campaigns (Admin only).
+     * 
+     * @param params Query parameters for pagination and filtering.
+     * @returns Promise
+     */
+    public static listCampaigns<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.listCampaigns, undefined, undefined, params);
+    }
+
+    /**
+     * Create a new newsletter campaign draft (Admin only).
+     * 
+     * @param data { subject, content_html, content_json }
+     * @returns Promise
+     */
+    public static createCampaign<T>(data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.createCampaign, data);
+    }
+
+    /**
+     * Retrieve a specific newsletter campaign (Admin only).
+     * 
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    public static viewCampaign<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.viewCampaign, undefined, { id });
+    }
+
+    /**
+     * Update a newsletter campaign draft (Admin only).
+     * 
+     * @param id The UUID of the campaign.
+     * @param data The updated campaign data.
+     * @returns Promise
+     */
+    public static updateCampaign<T>(id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.updateCampaign, data, { id });
+    }
+
+    /**
+     * Get analytics for a specific campaign (Admin only).
+     * Returns open rates, click rates, and human vs proxy metrics.
+     * 
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    public static getCampaignStats<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.getStats, undefined, { id });
+    }
+
+    /**
+     * Trigger the delivery of a newsletter campaign to all active subscribers (Admin only).
+     * 
+     * @param id The UUID of the campaign.
+     * @returns Promise
+     */
+    public static sendCampaign<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.sendCampaign, undefined, { id });
+    }
+
+    /**
+     * List all newsletter subscribers (Admin only).
+     * 
+     * @param params Query parameters for pagination and filtering.
+     * @returns Promise
+     */
+    public static listSubscribers<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.listSubscribers, undefined, undefined, params);
+    }
+
+    /**
+     * Delete a newsletter campaign (Admin only).
+     */
+    public static deleteCampaign<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.deleteCampaign, undefined, { id });
+    }
+
+    /**
+     * Send a test email of a campaign to a specific address (Admin only).
+     */
+    public static sendTestEmail<T>(id: string, email: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.sendTest, { email }, { id });
+    }
+
+    /**
+     * Get detailed delivery and open logs for a campaign (Admin only).
+     */
+    public static getDetailedLogs<T>(id: string, params?: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.getLogs, undefined, { id }, params);
+    }
+
+    /**
+     * Manually create a new subscriber (Admin only).
+     */
+    public static createSubscriber<T>(data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.createSubscriber, data);
+    }
+
+    /**
+     * Update a subscriber's details or status (Admin only).
+     */
+    public static updateSubscriber<T>(id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.updateSubscriber, data, { id });
+    }
+
+    /**
+     * Delete a subscriber (Admin only).
+     */
+    public static deleteSubscriber<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.deleteSubscriber, undefined, { id });
+    }
+
+
+    /**
+     * Retrieve a specific subscriber's details (Admin only).
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Newsletter%20Admin/showNewsletterSubscriber
+     * 
+     * @param id The UUID of the subscriber.
+     * @returns Promise
+     */
+    public static viewSubscriber<T>(id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(NewslettersRoutes.routes.viewSubscriber, undefined, { id });
+    }
+
+   
 
 }
 

package/src/routes/NewslettersRoutes.ts

@@ -8,6 +8,21 @@ class NewslettersRoutes {
     joinCourseWaitlist: { url: '/newsletters/joinCourseWaitlist', method: HTTP_METHODS.POST },
     joinRaffleWaitlist: { url: '/newsletters/joinRaffleWaitlist', method: HTTP_METHODS.POST },
     joinDiscordMarketplaceWaitlist: { url: '/newsletters/joinDiscordMarketplaceWaitlist', method: HTTP_METHODS.POST },
+
+    // --- New Admin Routes ---
+    listCampaigns: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.GET },
+    createCampaign: { url: '/admin/newsletters/campaigns', method: HTTP_METHODS.POST },
+    viewCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.GET },
+    updateCampaign: { url: '/admin/newsletters/campaigns/{id}', method: HTTP_METHODS.PUT },
+    getStats: { url: '/admin/newsletters/campaigns/{id}/stats', method: HTTP_METHODS.GET },
+    sendCampaign: { url: '/admin/newsletters/campaigns/{id}/send', method: HTTP_METHODS.POST },
+    listSubscribers: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.GET },
+
+    // --- Subscriber Management (Admin) ---
+    createSubscriber: { url: '/admin/newsletters/subscribers', method: HTTP_METHODS.POST },
+    viewSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.GET },
+    updateSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.PUT },
+    deleteSubscriber: { url: '/admin/newsletters/subscribers/{id}', method: HTTP_METHODS.DELETE },
   };
 
 }