perspectapi-ts-sdk 1.1.1 → 1.2.0

package/dist/index.d.mts

@@ -98,6 +98,74 @@ interface CreateSiteRequest {
     description?: string;
     organizationId: number;
 }
+interface NewsletterSubscription {
+    id: string;
+    email: string;
+    name?: string;
+    status: 'pending' | 'confirmed' | 'unsubscribed' | 'bounced' | 'complained';
+    frequency: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language: string;
+    confirmedAt?: string;
+    unsubscribedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateNewsletterSubscriptionRequest {
+    email: string;
+    name?: string;
+    list_ids?: string[];
+    frequency?: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language?: string;
+    source?: string;
+    source_url?: string;
+    double_opt_in?: boolean;
+    turnstile_token?: string;
+    metadata?: Record<string, any>;
+}
+interface NewsletterList {
+    id: string;
+    list_name: string;
+    slug: string;
+    description?: string;
+    is_default: boolean;
+    subscriber_count?: number;
+}
+interface NewsletterPreferences {
+    frequency?: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language?: string;
+    email_format?: 'html' | 'text' | 'both';
+    timezone?: string;
+    track_opens?: boolean;
+    track_clicks?: boolean;
+}
+interface NewsletterStatusResponse {
+    subscribed: boolean;
+    status: string;
+    frequency?: string;
+    created_at?: string;
+    confirmed_at?: string;
+}
+interface NewsletterSubscribeResponse {
+    message: string;
+    status: string;
+    subscription_id?: string;
+}
+interface NewsletterConfirmResponse {
+    message: string;
+    subscription?: {
+        email: string;
+        name?: string;
+        frequency: string;
+    };
+}
+interface NewsletterUnsubscribeRequest {
+    token?: string;
+    email?: string;
+    reason?: string;
+}
 type ContentStatus = 'draft' | 'publish' | 'private' | 'trash';
 type ContentType = 'post' | 'page';
 interface Content {
@@ -1532,6 +1600,198 @@ declare class ContactClient extends BaseClient {
     }>>;
 }
 
+/**
+ * Newsletter subscription client for PerspectAPI SDK
+ */
+
+declare class NewsletterClient extends BaseClient {
+    constructor(http: any);
+    /**
+     * Build a newsletter endpoint scoped to a site (without /sites prefix)
+     */
+    private newsletterEndpoint;
+    /**
+     * Subscribe to newsletter
+     */
+    subscribe(siteName: string, data: CreateNewsletterSubscriptionRequest): Promise<ApiResponse<NewsletterSubscribeResponse>>;
+    /**
+     * Confirm newsletter subscription via token
+     */
+    confirmSubscription(siteName: string, token: string): Promise<ApiResponse<NewsletterConfirmResponse>>;
+    /**
+     * Unsubscribe from newsletter
+     */
+    unsubscribe(siteName: string, data: NewsletterUnsubscribeRequest): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * One-click unsubscribe via token (GET request)
+     */
+    unsubscribeByToken(siteName: string, token: string): Promise<ApiResponse<string>>;
+    /**
+     * Update subscription preferences
+     */
+    updatePreferences(siteName: string, email: string, preferences: NewsletterPreferences): Promise<ApiResponse<{
+        message: string;
+        preferences: NewsletterPreferences;
+    }>>;
+    /**
+     * Get available newsletter lists
+     */
+    getLists(siteName: string): Promise<ApiResponse<{
+        lists: NewsletterList[];
+        total: number;
+    }>>;
+    /**
+     * Check subscription status by email
+     */
+    getStatus(siteName: string, email: string): Promise<ApiResponse<NewsletterStatusResponse>>;
+    /**
+     * Get all newsletter subscriptions (admin only)
+     */
+    getSubscriptions(siteName: string, params?: {
+        page?: number;
+        limit?: number;
+        status?: string;
+        list_id?: string;
+        search?: string;
+        startDate?: string;
+        endDate?: string;
+    }): Promise<PaginatedResponse<NewsletterSubscription>>;
+    /**
+     * Get subscription by ID (admin only)
+     */
+    getSubscriptionById(siteName: string, id: string): Promise<ApiResponse<NewsletterSubscription>>;
+    /**
+     * Update subscription status (admin only)
+     */
+    updateSubscriptionStatus(siteName: string, id: string, status: 'confirmed' | 'unsubscribed' | 'bounced' | 'complained', notes?: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Delete subscription (admin only)
+     */
+    deleteSubscription(siteName: string, id: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Bulk update subscriptions (admin only)
+     */
+    bulkUpdateSubscriptions(siteName: string, data: {
+        ids: string[];
+        action: 'confirm' | 'unsubscribe' | 'delete' | 'add_to_list' | 'remove_from_list';
+        list_id?: string;
+    }): Promise<ApiResponse<{
+        success: boolean;
+        updatedCount: number;
+        failedCount: number;
+    }>>;
+    /**
+     * Create newsletter list (admin only)
+     */
+    createList(siteName: string, data: {
+        list_name: string;
+        slug: string;
+        description?: string;
+        is_public?: boolean;
+        is_default?: boolean;
+        double_opt_in?: boolean;
+        welcome_email_enabled?: boolean;
+    }): Promise<ApiResponse<NewsletterList>>;
+    /**
+     * Update newsletter list (admin only)
+     */
+    updateList(siteName: string, listId: string, data: Partial<{
+        list_name: string;
+        description: string;
+        is_public: boolean;
+        is_default: boolean;
+        double_opt_in: boolean;
+        welcome_email_enabled: boolean;
+    }>): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Delete newsletter list (admin only)
+     */
+    deleteList(siteName: string, listId: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Get newsletter statistics (admin only)
+     */
+    getStatistics(siteName: string, params?: {
+        startDate?: string;
+        endDate?: string;
+        list_id?: string;
+    }): Promise<ApiResponse<{
+        totalSubscribers: number;
+        confirmedSubscribers: number;
+        pendingSubscribers: number;
+        unsubscribedCount: number;
+        bouncedCount: number;
+        subscribersByDay: Array<{
+            date: string;
+            count: number;
+        }>;
+        subscribersByList: Array<{
+            list_id: string;
+            list_name: string;
+            count: number;
+        }>;
+        engagementMetrics: {
+            averageOpenRate: number;
+            averageClickRate: number;
+        };
+    }>>;
+    /**
+     * Export newsletter subscriptions (admin only)
+     */
+    exportSubscriptions(siteName: string, params?: {
+        format?: 'csv' | 'json' | 'xlsx';
+        status?: string;
+        list_id?: string;
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ApiResponse<{
+        downloadUrl: string;
+        expiresAt: string;
+    }>>;
+    /**
+     * Import newsletter subscriptions (admin only)
+     */
+    importSubscriptions(siteName: string, data: {
+        subscriptions: Array<{
+            email: string;
+            name?: string;
+            status?: string;
+            lists?: string[];
+        }>;
+        skip_confirmation?: boolean;
+        update_existing?: boolean;
+    }): Promise<ApiResponse<{
+        imported: number;
+        updated: number;
+        failed: number;
+        errors?: Array<{
+            email: string;
+            error: string;
+        }>;
+    }>>;
+    /**
+     * Send test newsletter (admin only)
+     */
+    sendTestNewsletter(siteName: string, data: {
+        to: string;
+        subject: string;
+        html_content: string;
+        text_content?: string;
+    }): Promise<ApiResponse<{
+        message: string;
+        sent: boolean;
+    }>>;
+}
+
 /**
  * Main PerspectAPI SDK Client
  * Cloudflare Workers compatible TypeScript SDK
@@ -1549,6 +1809,7 @@ declare class PerspectApiClient {
     readonly webhooks: WebhooksClient;
     readonly checkout: CheckoutClient;
     readonly contact: ContactClient;
+    readonly newsletter: NewsletterClient;
     constructor(config: PerspectApiConfig);
     /**
      * Update authentication token
@@ -1767,4 +2028,4 @@ declare function createCheckoutSession(options: CheckoutSessionOptions): Promise
     error: string;
 }>;
 
-export { type ApiError, type ApiKey, ApiKeysClient, type ApiResponse, AuthClient, type AuthResponse, BaseClient, type BlogPost, CategoriesClient, type Category, CheckoutClient, type CheckoutMetadata, type CheckoutMetadataValue, type CheckoutSession, type CheckoutSessionOptions, ContactClient, type ContactSubmission, type Content, ContentClient, type ContentQueryParams, type ContentStatus, type ContentType, type CreateApiKeyRequest, type CreateCategoryRequest, type CreateCheckoutSessionRequest, type CreateContactRequest, type CreateContentRequest, type CreateOrganizationRequest, type CreatePaymentGatewayRequest, type CreateProductRequest, type CreateSiteRequest, type CreateWebhookRequest, HttpClient, type HttpMethod, type LoadContentBySlugOptions, type LoadContentOptions, type LoadProductBySlugOptions, type LoadProductsOptions, type LoaderLogger, type LoaderOptions, type MediaItem, type Organization, OrganizationsClient, type PaginatedResponse, type PaginationParams, type PaymentGateway, PerspectApiClient, type PerspectApiConfig, type Product, type ProductQueryParams, ProductsClient, type RequestOptions, type SignInRequest, type SignUpRequest, type Site, SitesClient, type UpdateApiKeyRequest, type UpdateContentRequest, type User, type Webhook, WebhooksClient, createApiError, createCheckoutSession, createPerspectApiClient, PerspectApiClient as default, loadAllContent, loadContentBySlug, loadPages, loadPosts, loadProductBySlug, loadProducts, transformContent, transformProduct };
+export { type ApiError, type ApiKey, ApiKeysClient, type ApiResponse, AuthClient, type AuthResponse, BaseClient, type BlogPost, CategoriesClient, type Category, CheckoutClient, type CheckoutMetadata, type CheckoutMetadataValue, type CheckoutSession, type CheckoutSessionOptions, ContactClient, type ContactSubmission, type Content, ContentClient, type ContentQueryParams, type ContentStatus, type ContentType, type CreateApiKeyRequest, type CreateCategoryRequest, type CreateCheckoutSessionRequest, type CreateContactRequest, type CreateContentRequest, type CreateNewsletterSubscriptionRequest, type CreateOrganizationRequest, type CreatePaymentGatewayRequest, type CreateProductRequest, type CreateSiteRequest, type CreateWebhookRequest, HttpClient, type HttpMethod, type LoadContentBySlugOptions, type LoadContentOptions, type LoadProductBySlugOptions, type LoadProductsOptions, type LoaderLogger, type LoaderOptions, type MediaItem, NewsletterClient, type NewsletterConfirmResponse, type NewsletterList, type NewsletterPreferences, type NewsletterStatusResponse, type NewsletterSubscribeResponse, type NewsletterSubscription, type NewsletterUnsubscribeRequest, type Organization, OrganizationsClient, type PaginatedResponse, type PaginationParams, type PaymentGateway, PerspectApiClient, type PerspectApiConfig, type Product, type ProductQueryParams, ProductsClient, type RequestOptions, type SignInRequest, type SignUpRequest, type Site, SitesClient, type UpdateApiKeyRequest, type UpdateContentRequest, type User, type Webhook, WebhooksClient, createApiError, createCheckoutSession, createPerspectApiClient, PerspectApiClient as default, loadAllContent, loadContentBySlug, loadPages, loadPosts, loadProductBySlug, loadProducts, transformContent, transformProduct };

package/dist/index.d.ts

@@ -98,6 +98,74 @@ interface CreateSiteRequest {
     description?: string;
     organizationId: number;
 }
+interface NewsletterSubscription {
+    id: string;
+    email: string;
+    name?: string;
+    status: 'pending' | 'confirmed' | 'unsubscribed' | 'bounced' | 'complained';
+    frequency: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language: string;
+    confirmedAt?: string;
+    unsubscribedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateNewsletterSubscriptionRequest {
+    email: string;
+    name?: string;
+    list_ids?: string[];
+    frequency?: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language?: string;
+    source?: string;
+    source_url?: string;
+    double_opt_in?: boolean;
+    turnstile_token?: string;
+    metadata?: Record<string, any>;
+}
+interface NewsletterList {
+    id: string;
+    list_name: string;
+    slug: string;
+    description?: string;
+    is_default: boolean;
+    subscriber_count?: number;
+}
+interface NewsletterPreferences {
+    frequency?: 'instant' | 'daily' | 'weekly' | 'monthly';
+    topics?: string[];
+    language?: string;
+    email_format?: 'html' | 'text' | 'both';
+    timezone?: string;
+    track_opens?: boolean;
+    track_clicks?: boolean;
+}
+interface NewsletterStatusResponse {
+    subscribed: boolean;
+    status: string;
+    frequency?: string;
+    created_at?: string;
+    confirmed_at?: string;
+}
+interface NewsletterSubscribeResponse {
+    message: string;
+    status: string;
+    subscription_id?: string;
+}
+interface NewsletterConfirmResponse {
+    message: string;
+    subscription?: {
+        email: string;
+        name?: string;
+        frequency: string;
+    };
+}
+interface NewsletterUnsubscribeRequest {
+    token?: string;
+    email?: string;
+    reason?: string;
+}
 type ContentStatus = 'draft' | 'publish' | 'private' | 'trash';
 type ContentType = 'post' | 'page';
 interface Content {
@@ -1532,6 +1600,198 @@ declare class ContactClient extends BaseClient {
     }>>;
 }
 
+/**
+ * Newsletter subscription client for PerspectAPI SDK
+ */
+
+declare class NewsletterClient extends BaseClient {
+    constructor(http: any);
+    /**
+     * Build a newsletter endpoint scoped to a site (without /sites prefix)
+     */
+    private newsletterEndpoint;
+    /**
+     * Subscribe to newsletter
+     */
+    subscribe(siteName: string, data: CreateNewsletterSubscriptionRequest): Promise<ApiResponse<NewsletterSubscribeResponse>>;
+    /**
+     * Confirm newsletter subscription via token
+     */
+    confirmSubscription(siteName: string, token: string): Promise<ApiResponse<NewsletterConfirmResponse>>;
+    /**
+     * Unsubscribe from newsletter
+     */
+    unsubscribe(siteName: string, data: NewsletterUnsubscribeRequest): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * One-click unsubscribe via token (GET request)
+     */
+    unsubscribeByToken(siteName: string, token: string): Promise<ApiResponse<string>>;
+    /**
+     * Update subscription preferences
+     */
+    updatePreferences(siteName: string, email: string, preferences: NewsletterPreferences): Promise<ApiResponse<{
+        message: string;
+        preferences: NewsletterPreferences;
+    }>>;
+    /**
+     * Get available newsletter lists
+     */
+    getLists(siteName: string): Promise<ApiResponse<{
+        lists: NewsletterList[];
+        total: number;
+    }>>;
+    /**
+     * Check subscription status by email
+     */
+    getStatus(siteName: string, email: string): Promise<ApiResponse<NewsletterStatusResponse>>;
+    /**
+     * Get all newsletter subscriptions (admin only)
+     */
+    getSubscriptions(siteName: string, params?: {
+        page?: number;
+        limit?: number;
+        status?: string;
+        list_id?: string;
+        search?: string;
+        startDate?: string;
+        endDate?: string;
+    }): Promise<PaginatedResponse<NewsletterSubscription>>;
+    /**
+     * Get subscription by ID (admin only)
+     */
+    getSubscriptionById(siteName: string, id: string): Promise<ApiResponse<NewsletterSubscription>>;
+    /**
+     * Update subscription status (admin only)
+     */
+    updateSubscriptionStatus(siteName: string, id: string, status: 'confirmed' | 'unsubscribed' | 'bounced' | 'complained', notes?: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Delete subscription (admin only)
+     */
+    deleteSubscription(siteName: string, id: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Bulk update subscriptions (admin only)
+     */
+    bulkUpdateSubscriptions(siteName: string, data: {
+        ids: string[];
+        action: 'confirm' | 'unsubscribe' | 'delete' | 'add_to_list' | 'remove_from_list';
+        list_id?: string;
+    }): Promise<ApiResponse<{
+        success: boolean;
+        updatedCount: number;
+        failedCount: number;
+    }>>;
+    /**
+     * Create newsletter list (admin only)
+     */
+    createList(siteName: string, data: {
+        list_name: string;
+        slug: string;
+        description?: string;
+        is_public?: boolean;
+        is_default?: boolean;
+        double_opt_in?: boolean;
+        welcome_email_enabled?: boolean;
+    }): Promise<ApiResponse<NewsletterList>>;
+    /**
+     * Update newsletter list (admin only)
+     */
+    updateList(siteName: string, listId: string, data: Partial<{
+        list_name: string;
+        description: string;
+        is_public: boolean;
+        is_default: boolean;
+        double_opt_in: boolean;
+        welcome_email_enabled: boolean;
+    }>): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Delete newsletter list (admin only)
+     */
+    deleteList(siteName: string, listId: string): Promise<ApiResponse<{
+        message: string;
+    }>>;
+    /**
+     * Get newsletter statistics (admin only)
+     */
+    getStatistics(siteName: string, params?: {
+        startDate?: string;
+        endDate?: string;
+        list_id?: string;
+    }): Promise<ApiResponse<{
+        totalSubscribers: number;
+        confirmedSubscribers: number;
+        pendingSubscribers: number;
+        unsubscribedCount: number;
+        bouncedCount: number;
+        subscribersByDay: Array<{
+            date: string;
+            count: number;
+        }>;
+        subscribersByList: Array<{
+            list_id: string;
+            list_name: string;
+            count: number;
+        }>;
+        engagementMetrics: {
+            averageOpenRate: number;
+            averageClickRate: number;
+        };
+    }>>;
+    /**
+     * Export newsletter subscriptions (admin only)
+     */
+    exportSubscriptions(siteName: string, params?: {
+        format?: 'csv' | 'json' | 'xlsx';
+        status?: string;
+        list_id?: string;
+        startDate?: string;
+        endDate?: string;
+    }): Promise<ApiResponse<{
+        downloadUrl: string;
+        expiresAt: string;
+    }>>;
+    /**
+     * Import newsletter subscriptions (admin only)
+     */
+    importSubscriptions(siteName: string, data: {
+        subscriptions: Array<{
+            email: string;
+            name?: string;
+            status?: string;
+            lists?: string[];
+        }>;
+        skip_confirmation?: boolean;
+        update_existing?: boolean;
+    }): Promise<ApiResponse<{
+        imported: number;
+        updated: number;
+        failed: number;
+        errors?: Array<{
+            email: string;
+            error: string;
+        }>;
+    }>>;
+    /**
+     * Send test newsletter (admin only)
+     */
+    sendTestNewsletter(siteName: string, data: {
+        to: string;
+        subject: string;
+        html_content: string;
+        text_content?: string;
+    }): Promise<ApiResponse<{
+        message: string;
+        sent: boolean;
+    }>>;
+}
+
 /**
  * Main PerspectAPI SDK Client
  * Cloudflare Workers compatible TypeScript SDK
@@ -1549,6 +1809,7 @@ declare class PerspectApiClient {
     readonly webhooks: WebhooksClient;
     readonly checkout: CheckoutClient;
     readonly contact: ContactClient;
+    readonly newsletter: NewsletterClient;
     constructor(config: PerspectApiConfig);
     /**
      * Update authentication token
@@ -1767,4 +2028,4 @@ declare function createCheckoutSession(options: CheckoutSessionOptions): Promise
     error: string;
 }>;
 
-export { type ApiError, type ApiKey, ApiKeysClient, type ApiResponse, AuthClient, type AuthResponse, BaseClient, type BlogPost, CategoriesClient, type Category, CheckoutClient, type CheckoutMetadata, type CheckoutMetadataValue, type CheckoutSession, type CheckoutSessionOptions, ContactClient, type ContactSubmission, type Content, ContentClient, type ContentQueryParams, type ContentStatus, type ContentType, type CreateApiKeyRequest, type CreateCategoryRequest, type CreateCheckoutSessionRequest, type CreateContactRequest, type CreateContentRequest, type CreateOrganizationRequest, type CreatePaymentGatewayRequest, type CreateProductRequest, type CreateSiteRequest, type CreateWebhookRequest, HttpClient, type HttpMethod, type LoadContentBySlugOptions, type LoadContentOptions, type LoadProductBySlugOptions, type LoadProductsOptions, type LoaderLogger, type LoaderOptions, type MediaItem, type Organization, OrganizationsClient, type PaginatedResponse, type PaginationParams, type PaymentGateway, PerspectApiClient, type PerspectApiConfig, type Product, type ProductQueryParams, ProductsClient, type RequestOptions, type SignInRequest, type SignUpRequest, type Site, SitesClient, type UpdateApiKeyRequest, type UpdateContentRequest, type User, type Webhook, WebhooksClient, createApiError, createCheckoutSession, createPerspectApiClient, PerspectApiClient as default, loadAllContent, loadContentBySlug, loadPages, loadPosts, loadProductBySlug, loadProducts, transformContent, transformProduct };
+export { type ApiError, type ApiKey, ApiKeysClient, type ApiResponse, AuthClient, type AuthResponse, BaseClient, type BlogPost, CategoriesClient, type Category, CheckoutClient, type CheckoutMetadata, type CheckoutMetadataValue, type CheckoutSession, type CheckoutSessionOptions, ContactClient, type ContactSubmission, type Content, ContentClient, type ContentQueryParams, type ContentStatus, type ContentType, type CreateApiKeyRequest, type CreateCategoryRequest, type CreateCheckoutSessionRequest, type CreateContactRequest, type CreateContentRequest, type CreateNewsletterSubscriptionRequest, type CreateOrganizationRequest, type CreatePaymentGatewayRequest, type CreateProductRequest, type CreateSiteRequest, type CreateWebhookRequest, HttpClient, type HttpMethod, type LoadContentBySlugOptions, type LoadContentOptions, type LoadProductBySlugOptions, type LoadProductsOptions, type LoaderLogger, type LoaderOptions, type MediaItem, NewsletterClient, type NewsletterConfirmResponse, type NewsletterList, type NewsletterPreferences, type NewsletterStatusResponse, type NewsletterSubscribeResponse, type NewsletterSubscription, type NewsletterUnsubscribeRequest, type Organization, OrganizationsClient, type PaginatedResponse, type PaginationParams, type PaymentGateway, PerspectApiClient, type PerspectApiConfig, type Product, type ProductQueryParams, ProductsClient, type RequestOptions, type SignInRequest, type SignUpRequest, type Site, SitesClient, type UpdateApiKeyRequest, type UpdateContentRequest, type User, type Webhook, WebhooksClient, createApiError, createCheckoutSession, createPerspectApiClient, PerspectApiClient as default, loadAllContent, loadContentBySlug, loadPages, loadPosts, loadProductBySlug, loadProducts, transformContent, transformProduct };