@finatic/client 0.9.0 → 0.9.2

package/dist/generated/wrappers/brokers.d.ts

@@ -1,1107 +0,0 @@
-/**
- * Generated wrapper functions for brokers operations (Phase 2A).
- *
- * This file is regenerated on each run - do not edit directly.
- * For custom logic, edit src/custom/wrappers/brokers.ts instead.
- */
-import { BrokersApi } from '../api/brokers-api';
-import type { Configuration } from '../configuration';
-import type { SdkConfig } from '../config';
-import { type Logger } from '../utils/logger';
-import { PublicAccountTypeEnum } from '../models';
-import { PublicAssetTypeEnum } from '../models';
-import { PublicOrderSideEnum } from '../models';
-import { PublicOrderStatusEnum } from '../models';
-import { PublicPositionStatusEnum } from '../models';
-import type { AccountStatus } from '../models';
-import type { Accounts } from '../models';
-import type { Balances } from '../models';
-import type { BrokerInfo } from '../models';
-import type { DisconnectActionResult } from '../models';
-import type { OrderActionResult } from '../models';
-import type { OrderEventResponse } from '../models';
-import type { OrderFillResponse } from '../models';
-import type { OrderGroupResponse } from '../models';
-import type { OrderResponse } from '../models';
-import type { PositionLotFillResponse } from '../models';
-import type { PositionLotResponse } from '../models';
-import type { PositionResponse } from '../models';
-import type { UserBrokerConnections } from '../models';
-export interface GetBrokersParams {
-}
-export interface GetBrokersResponse {
-    success: {
-        data: BrokerInfo[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface ListBrokerConnectionsParams {
-}
-export interface ListBrokerConnectionsResponse {
-    success: {
-        data: UserBrokerConnections[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface DisconnectCompanyFromBrokerParams {
-    connectionId: string;
-}
-export interface DisconnectCompanyFromBrokerResponse {
-    success: {
-        data: DisconnectActionResult;
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetOrdersParams {
-    brokerId?: string;
-    connectionId?: string;
-    accountId?: string;
-    symbol?: string;
-    orderStatus?: PublicOrderStatusEnum;
-    side?: PublicOrderSideEnum;
-    assetType?: PublicAssetTypeEnum;
-    limit?: number;
-    offset?: number;
-    createdAfter?: string;
-    createdBefore?: string;
-    withMetadata?: boolean;
-}
-export interface GetOrdersResponse {
-    success: {
-        data: OrderResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetPositionsParams {
-    brokerId?: string;
-    connectionId?: string;
-    accountId?: string;
-    symbol?: string;
-    side?: PublicOrderSideEnum;
-    assetType?: PublicAssetTypeEnum;
-    positionStatus?: PublicPositionStatusEnum;
-    limit?: number;
-    offset?: number;
-    updatedAfter?: string;
-    updatedBefore?: string;
-    withMetadata?: boolean;
-}
-export interface GetPositionsResponse {
-    success: {
-        data: PositionResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetBalancesParams {
-    brokerId?: string;
-    connectionId?: string;
-    accountId?: string;
-    isEndOfDaySnapshot?: boolean;
-    limit?: number;
-    offset?: number;
-    balanceCreatedAfter?: string;
-    balanceCreatedBefore?: string;
-    withMetadata?: boolean;
-}
-export interface GetBalancesResponse {
-    success: {
-        data: Balances[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetAccountsParams {
-    brokerId?: string;
-    connectionId?: string;
-    accountType?: PublicAccountTypeEnum;
-    status?: AccountStatus;
-    currency?: string;
-    limit?: number;
-    offset?: number;
-    withMetadata?: boolean;
-}
-export interface GetAccountsResponse {
-    success: {
-        data: Accounts[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetOrderFillsParams {
-    orderId: string;
-    connectionId?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface GetOrderFillsResponse {
-    success: {
-        data: OrderFillResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetOrderEventsParams {
-    orderId: string;
-    connectionId?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface GetOrderEventsResponse {
-    success: {
-        data: OrderEventResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetOrderGroupsParams {
-    brokerId?: string;
-    connectionId?: string;
-    limit?: number;
-    offset?: number;
-    createdAfter?: string;
-    createdBefore?: string;
-}
-export interface GetOrderGroupsResponse {
-    success: {
-        data: OrderGroupResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetPositionLotsParams {
-    brokerId?: string;
-    connectionId?: string;
-    accountId?: string;
-    symbol?: string;
-    positionId?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface GetPositionLotsResponse {
-    success: {
-        data: PositionLotResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface GetPositionLotFillsParams {
-    lotId: string;
-    connectionId?: string;
-    limit?: number;
-    offset?: number;
-}
-export interface GetPositionLotFillsResponse {
-    success: {
-        data: PositionLotFillResponse[];
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface PlaceOrderParams {
-    body?: any;
-    connectionId?: string;
-}
-export interface PlaceOrderResponse {
-    success: {
-        data: OrderActionResult;
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface CancelOrderParams {
-    orderId: string;
-    body?: any;
-    accountNumber?: string;
-    connectionId?: string;
-}
-export interface CancelOrderResponse {
-    success: {
-        data: OrderActionResult;
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-export interface ModifyOrderParams {
-    orderId: string;
-    body?: any;
-    accountNumber?: string;
-    connectionId?: string;
-}
-export interface ModifyOrderResponse {
-    success: {
-        data: OrderActionResult;
-        meta?: Record<string, any>;
-    };
-    Error?: {
-        message: string;
-        code?: string;
-        status?: number;
-        details?: Record<string, any>;
-    };
-    Warning?: Array<{
-        message: string;
-        code?: string;
-        details?: Record<string, any>;
-    }>;
-}
-/**
- * Brokers wrapper functions.
- * Provides simplified method names and response unwrapping.
- */
-export declare class BrokersWrapper {
-    protected api: BrokersApi;
-    protected config?: Configuration;
-    protected sdkConfig?: SdkConfig;
-    protected logger: Logger;
-    protected sessionId?: string;
-    protected companyId?: string;
-    protected csrfToken?: string;
-    constructor(api: BrokersApi, config?: Configuration, sdkConfig?: SdkConfig);
-    setSessionContext(sessionId: string, companyId: string, csrfToken: string): void;
-    protected _generateRequestId(): string;
-    protected _retryApiCall<T>(fn: () => Promise<T>): Promise<T>;
-    protected _handleError(error: any, requestId?: string): Error;
-    /**
-     * Get Brokers
-     *
-     * Get all available brokers.
-     *
-     * This is a fast operation that returns a cached list of available brokers.
-     * The list is loaded once at startup and never changes during runtime.
-     *
-     * Returns
-     * -------
-     * FinaticResponse[list[BrokerInfo]]
-     *     list of available brokers with their metadata.
-  
-     * @param params {GetBrokersParams} Input parameters object (empty for methods with no parameters)
-     * @returns {Promise<GetBrokersResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/
-     * @methodId get_brokers_api_v1_brokers__get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getBrokers({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     */
-    getBrokers(params: GetBrokersParams): Promise<GetBrokersResponse>;
-    /**
-     * List Broker Connections
-     *
-     * List all broker connections for the current user.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Returns connections that the user has any permissions for.
-  
-     * @param params {ListBrokerConnectionsParams} Input parameters object (empty for methods with no parameters)
-     * @returns {Promise<ListBrokerConnectionsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/connections
-     * @methodId list_broker_connections_api_v1_brokers_connections_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.listBrokerConnections({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     */
-    listBrokerConnections(params: ListBrokerConnectionsParams): Promise<ListBrokerConnectionsResponse>;
-    /**
-     * Disconnect Company From Broker
-     *
-     * Remove a company's access to a broker connection.
-     *
-     * If the company is the only one with access, the entire connection is deleted.
-     * If other companies have access, only the company's access is removed.
-  
-     * @param params {DisconnectCompanyFromBrokerParams} Input parameters object
-     * @returns {Promise<DisconnectCompanyFromBrokerResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: DELETE /api/v1/brokers/disconnect-company/{connection_id}
-     * @methodId disconnect_company_from_broker_api_v1_brokers_disconnect_company__connection_id__delete
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.disconnectCompanyFromBroker({
-      connectionId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     */
-    disconnectCompanyFromBroker(params: DisconnectCompanyFromBrokerParams): Promise<DisconnectCompanyFromBrokerResponse>;
-    /**
-     * Get Orders
-     *
-     * Get orders for all authorized broker connections.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Returns orders from connections the company has read access to.
-  
-     * @param params {GetOrdersParams} Input parameters object
-     * @returns {Promise<GetOrdersResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/orders
-     * @methodId get_orders_api_v1_brokers_data_orders_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getOrders({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getOrders({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      accountId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getOrders(params: GetOrdersParams): Promise<GetOrdersResponse>;
-    /**
-     * Get Positions
-     *
-     * Get positions for all authorized broker connections.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Returns positions from connections the company has read access to.
-  
-     * @param params {GetPositionsParams} Input parameters object
-     * @returns {Promise<GetPositionsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/positions
-     * @methodId get_positions_api_v1_brokers_data_positions_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getPositions({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getPositions({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      accountId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getPositions(params: GetPositionsParams): Promise<GetPositionsResponse>;
-    /**
-     * Get Balances
-     *
-     * Get balances for all authorized broker connections.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Returns balances from connections the company has read access to.
-  
-     * @param params {GetBalancesParams} Input parameters object
-     * @returns {Promise<GetBalancesResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/balances
-     * @methodId get_balances_api_v1_brokers_data_balances_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getBalances({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getBalances({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      accountId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getBalances(params: GetBalancesParams): Promise<GetBalancesResponse>;
-    /**
-     * Get Accounts
-     *
-     * Get accounts for all authorized broker connections.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Returns accounts from connections the company has read access to.
-  
-     * @param params {GetAccountsParams} Input parameters object
-     * @returns {Promise<GetAccountsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/accounts
-     * @methodId get_accounts_api_v1_brokers_data_accounts_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getAccounts({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getAccounts({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      accountType: 'cash'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getAccounts(params: GetAccountsParams): Promise<GetAccountsResponse>;
-    /**
-     * Get Order Fills
-     *
-     * Get order fills for a specific order.
-     *
-     * This endpoint returns all execution fills for the specified order.
-  
-     * @param params {GetOrderFillsParams} Input parameters object
-     * @returns {Promise<GetOrderFillsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/orders/{order_id}/fills
-     * @methodId get_order_fills_api_v1_brokers_data_orders__order_id__fills_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.getOrderFills({
-      orderId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getOrderFills({
-      orderId: 'id-123',
-      connectionId: 'id-123',
-      limit: 10,
-      offset: 0
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getOrderFills(params: GetOrderFillsParams): Promise<GetOrderFillsResponse>;
-    /**
-     * Get Order Events
-     *
-     * Get order events for a specific order.
-     *
-     * This endpoint returns all lifecycle events for the specified order.
-  
-     * @param params {GetOrderEventsParams} Input parameters object
-     * @returns {Promise<GetOrderEventsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/orders/{order_id}/events
-     * @methodId get_order_events_api_v1_brokers_data_orders__order_id__events_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.getOrderEvents({
-      orderId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getOrderEvents({
-      orderId: 'id-123',
-      connectionId: 'id-123',
-      limit: 10,
-      offset: 0
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getOrderEvents(params: GetOrderEventsParams): Promise<GetOrderEventsResponse>;
-    /**
-     * Get Order Groups
-     *
-     * Get order groups.
-     *
-     * This endpoint returns order groups that contain multiple orders.
-  
-     * @param params {GetOrderGroupsParams} Input parameters object
-     * @returns {Promise<GetOrderGroupsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/orders/groups
-     * @methodId get_order_groups_api_v1_brokers_data_orders_groups_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getOrderGroups({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getOrderGroups({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      limit: 10
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getOrderGroups(params: GetOrderGroupsParams): Promise<GetOrderGroupsResponse>;
-    /**
-     * Get Position Lots
-     *
-     * Get position lots (tax lots for positions).
-     *
-     * This endpoint returns tax lots for positions, which are used for tax reporting.
-     * Each lot tracks when a position was opened/closed and at what prices.
-  
-     * @param params {GetPositionLotsParams} Input parameters object
-     * @returns {Promise<GetPositionLotsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/positions/lots
-     * @methodId get_position_lots_api_v1_brokers_data_positions_lots_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.getPositionLots({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getPositionLots({
-      brokerId: 'id-123',
-      connectionId: 'id-123',
-      accountId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getPositionLots(params: GetPositionLotsParams): Promise<GetPositionLotsResponse>;
-    /**
-     * Get Position Lot Fills
-     *
-     * Get position lot fills for a specific lot.
-     *
-     * This endpoint returns all fills associated with a specific position lot.
-  
-     * @param params {GetPositionLotFillsParams} Input parameters object
-     * @returns {Promise<GetPositionLotFillsResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: GET /api/v1/brokers/data/positions/lots/{lot_id}/fills
-     * @methodId get_position_lot_fills_api_v1_brokers_data_positions_lots__lot_id__fills_get
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.getPositionLotFills({
-      lotId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.getPositionLotFills({
-      lotId: 'id-123',
-      connectionId: 'id-123',
-      limit: 10,
-      offset: 0
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    getPositionLotFills(params: GetPositionLotFillsParams): Promise<GetPositionLotFillsResponse>;
-    /**
-     * Place Order
-     *
-     * Create a new order via the specified broker connection.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Requires trading permissions for the company.
-     *
-     * Standard parameters
-     * -------------------
-     * The following fields constitute the unified Finatic *common order schema* and
-     * therefore appear individually as query parameters in the autogenerated
-     * OpenAPI documentation:
-     *
-     * - ``broker``
-     * - ``account_number``
-     * - ``order_type``
-     * - ``asset_type``
-     * - ``action``
-     * - ``time_in_force``
-     * - ``symbol``
-     * - ``order_qty``
-     *
-     * They are surfaced as *query* parameters **only to make the accepted fields
-     * obvious in the interactive docs**. In production usage you should send these
-     * fields inside the JSON body (see ``order_request``) so that the entire order
-     * specification travels in one payload. (Nothing will break if you send both, but there is no need to do so.)
-     *
-     * Body payload & broker-specific extras
-     * -------------------------------------
-     *
-     * Put the standard parameters plus any broker-specific extensions under the
-     * ``order`` key of the body. Refer to the bundled OpenAPI examples below to
-     * see complete payloads for common order types (market, limit, spreads, etc.)
-     * across supported brokers.
-     *
-     * For a formal reference of broker-specific extensions inspect the
-     * ``BrokerOrderPlaceExtras`` schema.
-     *
-     * The endpoint resolves the active ``user_broker_connection`` by calling the
-     * ``get_user_broker_connection_ids_for_broker`` RPC in Supabase. If no active
-     * connection exists it returns a list of *available* brokers so your client
-     * can guide the user accordingly.
-     *
-     * Broker Notes
-     * ------------
-     * - The responses that you get back from the broker are not always the same.
-     * The response models are validated for each broker, but we do not standardize the repsonses.
-     *
-     * - Tasty Trade: If you want to trade options for a particular stock, first fetch the full
-     * option chain via the GET https://api.tastyworks.com/option-chains/{stock_symbol}/nested endpoint.
-     * This endpoint returns all available expirations that tastytrade offers for that equity symbol.
-     * Each expiration contains a list of strikes, where each strike has a call and put field representing
-     * the call symbol and put symbol respectively.
-     *
-     * We are planning to add a new endpoint to fetch the option chain for a particular stock and
-     * handle this logic for you, but for now you need to fetch the option chain manually.
-  
-     * @param params {PlaceOrderParams} Input parameters object
-     * @returns {Promise<PlaceOrderResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: POST /api/v1/brokers/orders
-     * @methodId place_order_api_v1_brokers_orders_post
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Example with no parameters
-     * const result = await finatic.placeOrder({});
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.placeOrder({
-      body: {},
-      connectionId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    placeOrder(params: PlaceOrderParams): Promise<PlaceOrderResponse>;
-    /**
-     * Cancel Order
-     *
-     * Cancel an existing order.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Requires trading permissions for the company.
-  
-     * @param params {CancelOrderParams} Input parameters object
-     * @returns {Promise<CancelOrderResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: DELETE /api/v1/brokers/orders/{order_id}
-     * @methodId cancel_order_api_v1_brokers_orders__order_id__delete
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.cancelOrder({
-      orderId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.cancelOrder({
-      orderId: 'id-123',
-      body: {},
-      accountNumber: 'example',
-      connectionId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    cancelOrder(params: CancelOrderParams): Promise<CancelOrderResponse>;
-    /**
-     * Modify Order
-     *
-     * Modify an existing order.
-     *
-     * This endpoint is accessible from the portal and uses session-only authentication.
-     * Requires trading permissions for the company.
-  
-     * @param params {ModifyOrderParams} Input parameters object
-     * @returns {Promise<ModifyOrderResponse>} Standard response with success/Error/Warning structure
-     *
-     * Generated from: PATCH /api/v1/brokers/orders/{order_id}
-     * @methodId modify_order_api_v1_brokers_orders__order_id__patch
-     * @category brokers
-     * @example
-     * ```typescript-client
-     * // Minimal example with required parameters only
-     * const result = await finatic.modifyOrder({
-      orderId: 'id-123'
-     * });
-     *
-     * // Access the response data
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message);
-     * }
-     * ```
-     * @example
-     * ```typescript-client
-     * // Full example with optional parameters
-     * const result = await finatic.modifyOrder({
-      orderId: 'id-123',
-      body: {},
-      accountNumber: 'example',
-      connectionId: 'id-123'
-     * });
-     *
-     * // Handle response with warnings
-     * if (result.success) {
-     *   console.log('Data:', result.success.data);
-     *   if (result.Warning && result.Warning.length > 0) {
-     *     console.warn('Warnings:', result.Warning);
-     *   }
-     * } else if (result.Error) {
-     *   console.error('Error:', result.Error.message, result.Error.code);
-     * }
-     * ```
-     */
-    modifyOrder(params: ModifyOrderParams): Promise<ModifyOrderResponse>;
-}
-//# sourceMappingURL=brokers.d.ts.map