pocketsflow 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -48,13 +48,42 @@ interface ProductFile {
     size?: number;
 }
 interface CreateProductParams {
+    /** Product name (required) */
     name: string;
+    /** Product description */
     description?: string;
+    /** Product price (required, defaults to 0) */
     price: number;
-    currency?: string;
-    type?: 'one-time' | 'subscription';
-    billingInterval?: 'month' | 'year';
-    active?: boolean;
+    /** Product subtitle */
+    subtitle?: string;
+    /** Whether customer can pay what they want */
+    payWant?: boolean;
+    /** Minimum price for pay-what-you-want */
+    minPrice?: number;
+    /** Maximum price for pay-what-you-want */
+    maxPrice?: number;
+    /** Whether product is published */
+    published?: boolean;
+    /** Product slug for URL */
+    slug?: string;
+    /** Thumbnail image URL */
+    thumbnail?: string;
+    /** Product images array */
+    images?: string[];
+    /** Call to action text */
+    ctaText?: string;
+    /** Show sales count */
+    showSales?: boolean;
+    /** Show reviews */
+    showReviews?: boolean;
+    /** Refund policy text */
+    refundPolicy?: string;
+    /** Callback URL for redirects */
+    callbackUrl?: string;
+    /** Collect first name */
+    hasFirstName?: boolean;
+    /** Collect last name */
+    hasLastName?: boolean;
 }
 interface UpdateProductParams {
     name?: string;
@@ -162,12 +191,19 @@ interface Discount {
     createdAt: string;
 }
 interface CreateDiscountParams {
+    /** Discount name (required) */
     name: string;
+    /** Discount code (required) - what customers enter at checkout */
     code: string;
+    /** Discount value (required) */
     value: number;
-    valueType: 'percentage' | 'fixed';
+    /** Value type: 'percentage' or 'fixed' (defaults to 'percentage') */
+    valueType?: 'percentage' | 'fixed';
+    /** Whether discount is active (defaults to true) */
     active?: boolean;
+    /** Product IDs this discount applies to (required) */
     mainProductIds: string[];
+    /** Expiration date (ISO 8601 string) */
     expiration?: string;
 }
 interface UpdateDiscountParams {
@@ -199,14 +235,23 @@ interface UpsellsResponse {
     salesWithUpsells: any[];
 }
 interface CreateUpsellParams {
-    name: string;
+    /** Upsell name */
+    name?: string;
+    /** Offer text/headline */
+    offer?: string;
+    /** Product IDs that trigger this upsell (required) */
     mainProductIds: string[];
+    /** Product ID to upsell (required) */
     upsellProductId: string;
+    /** Upsell price (required) */
     upsellPrice: number;
+    /** Upsell description shown to customer */
     upsellDescription?: string;
+    /** Primary button text (e.g., "Yes, add this!") */
     primaryButtonText?: string;
+    /** Secondary button text (e.g., "No thanks") */
     secondaryButtonText?: string;
-    offer?: string;
+    /** Whether upsell is active (defaults to true) */
     active?: boolean;
 }
 interface UpdateUpsellParams {
@@ -248,11 +293,17 @@ interface Webhook {
     createdAt: string;
 }
 interface CreateWebhookParams {
+    /** Webhook endpoint URL (required) */
     url: string;
-    events: string[];
+    /** Events to subscribe to (required) */
+    events: WebhookEvent[];
+    /** Webhook description */
     description?: string;
+    /** Whether webhook is active (defaults to true) */
     active?: boolean;
 }
+/** Available webhook events */
+type WebhookEvent = 'order.completed' | 'order.refunded' | 'product.created' | 'product.updated' | 'product.deleted' | 'review.created' | 'customer.created' | 'customer.subscription.updated' | 'customer.subscription.deleted' | 'invoice.payment_succeeded' | 'invoice.payment_failed' | 'invoice.created' | 'invoice.upcoming' | 'payment_intent.succeeded' | 'payment_intent.payment_failed' | 'customer.subscription.trial_will_end' | 'customer.subscription.pause' | 'customer.subscription.resumed' | 'identity.verification_session.verified' | 'identity.verification_session.processing' | 'identity.verification_session.requires_input';
 interface UpdateWebhookParams {
     url?: string;
     events?: string[];
@@ -480,4 +531,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 };
+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 };

package/dist/index.d.ts

@@ -48,13 +48,42 @@ interface ProductFile {
     size?: number;
 }
 interface CreateProductParams {
+    /** Product name (required) */
     name: string;
+    /** Product description */
     description?: string;
+    /** Product price (required, defaults to 0) */
     price: number;
-    currency?: string;
-    type?: 'one-time' | 'subscription';
-    billingInterval?: 'month' | 'year';
-    active?: boolean;
+    /** Product subtitle */
+    subtitle?: string;
+    /** Whether customer can pay what they want */
+    payWant?: boolean;
+    /** Minimum price for pay-what-you-want */
+    minPrice?: number;
+    /** Maximum price for pay-what-you-want */
+    maxPrice?: number;
+    /** Whether product is published */
+    published?: boolean;
+    /** Product slug for URL */
+    slug?: string;
+    /** Thumbnail image URL */
+    thumbnail?: string;
+    /** Product images array */
+    images?: string[];
+    /** Call to action text */
+    ctaText?: string;
+    /** Show sales count */
+    showSales?: boolean;
+    /** Show reviews */
+    showReviews?: boolean;
+    /** Refund policy text */
+    refundPolicy?: string;
+    /** Callback URL for redirects */
+    callbackUrl?: string;
+    /** Collect first name */
+    hasFirstName?: boolean;
+    /** Collect last name */
+    hasLastName?: boolean;
 }
 interface UpdateProductParams {
     name?: string;
@@ -162,12 +191,19 @@ interface Discount {
     createdAt: string;
 }
 interface CreateDiscountParams {
+    /** Discount name (required) */
     name: string;
+    /** Discount code (required) - what customers enter at checkout */
     code: string;
+    /** Discount value (required) */
     value: number;
-    valueType: 'percentage' | 'fixed';
+    /** Value type: 'percentage' or 'fixed' (defaults to 'percentage') */
+    valueType?: 'percentage' | 'fixed';
+    /** Whether discount is active (defaults to true) */
     active?: boolean;
+    /** Product IDs this discount applies to (required) */
     mainProductIds: string[];
+    /** Expiration date (ISO 8601 string) */
     expiration?: string;
 }
 interface UpdateDiscountParams {
@@ -199,14 +235,23 @@ interface UpsellsResponse {
     salesWithUpsells: any[];
 }
 interface CreateUpsellParams {
-    name: string;
+    /** Upsell name */
+    name?: string;
+    /** Offer text/headline */
+    offer?: string;
+    /** Product IDs that trigger this upsell (required) */
     mainProductIds: string[];
+    /** Product ID to upsell (required) */
     upsellProductId: string;
+    /** Upsell price (required) */
     upsellPrice: number;
+    /** Upsell description shown to customer */
     upsellDescription?: string;
+    /** Primary button text (e.g., "Yes, add this!") */
     primaryButtonText?: string;
+    /** Secondary button text (e.g., "No thanks") */
     secondaryButtonText?: string;
-    offer?: string;
+    /** Whether upsell is active (defaults to true) */
     active?: boolean;
 }
 interface UpdateUpsellParams {
@@ -248,11 +293,17 @@ interface Webhook {
     createdAt: string;
 }
 interface CreateWebhookParams {
+    /** Webhook endpoint URL (required) */
     url: string;
-    events: string[];
+    /** Events to subscribe to (required) */
+    events: WebhookEvent[];
+    /** Webhook description */
     description?: string;
+    /** Whether webhook is active (defaults to true) */
     active?: boolean;
 }
+/** Available webhook events */
+type WebhookEvent = 'order.completed' | 'order.refunded' | 'product.created' | 'product.updated' | 'product.deleted' | 'review.created' | 'customer.created' | 'customer.subscription.updated' | 'customer.subscription.deleted' | 'invoice.payment_succeeded' | 'invoice.payment_failed' | 'invoice.created' | 'invoice.upcoming' | 'payment_intent.succeeded' | 'payment_intent.payment_failed' | 'customer.subscription.trial_will_end' | 'customer.subscription.pause' | 'customer.subscription.resumed' | 'identity.verification_session.verified' | 'identity.verification_session.processing' | 'identity.verification_session.requires_input';
 interface UpdateWebhookParams {
     url?: string;
     events?: string[];
@@ -480,4 +531,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 };
+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 };

package/package.json

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