pocketsflow 1.3.0 → 2.0.0

package/README.md

@@ -130,10 +130,33 @@ const customers = await pocketsflow.customers.list({
   sortOrder: 'desc',
 });
 
+// Only buyers of one product or subscription; each customer lists every
+// product they bought in `products`
+const buyers = await pocketsflow.customers.list({ productId: 'product_id' });
+buyers[0].products; // [{ _id: 'product_id', name: 'My course' }, ...]
+
 // Get a customer
 const customer = await pocketsflow.customers.get('customer_id');
 ```
 
+### Email Subscribers & Product Audiences
+
+```typescript
+// One audience per product or subscription you sell
+const audiences = await pocketsflow.newsletters.audiences.list();
+// [{ productId, name, kind: 'product', subscribers: 120, customers: 140 }, ...]
+
+// Add a product's buyers to your email list (omit productId for every buyer)
+const result = await pocketsflow.newsletters.audiences.sync({ productId: 'product_id' });
+// { customers: 140, added: 18, updated: 2, unsubscribed: 1 }
+
+// Your email subscribers, optionally only one product audience
+const subscribers = await pocketsflow.newsletters.subscribers.list({
+  productId: 'product_id',
+});
+const subscriber = await pocketsflow.newsletters.subscribers.get('subscriber_id');
+```
+
 ### Reviews
 
 ```typescript

package/dist/index.d.mts

@@ -168,6 +168,16 @@ interface Customer {
     totalSpent: number;
     testMode: boolean;
     createdAt: string;
+    /**
+     * Every product and subscription this buyer has bought (any purchase, not
+     * just the first). Returned by `customers.list()`.
+     */
+    products?: CustomerProduct[];
+}
+/** A product or subscription a customer bought. */
+interface CustomerProduct {
+    _id: string;
+    name: string;
 }
 interface ListCustomersParams {
     email?: string;
@@ -177,6 +187,48 @@ interface ListCustomersParams {
     limit?: number;
     offset?: number;
 }
+/** A contact on your email list (not a subscription membership). */
+interface EmailSubscriber {
+    _id: string;
+    userId: string;
+    email: string;
+    name?: string;
+    status: 'active' | 'unsubscribed';
+    tags: string[];
+    /** Products and subscriptions this contact bought — their product audiences. */
+    productIds?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ListEmailSubscribersParams {
+    /** Only contacts in this product audience (a product or subscription ID). */
+    productId?: string;
+}
+/** Everyone who bought one product or subscription, as an email audience. */
+interface ProductAudience {
+    /** Product or subscription ID. */
+    productId: string;
+    name: string;
+    kind: 'product' | 'subscription';
+    /** Contacts already on your list in this audience. */
+    subscribers: number;
+    /** Buyers of this product, on your list or not. */
+    customers: number;
+}
+interface SyncAudienceParams {
+    /** Product or subscription ID. Omit to add every buyer. */
+    productId?: string;
+}
+interface AudienceSyncResult {
+    /** Buyers found. */
+    customers: number;
+    /** New contacts added to your list. */
+    added: number;
+    /** Existing contacts newly linked to the product. */
+    updated: number;
+    /** Buyers who had unsubscribed: linked, but never emailed. */
+    unsubscribed: number;
+}
 interface Review {
     _id: string;
     productId: string;
@@ -472,6 +524,8 @@ declare class Pocketsflow {
     users: UsersResource;
     checkout: CheckoutResource;
     refunds: RefundsResource;
+    /** Your email list: subscribers and product audiences. */
+    newsletters: NewslettersResource;
     constructor(config: PocketsflowConfig);
     request<T>(method: string, path: string, options?: {
         body?: any;
@@ -640,5 +694,31 @@ declare class RefundsResource {
     /** Create a refund */
     create(params: CreateRefundParams): Promise<Refund>;
 }
+declare class NewsletterSubscribersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List your email subscribers, optionally only one product audience */
+    list(params?: ListEmailSubscribersParams): Promise<EmailSubscriber[]>;
+    /** Get an email subscriber by ID */
+    get(id: string): Promise<EmailSubscriber>;
+}
+declare class AudiencesResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List your product audiences: one per product or subscription you sell */
+    list(): Promise<ProductAudience[]>;
+    /**
+     * Add a product's buyers to your email list (or every buyer, without a
+     * productId). Throws a 403 `PocketsflowError` when it would exceed your
+     * plan's subscriber limit.
+     */
+    sync(params?: SyncAudienceParams): Promise<AudienceSyncResult>;
+}
+/** Your email list: subscribers and product audiences. */
+declare class NewslettersResource {
+    subscribers: NewsletterSubscribersResource;
+    audiences: AudiencesResource;
+    constructor(client: Pocketsflow);
+}
 
-export { type ApiError, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, type CreateSubscriptionOfferParams, type CreateUpsellParams, type CreateVariantParams, type CreateWebhookParams, type Customer, type DateRangeParams, type Discount, type ListCustomersParams, type ListOrdersParams, type ListReviewsParams, type ListSubscriptionsParams, type Order, type OrdersResponse, type PaginatedResponse, type PaginationParams, Pocketsflow, type PocketsflowConfig, PocketsflowError, type Product, type ProductFile, type ProductVariant, type Refund, type Review, type Subscription, type SubscriptionOffer, type UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };
+export { type ApiError, type AudienceSyncResult, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, type CreateSubscriptionOfferParams, type CreateUpsellParams, type CreateVariantParams, type CreateWebhookParams, type Customer, type CustomerProduct, type DateRangeParams, type Discount, type EmailSubscriber, type ListCustomersParams, type ListEmailSubscribersParams, type ListOrdersParams, type ListReviewsParams, type ListSubscriptionsParams, type Order, type OrdersResponse, type PaginatedResponse, type PaginationParams, Pocketsflow, type PocketsflowConfig, PocketsflowError, type Product, type ProductAudience, type ProductFile, type ProductVariant, type Refund, type Review, type Subscription, type SubscriptionOffer, type SyncAudienceParams, type UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };

package/dist/index.d.ts

@@ -168,6 +168,16 @@ interface Customer {
     totalSpent: number;
     testMode: boolean;
     createdAt: string;
+    /**
+     * Every product and subscription this buyer has bought (any purchase, not
+     * just the first). Returned by `customers.list()`.
+     */
+    products?: CustomerProduct[];
+}
+/** A product or subscription a customer bought. */
+interface CustomerProduct {
+    _id: string;
+    name: string;
 }
 interface ListCustomersParams {
     email?: string;
@@ -177,6 +187,48 @@ interface ListCustomersParams {
     limit?: number;
     offset?: number;
 }
+/** A contact on your email list (not a subscription membership). */
+interface EmailSubscriber {
+    _id: string;
+    userId: string;
+    email: string;
+    name?: string;
+    status: 'active' | 'unsubscribed';
+    tags: string[];
+    /** Products and subscriptions this contact bought — their product audiences. */
+    productIds?: string[];
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ListEmailSubscribersParams {
+    /** Only contacts in this product audience (a product or subscription ID). */
+    productId?: string;
+}
+/** Everyone who bought one product or subscription, as an email audience. */
+interface ProductAudience {
+    /** Product or subscription ID. */
+    productId: string;
+    name: string;
+    kind: 'product' | 'subscription';
+    /** Contacts already on your list in this audience. */
+    subscribers: number;
+    /** Buyers of this product, on your list or not. */
+    customers: number;
+}
+interface SyncAudienceParams {
+    /** Product or subscription ID. Omit to add every buyer. */
+    productId?: string;
+}
+interface AudienceSyncResult {
+    /** Buyers found. */
+    customers: number;
+    /** New contacts added to your list. */
+    added: number;
+    /** Existing contacts newly linked to the product. */
+    updated: number;
+    /** Buyers who had unsubscribed: linked, but never emailed. */
+    unsubscribed: number;
+}
 interface Review {
     _id: string;
     productId: string;
@@ -472,6 +524,8 @@ declare class Pocketsflow {
     users: UsersResource;
     checkout: CheckoutResource;
     refunds: RefundsResource;
+    /** Your email list: subscribers and product audiences. */
+    newsletters: NewslettersResource;
     constructor(config: PocketsflowConfig);
     request<T>(method: string, path: string, options?: {
         body?: any;
@@ -640,5 +694,31 @@ declare class RefundsResource {
     /** Create a refund */
     create(params: CreateRefundParams): Promise<Refund>;
 }
+declare class NewsletterSubscribersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List your email subscribers, optionally only one product audience */
+    list(params?: ListEmailSubscribersParams): Promise<EmailSubscriber[]>;
+    /** Get an email subscriber by ID */
+    get(id: string): Promise<EmailSubscriber>;
+}
+declare class AudiencesResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List your product audiences: one per product or subscription you sell */
+    list(): Promise<ProductAudience[]>;
+    /**
+     * Add a product's buyers to your email list (or every buyer, without a
+     * productId). Throws a 403 `PocketsflowError` when it would exceed your
+     * plan's subscriber limit.
+     */
+    sync(params?: SyncAudienceParams): Promise<AudienceSyncResult>;
+}
+/** Your email list: subscribers and product audiences. */
+declare class NewslettersResource {
+    subscribers: NewsletterSubscribersResource;
+    audiences: AudiencesResource;
+    constructor(client: Pocketsflow);
+}
 
-export { type ApiError, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, type CreateSubscriptionOfferParams, type CreateUpsellParams, type CreateVariantParams, type CreateWebhookParams, type Customer, type DateRangeParams, type Discount, type ListCustomersParams, type ListOrdersParams, type ListReviewsParams, type ListSubscriptionsParams, type Order, type OrdersResponse, type PaginatedResponse, type PaginationParams, Pocketsflow, type PocketsflowConfig, PocketsflowError, type Product, type ProductFile, type ProductVariant, type Refund, type Review, type Subscription, type SubscriptionOffer, type UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };
+export { type ApiError, type AudienceSyncResult, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, type CreateSubscriptionOfferParams, type CreateUpsellParams, type CreateVariantParams, type CreateWebhookParams, type Customer, type CustomerProduct, type DateRangeParams, type Discount, type EmailSubscriber, type ListCustomersParams, type ListEmailSubscribersParams, type ListOrdersParams, type ListReviewsParams, type ListSubscriptionsParams, type Order, type OrdersResponse, type PaginatedResponse, type PaginationParams, Pocketsflow, type PocketsflowConfig, PocketsflowError, type Product, type ProductAudience, type ProductFile, type ProductVariant, type Refund, type Review, type Subscription, type SubscriptionOffer, type SyncAudienceParams, type UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };

package/dist/index.js

@@ -59,6 +59,7 @@ var Pocketsflow = class {
     this.users = new UsersResource(this);
     this.checkout = new CheckoutResource(this);
     this.refunds = new RefundsResource(this);
+    this.newsletters = new NewslettersResource(this);
   }
   async request(method, path, options = {}) {
     const url = new URL(path, this.baseUrl);
@@ -365,6 +366,46 @@ var RefundsResource = class {
     return this.client.request("POST", "/refunds", { body: params });
   }
 };
+var NewsletterSubscribersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List your email subscribers, optionally only one product audience */
+  async list(params = {}) {
+    return this.client.request("GET", "/newsletters/subscribers", {
+      params
+    });
+  }
+  /** Get an email subscriber by ID */
+  async get(id) {
+    return this.client.request("GET", `/newsletters/subscribers/${id}`);
+  }
+};
+var AudiencesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List your product audiences: one per product or subscription you sell */
+  async list() {
+    return this.client.request("GET", "/newsletters/audiences");
+  }
+  /**
+   * Add a product's buyers to your email list (or every buyer, without a
+   * productId). Throws a 403 `PocketsflowError` when it would exceed your
+   * plan's subscriber limit.
+   */
+  async sync(params = {}) {
+    return this.client.request("POST", "/newsletters/audiences/sync", {
+      body: params
+    });
+  }
+};
+var NewslettersResource = class {
+  constructor(client) {
+    this.subscribers = new NewsletterSubscribersResource(client);
+    this.audiences = new AudiencesResource(client);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Pocketsflow,

package/dist/index.mjs

@@ -32,6 +32,7 @@ var Pocketsflow = class {
     this.users = new UsersResource(this);
     this.checkout = new CheckoutResource(this);
     this.refunds = new RefundsResource(this);
+    this.newsletters = new NewslettersResource(this);
   }
   async request(method, path, options = {}) {
     const url = new URL(path, this.baseUrl);
@@ -338,6 +339,46 @@ var RefundsResource = class {
     return this.client.request("POST", "/refunds", { body: params });
   }
 };
+var NewsletterSubscribersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List your email subscribers, optionally only one product audience */
+  async list(params = {}) {
+    return this.client.request("GET", "/newsletters/subscribers", {
+      params
+    });
+  }
+  /** Get an email subscriber by ID */
+  async get(id) {
+    return this.client.request("GET", `/newsletters/subscribers/${id}`);
+  }
+};
+var AudiencesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List your product audiences: one per product or subscription you sell */
+  async list() {
+    return this.client.request("GET", "/newsletters/audiences");
+  }
+  /**
+   * Add a product's buyers to your email list (or every buyer, without a
+   * productId). Throws a 403 `PocketsflowError` when it would exceed your
+   * plan's subscriber limit.
+   */
+  async sync(params = {}) {
+    return this.client.request("POST", "/newsletters/audiences/sync", {
+      body: params
+    });
+  }
+};
+var NewslettersResource = class {
+  constructor(client) {
+    this.subscribers = new NewsletterSubscribersResource(client);
+    this.audiences = new AudiencesResource(client);
+  }
+};
 export {
   Pocketsflow,
   PocketsflowError

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pocketsflow",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Official Pocketsflow SDK for Node.js and TypeScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",