snaptrade-typescript-sdk 8.7.0 → 8.8.0

package/models/performance-custom.ts

@@ -1,154 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { MonthlyDividends } from './monthly-dividends';
-// May contain unused imports in some cases
-// @ts-ignore
-import { NetContributions } from './net-contributions';
-// May contain unused imports in some cases
-// @ts-ignore
-import { NetDividend } from './net-dividend';
-// May contain unused imports in some cases
-// @ts-ignore
-import { PastValue } from './past-value';
-// May contain unused imports in some cases
-// @ts-ignore
-import { SubPeriodReturnRate } from './sub-period-return-rate';
-
-/**
- * Performance Custom Response Object
- * @export
- * @interface PerformanceCustom
- */
-export interface PerformanceCustom {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {Array<PastValue>}
-     * @memberof PerformanceCustom
-     */
-    'totalEquityTimeframe'?: Array<PastValue>;
-    /**
-     * 
-     * @type {NetContributions}
-     * @memberof PerformanceCustom
-     */
-    'contributions'?: NetContributions;
-    /**
-     * 
-     * @type {Array<PastValue>}
-     * @memberof PerformanceCustom
-     */
-    'contributionTimeframe'?: Array<PastValue>;
-    /**
-     * 
-     * @type {Array<PastValue>}
-     * @memberof PerformanceCustom
-     */
-    'contributionTimeframeCumulative'?: Array<PastValue>;
-    /**
-     * 
-     * @type {Array<PastValue>}
-     * @memberof PerformanceCustom
-     */
-    'withdrawalTimeframe'?: Array<PastValue>;
-    /**
-     * Current streak of cosecutive months where contributions were made
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'contributionStreak'?: number | null;
-    /**
-     * Number of months in the timeframe with contributions
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'contributionMonthsContributed'?: number | null;
-    /**
-     * Total months in timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'contributionTotalMonths'?: number | null;
-    /**
-     * 
-     * @type {Array<NetDividend>}
-     * @memberof PerformanceCustom
-     */
-    'dividends'?: Array<NetDividend>;
-    /**
-     * Total dividends received over the timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'dividendIncome'?: number | null;
-    /**
-     * Average dividends received per month over the timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'monthlyDividends'?: number | null;
-    /**
-     * list of tickers which may not be supported or may not have accurate price data
-     * @type {Array<string>}
-     * @memberof PerformanceCustom
-     */
-    'badTickers'?: Array<string>;
-    /**
-     * 
-     * @type {Array<MonthlyDividends>}
-     * @memberof PerformanceCustom
-     */
-    'dividendTimeline'?: Array<MonthlyDividends>;
-    /**
-     * commissions incurred during the timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'commissions'?: number | null;
-    /**
-     * forex fees incurred during the timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'forexFees'?: number | null;
-    /**
-     * other fees incurred during the timeframe
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'fees'?: number | null;
-    /**
-     * The return rate over the timeframe. Annualized if timeframe is longer than 1 year
-     * @type {number}
-     * @memberof PerformanceCustom
-     */
-    'rateOfReturn'?: number | null;
-    /**
-     * 
-     * @type {Array<SubPeriodReturnRate>}
-     * @memberof PerformanceCustom
-     */
-    'returnRateTimeframe'?: Array<SubPeriodReturnRate>;
-    /**
-     * Whether the user has detailed mode enabled (more frequent data points for totalEquity and contribution timeframes)
-     * @type {boolean}
-     * @memberof PerformanceCustom
-     */
-    'detailedMode'?: boolean;
-}
-

package/models/portfolio-group-info.ts

@@ -1,115 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { Balance } from './balance';
-// May contain unused imports in some cases
-// @ts-ignore
-import { BrokerageAuthorization } from './brokerage-authorization';
-// May contain unused imports in some cases
-// @ts-ignore
-import { CalculatedTrade } from './calculated-trade';
-// May contain unused imports in some cases
-// @ts-ignore
-import { ExcludedAsset } from './excluded-asset';
-// May contain unused imports in some cases
-// @ts-ignore
-import { PortfolioGroupSettings } from './portfolio-group-settings';
-// May contain unused imports in some cases
-// @ts-ignore
-import { Position } from './position';
-// May contain unused imports in some cases
-// @ts-ignore
-import { TargetAsset } from './target-asset';
-// May contain unused imports in some cases
-// @ts-ignore
-import { UniversalSymbol } from './universal-symbol';
-
-/**
- * Summary of all relevant information about a portfolio group.
- * @export
- * @interface PortfolioGroupInfo
- */
-export interface PortfolioGroupInfo {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {Array<UniversalSymbol>}
-     * @memberof PortfolioGroupInfo
-     */
-    'symbols'?: Array<UniversalSymbol>;
-    /**
-     * 
-     * @type {Array<UniversalSymbol>}
-     * @memberof PortfolioGroupInfo
-     */
-    'quotable_symbols'?: Array<UniversalSymbol>;
-    /**
-     * 
-     * @type {Array<Balance>}
-     * @memberof PortfolioGroupInfo
-     */
-    'balances'?: Array<Balance>;
-    /**
-     * 
-     * @type {Array<Position>}
-     * @memberof PortfolioGroupInfo
-     */
-    'positions'?: Array<Position>;
-    /**
-     * 
-     * @type {Array<TargetAsset>}
-     * @memberof PortfolioGroupInfo
-     */
-    'target_positions'?: Array<TargetAsset>;
-    /**
-     * 
-     * @type {Array<Position>}
-     * @memberof PortfolioGroupInfo
-     */
-    'ideal_positions'?: Array<Position>;
-    /**
-     * 
-     * @type {Array<ExcludedAsset>}
-     * @memberof PortfolioGroupInfo
-     */
-    'excluded_positions'?: Array<ExcludedAsset>;
-    /**
-     * 
-     * @type {Array<CalculatedTrade>}
-     * @memberof PortfolioGroupInfo
-     */
-    'calculated_trades'?: Array<CalculatedTrade>;
-    /**
-     * 
-     * @type {Array<BrokerageAuthorization>}
-     * @memberof PortfolioGroupInfo
-     */
-    'brokerage_authorizations'?: Array<BrokerageAuthorization>;
-    /**
-     * 
-     * @type {number}
-     * @memberof PortfolioGroupInfo
-     */
-    'accuracy'?: number;
-    /**
-     * 
-     * @type {PortfolioGroupSettings}
-     * @memberof PortfolioGroupInfo
-     */
-    'settings'?: PortfolioGroupSettings;
-}
-

package/models/portfolio-group-position.ts

@@ -1,46 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { UniversalSymbol } from './universal-symbol';
-
-/**
- * Details of a security held
- * @export
- * @interface PortfolioGroupPosition
- */
-export interface PortfolioGroupPosition {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {UniversalSymbol}
-     * @memberof PortfolioGroupPosition
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     * Last known market price for the symbol
-     * @type {number}
-     * @memberof PortfolioGroupPosition
-     */
-    'price'?: number | null;
-    /**
-     * 
-     * @type {number}
-     * @memberof PortfolioGroupPosition
-     */
-    'units'?: number;
-}
-

package/models/portfolio-group-settings.ts

@@ -1,58 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { Currency } from './currency';
-
-/**
- * 
- * @export
- * @interface PortfolioGroupSettings
- */
-export interface PortfolioGroupSettings {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PortfolioGroupSettings
-     */
-    'buyOnly'?: boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PortfolioGroupSettings
-     */
-    'cash_optimizer'?: boolean;
-    /**
-     * 
-     * @type {string}
-     * @memberof PortfolioGroupSettings
-     */
-    'notifyFrequency'?: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof PortfolioGroupSettings
-     */
-    'driftThreshold'?: number;
-    /**
-     * 
-     * @type {Currency}
-     * @memberof PortfolioGroupSettings
-     */
-    'preferred_currency'?: Currency;
-}
-

package/models/portfolio-group.ts

@@ -1,37 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-
-/**
- * 
- * @export
- * @interface PortfolioGroup
- */
-export interface PortfolioGroup {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {string}
-     * @memberof PortfolioGroup
-     */
-    'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PortfolioGroup
-     */
-    'name'?: string;
-}
-

package/models/position-symbol.ts

@@ -1,64 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { UniversalSymbol } from './universal-symbol';
-
-/**
- * Symbol returned in position object
- * @export
- * @interface PositionSymbol
- */
-export interface PositionSymbol {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {string}
-     * @memberof PositionSymbol
-     */
-    'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PositionSymbol
-     */
-    'description'?: string;
-    /**
-     * 
-     * @type {UniversalSymbol}
-     * @memberof PositionSymbol
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     * 
-     * @type {string}
-     * @memberof PositionSymbol
-     */
-    'local_id'?: string | null;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PositionSymbol
-     */
-    'is_quotable'?: boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PositionSymbol
-     */
-    'is_tradable'?: boolean;
-}
-

package/models/position.ts

@@ -1,64 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-// May contain unused imports in some cases
-// @ts-ignore
-import { PositionSymbol } from './position-symbol';
-
-/**
- * Account Position
- * @export
- * @interface Position
- */
-export interface Position {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {PositionSymbol}
-     * @memberof Position
-     */
-    'symbol'?: PositionSymbol;
-    /**
-     * 
-     * @type {number}
-     * @memberof Position
-     */
-    'units'?: number | null;
-    /**
-     * Last known market price for the symbol
-     * @type {number}
-     * @memberof Position
-     */
-    'price'?: number | null;
-    /**
-     * 
-     * @type {number}
-     * @memberof Position
-     */
-    'open_pnl'?: number | null;
-    /**
-     * Deprecated, use the units field for both fractional and integer units going forward
-     * @type {number}
-     * @memberof Position
-     */
-    'fractional_units'?: number | null;
-    /**
-     * Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
-     * @type {number}
-     * @memberof Position
-     */
-    'average_purchase_price'?: number | null;
-}
-

package/models/redirect-tokenand-pin.ts

@@ -1,37 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-
-/**
- * Response when register user is successful
- * @export
- * @interface RedirectTokenandPin
- */
-export interface RedirectTokenandPin {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {string}
-     * @memberof RedirectTokenandPin
-     */
-    'token'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof RedirectTokenandPin
-     */
-    'pin'?: string;
-}
-

package/models/security-type.ts

@@ -1,49 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-
-/**
- * Security Type
- * @export
- * @interface SecurityType
- */
-export interface SecurityType {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'code'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'description'?: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof SecurityType
-     */
-    'is_supported'?: boolean;
-}
-

package/models/session-event.ts

@@ -1,80 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * https://konfigthis.com
- * Do not edit the class manually.
- */
-
-
-/**
- * 
- * @export
- * @interface SessionEvent
- */
-export interface SessionEvent {
-    [key: string]: any;
-
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'id'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'session_event_type'?: SessionEventSessionEventTypeEnum;
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'session_id'?: string;
-    /**
-     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'user_id'?: string;
-    /**
-     * Time
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'created_date'?: string;
-    /**
-     * 
-     * @type {number}
-     * @memberof SessionEvent
-     */
-    'brokerage_status_code'?: number | null;
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionEvent
-     */
-    'brokerage_authorization_id'?: string;
-}
-
-export const SessionEventSessionEventTypeEnum = {
-    ConnectionFailed: 'CONNECTION_FAILED',
-    DisclaimerAccepted: 'DISCLAIMER_ACCEPTED',
-    BrokerageConnectionInitiated: 'BROKERAGE_CONNECTION_INITIATED',
-    BrokerageAuthentication: 'BROKERAGE_AUTHENTICATION',
-    MfaAuthorization: 'MFA_AUTHORIZATION',
-    ConnectionSuccessful: 'CONNECTION_SUCCESSFUL',
-    PartnerRedirect: 'PARTNER_REDIRECT'
-} as const;
-
-export type SessionEventSessionEventTypeEnum = typeof SessionEventSessionEventTypeEnum[keyof typeof SessionEventSessionEventTypeEnum];
-
-