@finatic/client 0.9.3 → 0.9.4

package/dist/index.d.ts

@@ -328,31 +328,6 @@ declare enum BrokerDataOrderSideEnum {
     Sell = "sell"
 }
 
-/**
- * Finatic FastAPI Backend
- * FinaticAPI REST API
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-declare enum BrokerDataOrderStatusEnum {
-    Submitted = "submitted",
-    New = "new",
-    PartiallyFilled = "partially_filled",
-    Filled = "filled",
-    PendingCancel = "pending_cancel",
-    Cancelled = "cancelled",
-    Rejected = "rejected",
-    Expired = "expired",
-    Created = "created",
-    Received = "received",
-    Queued = "queued"
-}
-
 /**
  * Finatic FastAPI Backend
  * FinaticAPI REST API
@@ -966,6 +941,8 @@ interface FDXBrokerBalance {
      * Associated account identifier
      */
     'accountId': string;
+    'internalAccountId'?: string | null;
+    'connectionId'?: string | null;
     'balanceType': Balancetype;
     'balanceName'?: string | null;
     'availableBalance'?: Availablebalance | null;
@@ -1279,6 +1256,7 @@ interface FDXBrokerOrder {
      * Broker account identifier
      */
     'accountId': string;
+    'internalAccountId'?: string | null;
     'connectionId'?: string | null;
     'orderType'?: Ordertype | null;
     'orderClass'?: Orderclass | null;
@@ -1758,6 +1736,7 @@ interface FDXBrokerPosition {
      * Broker account identifier
      */
     'accountId': string;
+    'internalAccountId'?: string | null;
     /**
      * User-broker connection identifier
      */
@@ -1997,6 +1976,8 @@ interface FDXBrokerPositionLot {
      * Broker account identifier
      */
     'accountId': string;
+    'internalAccountId'?: string | null;
+    'connectionId'?: string | null;
     /**
      * Security identifier
      */
@@ -3367,7 +3348,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
      * @summary Get Balances
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
      * @param {number} [limit] Maximum number of balances to return
      * @param {number} [offset] Number of balances to skip for pagination
@@ -3428,9 +3409,9 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
      * @summary Get Orders
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {string | null} [symbol] Filter by symbol
-     * @param {BrokerDataOrderStatusEnum | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
+     * @param {string | null} [orderStatus] Filter by order status (e.g., \'filled\', \'pending_new\', \'cancelled\')
      * @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \'buy\', \'sell\')
      * @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \'stock\', \'option\', \'crypto\', \'future\')
      * @param {number} [limit] Maximum number of orders to return
@@ -3441,7 +3422,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrdersApiV1BrokersDataOrdersGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: BrokerDataOrderStatusEnum | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getOrdersApiV1BrokersDataOrdersGet: (brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get position lot fills for a specific lot.  This endpoint returns all fills associated with a specific position lot.
      * @summary Get Position Lot Fills
@@ -3472,7 +3453,7 @@ declare const BrokersApiAxiosParamCreator: (configuration?: Configuration) => {
      * @summary Get Positions
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {string | null} [symbol] Filter by symbol
      * @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \&#39;long\&#39;, \&#39;short\&#39;)
      * @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
@@ -3526,7 +3507,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
      * @summary Get Balances
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {boolean | null} [isEndOfDaySnapshot] Filter by end-of-day snapshot status (true/false)
      * @param {number} [limit] Maximum number of balances to return
      * @param {number} [offset] Number of balances to skip for pagination
@@ -3587,9 +3568,9 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
      * @summary Get Orders
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {string | null} [symbol] Filter by symbol
-     * @param {BrokerDataOrderStatusEnum | null} [orderStatus] Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
+     * @param {string | null} [orderStatus] Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
      * @param {BrokerDataOrderSideEnum | null} [side] Filter by order side (e.g., \&#39;buy\&#39;, \&#39;sell\&#39;)
      * @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
      * @param {number} [limit] Maximum number of orders to return
@@ -3600,7 +3581,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrdersApiV1BrokersDataOrdersGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: BrokerDataOrderStatusEnum | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrder>>;
+    getOrdersApiV1BrokersDataOrdersGet(brokerId?: string | null, connectionId?: string | null, accountId?: string | null, symbol?: string | null, orderStatus?: string | null, side?: BrokerDataOrderSideEnum | null, assetType?: BrokerDataAssetTypeEnum | null, limit?: number, offset?: number, createdAfter?: string | null, createdBefore?: string | null, includeMetadata?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FinaticResponseListFDXBrokerOrder>>;
     /**
      * Get position lot fills for a specific lot.  This endpoint returns all fills associated with a specific position lot.
      * @summary Get Position Lot Fills
@@ -3631,7 +3612,7 @@ declare const BrokersApiFp: (configuration?: Configuration) => {
      * @summary Get Positions
      * @param {string | null} [brokerId] Filter by broker ID
      * @param {string | null} [connectionId] Filter by connection ID
-     * @param {string | null} [accountId] Filter by broker provided account ID
+     * @param {string | null} [accountId] Filter by broker provided account ID or internal account UUID
      * @param {string | null} [symbol] Filter by symbol
      * @param {BrokerDataOrderSideEnum | null} [side] Filter by position side (e.g., \&#39;long\&#39;, \&#39;short\&#39;)
      * @param {BrokerDataAssetTypeEnum | null} [assetType] Filter by asset type (e.g., \&#39;stock\&#39;, \&#39;option\&#39;, \&#39;crypto\&#39;, \&#39;future\&#39;)
@@ -3910,7 +3891,7 @@ interface BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest {
      */
     readonly connectionId?: string | null;
     /**
-     * Filter by broker provided account ID
+     * Filter by broker provided account ID or internal account UUID
      */
     readonly accountId?: string | null;
     /**
@@ -4034,7 +4015,7 @@ interface BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest {
      */
     readonly connectionId?: string | null;
     /**
-     * Filter by broker provided account ID
+     * Filter by broker provided account ID or internal account UUID
      */
     readonly accountId?: string | null;
     /**
@@ -4044,7 +4025,7 @@ interface BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest {
     /**
      * Filter by order status (e.g., \&#39;filled\&#39;, \&#39;pending_new\&#39;, \&#39;cancelled\&#39;)
      */
-    readonly orderStatus?: BrokerDataOrderStatusEnum | null;
+    readonly orderStatus?: string | null;
     /**
      * Filter by order side (e.g., \&#39;buy\&#39;, \&#39;sell\&#39;)
      */
@@ -4141,7 +4122,7 @@ interface BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest {
      */
     readonly connectionId?: string | null;
     /**
-     * Filter by broker provided account ID
+     * Filter by broker provided account ID or internal account UUID
      */
     readonly accountId?: string | null;
     /**
@@ -4512,6 +4493,21 @@ declare class PaginatedData<T> {
      * Returns a string representation of an array.
      */
     toLocaleString(): string;
+    /**
+     * Convert to JSON - returns just the items array for serialization.
+     * This allows clean serialization without exposing internal methods.
+     *
+     * @returns The items array
+     *
+     * @example
+     * ```typescript
+     * const orders = await sdk.getOrders();
+     * console.log(orders);  // Shows full PaginatedData with methods
+     * console.log(orders.toJSON());  // Shows just the items array
+     * JSON.stringify(orders);  // Automatically uses toJSON()
+     * ```
+     */
+    toJSON(): T[];
     /**
      * Get the next page of data.
      * @returns Promise<PaginatedData<T>> - The next page (not wrapped in FinaticResponse)
@@ -4578,12 +4574,12 @@ interface GetOrdersParams {
     brokerId?: string;
     /** Filter by connection ID */
     connectionId?: string;
-    /** Filter by broker provided account ID */
+    /** Filter by broker provided account ID or internal account UUID */
     accountId?: string;
     /** Filter by symbol */
     symbol?: string;
     /** Filter by order status (e.g., 'filled', 'pending_new', 'cancelled') */
-    orderStatus?: BrokerDataOrderStatusEnum;
+    orderStatus?: string;
     /** Filter by order side (e.g., 'buy', 'sell') */
     side?: BrokerDataOrderSideEnum;
     /** Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future') */
@@ -4604,7 +4600,7 @@ interface GetPositionsParams {
     brokerId?: string;
     /** Filter by connection ID */
     connectionId?: string;
-    /** Filter by broker provided account ID */
+    /** Filter by broker provided account ID or internal account UUID */
     accountId?: string;
     /** Filter by symbol */
     symbol?: string;
@@ -4630,7 +4626,7 @@ interface GetBalancesParams {
     brokerId?: string;
     /** Filter by connection ID */
     connectionId?: string;
-    /** Filter by broker provided account ID */
+    /** Filter by broker provided account ID or internal account UUID */
     accountId?: string;
     /** Filter by end-of-day snapshot status (true/false) */
     isEndOfDaySnapshot?: boolean;
@@ -4840,9 +4836,9 @@ declare class BrokersWrapper {
      * Returns orders from connections the company has read access to.
      * @param params.brokerId {string} (optional) Filter by broker ID
      * @param params.connectionId {string} (optional) Filter by connection ID
-     * @param params.accountId {string} (optional) Filter by broker provided account ID
+     * @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
      * @param params.symbol {string} (optional) Filter by symbol
-     * @param params.orderStatus {BrokerDataOrderStatusEnum} (optional) Filter by order status (e.g., 'filled', 'pending_new', 'cancelled')
+     * @param params.orderStatus {string} (optional) Filter by order status (e.g., 'filled', 'pending_new', 'cancelled')
      * @param params.side {BrokerDataOrderSideEnum} (optional) Filter by order side (e.g., 'buy', 'sell')
      * @param params.assetType {BrokerDataAssetTypeEnum} (optional) Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future')
      * @param params.limit {number} (optional) Maximum number of orders to return
@@ -4895,7 +4891,7 @@ declare class BrokersWrapper {
      * Returns positions from connections the company has read access to.
      * @param params.brokerId {string} (optional) Filter by broker ID
      * @param params.connectionId {string} (optional) Filter by connection ID
-     * @param params.accountId {string} (optional) Filter by broker provided account ID
+     * @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
      * @param params.symbol {string} (optional) Filter by symbol
      * @param params.side {BrokerDataOrderSideEnum} (optional) Filter by position side (e.g., 'long', 'short')
      * @param params.assetType {BrokerDataAssetTypeEnum} (optional) Filter by asset type (e.g., 'stock', 'option', 'crypto', 'future')
@@ -4950,7 +4946,7 @@ declare class BrokersWrapper {
      * Returns balances from connections the company has read access to.
      * @param params.brokerId {string} (optional) Filter by broker ID
      * @param params.connectionId {string} (optional) Filter by connection ID
-     * @param params.accountId {string} (optional) Filter by broker provided account ID
+     * @param params.accountId {string} (optional) Filter by broker provided account ID or internal account UUID
      * @param params.isEndOfDaySnapshot {boolean} (optional) Filter by end-of-day snapshot status (true/false)
      * @param params.limit {number} (optional) Maximum number of balances to return
      * @param params.offset {number} (optional) Number of balances to skip for pagination
@@ -7855,5 +7851,5 @@ declare class FinaticConnect extends FinaticConnect$1 {
     static readonly __CUSTOM_CLASS__ = true;
 }
 
-export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum, BrokerDataOrderStatusEnum, BrokerDataPositionStatusEnum, BrokersApi, BrokersApiAxiosParamCreator, BrokersApiFactory, BrokersApiFp, BrokersWrapper, CompanyApi, CompanyApiAxiosParamCreator, CompanyApiFactory, CompanyApiFp, CompanyWrapper, Configuration, EventEmitter, FDXAccountStatus, FDXAccountType, FDXAssetType, FDXBalanceType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FinaticConnect, PaginatedData, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SessionStatus, SessionWrapper, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
+export { AccountStatus, ApiError, BrokerDataAccountTypeEnum, BrokerDataAssetTypeEnum, BrokerDataOrderSideEnum, BrokerDataPositionStatusEnum, BrokersApi, BrokersApiAxiosParamCreator, BrokersApiFactory, BrokersApiFp, BrokersWrapper, CompanyApi, CompanyApiAxiosParamCreator, CompanyApiFactory, CompanyApiFp, CompanyWrapper, Configuration, EventEmitter, FDXAccountStatus, FDXAccountType, FDXAssetType, FDXBalanceType, FDXOrderClass, FDXOrderEventType, FDXOrderGroupType, FDXOrderSide, FDXOrderStatus, FDXOrderType, FDXPositionSide, FDXPositionStatus, FDXSecurityIdType, FDXTimeInForce, FinaticConnect, PaginatedData, SessionApi, SessionApiAxiosParamCreator, SessionApiFactory, SessionApiFp, SessionStatus, SessionWrapper, ValidationError, addErrorInterceptor, addRequestInterceptor, addResponseInterceptor, appendBrokerFilterToURL, appendThemeToURL, applyErrorInterceptors, applyRequestInterceptors, applyResponseInterceptors, coerceEnumValue, convertToPlainObject, defaultConfig, generateCacheKey, generateRequestId, getCache, getConfig, getLogger, handleError, numberSchema, retryApiCall, stringSchema, unwrapAxiosResponse, validateParams };
 export type { Accounttype, ValidationError$1 as ApiValidationError, Assettype, Availablebalance, Availabletowithdraw, Averagebuyprice, Averagefillprice, Averagesellprice, Balancetype, BrokerInfo, BrokersApiDisconnectCompanyFromBrokerApiV1BrokersDisconnectCompanyConnectionIdDeleteRequest, BrokersApiGetAccountsApiV1BrokersDataAccountsGetRequest, BrokersApiGetBalancesApiV1BrokersDataBalancesGetRequest, BrokersApiGetOrderEventsApiV1BrokersDataOrdersOrderIdEventsGetRequest, BrokersApiGetOrderFillsApiV1BrokersDataOrdersOrderIdFillsGetRequest, BrokersApiGetOrderGroupsApiV1BrokersDataOrdersGroupsGetRequest, BrokersApiGetOrdersApiV1BrokersDataOrdersGetRequest, BrokersApiGetPositionLotFillsApiV1BrokersDataPositionsLotsLotIdFillsGetRequest, BrokersApiGetPositionLotsApiV1BrokersDataPositionsLotsGetRequest, BrokersApiGetPositionsApiV1BrokersDataPositionsGetRequest, BrokersApiInterface, Buyingpower, Cashbalance, Closedquantity, Closepriceavg, Commission, Commissionshare, CompanyApiGetCompanyApiV1CompanyCompanyIdGet0Request, CompanyApiGetCompanyApiV1CompanyCompanyIdGetRequest, CompanyApiInterface, CompanyResponse, ConfigurationParameters, Costbasis, Costbasis1, Costbasiswithcommission, Costbasiswithcommission1, Currentbalance, Currentprice, DisconnectActionResult, ErrorInterceptor, Eventtype, FDXBrokerAccount, FDXBrokerBalance, FDXBrokerOrder, FDXBrokerOrderEvent, FDXBrokerOrderFill, FDXBrokerOrderGroup, FDXBrokerPosition, FDXBrokerPositionLot, FDXBrokerPositionLotFill, FDXOrderGroupOrder, FDXOrderLeg, Filledquantity, Fillprice, Fillquantity, FinaticConnectOptions, FinaticResponse$3 as FinaticResponse, FinaticResponseCompanyResponse, FinaticResponseDisconnectActionResult, FinaticResponseListBrokerInfo, FinaticResponseListFDXBrokerAccount, FinaticResponseListFDXBrokerBalance, FinaticResponseListFDXBrokerOrder, FinaticResponseListFDXBrokerOrderEvent, FinaticResponseListFDXBrokerOrderFill, FinaticResponseListFDXBrokerOrderGroup, FinaticResponseListFDXBrokerPosition, FinaticResponseListFDXBrokerPositionLot, FinaticResponseListFDXBrokerPositionLotFill, FinaticResponseListUserBrokerConnectionWithPermissions, FinaticResponsePortalUrlResponse, FinaticResponseSessionResponseData, FinaticResponseSessionUserResponse, FinaticResponseTokenResponseData, Futureunderlyingassettype, Grouptype, HTTPValidationError, Initialmargin, InterceptorChain, Limitprice, LogLevel, Logger, Maintenancemargin, Marketvalue, Netliquidationvalue, Openprice, Openquantity, Orderclass, Orderstatus, Ordertype, PaginationMeta, ParsedFinaticError, Pendingbalance, PortalUrlResponse, Previousstatus, Price, Quantity, Quantity1, Quantity2, Realizedprofitloss, Realizedprofitloss1, Realizedprofitlosspercent, Realizedprofitlosswithcommission, Realizedprofitlosswithcommission1, Remainingquantity, Remainingquantity1, RequestInterceptor, ResponseInterceptor, RetryOptions, SdkConfig, Securityidtype, SessionApiGetPortalUrlApiV1SessionPortalGetRequest, SessionApiGetSessionUserApiV1SessionSessionIdUserGetRequest, SessionApiInitSessionApiV1SessionInitPostRequest, SessionApiInterface, SessionApiStartSessionApiV1SessionStartPostRequest, SessionResponseData, SessionStartRequest, SessionUserResponse, Side, Side1, Side2, Side3, Status, Status1, Stopprice, Strikeprice, SuccessPayloadCompanyResponse, SuccessPayloadDisconnectActionResult, SuccessPayloadListBrokerInfo, SuccessPayloadListFDXBrokerAccount, SuccessPayloadListFDXBrokerBalance, SuccessPayloadListFDXBrokerOrder, SuccessPayloadListFDXBrokerOrderEvent, SuccessPayloadListFDXBrokerOrderFill, SuccessPayloadListFDXBrokerOrderGroup, SuccessPayloadListFDXBrokerPosition, SuccessPayloadListFDXBrokerPositionLot, SuccessPayloadListFDXBrokerPositionLotFill, SuccessPayloadListUserBrokerConnectionWithPermissions, SuccessPayloadPortalUrlResponse, SuccessPayloadSessionResponseData, SuccessPayloadSessionUserResponse, SuccessPayloadTokenResponseData, Timeinforce, TokenResponseData, Totalcashvalue, Totalrealizedpnl, Units, Unrealizedprofitloss, Unrealizedprofitlosspercent, UserBrokerConnectionWithPermissions, ValidationErrorLocInner };