snaptrade-typescript-sdk 9.0.200 → 10.0.1

package/dist/models/performance-custom.d.ts

@@ -1,127 +0,0 @@
-import { MonthlyDividends } from './monthly-dividends';
-import { NetContributions } from './net-contributions';
-import { NetDividend } from './net-dividend';
-import { PastValue } from './past-value';
-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/dist/models/performance-custom.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/position-currency.d.ts

@@ -1,25 +0,0 @@
-/**
- * The \'position currency\' (`price` and `average_purchase_price`). This currency can potentially be different from the \'listing currency\' of the security. The \'listing currency\' is what\'s quoted on the listing exchange, while the \'position currency\' is what the brokerage uses to hold and value your position.
- * @export
- * @interface PositionCurrency
- */
-export interface PositionCurrency {
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof PositionCurrency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof PositionCurrency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof PositionCurrency
-     */
-    'name'?: string;
-}

package/dist/models/position-currency.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/position-symbol.d.ts

@@ -1,50 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- * Uniquely describes a security for the position within an account. The distinction between this and the `symbol` child property is that this object is specific to a position within an account, while the `symbol` child property is universal across all brokerage accounts. The caller should rely on the `symbol` child property for most use cases.
- * @export
- * @interface PositionSymbol
- */
-export interface PositionSymbol {
-    [key: string]: any;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof PositionSymbol
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     * A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
-     * @type {string}
-     * @memberof PositionSymbol
-     * @deprecated
-     */
-    'id'?: string;
-    /**
-     * This field is deprecated and the caller should use the `symbol` child property\'s `description` instead.
-     * @type {string}
-     * @memberof PositionSymbol
-     * @deprecated
-     */
-    'description'?: string;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {string}
-     * @memberof PositionSymbol
-     * @deprecated
-     */
-    'local_id'?: string | null;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {boolean}
-     * @memberof PositionSymbol
-     * @deprecated
-     */
-    'is_quotable'?: boolean;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {boolean}
-     * @memberof PositionSymbol
-     * @deprecated
-     */
-    'is_tradable'?: boolean;
-}

package/dist/models/position-symbol.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/position.d.ts

@@ -1,66 +0,0 @@
-import { PositionCurrency } from './position-currency';
-import { PositionSymbol } from './position-symbol';
-import { TaxLot } from './tax-lot';
-/**
- * Describes a single stock/ETF/crypto/mutual fund position in an account.
- * @export
- * @interface Position
- */
-export interface Position {
-    [key: string]: any;
-    /**
-     *
-     * @type {PositionSymbol}
-     * @memberof Position
-     */
-    'symbol'?: PositionSymbol;
-    /**
-     * The number of shares of the position. This can be fractional or integer units. A positive number indicates a long position, while a negative number indicates a short position.
-     * @type {number}
-     * @memberof Position
-     */
-    'units'?: number | null;
-    /**
-     * Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
-     * @type {number}
-     * @memberof Position
-     */
-    'price'?: number | null;
-    /**
-     * The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
-     * @type {number}
-     * @memberof Position
-     */
-    'open_pnl'?: number | null;
-    /**
-     * Cost basis _per share_ of this position.
-     * @type {number}
-     * @memberof Position
-     */
-    'average_purchase_price'?: number | null;
-    /**
-     * Deprecated, use the `units` field for both fractional and integer units going forward
-     * @type {number}
-     * @memberof Position
-     * @deprecated
-     */
-    'fractional_units'?: number | null;
-    /**
-     *
-     * @type {PositionCurrency}
-     * @memberof Position
-     */
-    'currency'?: PositionCurrency;
-    /**
-     * If the position is a cash equivalent (usually a money market fund) that is also counted in account cash balance and buying power
-     * @type {boolean}
-     * @memberof Position
-     */
-    'cash_equivalent'?: boolean | null;
-    /**
-     * List of tax lots for the given position (disabled by default, contact support if needed)
-     * @type {Array<TaxLot>}
-     * @memberof Position
-     */
-    'tax_lots'?: Array<TaxLot>;
-}

package/dist/models/position.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/rate-of-return-object.d.ts

@@ -1,28 +0,0 @@
-/**
- * Individual rate of return object with return percent and timeframe
- * @export
- * @interface RateOfReturnObject
- */
-export interface RateOfReturnObject {
-    [key: string]: any;
-    /**
-     * The timeframe this return percent is reflecting
-     * @type {string}
-     * @memberof RateOfReturnObject
-     */
-    'timeframe'?: RateOfReturnObjectTimeframeEnum;
-    /**
-     * The percent return of the portfolio, directly from the brokerage. 5.97 indicates a 5.97% return over the timeframe
-     * @type {number}
-     * @memberof RateOfReturnObject
-     */
-    'return_percent'?: number;
-    /**
-     * The date this was fetched
-     * @type {string}
-     * @memberof RateOfReturnObject
-     */
-    'created_date'?: string;
-}
-type RateOfReturnObjectTimeframeEnum = 'ALL' | '1Y' | 'YTD' | '1M' | '1W' | '1D';
-export {};

package/dist/models/rate-of-return-object.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/rate-of-return-response.d.ts

@@ -1,15 +0,0 @@
-import { RateOfReturnObject } from './rate-of-return-object';
-/**
- * List of return rates with their timeframe
- * @export
- * @interface RateOfReturnResponse
- */
-export interface RateOfReturnResponse {
-    [key: string]: any;
-    /**
-     * List of return percentages
-     * @type {Array<RateOfReturnObject>}
-     * @memberof RateOfReturnResponse
-     */
-    'data'?: Array<RateOfReturnObject>;
-}

package/dist/models/rate-of-return-response.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/recent-orders-response.d.ts

@@ -1,15 +0,0 @@
-import { AccountOrderRecord } from './account-order-record';
-/**
- * List of orders executed within the last 24 hours
- * @export
- * @interface RecentOrdersResponse
- */
-export interface RecentOrdersResponse {
-    [key: string]: any;
-    /**
-     * List of orders executed in the last 24 hours
-     * @type {Array<AccountOrderRecord>}
-     * @memberof RecentOrdersResponse
-     */
-    'orders'?: Array<AccountOrderRecord>;
-}

package/dist/models/recent-orders-response.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/security-type.d.ts

@@ -1,33 +0,0 @@
-/**
- * The type of security. For example, \"Common Stock\" or \"ETF\".
- * @export
- * @interface SecurityType
- */
-export interface SecurityType {
-    [key: string]: any;
-    /**
-     * Unique identifier for the security type within SnapTrade. This is the ID used to reference the security type in SnapTrade API calls.
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'id'?: string;
-    /**
-     * A short code representing the security type. For example, \"cs\" for Common Stock. Here are some common values:   - `ad` - ADR   - `bnd` - Bond   - `cs` - Common Stock   - `cef` - Closed End Fund   - `crypto` - Cryptocurrency   - `et` - ETF   - `oef` - Open Ended Fund   - `pm` - Precious Metals   - `ps` - Preferred Stock   - `rt` - Right   - `struct` - Structured Product   - `ut` - Unit   - `wi` - When Issued   - `wt` - Warrant
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'code'?: string;
-    /**
-     * A human-readable description of the security type. For example, \"Common Stock\" or \"ETF\".
-     * @type {string}
-     * @memberof SecurityType
-     */
-    'description'?: string;
-    /**
-     * This field is deprecated and should not be used. Please reach out to SnapTrade support if you have a valid use case for this.
-     * @type {boolean}
-     * @memberof SecurityType
-     * @deprecated
-     */
-    'is_supported'?: boolean;
-}

package/dist/models/security-type.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/session-event.d.ts

@@ -1,52 +0,0 @@
-/**
- *
- * @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. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
-     * @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;
-}
-type SessionEventSessionEventTypeEnum = 'OAUTH_REDIRECT' | 'DISCLAIMER_ACCEPTED' | 'BROKERAGE_CONNECTION_INITIATED' | 'BROKERAGE_RECONNECT_INITIATED' | 'BROKERAGE_AUTHENTICATION' | 'OAUTH_BROKERAGE_AUTHENTICATION' | 'MFA_REQUESTED' | 'MFA_SUBMITTED' | 'MFA_CHOICE_REQUESTED' | 'MFA_CHOICE_SUBMITTED' | 'CONNECTION_SUCCESSFUL' | 'CONNECTION_FAILED' | 'PARTNER_REDIRECT' | 'CONNECTION_ABORTED' | 'SESSION_STARTED';
-export {};

package/dist/models/session-event.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/simple-order-form.d.ts

@@ -1,67 +0,0 @@
-import { ActionStrict } from './action-strict';
-import { TradingInstrument } from './trading-instrument';
-/**
- *
- * @export
- * @interface SimpleOrderForm
- */
-export interface SimpleOrderForm {
-    [key: string]: any;
-    /**
-     *
-     * @type {TradingInstrument}
-     * @memberof SimpleOrderForm
-     */
-    'instrument': TradingInstrument;
-    /**
-     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
-     * @type {ActionStrict}
-     * @memberof SimpleOrderForm
-     */
-    'side': ActionStrict;
-    /**
-     * The type of order to place.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'type': SimpleOrderFormTypeEnum;
-    /**
-     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'time_in_force': SimpleOrderFormTimeInForceEnum;
-    /**
-     * The amount of the base currency to buy or sell.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'amount': string;
-    /**
-     * The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'limit_price'?: string;
-    /**
-     * The stop price. Required if the order type is `STOP_LOSS_MARKET`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT_MARKET` or `TAKE_PROFIT_LIMIT`.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'stop_price'?: string;
-    /**
-     * Valid and required only for order type `LIMIT`. If true orders that would be filled immediately are rejected to avoid incurring TAKER fees.
-     * @type {boolean}
-     * @memberof SimpleOrderForm
-     */
-    'post_only'?: boolean;
-    /**
-     * The expiration date of the order. Required if the time_in_force is `GTD`.
-     * @type {string}
-     * @memberof SimpleOrderForm
-     */
-    'expiration_date'?: string;
-}
-type SimpleOrderFormTypeEnum = 'MARKET' | 'LIMIT' | 'STOP_LOSS_MARKET' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT_MARKET' | 'TAKE_PROFIT_LIMIT';
-type SimpleOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
-export {};

package/dist/models/simple-order-form.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/snap-trade-holdings-account.d.ts

@@ -1,60 +0,0 @@
-import { AccountSyncStatus } from './account-sync-status';
-import { BrokerageAuthorization } from './brokerage-authorization';
-/**
- * SnapTradeUser Investment Account
- * @export
- * @interface SnapTradeHoldingsAccount
- */
-export interface SnapTradeHoldingsAccount {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {BrokerageAuthorization}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'brokerage_authorization'?: BrokerageAuthorization;
-    /**
-     *
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'portfolio_group'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'name'?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'number'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'institution_name'?: string;
-    /**
-     *
-     * @type {AccountSyncStatus}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'sync_status'?: AccountSyncStatus;
-    /**
-     *
-     * @type {{ [key: string]: any; }}
-     * @memberof SnapTradeHoldingsAccount
-     */
-    'meta'?: {
-        [key: string]: any;
-    };
-}

package/dist/models/snap-trade-holdings-account.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/snap-trade-holdings-total-value.d.ts

@@ -1,20 +0,0 @@
-/**
- * This field is deprecated. To get the brokerage reported total market value of the account, please refer to `account.balance.total`.  The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. In certain cases, this value may also be double-counting cash-equivalent assets if those assets are represented as both cash and positions in the account.
- * @export
- * @interface SnapTradeHoldingsTotalValue
- */
-export interface SnapTradeHoldingsTotalValue {
-    [key: string]: any;
-    /**
-     * Total value denominated in the currency of the `currency` field.
-     * @type {number}
-     * @memberof SnapTradeHoldingsTotalValue
-     */
-    'value'?: number | null;
-    /**
-     * The ISO-4217 currency code for the amount.
-     * @type {string}
-     * @memberof SnapTradeHoldingsTotalValue
-     */
-    'currency'?: string | null;
-}

package/dist/models/snap-trade-holdings-total-value.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });