@buildbase/sdk 0.0.24 → 0.0.25

package/dist/types/providers/workspace/subscription-hooks.d.ts

@@ -1,741 +0,0 @@
-import { BillingInterval, CheckoutResult, ICheckoutSessionRequest, ICheckoutSessionResponse, IInvoice, IPlanGroupResponse, IPlanGroupVersion, IPlanGroupVersionsResponse, IQuotaUsageStatus, IQuotaUsageStatusResponse, IRecordUsageRequest, IRecordUsageResponse, ISubscriptionResponse, ISubscriptionUpdateResponse, IUsageLogEntry } from '../../api/types';
-/**
- * Hook to get public plans by slug (no auth required).
- * Returns items (features, limits, quotas) and plans (with pricing).
- * Uses orgId from SaaSOSProvider - must be inside provider.
- *
- * @param slug - Plan group slug (e.g. 'main-pricing', 'enterprise')
- * @returns { items, plans, loading, error, refetch }
- */
-export declare const usePublicPlans: (slug: string) => {
-    items: import("../..").IPublicPlanItem[];
-    plans: import("../..").IPublicPlanVersion[];
-    notes: string | undefined;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get a single plan group version by ID (no auth required).
- * Use this for public pricing pages when you have the groupVersionId (e.g. from config or URL).
- *
- * @param groupVersionId - The plan group version ID to fetch. Pass null/undefined to disable fetching.
- * @returns An object containing:
- * - `planGroupVersion`: Plan group version data (null if not loaded)
- * - `loading`: Boolean indicating if data is being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch
- *
- * @example
- * ```tsx
- * function PublicPricingPage() {
- *   const groupVersionId = 'your-plan-group-version-id'; // from config or URL
- *   const { planGroupVersion, loading } = usePublicPlanGroupVersion(groupVersionId);
- *
- *   if (loading) return <Loading />;
- *   if (!planGroupVersion) return null;
- *
- *   const plans = Array.isArray(planGroupVersion.planVersionIds)
- *     ? planGroupVersion.planVersionIds.filter((p): p is IPlanVersionWithPlan => typeof p !== 'string')
- *     : [];
- *
- *   return (
- *     <div>
- *       {plans.map(plan => <PlanCard key={plan._id} plan={plan} />)}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const usePublicPlanGroupVersion: (groupVersionId: string | null | undefined) => {
-    planGroupVersion: IPlanGroupVersion | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get and manage the current subscription for a workspace.
- * Automatically fetches subscription when workspaceId changes.
- *
- * @param workspaceId - The workspace ID to get subscription for. Can be null/undefined to disable fetching.
- * @returns An object containing:
- * - `subscription`: Current subscription data (null if no subscription or not loaded)
- * - `loading`: Boolean indicating if subscription is being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch the subscription
- *
- * @example
- * ```tsx
- * function SubscriptionStatus() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { subscription, loading, error } = useSubscription(currentWorkspace?._id);
- *
- *   if (loading) return <Loading />;
- *   if (error) return <Error message={error} />;
- *   if (!subscription) return <p>No active subscription</p>;
- *
- *   return <p>Plan: {subscription.plan.name}</p>;
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Edge case: Workspace ID changes
- * function SubscriptionComponent({ workspaceId }) {
- *   const { subscription, refetch } = useSubscription(workspaceId);
- *
- *   // Subscription automatically refetches when workspaceId changes
- *   // Use refetch() to manually refresh after mutations
- *   return <SubscriptionDetails subscription={subscription} />;
- * }
- * ```
- */
-export declare const useSubscription: (workspaceId: string | null | undefined) => {
-    subscription: ISubscriptionResponse | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get the plan group for a workspace.
- * Returns the plan group containing the current plan if subscription exists,
- * otherwise returns the latest published group.
- * Automatically fetches when workspaceId or groupVersionId changes.
- *
- * @param workspaceId - The workspace ID to get plan group for. Can be null/undefined to disable fetching.
- * @param groupVersionId - Optional: specific group version ID to fetch (for viewing historical versions)
- * @returns An object containing:
- * - `planGroup`: Plan group data (null if not loaded)
- * - `loading`: Boolean indicating if plan group is being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch the plan group
- *
- * @example
- * ```tsx
- * function PlanGroupDisplay() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { planGroup, loading } = usePlanGroup(currentWorkspace?._id);
- *
- *   if (loading) return <Loading />;
- *   if (!planGroup) return <p>No plan group available</p>;
- *
- *   return (
- *     <div>
- *       <h3>{planGroup.group.name}</h3>
- *       {planGroup.plans.map(plan => (
- *         <PlanCard key={plan._id} plan={plan} />
- *       ))}
- *     </div>
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Fetch specific version for comparison
- * function PlanVersionComparison() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const current = usePlanGroup(currentWorkspace?._id);
- *   const previous = usePlanGroup(currentWorkspace?._id, 'previous-version-id');
- *
- *   return <ComparePlans current={current.planGroup} previous={previous.planGroup} />;
- * }
- * ```
- */
-export declare const usePlanGroup: (workspaceId: string | null | undefined, groupVersionId?: string | null) => {
-    planGroup: IPlanGroupResponse | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get all available versions of a plan group for a workspace.
- * Shows current version and available newer versions for upgrade paths.
- * Automatically fetches when workspaceId changes.
- *
- * @param workspaceId - The workspace ID to get plan group versions for. Can be null/undefined to disable fetching.
- * @returns An object containing:
- * - `versions`: Plan group versions response with currentVersion and availableVersions
- * - `loading`: Boolean indicating if versions are being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch the versions
- *
- * @example
- * ```tsx
- * function UpgradeOptions() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { versions, loading } = usePlanGroupVersions(currentWorkspace?._id);
- *
- *   if (loading) return <Loading />;
- *
- *   return (
- *     <div>
- *       <p>Current: {versions?.currentVersion.name}</p>
- *       <h4>Available Upgrades:</h4>
- *       {versions?.availableVersions.map(version => (
- *         <UpgradeCard key={version._id} version={version} />
- *       ))}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const usePlanGroupVersions: (workspaceId: string | null | undefined) => {
-    versions: IPlanGroupVersionsResponse | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to create a checkout session for a new subscription.
- * Returns a function to initiate the checkout process.
- *
- * @param workspaceId - The workspace ID to create checkout session for. Can be null/undefined.
- * @returns An object containing:
- * - `createCheckoutSession(request)`: Function to create checkout session (throws if workspaceId is null)
- * - `loading`: Boolean indicating if checkout session is being created
- * - `error`: Error message string (null if no error)
- *
- * @example
- * ```tsx
- * function SubscribeButton({ planVersionId }) {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { createCheckoutSession, loading } = useCreateCheckoutSession(currentWorkspace?._id);
- *
- *   const handleSubscribe = async () => {
- *     try {
- *       const result = await createCheckoutSession({
- *         planVersionId,
- *         successUrl: window.location.href,
- *         cancelUrl: window.location.href,
- *       });
- *       // Redirect to checkout
- *       window.location.href = result.checkoutUrl;
- *     } catch (error) {
- *       console.error('Failed to create checkout:', error);
- *     }
- *   };
- *
- *   return (
- *     <button onClick={handleSubscribe} disabled={loading}>
- *       {loading ? 'Loading...' : 'Subscribe'}
- *     </button>
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Edge case: Workspace ID not available
- * function SubscribeButton() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { createCheckoutSession } = useCreateCheckoutSession(currentWorkspace?._id);
- *
- *   const handleSubscribe = async () => {
- *     try {
- *       await createCheckoutSession({ planVersionId: 'plan-123' });
- *     } catch (error) {
- *       // Error: "Workspace ID is required"
- *       alert('Please select a workspace first');
- *     }
- *   };
- *
- *   return <button onClick={handleSubscribe}>Subscribe</button>;
- * }
- * ```
- */
-export declare const useCreateCheckoutSession: (workspaceId: string | null | undefined) => {
-    createCheckoutSession: (request: ICheckoutSessionRequest) => Promise<CheckoutResult>;
-    loading: boolean;
-    error: string | null;
-};
-/**
- * Hook to update subscription (upgrade/downgrade).
- * Returns checkout session if payment is required, otherwise returns subscription update response.
- *
- * @param workspaceId - The workspace ID to update subscription for. Can be null/undefined.
- * @returns An object containing:
- * - `updateSubscription(planVersionId, options?)`: Function to update subscription (throws if workspaceId is null)
- * - `loading`: Boolean indicating if subscription is being updated
- * - `error`: Error message string (null if no error)
- *
- * @example
- * ```tsx
- * function UpgradeButton({ planVersionId }) {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { updateSubscription, loading } = useUpdateSubscription(currentWorkspace?._id);
- *
- *   const handleUpgrade = async () => {
- *     try {
- *       const result = await updateSubscription(planVersionId, {
- *         billingInterval: 'monthly',
- *         successUrl: window.location.href,
- *         cancelUrl: window.location.href,
- *       });
- *
- *       // Check if payment is required
- *       if ('checkoutUrl' in result) {
- *         window.location.href = result.checkoutUrl;
- *       } else {
- *         // Subscription updated without payment
- *         alert('Subscription updated successfully!');
- *       }
- *     } catch (error) {
- *       console.error('Failed to update subscription:', error);
- *     }
- *   };
- *
- *   return (
- *     <button onClick={handleUpgrade} disabled={loading}>
- *       {loading ? 'Upgrading...' : 'Upgrade'}
- *     </button>
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Handle both checkout and direct update responses
- * function SubscriptionUpdater({ planVersionId }) {
- *   const { updateSubscription } = useUpdateSubscription(workspaceId);
- *
- *   const handleUpdate = async () => {
- *     const result = await updateSubscription(planVersionId);
- *
- *     // Type guard to check response type
- *     if ('checkoutUrl' in result) {
- *       // Redirect to payment
- *       window.location.href = result.checkoutUrl;
- *     } else {
- *       // Direct update successful
- *       console.log('Updated subscription:', result.subscription);
- *     }
- *   };
- *
- *   return <button onClick={handleUpdate}>Update</button>;
- * }
- * ```
- */
-export declare const useUpdateSubscription: (workspaceId: string | null | undefined) => {
-    updateSubscription: (planVersionId: string, options?: {
-        billingInterval?: BillingInterval;
-        successUrl?: string;
-        cancelUrl?: string;
-    }) => Promise<ISubscriptionUpdateResponse | ICheckoutSessionResponse>;
-    loading: boolean;
-    error: string | null;
-};
-/**
- * Combined hook that provides both subscription and plan group data.
- * Useful for subscription management pages that need both pieces of data.
- * Combines useSubscription, usePlanGroup, and useUpdateSubscription.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined to disable fetching.
- * @param groupVersionId - Optional: specific group version ID to fetch
- * @returns An object containing:
- * - `subscription`: Current subscription data (from useSubscription)
- * - `planGroup`: Plan group data (from usePlanGroup)
- * - `loading`: Boolean indicating if any operation is in progress
- * - `error`: Error message string (null if no error)
- * - `updateSubscription(planVersionId, options?)`: Function to update subscription
- * - `refetch()`: Function to refetch both subscription and plan group
- *
- * @example
- * ```tsx
- * function SubscriptionManagementPage() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const {
- *     subscription,
- *     planGroup,
- *     loading,
- *     updateSubscription,
- *     refetch,
- *   } = useSubscriptionManagement(currentWorkspace?._id);
- *
- *   if (loading) return <Loading />;
- *
- *   return (
- *     <div>
- *       <CurrentPlan subscription={subscription} />
- *       <AvailablePlans planGroup={planGroup} onSelect={updateSubscription} />
- *       <button onClick={refetch}>Refresh</button>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useSubscriptionManagement: (workspaceId: string | null | undefined, groupVersionId?: string | null) => {
-    subscription: ISubscriptionResponse | null;
-    planGroup: IPlanGroupResponse | null;
-    loading: boolean;
-    error: string | null;
-    updateSubscription: (planVersionId: string, options?: {
-        billingInterval?: BillingInterval;
-        successUrl?: string;
-        cancelUrl?: string;
-    }) => Promise<ISubscriptionUpdateResponse | ICheckoutSessionResponse>;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to list invoices for a workspace subscription with pagination support.
- * Automatically fetches when workspaceId, limit, or startingAfter changes.
- *
- * @param workspaceId - The workspace ID to get invoices for. Can be null/undefined to disable fetching.
- * @param limit - Number of invoices to return (default: 10)
- * @param startingAfter - Invoice ID to start after (for pagination)
- * @returns An object containing:
- * - `invoices`: Array of invoice objects
- * - `hasMore`: Boolean indicating if there are more invoices to load
- * - `loading`: Boolean indicating if invoices are being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch invoices
- *
- * @example
- * ```tsx
- * function InvoiceList() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { invoices, hasMore, loading, refetch } = useInvoices(currentWorkspace?._id, 10);
- *
- *   if (loading) return <Loading />;
- *
- *   return (
- *     <div>
- *       {invoices.map(invoice => (
- *         <InvoiceCard key={invoice._id} invoice={invoice} />
- *       ))}
- *       {hasMore && <button onClick={() => refetch()}>Load More</button>}
- *     </div>
- *   );
- * }
- * ```
- *
- * @example
- * ```tsx
- * // Pagination example
- * function PaginatedInvoices() {
- *   const [lastInvoiceId, setLastInvoiceId] = useState<string | undefined>();
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { invoices, hasMore, refetch } = useInvoices(
- *     currentWorkspace?._id,
- *     10,
- *     lastInvoiceId
- *   );
- *
- *   const loadMore = () => {
- *     if (invoices.length > 0) {
- *       setLastInvoiceId(invoices[invoices.length - 1]._id);
- *     }
- *   };
- *
- *   return (
- *     <div>
- *       {invoices.map(invoice => <InvoiceCard key={invoice._id} invoice={invoice} />)}
- *       {hasMore && <button onClick={loadMore}>Load More</button>}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useInvoices: (workspaceId: string | null | undefined, limit?: number, startingAfter?: string) => {
-    invoices: IInvoice[];
-    hasMore: boolean;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get a single invoice by ID.
- * Automatically fetches when workspaceId or invoiceId changes.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined to disable fetching.
- * @param invoiceId - The invoice ID to fetch. Can be null/undefined to disable fetching.
- * @returns An object containing:
- * - `invoice`: Invoice data object (null if not loaded)
- * - `loading`: Boolean indicating if invoice is being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch the invoice
- *
- * @example
- * ```tsx
- * function InvoiceDetails({ invoiceId }) {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { invoice, loading, error } = useInvoice(currentWorkspace?._id, invoiceId);
- *
- *   if (loading) return <Loading />;
- *   if (error) return <Error message={error} />;
- *   if (!invoice) return <p>Invoice not found</p>;
- *
- *   return (
- *     <div>
- *       <h2>Invoice #{invoice.invoiceNumber}</h2>
- *       <p>Amount: ${invoice.amount}</p>
- *       <p>Status: {invoice.status}</p>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useInvoice: (workspaceId: string | null | undefined, invoiceId: string | null | undefined) => {
-    invoice: IInvoice | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to cancel a subscription at the end of the current billing period.
- * Sets cancelAtPeriodEnd: true - subscription remains active until period ends.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined.
- * @returns An object containing:
- * - `cancelSubscription()`: Function to cancel subscription at period end
- * - `loading`: Boolean indicating if cancellation is in progress
- * - `error`: Error message string (null if no error)
- *
- * @example
- * ```tsx
- * function CancelSubscriptionButton() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { cancelSubscription, loading } = useCancelSubscription(currentWorkspace?._id);
- *   const { refetch } = useSubscription(currentWorkspace?._id);
- *
- *   const handleCancel = async () => {
- *     try {
- *       await cancelSubscription();
- *       await refetch(); // Refresh subscription data
- *       alert('Subscription will be canceled at the end of the billing period');
- *     } catch (error) {
- *       console.error('Failed to cancel:', error);
- *     }
- *   };
- *
- *   return (
- *     <button onClick={handleCancel} disabled={loading}>
- *       {loading ? 'Canceling...' : 'Cancel Subscription'}
- *     </button>
- *   );
- * }
- * ```
- */
-export declare const useCancelSubscription: (workspaceId: string | null | undefined) => {
-    cancelSubscription: () => Promise<ISubscriptionResponse>;
-    loading: boolean;
-    error: string | null;
-};
-/**
- * Hook to resume a subscription that was scheduled for cancellation.
- * Sets cancelAtPeriodEnd: false - subscription will continue after period ends.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined.
- * @returns An object containing:
- * - `resumeSubscription()`: Function to resume subscription
- * - `loading`: Boolean indicating if resume is in progress
- * - `error`: Error message string (null if no error)
- *
- * @example
- * ```tsx
- * function ResumeSubscriptionButton() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { resumeSubscription, loading } = useResumeSubscription(currentWorkspace?._id);
- *   const { refetch } = useSubscription(currentWorkspace?._id);
- *
- *   const handleResume = async () => {
- *     try {
- *       await resumeSubscription();
- *       await refetch(); // Refresh subscription data
- *       alert('Subscription has been resumed');
- *     } catch (error) {
- *       console.error('Failed to resume:', error);
- *     }
- *   };
- *
- *   return (
- *     <button onClick={handleResume} disabled={loading}>
- *       {loading ? 'Resuming...' : 'Resume Subscription'}
- *     </button>
- *   );
- * }
- * ```
- */
-export declare const useResumeSubscription: (workspaceId: string | null | undefined) => {
-    resumeSubscription: () => Promise<ISubscriptionResponse>;
-    loading: boolean;
-    error: string | null;
-};
-/**
- * Hook to record quota usage for a workspace.
- * Returns a function to record usage (mutation pattern).
- *
- * @param workspaceId - The workspace ID. Can be null/undefined.
- * @returns An object containing:
- * - `recordUsage(request)`: Function to record usage (throws if workspaceId is null)
- * - `loading`: Boolean indicating if recording is in progress
- * - `error`: Error message string (null if no error)
- *
- * @example
- * ```tsx
- * function RecordUsageButton() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { recordUsage, loading } = useRecordUsage(currentWorkspace?._id);
- *
- *   const handleRecord = async () => {
- *     try {
- *       const result = await recordUsage({
- *         quotaSlug: 'api_calls',
- *         quantity: 1,
- *         source: 'web-app',
- *       });
- *       console.log(`Used: ${result.consumed}/${result.included}`);
- *     } catch (error) {
- *       console.error('Failed to record usage:', error);
- *     }
- *   };
- *
- *   return (
- *     <button onClick={handleRecord} disabled={loading}>
- *       {loading ? 'Recording...' : 'Record Usage'}
- *     </button>
- *   );
- * }
- * ```
- */
-export declare const useRecordUsage: (workspaceId: string | null | undefined) => {
-    recordUsage: (request: IRecordUsageRequest) => Promise<IRecordUsageResponse>;
-    loading: boolean;
-    error: string | null;
-};
-/**
- * Hook to get usage status for a single quota.
- * Automatically fetches when workspaceId or quotaSlug changes.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined to disable fetching.
- * @param quotaSlug - The quota slug to check. Can be null/undefined to disable fetching.
- * @returns An object containing:
- * - `status`: Quota usage status (null if not loaded)
- * - `loading`: Boolean indicating if status is being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch the status
- *
- * @example
- * ```tsx
- * function QuotaStatusDisplay() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { status, loading } = useQuotaUsageStatus(currentWorkspace?._id, 'api_calls');
- *
- *   if (loading) return <Loading />;
- *   if (!status) return null;
- *
- *   return (
- *     <div>
- *       <p>Used: {status.consumed} / {status.included}</p>
- *       <p>Available: {status.available}</p>
- *       {status.hasOverage && <p>Overage: {status.overage}</p>}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useQuotaUsageStatus: (workspaceId: string | null | undefined, quotaSlug: string | null | undefined) => {
-    status: IQuotaUsageStatusResponse | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get usage status for all quotas in the workspace's current plan.
- * Automatically fetches when workspaceId changes.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined to disable fetching.
- * @returns An object containing:
- * - `quotas`: Record of quota usage statuses keyed by slug (null if not loaded)
- * - `loading`: Boolean indicating if statuses are being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch all statuses
- *
- * @example
- * ```tsx
- * function AllQuotasDisplay() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { quotas, loading } = useAllQuotaUsage(currentWorkspace?._id);
- *
- *   if (loading) return <Loading />;
- *   if (!quotas) return null;
- *
- *   return (
- *     <div>
- *       {Object.entries(quotas).map(([slug, usage]) => (
- *         <div key={slug}>
- *           <p>{slug}: {usage.consumed}/{usage.included}</p>
- *           {usage.hasOverage && <p>Overage: {usage.overage}</p>}
- *         </div>
- *       ))}
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useAllQuotaUsage: (workspaceId: string | null | undefined) => {
-    quotas: Record<string, IQuotaUsageStatus> | null;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};
-/**
- * Hook to get paginated usage logs for a workspace.
- * Automatically fetches when workspaceId or filter params change.
- *
- * @param workspaceId - The workspace ID. Can be null/undefined to disable fetching.
- * @param quotaSlug - Optional quota slug to filter logs by.
- * @param options - Optional filters: from, to, source, page, limit
- * @returns An object containing:
- * - `logs`: Array of usage log entries
- * - `totalDocs`: Total number of log entries matching the query
- * - `totalPages`: Total number of pages
- * - `page`: Current page number
- * - `hasNextPage`: Whether there are more pages after the current one
- * - `hasPrevPage`: Whether there are pages before the current one
- * - `loading`: Boolean indicating if logs are being fetched
- * - `error`: Error message string (null if no error)
- * - `refetch()`: Function to manually refetch logs
- *
- * @example
- * ```tsx
- * function UsageLogsTable() {
- *   const { currentWorkspace } = useSaaSWorkspaces();
- *   const { logs, totalPages, page, hasNextPage, loading } = useUsageLogs(
- *     currentWorkspace?._id,
- *     'api_calls',
- *     { limit: 20 }
- *   );
- *
- *   if (loading) return <Loading />;
- *
- *   return (
- *     <div>
- *       {logs.map(log => (
- *         <div key={log._id}>
- *           {log.quotaSlug}: {log.quantity} ({log.createdAt})
- *         </div>
- *       ))}
- *       <p>Page {page} of {totalPages}</p>
- *     </div>
- *   );
- * }
- * ```
- */
-export declare const useUsageLogs: (workspaceId: string | null | undefined, quotaSlug?: string, options?: {
-    from?: string;
-    to?: string;
-    source?: string;
-    page?: number;
-    limit?: number;
-}) => {
-    logs: IUsageLogEntry[];
-    totalDocs: number;
-    totalPages: number;
-    page: number;
-    hasNextPage: boolean;
-    hasPrevPage: boolean;
-    loading: boolean;
-    error: string | null;
-    refetch: () => Promise<void>;
-};