@finatic/client 0.0.136 → 0.0.138

package/dist/index.d.ts

@@ -205,6 +205,18 @@ interface BrokerAccount {
     updated_at: string;
     /** ISO 8601 timestamp with timezone information */
     last_synced_at: string;
+    /** ISO 8601 timestamp with timezone information - when positions were last synced */
+    positions_synced_at: string | null;
+    /** ISO 8601 timestamp with timezone information - when orders were last synced */
+    orders_synced_at: string | null;
+    /** ISO 8601 timestamp with timezone information - when balances were last synced */
+    balances_synced_at: string | null;
+    /** ISO 8601 timestamp with timezone information - when the account was created */
+    account_created_at: string | null;
+    /** ISO 8601 timestamp with timezone information - when the account was last updated */
+    account_updated_at: string | null;
+    /** ISO 8601 timestamp with timezone information - when the first trade occurred */
+    account_first_trade_at: string | null;
 }
 interface BrokerOrder {
     id: string;
@@ -247,6 +259,24 @@ interface BrokerPosition {
     /** ISO 8601 timestamp with timezone information */
     updated_at: string;
 }
+interface BrokerBalance {
+    id: string;
+    account_id: string;
+    total_cash_value: number | null;
+    net_liquidation_value: number | null;
+    initial_margin: number | null;
+    maintenance_margin: number | null;
+    available_to_withdraw: number | null;
+    total_realized_pnl: number | null;
+    balance_created_at: string | null;
+    balance_updated_at: string | null;
+    is_end_of_day_snapshot: boolean | null;
+    raw_payload: any | null;
+    /** ISO 8601 timestamp with timezone information */
+    created_at: string;
+    /** ISO 8601 timestamp with timezone information */
+    updated_at: string;
+}
 interface BrokerDataOptions {
     broker_name?: string;
     account_id?: string;
@@ -415,6 +445,17 @@ interface AccountsFilter {
     offset?: number;
     with_metadata?: boolean;
 }
+interface BalancesFilter {
+    broker_id?: string;
+    connection_id?: string;
+    account_id?: string;
+    is_end_of_day_snapshot?: boolean;
+    limit?: number;
+    offset?: number;
+    balance_created_after?: string;
+    balance_created_before?: string;
+    with_metadata?: boolean;
+}
 interface FilteredOrdersResponse {
     orders: BrokerDataOrder[];
     total: number;
@@ -433,6 +474,12 @@ interface FilteredAccountsResponse {
     limit: number;
     offset: number;
 }
+interface FilteredBalancesResponse {
+    balances: BrokerBalance[];
+    total: number;
+    limit: number;
+    offset: number;
+}
 interface DisconnectCompanyResponse {
     success: boolean;
     response_data: {
@@ -653,62 +700,191 @@ interface PortalConfig {
     zIndex?: number;
 }
 interface PortalThemeConfig {
-    mode: 'dark' | 'light' | 'auto';
-    colors: {
-        background: {
-            primary: string;
-            secondary: string;
-            tertiary: string;
-            accent: string;
-            glass: string;
+    mode?: 'dark' | 'light' | 'auto';
+    colors?: {
+        background?: {
+            primary?: string;
+            secondary?: string;
+            tertiary?: string;
+            accent?: string;
+            glass?: string;
         };
-        status: {
-            connected: string;
-            disconnected: string;
-            warning: string;
-            pending: string;
-            error: string;
-            success: string;
+        status?: {
+            connected?: string;
+            disconnected?: string;
+            warning?: string;
+            pending?: string;
+            error?: string;
+            success?: string;
         };
-        text: {
-            primary: string;
-            secondary: string;
-            muted: string;
-            inverse: string;
+        text?: {
+            primary?: string;
+            secondary?: string;
+            muted?: string;
+            inverse?: string;
         };
-        border: {
-            primary: string;
-            secondary: string;
-            hover: string;
-            focus: string;
-            accent: string;
+        border?: {
+            primary?: string;
+            secondary?: string;
+            hover?: string;
+            focus?: string;
+            accent?: string;
         };
-        input: {
-            background: string;
-            border: string;
-            borderFocus: string;
-            text: string;
-            placeholder: string;
+        input?: {
+            background?: string;
+            border?: string;
+            borderFocus?: string;
+            text?: string;
+            placeholder?: string;
         };
-        button: {
-            primary: {
-                background: string;
-                text: string;
-                hover: string;
-                active: string;
+        button?: {
+            primary?: {
+                background?: string;
+                text?: string;
+                hover?: string;
+                active?: string;
+            };
+            secondary?: {
+                background?: string;
+                text?: string;
+                border?: string;
+                hover?: string;
+                active?: string;
+            };
+        };
+    };
+    typography?: {
+        fontFamily?: {
+            primary?: string;
+            secondary?: string;
+        };
+        fontSize?: {
+            xs?: string;
+            sm?: string;
+            base?: string;
+            lg?: string;
+            xl?: string;
+            '2xl'?: string;
+            '3xl'?: string;
+            '4xl'?: string;
+        };
+        fontWeight?: {
+            normal?: number;
+            medium?: number;
+            semibold?: number;
+            bold?: number;
+            extrabold?: number;
+        };
+        lineHeight?: {
+            tight?: string;
+            normal?: string;
+            relaxed?: string;
+        };
+    };
+    spacing?: {
+        xs?: string;
+        sm?: string;
+        md?: string;
+        lg?: string;
+        xl?: string;
+        '2xl'?: string;
+        '3xl'?: string;
+    };
+    layout?: {
+        containerMaxWidth?: string;
+        gridGap?: string;
+        cardPadding?: string;
+        borderRadius?: {
+            sm?: string;
+            md?: string;
+            lg?: string;
+            xl?: string;
+            '2xl'?: string;
+            full?: string;
+        };
+    };
+    components?: {
+        brokerCard?: {
+            width?: string;
+            height?: string;
+            logoSize?: string;
+            padding?: string;
+        };
+        statusIndicator?: {
+            size?: string;
+            glowIntensity?: number;
+        };
+        modal?: {
+            background?: string;
+            backdrop?: string;
+        };
+        brokerCardModern?: {
+            width?: string;
+            height?: string;
+            padding?: string;
+            logoSize?: string;
+            statusSize?: string;
+        };
+        connectButton?: {
+            width?: string;
+            height?: string;
+        };
+        themeSwitcher?: {
+            indicatorSize?: string;
+        };
+    };
+    effects?: {
+        glassmorphism?: {
+            enabled?: boolean;
+            blur?: string;
+            opacity?: number;
+            border?: string;
+        };
+        animations?: {
+            enabled?: boolean;
+            duration?: {
+                fast?: string;
+                normal?: string;
+                slow?: string;
             };
-            secondary: {
-                background: string;
-                text: string;
-                border: string;
-                hover: string;
-                active: string;
+            easing?: {
+                default?: string;
+                smooth?: string;
+                bounce?: string;
             };
         };
+        shadows?: {
+            sm?: string;
+            md?: string;
+            lg?: string;
+            xl?: string;
+            card?: string;
+            cardHover?: string;
+            glow?: string;
+            focus?: string;
+        };
     };
     branding?: {
+        logo?: string;
+        companyName?: string;
+        favicon?: string;
         primaryColor?: string;
     };
+    glow?: {
+        primary?: string;
+        secondary?: string;
+        card?: string;
+        cardHover?: string;
+        button?: string;
+        focus?: string;
+        scrollbar?: string;
+    };
+    gradients?: {
+        start?: string;
+        end?: string;
+        hoverStart?: string;
+        hoverEnd?: string;
+    };
 }
 type PortalThemePreset = 'dark' | 'light' | 'corporateBlue' | 'purple' | 'green' | 'orange';
 interface PortalTheme {
@@ -771,6 +947,8 @@ interface PortalOptions {
     theme?: PortalTheme;
     /** Optional list of broker names to filter by (only these brokers will be shown) */
     brokers?: string[];
+    /** Optional email address to prefill in the portal */
+    email?: string;
 }
 
 /**
@@ -920,17 +1098,10 @@ declare class ApiClient {
      * @throws SessionError if session is not in ACTIVE state
      */
     getPortalUrl(sessionId: string): Promise<PortalUrlResponse>;
-    validatePortalSession(sessionId: string, signature: string): Promise<SessionValidationResponse>;
     completePortalSession(sessionId: string): Promise<PortalUrlResponse>;
-    getHoldings(): Promise<{
-        data: Holding[];
-    }>;
     getOrders(): Promise<{
         data: Order[];
     }>;
-    getPortfolio(): Promise<{
-        data: Portfolio;
-    }>;
     placeBrokerOrder(params: Partial<BrokerOrderParams> & {
         symbol: string;
         orderQty: number;
@@ -956,8 +1127,7 @@ declare class ApiClient {
     private buildOrderRequestBody;
     private buildModifyRequestBody;
     private applyBrokerDefaults;
-    revokeToken(): Promise<void>;
-    getUserToken(userId: string): Promise<UserToken>;
+    getUserToken(sessionId: string): Promise<UserToken>;
     /**
      * Get the current session state
      */
@@ -1010,6 +1180,14 @@ declare class ApiClient {
         warnings: null;
         errors: null;
     }>;
+    getBrokerBalances(options?: BrokerDataOptions): Promise<{
+        _id: string;
+        response_data: BrokerBalance[];
+        message: string;
+        status_code: number;
+        warnings: null;
+        errors: null;
+    }>;
     getBrokerConnections(): Promise<{
         _id: string;
         response_data: BrokerConnection[];
@@ -1018,9 +1196,18 @@ declare class ApiClient {
         warnings: null;
         errors: null;
     }>;
+    getBalances(filters?: any): Promise<{
+        _id: string;
+        response_data: any[];
+        message: string;
+        status_code: number;
+        warnings: null;
+        errors: null;
+    }>;
     getBrokerOrdersPage(page?: number, perPage?: number, filters?: OrdersFilter): Promise<PaginatedResult<BrokerOrder[]>>;
     getBrokerAccountsPage(page?: number, perPage?: number, filters?: AccountsFilter): Promise<PaginatedResult<BrokerAccount[]>>;
     getBrokerPositionsPage(page?: number, perPage?: number, filters?: PositionsFilter): Promise<PaginatedResult<BrokerPosition[]>>;
+    getBrokerBalancesPage(page?: number, perPage?: number, filters?: BalancesFilter): Promise<PaginatedResult<BrokerBalance[]>>;
     getNextPage<T>(previousResult: PaginatedResult<T>, fetchFunction: (offset: number, limit: number) => Promise<PaginatedResult<T>>): Promise<PaginatedResult<T> | null>;
     /**
      * Check if this is a mock client
@@ -1078,6 +1265,11 @@ declare class FinaticConnect extends EventEmitter {
      * @returns True if the user is fully authenticated and ready for API calls
      */
     isAuthed(): boolean;
+    /**
+     * Check if the client is authenticated (alias for isAuthed for consistency)
+     * @returns True if authenticated, false otherwise
+     */
+    is_authenticated(): boolean;
     /**
      * Get user's orders with pagination and optional filtering
      * @param params - Query parameters including page, perPage, and filters
@@ -1108,10 +1300,6 @@ declare class FinaticConnect extends EventEmitter {
         perPage?: number;
         filter?: AccountsFilter;
     }): Promise<PaginatedResult<BrokerDataAccount[]>>;
-    /**
-     * Revoke the current user's access
-     */
-    revokeToken(): Promise<void>;
     /**
      * Initialize the Finatic Connect SDK
      * @param token - The portal token from your backend
@@ -1127,6 +1315,11 @@ declare class FinaticConnect extends EventEmitter {
      * @param userId - The user ID from a previous session
      */
     setUserId(userId: string): Promise<void>;
+    /**
+     * Get the user and tokens for a completed session
+     * @returns Promise with user information and tokens
+     */
+    getSessionUser(): Promise<Record<string, any>>;
     private initializeWithUser;
     /**
      * Handle company access error by opening the portal
@@ -1194,13 +1387,13 @@ declare class FinaticConnect extends EventEmitter {
      * Set the broker context for trading
      * @param broker - The broker to use for trading
      */
-    setBroker(broker: 'robinhood' | 'tasty_trade' | 'ninja_trader'): void;
+    setTradingContextBroker(broker: 'robinhood' | 'tasty_trade' | 'ninja_trader' | 'interactive_brokers' | 'tradestation'): void;
     /**
      * Set the account context for trading
      * @param accountNumber - The account number to use for trading
      * @param accountId - Optional account ID
      */
-    setAccount(accountNumber: string, accountId?: string): void;
+    setTradingContextAccount(accountNumber: string, accountId?: string): void;
     /**
      * Get the current trading context
      */
@@ -1217,6 +1410,34 @@ declare class FinaticConnect extends EventEmitter {
      * Place a stock limit order (convenience method)
      */
     placeStockLimitOrder(symbol: string, quantity: number, side: 'buy' | 'sell', price: number, timeInForce?: 'day' | 'gtc', broker?: 'robinhood' | 'tasty_trade' | 'ninja_trader', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place a stock stop order (convenience method)
+     */
+    placeStockStopOrder(symbol: string, quantity: number, side: 'buy' | 'sell', stopPrice: number, timeInForce?: 'day' | 'gtc', broker?: 'robinhood' | 'tasty_trade' | 'ninja_trader', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place a crypto market order (convenience method)
+     */
+    placeCryptoMarketOrder(symbol: string, quantity: number, side: 'buy' | 'sell', broker?: 'coinbase' | 'binance' | 'kraken', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place a crypto limit order (convenience method)
+     */
+    placeCryptoLimitOrder(symbol: string, quantity: number, side: 'buy' | 'sell', price: number, timeInForce?: 'day' | 'gtc', broker?: 'coinbase' | 'binance' | 'kraken', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place an options market order (convenience method)
+     */
+    placeOptionsMarketOrder(symbol: string, quantity: number, side: 'buy' | 'sell', broker?: 'tasty_trade' | 'robinhood' | 'ninja_trader', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place an options limit order (convenience method)
+     */
+    placeOptionsLimitOrder(symbol: string, quantity: number, side: 'buy' | 'sell', price: number, timeInForce?: 'day' | 'gtc', broker?: 'tasty_trade' | 'robinhood' | 'ninja_trader', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place a futures market order (convenience method)
+     */
+    placeFuturesMarketOrder(symbol: string, quantity: number, side: 'buy' | 'sell', broker?: 'ninja_trader' | 'tasty_trade', accountNumber?: string): Promise<OrderResponse>;
+    /**
+     * Place a futures limit order (convenience method)
+     */
+    placeFuturesLimitOrder(symbol: string, quantity: number, side: 'buy' | 'sell', price: number, timeInForce?: 'day' | 'gtc', broker?: 'ninja_trader' | 'tasty_trade', accountNumber?: string): Promise<OrderResponse>;
     /**
      * Get the current user ID
      * @returns The current user ID or undefined if not authenticated
@@ -1302,6 +1523,7 @@ declare class FinaticConnect extends EventEmitter {
      * @returns Promise with paginated accounts result
      */
     getAccountsPage(page?: number, perPage?: number, filter?: AccountsFilter): Promise<PaginatedResult<BrokerDataAccount[]>>;
+    getBalancesPage(page?: number, perPage?: number, filter?: BalancesFilter): Promise<PaginatedResult<BrokerBalance[]>>;
     /**
      * Get the next page of orders
      * @param previousResult - The previous paginated result
@@ -1320,6 +1542,7 @@ declare class FinaticConnect extends EventEmitter {
      * @returns Promise with next page of accounts or null if no more pages
      */
     getNextAccountsPage(previousResult: PaginatedResult<BrokerDataAccount[]>): Promise<PaginatedResult<BrokerDataAccount[]> | null>;
+    getNextBalancesPage(previousResult: PaginatedResult<BrokerBalance[]>): Promise<PaginatedResult<BrokerBalance[]> | null>;
     /**
      * Get all orders across all pages (convenience method)
      * @param filter - Optional filter parameters
@@ -1338,6 +1561,7 @@ declare class FinaticConnect extends EventEmitter {
      * @returns Promise with all accounts
      */
     getAllAccounts(filter?: AccountsFilter): Promise<BrokerDataAccount[]>;
+    getAllBalances(filter?: BalancesFilter): Promise<BrokerBalance[]>;
     /**
      * Register session management (but don't auto-cleanup for 24-hour sessions)
      */
@@ -1498,12 +1722,6 @@ declare class MockDataProvider {
         warnings: null;
         errors: null;
     }>;
-    mockGetHoldings(): Promise<{
-        data: Holding[];
-    }>;
-    mockGetPortfolio(): Promise<{
-        data: Portfolio;
-    }>;
     mockGetOrders(filter?: OrdersFilter): Promise<{
         data: Order[];
     }>;
@@ -1513,6 +1731,9 @@ declare class MockDataProvider {
     mockGetBrokerPositions(filter?: PositionsFilter): Promise<{
         data: BrokerDataPosition[];
     }>;
+    mockGetBrokerBalances(filter?: BalancesFilter): Promise<{
+        data: BrokerBalance[];
+    }>;
     mockGetBrokerDataAccounts(filter?: AccountsFilter): Promise<{
         data: BrokerAccount[];
     }>;
@@ -1524,7 +1745,7 @@ declare class MockDataProvider {
     /**
      * Get stored user token
      */
-    getUserToken(userId: string): UserToken | undefined;
+    getUserToken(sessionId: string): UserToken | undefined;
     /**
      * Clear all stored data
      */
@@ -1539,6 +1760,7 @@ declare class MockDataProvider {
     private applyBrokerOrderFilters;
     private applyBrokerPositionFilters;
     private applyBrokerAccountFilters;
+    private applyBrokerBalanceFilters;
     /**
      * Generate mock orders with diverse data
      */
@@ -1628,15 +1850,9 @@ declare class MockApiClient {
     getPortalUrl(sessionId: string): Promise<PortalUrlResponse>;
     validatePortalSession(sessionId: string, signature: string): Promise<SessionValidationResponse>;
     completePortalSession(sessionId: string): Promise<PortalUrlResponse>;
-    getHoldings(filter?: OrdersFilter): Promise<{
-        data: Holding[];
-    }>;
     getOrders(filter?: OrdersFilter): Promise<{
         data: Order[];
     }>;
-    getPortfolio(): Promise<{
-        data: Portfolio;
-    }>;
     placeOrder(order: BrokerOrderParams): Promise<void>;
     placeBrokerOrder(params: Partial<BrokerOrderParams> & {
         symbol: string;
@@ -1660,8 +1876,7 @@ declare class MockApiClient {
     placeOptionsLimitOrder(symbol: string, orderQty: number, action: 'Buy' | 'Sell', price: number, options: OptionsOrderOptions, timeInForce?: 'day' | 'gtc', broker?: 'robinhood' | 'tasty_trade' | 'ninja_trader', accountNumber?: string, extras?: BrokerExtras): Promise<OrderResponse>;
     placeFuturesMarketOrder(symbol: string, orderQty: number, action: 'Buy' | 'Sell', broker?: 'robinhood' | 'tasty_trade' | 'ninja_trader', accountNumber?: string, extras?: BrokerExtras): Promise<OrderResponse>;
     placeFuturesLimitOrder(symbol: string, orderQty: number, action: 'Buy' | 'Sell', price: number, timeInForce?: 'day' | 'gtc', broker?: 'robinhood' | 'tasty_trade' | 'ninja_trader', accountNumber?: string, extras?: BrokerExtras): Promise<OrderResponse>;
-    revokeToken(accessToken: string): Promise<void>;
-    getUserToken(userId: string): Promise<UserToken>;
+    getUserToken(sessionId: string): Promise<UserToken>;
     getCurrentSessionState(): SessionState | null;
     getBrokerList(): Promise<{
         _id: string;
@@ -1701,12 +1916,16 @@ declare class MockApiClient {
     getBrokerPositionsWithFilter(filter?: PositionsFilter): Promise<{
         data: BrokerDataPosition[];
     }>;
+    getBrokerBalancesWithFilter(filter?: BalancesFilter): Promise<{
+        data: BrokerBalance[];
+    }>;
     getBrokerDataAccountsWithFilter(filter?: AccountsFilter): Promise<{
         data: BrokerAccount[];
     }>;
     getBrokerOrdersPage(page?: number, perPage?: number, filters?: OrdersFilter): Promise<PaginatedResult<BrokerDataOrder[]>>;
     getBrokerAccountsPage(page?: number, perPage?: number, filters?: AccountsFilter): Promise<PaginatedResult<BrokerAccount[]>>;
     getBrokerPositionsPage(page?: number, perPage?: number, filters?: PositionsFilter): Promise<PaginatedResult<BrokerDataPosition[]>>;
+    getBrokerBalancesPage(page?: number, perPage?: number, filters?: BalancesFilter): Promise<PaginatedResult<BrokerBalance[]>>;
     getBrokerConnections(): Promise<{
         _id: string;
         response_data: BrokerConnection[];
@@ -1773,4 +1992,4 @@ declare class MockFactory {
 }
 
 export { ApiClient, ApiError, AuthenticationError, AuthorizationError, BaseError, CompanyAccessError, EventEmitter, FinaticConnect, MockFactory, NetworkError, OrderError, OrderValidationError, PaginatedResult, RateLimitError, SecurityError, SessionError, TokenError, TradingNotEnabledError, appendThemeToURL, createCustomThemeFromPreset, generatePortalThemeURL, getThemePreset, portalThemePresets, validateCustomTheme };
-export type { AccountsFilter, ApiConfig, ApiResponse, BrokerAccount, BrokerConnection, BrokerDataAccount, BrokerDataOptions, BrokerDataOrder, BrokerDataPosition, BrokerExtras, BrokerInfo, BrokerOrder, BrokerOrderParams, BrokerPosition, CryptoOrderOptions, DeviceInfo$1 as DeviceInfo, FilteredAccountsResponse, FilteredOrdersResponse, FilteredPositionsResponse, FinaticConnectOptions, FinaticUserToken, Holding, OptionsOrder, OptionsOrderOptions, Order, OrderNotFoundError, OrderResponse, OrdersFilter, OtpRequestResponse, OtpVerifyResponse, PerformanceMetrics, PortalMessage, PortalProps, PortalResponse, PortalTheme, PortalThemeConfig, PortalThemePreset, PortalUrlResponse, Portfolio, PortfolioSnapshot, PositionsFilter, RefreshTokenRequest, RefreshTokenResponse, RequestHeaders, SessionAuthenticateResponse, SessionInitResponse, SessionResponse, SessionStartResponse, SessionStatus, SessionValidationResponse, TokenInfo, TradeAccessDeniedError, TradingContext, UserToken, ValidationError };
+export type { AccountsFilter, ApiConfig, ApiResponse, BalancesFilter, BrokerAccount, BrokerBalance, BrokerConnection, BrokerDataAccount, BrokerDataOptions, BrokerDataOrder, BrokerDataPosition, BrokerExtras, BrokerInfo, BrokerOrder, BrokerOrderParams, BrokerPosition, CryptoOrderOptions, DeviceInfo$1 as DeviceInfo, FilteredAccountsResponse, FilteredBalancesResponse, FilteredOrdersResponse, FilteredPositionsResponse, FinaticConnectOptions, FinaticUserToken, Holding, OptionsOrder, OptionsOrderOptions, Order, OrderNotFoundError, OrderResponse, OrdersFilter, OtpRequestResponse, OtpVerifyResponse, PerformanceMetrics, PortalMessage, PortalProps, PortalResponse, PortalTheme, PortalThemeConfig, PortalThemePreset, PortalUrlResponse, Portfolio, PortfolioSnapshot, PositionsFilter, RefreshTokenRequest, RefreshTokenResponse, RequestHeaders, SessionAuthenticateResponse, SessionInitResponse, SessionResponse, SessionStartResponse, SessionStatus, SessionValidationResponse, TokenInfo, TradeAccessDeniedError, TradingContext, UserToken, ValidationError };