@stackbe/sdk 0.6.4 → 0.7.1

package/dist/index.d.ts

@@ -304,8 +304,43 @@ interface OrganizationInvite {
     status: 'pending' | 'accepted' | 'cancelled';
     sentAt: string;
 }
+interface Plan {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    priceCents: number;
+    currency: string;
+    interval: 'month' | 'year';
+    trialDays?: number;
+    entitlements: Record<string, boolean | number | string>;
+    status: 'active' | 'archived';
+    requirePaymentMethod: boolean;
+    productId: string;
+    product?: Product;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Product {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    appId: string;
+    plans?: Plan[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface ListPlansOptions {
+    /** Filter by product ID */
+    productId?: string;
+}
+interface ListProductsOptions {
+    /** Filter by app ID (defaults to SDK appId) */
+    appId?: string;
+}
 interface CreateCheckoutOptions {
-    /** Customer ID or email */
+    /** Customer ID or object with email. Use string for existing customer ID, object for email-based lookup/creation */
     customer: string | {
         email: string;
         name?: string;
@@ -316,6 +351,8 @@ interface CreateCheckoutOptions {
     successUrl: string;
     /** URL to redirect if checkout is canceled */
     cancelUrl?: string;
+    /** Organization ID for org-level subscriptions. Customer must be owner/admin of the org. */
+    organizationId?: string;
     /** Allow promotion codes */
     allowPromotionCodes?: boolean;
     /** Trial period in days */
@@ -790,7 +827,7 @@ declare class CheckoutClient {
      *
      * @example
      * ```typescript
-     * // With new customer (will be created)
+     * // With customer email (looks up or creates customer)
      * const { url } = await stackbe.checkout.createSession({
      *   customer: { email: 'user@example.com', name: 'John' },
      *   planId: 'plan_pro_monthly',
@@ -798,6 +835,18 @@ declare class CheckoutClient {
      *   trialDays: 14,
      * });
      * ```
+     *
+     * @example
+     * ```typescript
+     * // Organization-level subscription (B2B)
+     * const { url } = await stackbe.checkout.createSession({
+     *   customer: 'cust_123',
+     *   organizationId: 'org_456',  // Customer must be owner/admin
+     *   planId: 'plan_team',
+     *   successUrl: 'https://myapp.com/success',
+     *   cancelUrl: 'https://myapp.com/pricing',
+     * });
+     * ```
      */
     createSession(options: CreateCheckoutOptions): Promise<CheckoutSessionResponse>;
     /**
@@ -1230,6 +1279,342 @@ declare class OrganizationsClient {
     cancelInvite(orgId: string, inviteId: string): Promise<void>;
 }
 
+/**
+ * Client for managing plans and products.
+ * Use this to list available pricing plans for display in your pricing page.
+ *
+ * @example
+ * ```typescript
+ * // List all plans
+ * const plans = await stackbe.plans.list();
+ *
+ * // List plans for a specific product
+ * const plans = await stackbe.plans.list({ productId: 'prod_123' });
+ *
+ * // Get a specific plan
+ * const plan = await stackbe.plans.get('plan_123');
+ *
+ * // List products
+ * const products = await stackbe.products.list();
+ * ```
+ */
+declare class PlansClient {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * List all plans for the app.
+     *
+     * @example
+     * ```typescript
+     * // List all plans
+     * const plans = await stackbe.plans.list();
+     *
+     * // Filter by product
+     * const plans = await stackbe.plans.list({ productId: 'prod_123' });
+     *
+     * // Display in pricing page
+     * plans.forEach(plan => {
+     *   console.log(`${plan.name}: $${plan.priceCents / 100}/${plan.interval}`);
+     * });
+     * ```
+     */
+    list(options?: ListPlansOptions): Promise<Plan[]>;
+    /**
+     * Get a plan by ID.
+     *
+     * @example
+     * ```typescript
+     * const plan = await stackbe.plans.get('plan_123');
+     * console.log(plan.name, plan.priceCents, plan.entitlements);
+     * ```
+     */
+    get(planId: string): Promise<Plan>;
+    /**
+     * Get active plans only (excludes archived plans).
+     *
+     * @example
+     * ```typescript
+     * const activePlans = await stackbe.plans.getActive();
+     * ```
+     */
+    getActive(options?: ListPlansOptions): Promise<Plan[]>;
+    /**
+     * Get plans sorted by price (ascending).
+     *
+     * @example
+     * ```typescript
+     * const plans = await stackbe.plans.listByPrice();
+     * // [Free, Starter, Pro, Enterprise]
+     * ```
+     */
+    listByPrice(options?: ListPlansOptions): Promise<Plan[]>;
+}
+/**
+ * Client for managing products.
+ *
+ * @example
+ * ```typescript
+ * // List all products
+ * const products = await stackbe.products.list();
+ *
+ * // Get a specific product
+ * const product = await stackbe.products.get('prod_123');
+ * ```
+ */
+declare class ProductsClient {
+    private readonly http;
+    private readonly appId;
+    constructor(http: HttpClient, appId: string);
+    /**
+     * List all products for the app.
+     *
+     * @example
+     * ```typescript
+     * const products = await stackbe.products.list();
+     * products.forEach(product => {
+     *   console.log(product.name, product.plans?.length, 'plans');
+     * });
+     * ```
+     */
+    list(options?: ListProductsOptions): Promise<Product[]>;
+    /**
+     * Get a product by ID.
+     *
+     * @example
+     * ```typescript
+     * const product = await stackbe.products.get('prod_123');
+     * console.log(product.name, product.description);
+     * ```
+     */
+    get(productId: string): Promise<Product>;
+}
+
+interface FeatureRequest {
+    id: string;
+    title: string;
+    description?: string;
+    status: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
+    category?: string;
+    authorId: string;
+    authorEmail: string;
+    voteCount: number;
+    hasVoted?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface FeatureRequestComment {
+    id: string;
+    customerEmail: string;
+    content: string;
+    isAdminReply: boolean;
+    createdAt: string;
+}
+interface CreateFeatureRequestOptions {
+    title: string;
+    description?: string;
+    category?: string;
+}
+interface ListFeatureRequestsOptions {
+    status?: 'new' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
+    category?: string;
+    sortBy?: 'newest' | 'votes' | 'recent_activity';
+    limit?: number;
+    offset?: number;
+}
+interface FeatureRequestListResponse {
+    data: FeatureRequest[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface InterestedCustomer {
+    customerId: string;
+    email: string;
+    votedAt?: string;
+    submittedAt?: string;
+}
+interface InterestedCustomersResponse {
+    featureRequestId: string;
+    title: string;
+    status: string;
+    author: {
+        customerId: string;
+        email: string;
+        submittedAt: string;
+    };
+    voters: InterestedCustomer[];
+    totalInterested: number;
+}
+interface CustomerFeatureActivity {
+    customerId: string;
+    submitted: Array<{
+        id: string;
+        title: string;
+        status: string;
+        voteCount: number;
+        submittedAt: string;
+    }>;
+    votedOn: Array<{
+        id: string;
+        title: string;
+        status: string;
+        voteCount: number;
+        votedAt: string;
+    }>;
+    totalSubmitted: number;
+    totalVotes: number;
+}
+declare class FeatureRequestsClient {
+    private http;
+    private appId;
+    constructor(http: HttpClient, appId: string);
+    /**
+     * List feature requests for the app.
+     *
+     * @example
+     * ```typescript
+     * // Get all feature requests
+     * const { data, total } = await stackbe.featureRequests.list();
+     *
+     * // Filter by status
+     * const planned = await stackbe.featureRequests.list({ status: 'planned' });
+     *
+     * // Sort by votes
+     * const popular = await stackbe.featureRequests.list({ sortBy: 'votes' });
+     * ```
+     */
+    list(options?: ListFeatureRequestsOptions): Promise<FeatureRequestListResponse>;
+    /**
+     * Submit a new feature request.
+     * Requires customer session token.
+     *
+     * @example
+     * ```typescript
+     * const request = await stackbe.featureRequests.create({
+     *   title: 'Dark mode support',
+     *   description: 'Would love to have a dark theme option',
+     *   category: 'UI',
+     * });
+     * ```
+     */
+    create(options: CreateFeatureRequestOptions): Promise<FeatureRequest>;
+    /**
+     * Get a specific feature request by ID.
+     *
+     * @example
+     * ```typescript
+     * const request = await stackbe.featureRequests.get('req_123');
+     * console.log(`${request.title} has ${request.voteCount} votes`);
+     * ```
+     */
+    get(requestId: string): Promise<FeatureRequest & {
+        comments: FeatureRequestComment[];
+    }>;
+    /**
+     * Upvote a feature request.
+     * Requires customer session token. Idempotent.
+     *
+     * @example
+     * ```typescript
+     * await stackbe.featureRequests.vote('req_123');
+     * ```
+     */
+    vote(requestId: string): Promise<{
+        success?: boolean;
+        alreadyVoted?: boolean;
+        voteCount: number;
+    }>;
+    /**
+     * Remove your vote from a feature request.
+     * Requires customer session token.
+     *
+     * @example
+     * ```typescript
+     * await stackbe.featureRequests.removeVote('req_123');
+     * ```
+     */
+    removeVote(requestId: string): Promise<{
+        success: boolean;
+        voteCount: number;
+    }>;
+    /**
+     * Add a comment to a feature request.
+     * Requires customer session token.
+     *
+     * @example
+     * ```typescript
+     * await stackbe.featureRequests.addComment('req_123', {
+     *   content: 'This would be really helpful for my workflow!',
+     * });
+     * ```
+     */
+    addComment(requestId: string, options: {
+        content: string;
+    }): Promise<FeatureRequestComment>;
+    /**
+     * Update a feature request status or category.
+     * Requires API key (admin).
+     *
+     * @example
+     * ```typescript
+     * await stackbe.featureRequests.update('req_123', {
+     *   status: 'planned',
+     *   category: 'Core Features',
+     * });
+     * ```
+     */
+    update(requestId: string, options: {
+        status?: string;
+        category?: string;
+    }): Promise<FeatureRequest>;
+    /**
+     * Delete a feature request.
+     * Requires API key (admin).
+     *
+     * @example
+     * ```typescript
+     * await stackbe.featureRequests.delete('req_123');
+     * ```
+     */
+    delete(requestId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Get all customers interested in a feature request (author + voters).
+     * Useful for user research or notifying users when the feature ships.
+     * Requires API key (admin).
+     *
+     * @example
+     * ```typescript
+     * const { author, voters, totalInterested } = await stackbe.featureRequests.getInterestedCustomers('req_123');
+     *
+     * // Notify all interested users
+     * const emails = [author.email, ...voters.map(v => v.email)];
+     * await sendNotification(emails, 'Your requested feature is now live!');
+     * ```
+     */
+    getInterestedCustomers(requestId: string): Promise<InterestedCustomersResponse>;
+    /**
+     * Get a customer's feature request activity (requests submitted + votes).
+     * Useful for displaying on customer profile.
+     * Requires API key (admin).
+     *
+     * @example
+     * ```typescript
+     * const activity = await stackbe.featureRequests.getCustomerActivity('cust_123');
+     *
+     * console.log(`Submitted ${activity.totalSubmitted} requests`);
+     * console.log(`Voted on ${activity.totalVotes} requests`);
+     *
+     * // Show their most wanted features
+     * activity.votedOn.forEach(r => {
+     *   console.log(`- ${r.title} (${r.status})`);
+     * });
+     * ```
+     */
+    getCustomerActivity(customerId: string): Promise<CustomerFeatureActivity>;
+}
+
 declare class StackBE {
     private http;
     private appId;
@@ -1247,6 +1632,12 @@ declare class StackBE {
     readonly auth: AuthClient;
     /** Organization management (B2B multi-user) */
     readonly organizations: OrganizationsClient;
+    /** Pricing plans */
+    readonly plans: PlansClient;
+    /** Products */
+    readonly products: ProductsClient;
+    /** Feature requests and voting */
+    readonly featureRequests: FeatureRequestsClient;
     /**
      * Create a new StackBE client.
      *
@@ -1347,4 +1738,4 @@ declare class StackBE {
     }): (req: any, res: any, next: any) => Promise<any>;
 }
 
-export { type AddMemberOptions, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EntitlementsClient, type EntitlementsResponse, type InviteMemberOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };
+export { type AddMemberOptions, type AnyWebhookEvent, AuthClient, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type CreateCheckoutOptions, type CreateCustomerOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestListResponse, FeatureRequestsClient, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type Plan, PlansClient, type Product, ProductsClient, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialStartedEvent, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };