perspectapi-ts-sdk 1.1.1 → 1.2.0

package/dist/index.js

@@ -28,6 +28,7 @@ __export(index_exports, {
   ContactClient: () => ContactClient,
   ContentClient: () => ContentClient,
   HttpClient: () => HttpClient,
+  NewsletterClient: () => NewsletterClient,
   OrganizationsClient: () => OrganizationsClient,
   PerspectApiClient: () => PerspectApiClient,
   ProductsClient: () => ProductsClient,
@@ -1267,6 +1268,185 @@ var ContactClient = class extends BaseClient {
   }
 };
 
+// src/client/newsletter-client.ts
+var NewsletterClient = class extends BaseClient {
+  constructor(http) {
+    super(http, "/api/v1");
+  }
+  /**
+   * Build a newsletter endpoint scoped to a site (without /sites prefix)
+   */
+  newsletterEndpoint(siteName, endpoint) {
+    return this.siteScopedEndpoint(siteName, endpoint, { includeSitesSegment: false });
+  }
+  /**
+   * Subscribe to newsletter
+   */
+  async subscribe(siteName, data) {
+    return this.create(
+      this.newsletterEndpoint(siteName, "/newsletter/subscribe"),
+      data
+    );
+  }
+  /**
+   * Confirm newsletter subscription via token
+   */
+  async confirmSubscription(siteName, token) {
+    return this.getSingle(
+      this.newsletterEndpoint(siteName, `/newsletter/confirm/${encodeURIComponent(token)}`)
+    );
+  }
+  /**
+   * Unsubscribe from newsletter
+   */
+  async unsubscribe(siteName, data) {
+    return this.create(
+      this.newsletterEndpoint(siteName, "/newsletter/unsubscribe"),
+      data
+    );
+  }
+  /**
+   * One-click unsubscribe via token (GET request)
+   */
+  async unsubscribeByToken(siteName, token) {
+    return this.http.get(
+      this.buildPath(this.newsletterEndpoint(siteName, `/newsletter/unsubscribe/${encodeURIComponent(token)}`))
+    );
+  }
+  /**
+   * Update subscription preferences
+   */
+  async updatePreferences(siteName, email, preferences) {
+    return this.patch(
+      this.newsletterEndpoint(siteName, "/newsletter/preferences"),
+      { email, ...preferences }
+    );
+  }
+  /**
+   * Get available newsletter lists
+   */
+  async getLists(siteName) {
+    return this.getSingle(
+      this.newsletterEndpoint(siteName, "/newsletter/lists")
+    );
+  }
+  /**
+   * Check subscription status by email
+   */
+  async getStatus(siteName, email) {
+    return this.http.get(
+      this.buildPath(this.newsletterEndpoint(siteName, "/newsletter/status")),
+      { 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
+    );
+  }
+};
+
 // src/perspect-api-client.ts
 var PerspectApiClient = class {
   http;
@@ -1281,6 +1461,7 @@ var PerspectApiClient = class {
   webhooks;
   checkout;
   contact;
+  newsletter;
   constructor(config) {
     if (!config.baseUrl) {
       throw new Error("baseUrl is required in PerspectApiConfig");
@@ -1296,6 +1477,7 @@ var PerspectApiClient = class {
     this.webhooks = new WebhooksClient(this.http);
     this.checkout = new CheckoutClient(this.http);
     this.contact = new ContactClient(this.http);
+    this.newsletter = new NewsletterClient(this.http);
   }
   /**
    * Update authentication token
@@ -1758,6 +1940,7 @@ async function createCheckoutSession(options) {
   ContactClient,
   ContentClient,
   HttpClient,
+  NewsletterClient,
   OrganizationsClient,
   PerspectApiClient,
   ProductsClient,

package/dist/index.mjs

@@ -1217,6 +1217,185 @@ var ContactClient = class extends BaseClient {
   }
 };
 
+// src/client/newsletter-client.ts
+var NewsletterClient = class extends BaseClient {
+  constructor(http) {
+    super(http, "/api/v1");
+  }
+  /**
+   * Build a newsletter endpoint scoped to a site (without /sites prefix)
+   */
+  newsletterEndpoint(siteName, endpoint) {
+    return this.siteScopedEndpoint(siteName, endpoint, { includeSitesSegment: false });
+  }
+  /**
+   * Subscribe to newsletter
+   */
+  async subscribe(siteName, data) {
+    return this.create(
+      this.newsletterEndpoint(siteName, "/newsletter/subscribe"),
+      data
+    );
+  }
+  /**
+   * Confirm newsletter subscription via token
+   */
+  async confirmSubscription(siteName, token) {
+    return this.getSingle(
+      this.newsletterEndpoint(siteName, `/newsletter/confirm/${encodeURIComponent(token)}`)
+    );
+  }
+  /**
+   * Unsubscribe from newsletter
+   */
+  async unsubscribe(siteName, data) {
+    return this.create(
+      this.newsletterEndpoint(siteName, "/newsletter/unsubscribe"),
+      data
+    );
+  }
+  /**
+   * One-click unsubscribe via token (GET request)
+   */
+  async unsubscribeByToken(siteName, token) {
+    return this.http.get(
+      this.buildPath(this.newsletterEndpoint(siteName, `/newsletter/unsubscribe/${encodeURIComponent(token)}`))
+    );
+  }
+  /**
+   * Update subscription preferences
+   */
+  async updatePreferences(siteName, email, preferences) {
+    return this.patch(
+      this.newsletterEndpoint(siteName, "/newsletter/preferences"),
+      { email, ...preferences }
+    );
+  }
+  /**
+   * Get available newsletter lists
+   */
+  async getLists(siteName) {
+    return this.getSingle(
+      this.newsletterEndpoint(siteName, "/newsletter/lists")
+    );
+  }
+  /**
+   * Check subscription status by email
+   */
+  async getStatus(siteName, email) {
+    return this.http.get(
+      this.buildPath(this.newsletterEndpoint(siteName, "/newsletter/status")),
+      { 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
+    );
+  }
+};
+
 // src/perspect-api-client.ts
 var PerspectApiClient = class {
   http;
@@ -1231,6 +1410,7 @@ var PerspectApiClient = class {
   webhooks;
   checkout;
   contact;
+  newsletter;
   constructor(config) {
     if (!config.baseUrl) {
       throw new Error("baseUrl is required in PerspectApiConfig");
@@ -1246,6 +1426,7 @@ var PerspectApiClient = class {
     this.webhooks = new WebhooksClient(this.http);
     this.checkout = new CheckoutClient(this.http);
     this.contact = new ContactClient(this.http);
+    this.newsletter = new NewsletterClient(this.http);
   }
   /**
    * Update authentication token
@@ -1707,6 +1888,7 @@ export {
   ContactClient,
   ContentClient,
   HttpClient,
+  NewsletterClient,
   OrganizationsClient,
   PerspectApiClient,
   ProductsClient,

package/package.json

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