perspectapi-ts-sdk 3.7.0 → 4.1.0

package/dist/index.js

@@ -33,6 +33,7 @@ __export(index_exports, {
   HttpClient: () => HttpClient,
   InMemoryCacheAdapter: () => InMemoryCacheAdapter,
   NewsletterClient: () => NewsletterClient,
+  NewsletterManagementClient: () => NewsletterManagementClient,
   NoopCacheAdapter: () => NoopCacheAdapter,
   OrganizationsClient: () => OrganizationsClient,
   PerspectApiClient: () => PerspectApiClient,
@@ -2221,112 +2222,6 @@ var NewsletterClient = class extends BaseClient {
       { email }
     );
   }
-  // Admin methods (require authentication)
-  /**
-   * Get all newsletter subscriptions (admin only)
-   */
-  async getSubscriptions(siteName, params) {
-    return this.getPaginated(
-      this.newsletterEndpoint(siteName, "/newsletter/subscriptions"),
-      params
-    );
-  }
-  /**
-   * Get subscription by ID (admin only)
-   */
-  async getSubscriptionById(siteName, id) {
-    return this.getSingle(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`)
-    );
-  }
-  /**
-   * Update subscription status (admin only)
-   */
-  async updateSubscriptionStatus(siteName, id, status, notes) {
-    return this.patch(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`),
-      { status, notes }
-    );
-  }
-  /**
-   * Delete subscription (admin only)
-   */
-  async deleteSubscription(siteName, id) {
-    return this.delete(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`)
-    );
-  }
-  /**
-   * Bulk update subscriptions (admin only)
-   */
-  async bulkUpdateSubscriptions(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/subscriptions/bulk-update"),
-      data
-    );
-  }
-  /**
-   * Create newsletter list (admin only)
-   */
-  async createList(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/lists"),
-      data
-    );
-  }
-  /**
-   * Update newsletter list (admin only)
-   */
-  async updateList(siteName, listId, data) {
-    return this.update(
-      this.newsletterEndpoint(siteName, `/newsletter/lists/${encodeURIComponent(listId)}`),
-      data
-    );
-  }
-  /**
-   * Delete newsletter list (admin only)
-   */
-  async deleteList(siteName, listId) {
-    return this.delete(
-      this.newsletterEndpoint(siteName, `/newsletter/lists/${encodeURIComponent(listId)}`)
-    );
-  }
-  /**
-   * Get newsletter statistics (admin only)
-   */
-  async getStatistics(siteName, params) {
-    return this.http.get(
-      this.buildPath(this.newsletterEndpoint(siteName, "/newsletter/statistics")),
-      params
-    );
-  }
-  /**
-   * Export newsletter subscriptions (admin only)
-   */
-  async exportSubscriptions(siteName, params) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/export"),
-      params || {}
-    );
-  }
-  /**
-   * Import newsletter subscriptions (admin only)
-   */
-  async importSubscriptions(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/import"),
-      data
-    );
-  }
-  /**
-   * Send test newsletter (admin only)
-   */
-  async sendTestNewsletter(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/test"),
-      data
-    );
-  }
   // ============================================
   // Tracking methods (for first-party tracking)
   // ============================================
@@ -2510,6 +2405,181 @@ var NewsletterClient = class extends BaseClient {
   }
 };
 
+// src/client/newsletter-management-client.ts
+var NewsletterManagementClient = class extends BaseClient {
+  constructor(http, cache) {
+    super(http, "/api/v1", cache);
+  }
+  managementEndpoint(siteName, endpoint) {
+    return this.siteScopedEndpoint(
+      siteName,
+      `/newsletter/management${endpoint}`,
+      { includeSitesSegment: false }
+    );
+  }
+  async listSubscriptions(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/subscriptions")),
+      params
+    );
+  }
+  async getSubscriptionById(siteName, subscriptionId) {
+    return this.getSingle(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      )
+    );
+  }
+  async getSubscriptionByEmail(siteName, email) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/subscriptions/by-email")),
+      { email }
+    );
+  }
+  async syncSubscription(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/subscriptions/sync"), data);
+  }
+  async updateSubscription(siteName, subscriptionId, data) {
+    return this.patch(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      ),
+      data
+    );
+  }
+  async deleteSubscription(siteName, subscriptionId) {
+    return this.delete(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      )
+    );
+  }
+  async bulkUpdateSubscriptions(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/subscriptions/bulk"), data);
+  }
+  async updateSubscriptionListMembership(siteName, subscriptionId, data) {
+    return this.create(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}/list-membership`
+      ),
+      data
+    );
+  }
+  async importSubscriptions(siteName, data) {
+    return this.create(
+      this.managementEndpoint(siteName, "/subscriptions/import"),
+      data
+    );
+  }
+  async listLists(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/lists")),
+      params
+    );
+  }
+  async getListById(siteName, listId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`)
+    );
+  }
+  async createList(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/lists"), data);
+  }
+  async updateList(siteName, listId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`),
+      data
+    );
+  }
+  async deleteList(siteName, listId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`)
+    );
+  }
+  async listSeries(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/series")),
+      params
+    );
+  }
+  async getSeriesById(siteName, seriesId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`)
+    );
+  }
+  async createSeries(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/series"), data);
+  }
+  async updateSeries(siteName, seriesId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`),
+      data
+    );
+  }
+  async deleteSeries(siteName, seriesId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`)
+    );
+  }
+  async listCampaigns(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/campaigns")),
+      params
+    );
+  }
+  async getCampaignById(siteName, campaignId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`)
+    );
+  }
+  async createCampaign(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/campaigns"), data);
+  }
+  async updateCampaign(siteName, campaignId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`),
+      data
+    );
+  }
+  async deleteCampaign(siteName, campaignId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`)
+    );
+  }
+  async sendCampaignTest(siteName, campaignId, data) {
+    return this.create(
+      this.managementEndpoint(
+        siteName,
+        `/campaigns/${encodeURIComponent(campaignId)}/test-send`
+      ),
+      data
+    );
+  }
+  async getStats(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/stats")),
+      params
+    );
+  }
+  async createExport(siteName, data) {
+    return this.create(
+      this.managementEndpoint(siteName, "/exports"),
+      data
+    );
+  }
+  async downloadExport(siteName, exportId) {
+    return this.http.get(
+      this.buildPath(
+        this.managementEndpoint(siteName, `/exports/${encodeURIComponent(exportId)}/download`)
+      )
+    );
+  }
+};
+
 // src/client/site-users-client.ts
 var SiteUsersClient = class extends BaseClient {
   constructor(http, cache) {
@@ -3161,6 +3231,7 @@ var PerspectApiClient = class {
   checkout;
   contact;
   newsletter;
+  newsletterManagement;
   siteUsers;
   bundles;
   constructor(config) {
@@ -3180,6 +3251,7 @@ var PerspectApiClient = class {
     this.checkout = new CheckoutClient(this.http, this.cache);
     this.contact = new ContactClient(this.http, this.cache);
     this.newsletter = new NewsletterClient(this.http, this.cache);
+    this.newsletterManagement = new NewsletterManagementClient(this.http, this.cache);
     this.siteUsers = new SiteUsersClient(this.http, this.cache);
     this.bundles = new BundlesClient(this.http, this.cache);
   }
@@ -3868,6 +3940,7 @@ async function createCheckoutSession(options) {
   HttpClient,
   InMemoryCacheAdapter,
   NewsletterClient,
+  NewsletterManagementClient,
   NoopCacheAdapter,
   OrganizationsClient,
   PerspectApiClient,

package/dist/index.mjs

@@ -2158,112 +2158,6 @@ var NewsletterClient = class extends BaseClient {
       { email }
     );
   }
-  // Admin methods (require authentication)
-  /**
-   * Get all newsletter subscriptions (admin only)
-   */
-  async getSubscriptions(siteName, params) {
-    return this.getPaginated(
-      this.newsletterEndpoint(siteName, "/newsletter/subscriptions"),
-      params
-    );
-  }
-  /**
-   * Get subscription by ID (admin only)
-   */
-  async getSubscriptionById(siteName, id) {
-    return this.getSingle(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`)
-    );
-  }
-  /**
-   * Update subscription status (admin only)
-   */
-  async updateSubscriptionStatus(siteName, id, status, notes) {
-    return this.patch(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`),
-      { status, notes }
-    );
-  }
-  /**
-   * Delete subscription (admin only)
-   */
-  async deleteSubscription(siteName, id) {
-    return this.delete(
-      this.newsletterEndpoint(siteName, `/newsletter/subscriptions/${encodeURIComponent(id)}`)
-    );
-  }
-  /**
-   * Bulk update subscriptions (admin only)
-   */
-  async bulkUpdateSubscriptions(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/subscriptions/bulk-update"),
-      data
-    );
-  }
-  /**
-   * Create newsletter list (admin only)
-   */
-  async createList(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/lists"),
-      data
-    );
-  }
-  /**
-   * Update newsletter list (admin only)
-   */
-  async updateList(siteName, listId, data) {
-    return this.update(
-      this.newsletterEndpoint(siteName, `/newsletter/lists/${encodeURIComponent(listId)}`),
-      data
-    );
-  }
-  /**
-   * Delete newsletter list (admin only)
-   */
-  async deleteList(siteName, listId) {
-    return this.delete(
-      this.newsletterEndpoint(siteName, `/newsletter/lists/${encodeURIComponent(listId)}`)
-    );
-  }
-  /**
-   * Get newsletter statistics (admin only)
-   */
-  async getStatistics(siteName, params) {
-    return this.http.get(
-      this.buildPath(this.newsletterEndpoint(siteName, "/newsletter/statistics")),
-      params
-    );
-  }
-  /**
-   * Export newsletter subscriptions (admin only)
-   */
-  async exportSubscriptions(siteName, params) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/export"),
-      params || {}
-    );
-  }
-  /**
-   * Import newsletter subscriptions (admin only)
-   */
-  async importSubscriptions(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/import"),
-      data
-    );
-  }
-  /**
-   * Send test newsletter (admin only)
-   */
-  async sendTestNewsletter(siteName, data) {
-    return this.create(
-      this.newsletterEndpoint(siteName, "/newsletter/test"),
-      data
-    );
-  }
   // ============================================
   // Tracking methods (for first-party tracking)
   // ============================================
@@ -2447,6 +2341,181 @@ var NewsletterClient = class extends BaseClient {
   }
 };
 
+// src/client/newsletter-management-client.ts
+var NewsletterManagementClient = class extends BaseClient {
+  constructor(http, cache) {
+    super(http, "/api/v1", cache);
+  }
+  managementEndpoint(siteName, endpoint) {
+    return this.siteScopedEndpoint(
+      siteName,
+      `/newsletter/management${endpoint}`,
+      { includeSitesSegment: false }
+    );
+  }
+  async listSubscriptions(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/subscriptions")),
+      params
+    );
+  }
+  async getSubscriptionById(siteName, subscriptionId) {
+    return this.getSingle(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      )
+    );
+  }
+  async getSubscriptionByEmail(siteName, email) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/subscriptions/by-email")),
+      { email }
+    );
+  }
+  async syncSubscription(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/subscriptions/sync"), data);
+  }
+  async updateSubscription(siteName, subscriptionId, data) {
+    return this.patch(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      ),
+      data
+    );
+  }
+  async deleteSubscription(siteName, subscriptionId) {
+    return this.delete(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}`
+      )
+    );
+  }
+  async bulkUpdateSubscriptions(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/subscriptions/bulk"), data);
+  }
+  async updateSubscriptionListMembership(siteName, subscriptionId, data) {
+    return this.create(
+      this.managementEndpoint(
+        siteName,
+        `/subscriptions/${encodeURIComponent(subscriptionId)}/list-membership`
+      ),
+      data
+    );
+  }
+  async importSubscriptions(siteName, data) {
+    return this.create(
+      this.managementEndpoint(siteName, "/subscriptions/import"),
+      data
+    );
+  }
+  async listLists(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/lists")),
+      params
+    );
+  }
+  async getListById(siteName, listId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`)
+    );
+  }
+  async createList(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/lists"), data);
+  }
+  async updateList(siteName, listId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`),
+      data
+    );
+  }
+  async deleteList(siteName, listId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/lists/${encodeURIComponent(listId)}`)
+    );
+  }
+  async listSeries(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/series")),
+      params
+    );
+  }
+  async getSeriesById(siteName, seriesId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`)
+    );
+  }
+  async createSeries(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/series"), data);
+  }
+  async updateSeries(siteName, seriesId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`),
+      data
+    );
+  }
+  async deleteSeries(siteName, seriesId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/series/${encodeURIComponent(seriesId)}`)
+    );
+  }
+  async listCampaigns(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/campaigns")),
+      params
+    );
+  }
+  async getCampaignById(siteName, campaignId) {
+    return this.getSingle(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`)
+    );
+  }
+  async createCampaign(siteName, data) {
+    return this.create(this.managementEndpoint(siteName, "/campaigns"), data);
+  }
+  async updateCampaign(siteName, campaignId, data) {
+    return this.update(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`),
+      data
+    );
+  }
+  async deleteCampaign(siteName, campaignId) {
+    return this.delete(
+      this.managementEndpoint(siteName, `/campaigns/${encodeURIComponent(campaignId)}`)
+    );
+  }
+  async sendCampaignTest(siteName, campaignId, data) {
+    return this.create(
+      this.managementEndpoint(
+        siteName,
+        `/campaigns/${encodeURIComponent(campaignId)}/test-send`
+      ),
+      data
+    );
+  }
+  async getStats(siteName, params) {
+    return this.http.get(
+      this.buildPath(this.managementEndpoint(siteName, "/stats")),
+      params
+    );
+  }
+  async createExport(siteName, data) {
+    return this.create(
+      this.managementEndpoint(siteName, "/exports"),
+      data
+    );
+  }
+  async downloadExport(siteName, exportId) {
+    return this.http.get(
+      this.buildPath(
+        this.managementEndpoint(siteName, `/exports/${encodeURIComponent(exportId)}/download`)
+      )
+    );
+  }
+};
+
 // src/client/site-users-client.ts
 var SiteUsersClient = class extends BaseClient {
   constructor(http, cache) {
@@ -3098,6 +3167,7 @@ var PerspectApiClient = class {
   checkout;
   contact;
   newsletter;
+  newsletterManagement;
   siteUsers;
   bundles;
   constructor(config) {
@@ -3117,6 +3187,7 @@ var PerspectApiClient = class {
     this.checkout = new CheckoutClient(this.http, this.cache);
     this.contact = new ContactClient(this.http, this.cache);
     this.newsletter = new NewsletterClient(this.http, this.cache);
+    this.newsletterManagement = new NewsletterManagementClient(this.http, this.cache);
     this.siteUsers = new SiteUsersClient(this.http, this.cache);
     this.bundles = new BundlesClient(this.http, this.cache);
   }
@@ -3804,6 +3875,7 @@ export {
   HttpClient,
   InMemoryCacheAdapter,
   NewsletterClient,
+  NewsletterManagementClient,
   NoopCacheAdapter,
   OrganizationsClient,
   PerspectApiClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perspectapi-ts-sdk",
-  "version": "3.7.0",
+  "version": "4.1.0",
   "description": "TypeScript SDK for PerspectAPI - Cloudflare Workers compatible",
   "main": "dist/index.js",
   "module": "dist/index.mjs",