pocketsflow 1.0.1 → 1.2.0

package/README.md

@@ -202,6 +202,23 @@ await pocketsflow.upsells.delete('upsell_id');
 
 ### Subscriptions
 
+The `subscriptions` namespace manages buyer subscriptions. Subscription offers
+(the recurring products you sell) use `subscriptionOffers`:
+
+```typescript
+// Create a subscription offer
+const newOffer = await pocketsflow.subscriptionOffers.create({
+  name: 'Pro Membership',
+  price: 29,
+  frequency: 'monthly',
+  trialPeriod: 7,
+});
+
+// List and get subscription offers
+const offers = await pocketsflow.subscriptionOffers.list();
+const offer = await pocketsflow.subscriptionOffers.get(newOffer._id);
+```
+
 ```typescript
 // List subscription customers
 const subscriptions = await pocketsflow.subscriptions.list({

package/dist/index.d.mts

@@ -281,6 +281,78 @@ interface Subscription {
 interface ListSubscriptionsParams extends PaginationParams, DateRangeParams {
     status?: 'active' | 'canceled' | 'paused';
 }
+/** A subscription offer — a recurring product you sell. */
+interface SubscriptionOffer {
+    _id: string;
+    userId: string;
+    name: string;
+    subtitle?: string;
+    description?: string;
+    price: number;
+    currency?: string;
+    frequency: 'weekly' | 'monthly' | 'yearly';
+    trialPeriod?: number;
+    published?: boolean;
+    redirectBackUrl?: string;
+    slug?: string;
+    thumbnail?: string;
+    images?: string[];
+    testMode: boolean;
+    createdAt: string;
+    updatedAt?: string;
+}
+interface CreateSubscriptionOfferParams {
+    /** Subscription offer name (required) */
+    name: string;
+    /** Recurring price in USD (required) */
+    price: number;
+    /** Billing frequency (required) */
+    frequency: 'weekly' | 'monthly' | 'yearly';
+    /** Short offer subtitle */
+    subtitle?: string;
+    /** Offer description */
+    description?: string;
+    /** Trial duration in days */
+    trialPeriod?: number;
+    /** Whether the offer is published */
+    published?: boolean;
+    /** Return URL used by the customer billing portal */
+    redirectBackUrl?: string;
+    /** Offer URL slug */
+    slug?: string;
+    /** Thumbnail URL */
+    thumbnail?: string;
+    /** Offer image URLs */
+    images?: string[];
+    /** Whether the offer is backed by a downloadable file */
+    isFile?: boolean;
+    /** File URL or uploaded file reference */
+    file?: string | Record<string, unknown>;
+    /** External offer URL */
+    url?: string;
+    /** Checkout copy and seller-facing configuration */
+    checkoutText?: string;
+    refundPolicy?: string;
+    callbackUrl?: string;
+    hasCallbackUrl?: boolean;
+    hasFirstName?: boolean;
+    hasLastName?: boolean;
+    portalText?: string;
+    privacyPolicy?: string;
+    termsOfService?: string;
+    ctaText?: string;
+    thankYouText?: string;
+    hasProductPage?: boolean;
+    showSales?: boolean;
+    showReviews?: boolean;
+    maxPrice?: number;
+    minPrice?: number;
+    design?: Record<string, unknown>;
+    colors?: Record<string, unknown>;
+    pageStyle?: Record<string, unknown>;
+    checkoutStyle?: Record<string, unknown>;
+    checkoutColors?: Record<string, unknown>;
+}
 interface Webhook {
     _id: string;
     userId: string;
@@ -380,6 +452,8 @@ declare class Pocketsflow {
     discounts: DiscountsResource;
     upsells: UpsellsResource;
     subscriptions: SubscriptionsResource;
+    /** Subscription offers (recurring products), distinct from buyer memberships. */
+    subscriptionOffers: SubscriptionOffersResource;
     webhooks: WebhooksResource;
     users: UsersResource;
     checkout: CheckoutResource;
@@ -486,6 +560,17 @@ declare class SubscriptionsResource {
         message: string;
     }>;
 }
+/** Your subscription offers — the recurring products you sell. */
+declare class SubscriptionOffersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all subscription offers */
+    list(): Promise<SubscriptionOffer[]>;
+    /** Get a subscription offer by ID */
+    get(id: string): Promise<SubscriptionOffer>;
+    /** Create a subscription offer */
+    create(params: CreateSubscriptionOfferParams): Promise<SubscriptionOffer>;
+}
 declare class WebhooksResource {
     private client;
     constructor(client: Pocketsflow);
@@ -531,4 +616,4 @@ declare class RefundsResource {
     create(params: CreateRefundParams): Promise<Refund>;
 }
 
-export { type ApiError, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, 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 UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };
+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 };

package/dist/index.d.ts

@@ -281,6 +281,78 @@ interface Subscription {
 interface ListSubscriptionsParams extends PaginationParams, DateRangeParams {
     status?: 'active' | 'canceled' | 'paused';
 }
+/** A subscription offer — a recurring product you sell. */
+interface SubscriptionOffer {
+    _id: string;
+    userId: string;
+    name: string;
+    subtitle?: string;
+    description?: string;
+    price: number;
+    currency?: string;
+    frequency: 'weekly' | 'monthly' | 'yearly';
+    trialPeriod?: number;
+    published?: boolean;
+    redirectBackUrl?: string;
+    slug?: string;
+    thumbnail?: string;
+    images?: string[];
+    testMode: boolean;
+    createdAt: string;
+    updatedAt?: string;
+}
+interface CreateSubscriptionOfferParams {
+    /** Subscription offer name (required) */
+    name: string;
+    /** Recurring price in USD (required) */
+    price: number;
+    /** Billing frequency (required) */
+    frequency: 'weekly' | 'monthly' | 'yearly';
+    /** Short offer subtitle */
+    subtitle?: string;
+    /** Offer description */
+    description?: string;
+    /** Trial duration in days */
+    trialPeriod?: number;
+    /** Whether the offer is published */
+    published?: boolean;
+    /** Return URL used by the customer billing portal */
+    redirectBackUrl?: string;
+    /** Offer URL slug */
+    slug?: string;
+    /** Thumbnail URL */
+    thumbnail?: string;
+    /** Offer image URLs */
+    images?: string[];
+    /** Whether the offer is backed by a downloadable file */
+    isFile?: boolean;
+    /** File URL or uploaded file reference */
+    file?: string | Record<string, unknown>;
+    /** External offer URL */
+    url?: string;
+    /** Checkout copy and seller-facing configuration */
+    checkoutText?: string;
+    refundPolicy?: string;
+    callbackUrl?: string;
+    hasCallbackUrl?: boolean;
+    hasFirstName?: boolean;
+    hasLastName?: boolean;
+    portalText?: string;
+    privacyPolicy?: string;
+    termsOfService?: string;
+    ctaText?: string;
+    thankYouText?: string;
+    hasProductPage?: boolean;
+    showSales?: boolean;
+    showReviews?: boolean;
+    maxPrice?: number;
+    minPrice?: number;
+    design?: Record<string, unknown>;
+    colors?: Record<string, unknown>;
+    pageStyle?: Record<string, unknown>;
+    checkoutStyle?: Record<string, unknown>;
+    checkoutColors?: Record<string, unknown>;
+}
 interface Webhook {
     _id: string;
     userId: string;
@@ -380,6 +452,8 @@ declare class Pocketsflow {
     discounts: DiscountsResource;
     upsells: UpsellsResource;
     subscriptions: SubscriptionsResource;
+    /** Subscription offers (recurring products), distinct from buyer memberships. */
+    subscriptionOffers: SubscriptionOffersResource;
     webhooks: WebhooksResource;
     users: UsersResource;
     checkout: CheckoutResource;
@@ -486,6 +560,17 @@ declare class SubscriptionsResource {
         message: string;
     }>;
 }
+/** Your subscription offers — the recurring products you sell. */
+declare class SubscriptionOffersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all subscription offers */
+    list(): Promise<SubscriptionOffer[]>;
+    /** Get a subscription offer by ID */
+    get(id: string): Promise<SubscriptionOffer>;
+    /** Create a subscription offer */
+    create(params: CreateSubscriptionOfferParams): Promise<SubscriptionOffer>;
+}
 declare class WebhooksResource {
     private client;
     constructor(client: Pocketsflow);
@@ -531,4 +616,4 @@ declare class RefundsResource {
     create(params: CreateRefundParams): Promise<Refund>;
 }
 
-export { type ApiError, type CheckoutSession, type CreateCheckoutParams, type CreateDiscountParams, type CreateProductParams, type CreateRefundParams, 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 UpdateDiscountParams, type UpdateProductParams, type UpdateUpsellParams, type UpdateUserParams, type UpdateWebhookParams, type Upsell, type UpsellsResponse, type User, type Webhook, type WebhookEvent };
+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 };

package/dist/index.js

@@ -54,6 +54,7 @@ var Pocketsflow = class {
     this.discounts = new DiscountsResource(this);
     this.upsells = new UpsellsResource(this);
     this.subscriptions = new SubscriptionsResource(this);
+    this.subscriptionOffers = new SubscriptionOffersResource(this);
     this.webhooks = new WebhooksResource(this);
     this.users = new UsersResource(this);
     this.checkout = new CheckoutResource(this);
@@ -262,6 +263,23 @@ var SubscriptionsResource = class {
     );
   }
 };
+var SubscriptionOffersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all subscription offers */
+  async list() {
+    return this.client.request("GET", "/subscriptions");
+  }
+  /** Get a subscription offer by ID */
+  async get(id) {
+    return this.client.request("GET", `/subscriptions/${id}`);
+  }
+  /** Create a subscription offer */
+  async create(params) {
+    return this.client.request("POST", "/subscriptions", { body: params });
+  }
+};
 var WebhooksResource = class {
   constructor(client) {
     this.client = client;

package/dist/index.mjs

@@ -27,6 +27,7 @@ var Pocketsflow = class {
     this.discounts = new DiscountsResource(this);
     this.upsells = new UpsellsResource(this);
     this.subscriptions = new SubscriptionsResource(this);
+    this.subscriptionOffers = new SubscriptionOffersResource(this);
     this.webhooks = new WebhooksResource(this);
     this.users = new UsersResource(this);
     this.checkout = new CheckoutResource(this);
@@ -235,6 +236,23 @@ var SubscriptionsResource = class {
     );
   }
 };
+var SubscriptionOffersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all subscription offers */
+  async list() {
+    return this.client.request("GET", "/subscriptions");
+  }
+  /** Get a subscription offer by ID */
+  async get(id) {
+    return this.client.request("GET", `/subscriptions/${id}`);
+  }
+  /** Create a subscription offer */
+  async create(params) {
+    return this.client.request("POST", "/subscriptions", { body: params });
+  }
+};
 var WebhooksResource = class {
   constructor(client) {
     this.client = client;

package/package.json

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