@finatic/client 0.0.133 → 0.0.134

package/dist/types/types/api/auth.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Authentication-related types
+ */
+export interface SessionInitResponse {
+    success: boolean;
+    message: string;
+    data: {
+        one_time_token: string;
+        expires_at: string;
+    };
+}
+export interface SessionResponseData {
+    session_id: string;
+    company_id: string;
+    status: 'pending';
+    expires_at: string;
+}
+export interface SessionStartResponse {
+    data: SessionResponseData;
+    message: 'Session started successfully';
+}
+export interface OtpRequestResponse {
+    success: boolean;
+    message: string;
+    data: boolean;
+}
+export interface OtpVerifyResponse {
+    success: boolean;
+    message: string;
+    data: {
+        access_token: string;
+        refresh_token: string;
+        user_id: string;
+        expires_in: number;
+        scope: string;
+        token_type: 'Bearer';
+    };
+}
+export interface UserToken {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+    user_id: string;
+    tokenType: string;
+    scope: string;
+}
+export interface SessionValidationResponse {
+    valid: boolean;
+    company_id: string;
+    status: string;
+}
+export interface SessionAuthenticateResponse {
+    success: boolean;
+    message: string;
+    data: {
+        access_token: string;
+        refresh_token: string;
+    };
+}
+export interface RefreshTokenRequest {
+    refresh_token: string;
+}
+export interface RefreshTokenResponse {
+    success: boolean;
+    response_data: {
+        access_token: string;
+        refresh_token: string;
+        expires_at: string;
+        company_id: string;
+        company_name: string;
+        email_verified: boolean;
+    };
+    message: string;
+}
+export interface TokenInfo {
+    accessToken: string;
+    refreshToken: string;
+    expiresAt: string;
+    userId?: string;
+}
+export interface SessionResponse {
+    data: {
+        session_id: string;
+        state: SessionState;
+        device_info?: Record<string, string>;
+        company_id?: string;
+        status?: string;
+        expires_at?: string;
+        user_id?: string | null;
+        auto_login?: boolean;
+        access_token?: string;
+        refresh_token?: string;
+        expires_in?: number;
+        token_type?: string;
+        scope?: string;
+    };
+    message: string;
+}
+export declare enum SessionState {
+    PENDING = "PENDING",
+    AUTHENTICATING = "AUTHENTICATING",
+    ACTIVE = "ACTIVE",
+    COMPLETED = "COMPLETED",
+    EXPIRED = "EXPIRED"
+}
+export type SessionStatus = SessionState;
+export interface DeviceInfo {
+    ip_address: string;
+    user_agent: string;
+    fingerprint: string;
+}

package/dist/types/types/{api.d.ts → api/broker.d.ts}

@@ -1,106 +1,6 @@
 /**
- * API-related types for Finatic Connect SDK
+ * Broker-related types
  */
-export interface SessionInitResponse {
-    success: boolean;
-    message: string;
-    data: {
-        one_time_token: string;
-        expires_at: string;
-    };
-}
-export interface SessionResponseData {
-    session_id: string;
-    company_id: string;
-    status: 'pending';
-    expires_at: string;
-}
-export interface SessionStartResponse {
-    data: SessionResponseData;
-    message: 'Session started successfully';
-}
-export interface OtpRequestResponse {
-    success: boolean;
-    message: string;
-    data: boolean;
-}
-export interface OtpVerifyResponse {
-    success: boolean;
-    message: string;
-    data: {
-        access_token: string;
-        refresh_token: string;
-        user_id: string;
-        expires_in: number;
-        scope: string;
-        token_type: 'Bearer';
-    };
-}
-export interface PortalUrlResponse {
-    success: boolean;
-    message: string;
-    data: {
-        portal_url: string;
-    };
-}
-export interface UserToken {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-    user_id: string;
-    tokenType: string;
-    scope: string;
-}
-export interface ApiError {
-    code: string;
-    message: string;
-    details?: Record<string, any>;
-}
-export interface ApiConfig {
-    baseUrl: string;
-    apiKey?: string;
-    sandbox?: boolean;
-}
-export interface RequestHeaders {
-    'Content-Type': string;
-    'X-API-Key'?: string;
-    Authorization?: string;
-    'X-CSRF-Token'?: string;
-    token?: string;
-    'User-Agent'?: string;
-    'X-Device-Info'?: string;
-    'X-Request-ID'?: string;
-    'X-Request-Timestamp'?: string;
-    'X-Request-Signature'?: string;
-    [key: string]: string | undefined;
-}
-export declare enum SessionState {
-    PENDING = "PENDING",
-    AUTHENTICATING = "AUTHENTICATING",
-    ACTIVE = "ACTIVE",
-    COMPLETED = "COMPLETED",
-    EXPIRED = "EXPIRED"
-}
-export type SessionStatus = SessionState;
-export interface ApiResponse<T> {
-    data: T;
-    error?: string;
-    status: number;
-}
-export interface Order {
-    symbol: string;
-    side: 'buy' | 'sell';
-    quantity: number;
-    type_: 'market' | 'limit' | 'stop' | 'stop_limit';
-    price?: number;
-    stopPrice?: number;
-    timeInForce: 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok';
-}
-export interface OptionsOrder extends Order {
-    optionType: 'call' | 'put';
-    strikePrice: number;
-    expirationDate: string;
-}
 export interface BrokerAccount {
     id: string;
     user_broker_connection_id: string;
@@ -164,115 +64,6 @@ export interface BrokerDataOptions {
     account_id?: string;
     symbol?: string;
 }
-export interface PortfolioSnapshot {
-    timestamp: string;
-    totalValue: number;
-    cash: number;
-    equity: number;
-    positions: {
-        symbol: string;
-        quantity: number;
-        averagePrice: number;
-        currentPrice: number;
-        marketValue: number;
-        unrealizedPnL: number;
-    }[];
-}
-export interface PerformanceMetrics {
-    totalReturn: number;
-    dailyReturn: number;
-    weeklyReturn: number;
-    monthlyReturn: number;
-    yearlyReturn: number;
-    maxDrawdown: number;
-    sharpeRatio: number;
-    beta: number;
-    alpha: number;
-}
-export interface Holding {
-    symbol: string;
-    quantity: number;
-    averagePrice: number;
-    currentPrice: number;
-    marketValue: number;
-    unrealizedPnL: number;
-    realizedPnL: number;
-    costBasis: number;
-    currency: string;
-}
-export interface Portfolio {
-    id: string;
-    name: string;
-    type: string;
-    status: string;
-    cash: number;
-    buyingPower: number;
-    equity: number;
-    longMarketValue: number;
-    shortMarketValue: number;
-    initialMargin: number;
-    maintenanceMargin: number;
-    lastEquity: number;
-    positions: Holding[];
-    performance: PerformanceMetrics;
-}
-export interface PortalResponse {
-    portalUrl: string;
-    token: string;
-    expiresIn: number;
-}
-export interface SessionValidationResponse {
-    valid: boolean;
-    company_id: string;
-    status: string;
-}
-export interface SessionAuthenticateResponse {
-    success: boolean;
-    message: string;
-    data: {
-        access_token: string;
-        refresh_token: string;
-    };
-}
-export interface RefreshTokenRequest {
-    refresh_token: string;
-}
-export interface RefreshTokenResponse {
-    success: boolean;
-    response_data: {
-        access_token: string;
-        refresh_token: string;
-        expires_at: string;
-        company_id: string;
-        company_name: string;
-        email_verified: boolean;
-    };
-    message: string;
-}
-export interface TokenInfo {
-    accessToken: string;
-    refreshToken: string;
-    expiresAt: string;
-    userId?: string;
-}
-export interface SessionResponse {
-    data: {
-        session_id: string;
-        state: SessionState;
-        device_info?: Record<string, string>;
-        company_id?: string;
-        status?: string;
-        expires_at?: string;
-        user_id?: string | null;
-        auto_login?: boolean;
-        access_token?: string;
-        refresh_token?: string;
-        expires_in?: number;
-        token_type?: string;
-        scope?: string;
-    };
-    message: string;
-}
 export interface BrokerInfo {
     id: string;
     name: string;
@@ -284,20 +75,16 @@ export interface BrokerInfo {
     logo_path: string;
     is_active: boolean;
 }
-export interface DeviceInfo {
-    ip_address: string;
-    user_agent: string;
-    fingerprint: string;
-}
 export interface BrokerOrderParams {
     broker: 'robinhood' | 'tasty_trade' | 'ninja_trader';
-    accountNumber: string;
-    symbol: string;
-    orderQty: number;
+    order_id?: string;
+    orderType: 'Market' | 'Limit' | 'Stop' | 'StopLimit';
+    assetType: 'Stock' | 'Option' | 'Crypto' | 'Future';
     action: 'Buy' | 'Sell';
-    orderType: 'Market' | 'Limit' | 'Stop' | 'TrailingStop';
-    assetType: 'Stock' | 'Option' | 'Crypto' | 'Futures';
     timeInForce: 'day' | 'gtc' | 'gtd' | 'ioc' | 'fok';
+    accountNumber: string | number;
+    symbol: string;
+    orderQty: number;
     price?: number;
     stopPrice?: number;
 }
@@ -325,32 +112,6 @@ export interface BrokerExtras {
         valueEffect?: 'Debit' | 'Credit';
     };
 }
-export interface CryptoOrderOptions {
-    quantity?: number;
-    notional?: number;
-}
-export interface OptionsOrderOptions {
-    strikePrice: number;
-    expirationDate: string;
-    optionType: 'call' | 'put';
-    contractSize?: number;
-}
-export interface OrderResponse {
-    success: boolean;
-    response_data: {
-        orderId: string;
-        status: string;
-        broker?: string;
-        accountNumber?: string;
-    };
-    message: string;
-    status_code: number;
-}
-export interface TradingContext {
-    broker?: string;
-    accountNumber?: string;
-    accountId?: string;
-}
 export interface BrokerConnection {
     id: string;
     broker_id: string;
@@ -369,44 +130,6 @@ export interface BrokerConnection {
     };
     needs_reauth: boolean;
 }
-export interface OrdersFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    symbol?: string;
-    status?: 'filled' | 'pending' | 'cancelled' | 'rejected' | 'partially_filled';
-    side?: 'buy' | 'sell';
-    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
-    limit?: number;
-    offset?: number;
-    created_after?: string;
-    created_before?: string;
-    with_metadata?: boolean;
-}
-export interface PositionsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_id?: string;
-    symbol?: string;
-    side?: 'long' | 'short';
-    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
-    position_status?: 'open' | 'closed';
-    limit?: number;
-    offset?: number;
-    updated_after?: string;
-    updated_before?: string;
-    with_metadata?: boolean;
-}
-export interface AccountsFilter {
-    broker_id?: string;
-    connection_id?: string;
-    account_type?: 'margin' | 'cash' | 'crypto_wallet' | 'live' | 'sim';
-    status?: 'active' | 'inactive';
-    currency?: string;
-    limit?: number;
-    offset?: number;
-    with_metadata?: boolean;
-}
 export interface BrokerDataOrder {
     id: string;
     broker_id: string;
@@ -466,6 +189,44 @@ export interface BrokerDataAccount {
     last_synced_at: string;
     metadata?: Record<string, any>;
 }
+export interface OrdersFilter {
+    broker_id?: string;
+    connection_id?: string;
+    account_id?: string;
+    symbol?: string;
+    status?: 'filled' | 'pending' | 'cancelled' | 'rejected' | 'partially_filled';
+    side?: 'buy' | 'sell';
+    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
+    limit?: number;
+    offset?: number;
+    created_after?: string;
+    created_before?: string;
+    with_metadata?: boolean;
+}
+export interface PositionsFilter {
+    broker_id?: string;
+    connection_id?: string;
+    account_id?: string;
+    symbol?: string;
+    side?: 'long' | 'short';
+    asset_type?: 'stock' | 'option' | 'crypto' | 'future';
+    position_status?: 'open' | 'closed';
+    limit?: number;
+    offset?: number;
+    updated_after?: string;
+    updated_before?: string;
+    with_metadata?: boolean;
+}
+export interface AccountsFilter {
+    broker_id?: string;
+    connection_id?: string;
+    account_type?: 'margin' | 'cash' | 'crypto_wallet' | 'live' | 'sim';
+    status?: 'active' | 'inactive';
+    currency?: string;
+    limit?: number;
+    offset?: number;
+    with_metadata?: boolean;
+}
 export interface FilteredOrdersResponse {
     orders: BrokerDataOrder[];
     total: number;
@@ -484,3 +245,14 @@ export interface FilteredAccountsResponse {
     limit: number;
     offset: number;
 }
+export interface DisconnectCompanyResponse {
+    success: boolean;
+    response_data: {
+        connection_id: string;
+        action: 'company_access_removed' | 'connection_deleted';
+        remaining_companies?: number;
+        message: string;
+    };
+    message: string;
+    status_code: number;
+}

package/dist/types/types/api/core.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Core API types
+ */
+import { ApiPaginationInfo } from '../common/pagination';
+export interface ApiConfig {
+    baseUrl: string;
+    apiKey?: string;
+    sandbox?: boolean;
+}
+export interface ApiResponse<T> {
+    success: boolean;
+    response_data: T;
+    message: string;
+    status_code: number;
+    pagination?: ApiPaginationInfo;
+}
+export interface ApiError {
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+}
+export interface RequestHeaders {
+    'Content-Type': string;
+    'X-API-Key'?: string;
+    Authorization?: string;
+    'X-CSRF-Token'?: string;
+    token?: string;
+    'User-Agent'?: string;
+    'X-Device-Info'?: string;
+    'X-Request-ID'?: string;
+    'X-Request-Timestamp'?: string;
+    'X-Request-Signature'?: string;
+    [key: string]: string | undefined;
+}
+export interface PortalResponse {
+    portalUrl: string;
+    token: string;
+    expiresIn: number;
+}
+export interface PortalUrlResponse {
+    success: boolean;
+    message: string;
+    data: {
+        portal_url: string;
+    };
+}

package/dist/types/types/api/errors.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Error response types matching API documentation
+ */
+export interface TradeAccessDeniedError {
+    success: false;
+    response_data: null;
+    message: string;
+    status_code: 403;
+    category: 'TRADE_ACCESS_DENIED';
+}
+export interface OrderNotFoundError {
+    success: false;
+    response_data: null;
+    message: string;
+    status_code: 404;
+    category: 'ORDER_NOT_FOUND';
+}
+export interface ValidationError {
+    success: false;
+    response_data: null;
+    message: string;
+    status_code: 400;
+}

package/dist/types/types/api/orders.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Order-related types
+ */
+export interface Order {
+    symbol: string;
+    side: 'buy' | 'sell';
+    quantity: number;
+    type_: 'market' | 'limit' | 'stop' | 'stop_limit';
+    price?: number;
+    stopPrice?: number;
+    timeInForce: 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok';
+}
+export interface OptionsOrder extends Order {
+    optionType: 'call' | 'put';
+    strikePrice: number;
+    expirationDate: string;
+}
+export interface CryptoOrderOptions {
+    quantity?: number;
+    notional?: number;
+}
+export interface OptionsOrderOptions {
+    strikePrice: number;
+    expirationDate: string;
+    optionType: 'call' | 'put';
+    contractSize?: number;
+}
+export interface OrderResponse {
+    success: boolean;
+    response_data: any;
+    message: string;
+    status_code: number;
+    category?: string;
+}
+export interface TradingContext {
+    broker?: string;
+    accountNumber?: string;
+    accountId?: string;
+}

package/dist/types/types/{shared.d.ts → api/portfolio.d.ts}

@@ -1,6 +1,31 @@
 /**
- * Shared types for Finatic Connect SDK
+ * Portfolio-related types
  */
+export interface PortfolioSnapshot {
+    timestamp: string;
+    totalValue: number;
+    cash: number;
+    equity: number;
+    positions: {
+        symbol: string;
+        quantity: number;
+        averagePrice: number;
+        currentPrice: number;
+        marketValue: number;
+        unrealizedPnL: number;
+    }[];
+}
+export interface PerformanceMetrics {
+    totalReturn: number;
+    dailyReturn: number;
+    weeklyReturn: number;
+    monthlyReturn: number;
+    yearlyReturn: number;
+    maxDrawdown: number;
+    sharpeRatio: number;
+    beta: number;
+    alpha: number;
+}
 export interface Holding {
     symbol: string;
     quantity: number;
@@ -12,15 +37,6 @@ export interface Holding {
     costBasis: number;
     currency: string;
 }
-export interface Order {
-    symbol: string;
-    quantity: number;
-    side: 'buy' | 'sell';
-    type_: 'market' | 'limit' | 'stop' | 'stop_limit';
-    timeInForce: 'day' | 'gtc' | 'opg' | 'cls' | 'ioc' | 'fok';
-    price?: number;
-    stopPrice?: number;
-}
 export interface Portfolio {
     id: string;
     name: string;
@@ -37,14 +53,3 @@ export interface Portfolio {
     positions: Holding[];
     performance: PerformanceMetrics;
 }
-export interface PerformanceMetrics {
-    totalReturn: number;
-    dailyReturn: number;
-    weeklyReturn: number;
-    monthlyReturn: number;
-    yearlyReturn: number;
-    maxDrawdown: number;
-    sharpeRatio: number;
-    beta: number;
-    alpha: number;
-}

package/dist/types/types/common/pagination.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Pagination-related types and classes
+ */
+export interface ApiPaginationInfo {
+    has_more: boolean;
+    next_offset: number;
+    current_offset: number;
+    limit: number;
+}
+export interface PaginationMetadata {
+    hasMore: boolean;
+    nextOffset: number;
+    currentOffset: number;
+    limit: number;
+    currentPage: number;
+    hasNext: boolean;
+    hasPrevious: boolean;
+}
+export declare class PaginatedResult<T> {
+    readonly data: T;
+    readonly metadata: PaginationMetadata;
+    private navigationCallback?;
+    constructor(data: T, paginationInfo: ApiPaginationInfo, navigationCallback?: (offset: number, limit: number) => Promise<PaginatedResult<T>>);
+    get hasNext(): boolean;
+    get hasPrevious(): boolean;
+    get currentPage(): number;
+    nextPage(): Promise<PaginatedResult<T> | null>;
+    previousPage(): Promise<PaginatedResult<T> | null>;
+    goToPage(pageNumber: number): Promise<PaginatedResult<T> | null>;
+    firstPage(): Promise<PaginatedResult<T> | null>;
+    lastPage(): Promise<PaginatedResult<T> | null>;
+    getPaginationInfo(): string;
+}