pocketsflow 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,483 @@
+interface PocketsflowConfig {
+    /** Your Pocketsflow API key (pk_live_... or pk_test_...) */
+    apiKey: string;
+    /** Base URL for the API (defaults to https://api.pocketsflow.com) */
+    baseUrl?: string;
+    /** Request timeout in milliseconds (defaults to 30000) */
+    timeout?: number;
+}
+interface PaginationParams {
+    page?: number;
+    pageSize?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: {
+        totalCount: number;
+        totalPages: number;
+        currentPage: number;
+        pageSize: number;
+        hasMore: boolean;
+    };
+}
+interface DateRangeParams {
+    startDate?: string;
+    endDate?: string;
+}
+interface Product {
+    _id: string;
+    userId: string;
+    name: string;
+    description?: string;
+    price: number;
+    currency: string;
+    type: 'one-time' | 'subscription';
+    billingInterval?: 'month' | 'year';
+    active: boolean;
+    published: boolean;
+    slug?: string;
+    images?: string[];
+    files?: ProductFile[];
+    testMode: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ProductFile {
+    name: string;
+    url: string;
+    size?: number;
+}
+interface CreateProductParams {
+    name: string;
+    description?: string;
+    price: number;
+    currency?: string;
+    type?: 'one-time' | 'subscription';
+    billingInterval?: 'month' | 'year';
+    active?: boolean;
+}
+interface UpdateProductParams {
+    name?: string;
+    description?: string;
+    price?: number;
+    currency?: string;
+    active?: boolean;
+    published?: boolean;
+}
+interface ProductVariant {
+    _id: string;
+    productId: string;
+    name: string;
+    price: number;
+    description?: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateVariantParams {
+    productId: string;
+    name: string;
+    price: number;
+    description?: string;
+}
+interface Order {
+    _id: string;
+    userId: string;
+    productId: string;
+    buyerEmail: string;
+    grossAmount: number;
+    netAmount: number;
+    taxAmount: number;
+    stripeFee?: number;
+    paypalFee?: number;
+    affiliateCut?: number;
+    currency: string;
+    country?: string;
+    isRefunded: boolean;
+    isDisputed: boolean;
+    testMode: boolean;
+    product?: Product;
+    customer?: {
+        _id: string;
+        buyerEmail: string;
+    };
+    createdAt: string;
+}
+interface ListOrdersParams extends PaginationParams, DateRangeParams {
+    productId?: string;
+}
+interface OrdersResponse {
+    orders: Order[];
+    pagination: {
+        totalCount: number;
+        totalPages: number;
+        currentPage: number;
+        pageSize: number;
+        hasMore: boolean;
+    };
+}
+interface Customer {
+    _id: string;
+    userId: string;
+    buyerEmail: string;
+    country?: string;
+    numberOfOrders: number;
+    totalSpent: number;
+    testMode: boolean;
+    createdAt: string;
+}
+interface ListCustomersParams {
+    email?: string;
+    productId?: string;
+    sortBy?: 'email' | 'country' | 'numberOfOrders' | 'createdAt';
+    sortOrder?: 'asc' | 'desc';
+    limit?: number;
+    offset?: number;
+}
+interface Review {
+    _id: string;
+    productId: string;
+    userId: string;
+    buyerEmail: string;
+    rating: number;
+    review?: string;
+    testMode: boolean;
+    createdAt: string;
+}
+interface ListReviewsParams {
+    productId?: string;
+}
+interface Discount {
+    _id: string;
+    userId: string;
+    name: string;
+    code: string;
+    value: number;
+    valueType: 'percentage' | 'fixed';
+    active: boolean;
+    mainProductIds: string[];
+    expiration?: string;
+    used?: number;
+    testMode: boolean;
+    createdAt: string;
+}
+interface CreateDiscountParams {
+    name: string;
+    code: string;
+    value: number;
+    valueType: 'percentage' | 'fixed';
+    active?: boolean;
+    mainProductIds: string[];
+    expiration?: string;
+}
+interface UpdateDiscountParams {
+    name?: string;
+    code?: string;
+    value?: number;
+    valueType?: 'percentage' | 'fixed';
+    active?: boolean;
+    mainProductIds?: string[];
+    expiration?: string;
+}
+interface Upsell {
+    _id: string;
+    userId: string;
+    name: string;
+    mainProductIds: string[];
+    upsellProductId: string;
+    upsellPrice: number;
+    upsellDescription?: string;
+    primaryButtonText?: string;
+    secondaryButtonText?: string;
+    offer?: string;
+    active: boolean;
+    testMode: boolean;
+    createdAt: string;
+}
+interface UpsellsResponse {
+    upsells: Upsell[];
+    salesWithUpsells: any[];
+}
+interface CreateUpsellParams {
+    name: string;
+    mainProductIds: string[];
+    upsellProductId: string;
+    upsellPrice: number;
+    upsellDescription?: string;
+    primaryButtonText?: string;
+    secondaryButtonText?: string;
+    offer?: string;
+    active?: boolean;
+}
+interface UpdateUpsellParams {
+    name?: string;
+    mainProductIds?: string[];
+    upsellProductId?: string;
+    upsellPrice?: number;
+    upsellDescription?: string;
+    primaryButtonText?: string;
+    secondaryButtonText?: string;
+    offer?: string;
+    active?: boolean;
+}
+interface Subscription {
+    _id: string;
+    userId: string;
+    customerId: string;
+    productId: string;
+    stripeSubscriptionId?: string;
+    status: 'active' | 'canceled' | 'paused' | 'past_due';
+    currentPeriodStart: string;
+    currentPeriodEnd: string;
+    cancelAtPeriodEnd: boolean;
+    testMode: boolean;
+    createdAt: string;
+}
+interface ListSubscriptionsParams extends PaginationParams, DateRangeParams {
+    status?: 'active' | 'canceled' | 'paused';
+}
+interface Webhook {
+    _id: string;
+    userId: string;
+    url: string;
+    events: string[];
+    description?: string;
+    active: boolean;
+    secret: string;
+    testMode: boolean;
+    createdAt: string;
+}
+interface CreateWebhookParams {
+    url: string;
+    events: string[];
+    description?: string;
+    active?: boolean;
+}
+interface UpdateWebhookParams {
+    url?: string;
+    events?: string[];
+    description?: string;
+    active?: boolean;
+}
+interface User {
+    _id: string;
+    userId: string;
+    email: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    subdomain?: string;
+    currency: string;
+    country?: string;
+    testMode: boolean;
+    hasSales: boolean;
+    createdFirstProduct?: boolean;
+}
+interface UpdateUserParams {
+    firstName?: string;
+    lastName?: string;
+    currency?: string;
+    country?: string;
+    subdomain?: string;
+    contactEmail?: string;
+}
+interface CreateCheckoutParams {
+    productId: string;
+    successUrl: string;
+    cancelUrl: string;
+    customerEmail?: string;
+    discountCode?: string;
+    metadata?: Record<string, any>;
+}
+interface CheckoutSession {
+    id: string;
+    url: string;
+}
+interface Refund {
+    _id: string;
+    orderId: string;
+    amount: number;
+    reason?: string;
+    status: 'pending' | 'completed' | 'failed';
+    createdAt: string;
+}
+interface CreateRefundParams {
+    orderId: string;
+    amount?: number;
+    reason?: string;
+}
+interface ApiError {
+    message: string;
+    code?: string;
+    status?: number;
+}
+declare class PocketsflowError extends Error {
+    code?: string;
+    status?: number;
+    constructor(message: string, code?: string, status?: number);
+}
+
+declare class Pocketsflow {
+    private apiKey;
+    private baseUrl;
+    private timeout;
+    products: ProductsResource;
+    variants: VariantsResource;
+    orders: OrdersResource;
+    customers: CustomersResource;
+    reviews: ReviewsResource;
+    discounts: DiscountsResource;
+    upsells: UpsellsResource;
+    subscriptions: SubscriptionsResource;
+    webhooks: WebhooksResource;
+    users: UsersResource;
+    checkout: CheckoutResource;
+    refunds: RefundsResource;
+    constructor(config: PocketsflowConfig);
+    request<T>(method: string, path: string, options?: {
+        body?: any;
+        params?: Record<string, any>;
+    }): Promise<T>;
+}
+declare class ProductsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all products */
+    list(): Promise<Product[]>;
+    /** Get a product by ID */
+    get(id: string): Promise<Product>;
+    /** Create a new product */
+    create(params: CreateProductParams): Promise<Product>;
+    /** Update a product */
+    update(id: string, params: UpdateProductParams): Promise<Product>;
+    /** Delete a product */
+    delete(id: string): Promise<{
+        message: string;
+    }>;
+}
+declare class VariantsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** Create a product variant */
+    create(params: CreateVariantParams): Promise<ProductVariant>;
+    /** Delete a product variant */
+    delete(id: string): Promise<{
+        message: string;
+    }>;
+}
+declare class OrdersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all orders with optional filters */
+    list(params?: ListOrdersParams): Promise<OrdersResponse>;
+    /** Get an order by ID */
+    get(id: string): Promise<Order>;
+}
+declare class CustomersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all customers */
+    list(params?: ListCustomersParams): Promise<Customer[]>;
+    /** Get a customer by ID */
+    get(id: string): Promise<Customer>;
+}
+declare class ReviewsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all reviews */
+    list(params?: ListReviewsParams): Promise<Review[]>;
+}
+declare class DiscountsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all discounts */
+    list(): Promise<Discount[]>;
+    /** Get a discount by ID */
+    get(id: string): Promise<Discount>;
+    /** Create a new discount */
+    create(params: CreateDiscountParams): Promise<Discount>;
+    /** Update a discount */
+    update(id: string, params: UpdateDiscountParams): Promise<Discount>;
+    /** Delete a discount */
+    delete(id: string): Promise<{
+        message: string;
+    }>;
+}
+declare class UpsellsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all upsells */
+    list(): Promise<UpsellsResponse>;
+    /** Get an upsell by ID */
+    get(id: string): Promise<Upsell>;
+    /** Create a new upsell */
+    create(params: CreateUpsellParams): Promise<Upsell>;
+    /** Update an upsell */
+    update(id: string, params: UpdateUpsellParams): Promise<Upsell>;
+    /** Delete an upsell */
+    delete(id: string): Promise<{
+        message: string;
+    }>;
+}
+declare class SubscriptionsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List subscription customers */
+    list(params?: ListSubscriptionsParams): Promise<any>;
+    /** Get a subscription by ID */
+    get(id: string): Promise<Subscription>;
+    /** Cancel a subscription */
+    cancel(stripeSubscriptionId: string): Promise<{
+        message: string;
+    }>;
+    /** Refund a subscription */
+    refund(stripeSubscriptionId: string): Promise<{
+        message: string;
+    }>;
+}
+declare class WebhooksResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all webhooks */
+    list(): Promise<Webhook[]>;
+    /** Get a webhook by ID */
+    get(id: string): Promise<Webhook>;
+    /** Create a new webhook */
+    create(params: CreateWebhookParams): Promise<Webhook>;
+    /** Update a webhook */
+    update(id: string, params: UpdateWebhookParams): Promise<Webhook>;
+    /** Delete a webhook */
+    delete(id: string): Promise<{
+        message: string;
+    }>;
+    /** Test a webhook */
+    test(id: string): Promise<{
+        message: string;
+    }>;
+}
+declare class UsersResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** Get current user information */
+    me(): Promise<User>;
+    /** Update current user */
+    update(params: UpdateUserParams): Promise<User>;
+}
+declare class CheckoutResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** Create a checkout session */
+    create(params: CreateCheckoutParams): Promise<CheckoutSession>;
+}
+declare class RefundsResource {
+    private client;
+    constructor(client: Pocketsflow);
+    /** List all refunds */
+    list(): Promise<Refund[]>;
+    /** Get a refund by ID */
+    get(id: string): Promise<Refund>;
+    /** Create a refund */
+    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 };