snaptrade-typescript-sdk 9.0.199 → 10.0.1

package/dist/models/snap-trade-login-user-request-body.d.ts

@@ -1,58 +0,0 @@
-/**
- * Data to login a user via SnapTrade Partner
- * @export
- * @interface SnapTradeLoginUserRequestBody
- */
-export interface SnapTradeLoginUserRequestBody {
-    /**
-     * Slug of the brokerage to connect the user to. See [the integrations page](https://support.snaptrade.com/brokerages) for a list of supported brokerages and their slugs.
-     * @type {string}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'broker'?: string;
-    /**
-     * When set to `true`, user will be redirected back to the partner\'s site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
-     * @type {boolean}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'immediateRedirect'?: boolean;
-    /**
-     * URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](/docs/implement-connection-portal) for more information.
-     * @type {string}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'customRedirect'?: string;
-    /**
-     * The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](/docs/fix-broken-connections) for more information.
-     * @type {string}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'reconnect'?: string;
-    /**
-     * Determines connection permissions (default: read) - `read`: Data access only. - `trade`: Data and trading access. - `trade-if-available`: Attempts to establish a trading connection if the brokerage supports it, otherwise falls back to read-only access automatically.
-     * @type {string}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'connectionType'?: SnapTradeLoginUserRequestBodyConnectionTypeEnum;
-    /**
-     * Controls whether the close (X) button is displayed in the connection portal. When false, you control closing behavior from your app. Defaults to true.
-     * @type {boolean}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'showCloseButton'?: boolean;
-    /**
-     * Enable dark mode for the connection portal. Defaults to false.
-     * @type {boolean}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'darkMode'?: boolean;
-    /**
-     * Sets the connection portal version to render. Currently only `v4` is supported and is the default. All other versions are deprecated and will automatically be set to v4.
-     * @type {string}
-     * @memberof SnapTradeLoginUserRequestBody
-     */
-    'connectionPortalVersion'?: SnapTradeLoginUserRequestBodyConnectionPortalVersionEnum;
-}
-type SnapTradeLoginUserRequestBodyConnectionTypeEnum = 'read' | 'trade' | 'trade-if-available';
-type SnapTradeLoginUserRequestBodyConnectionPortalVersionEnum = 'v4' | 'v3' | 'v2';
-export {};

package/dist/models/snap-trade-login-user-request-body.js

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

package/dist/models/snap-trade-register-user-request-body.d.ts

@@ -1,13 +0,0 @@
-/**
- * Data required to register a user via SnapTrade Partner
- * @export
- * @interface SnapTradeRegisterUserRequestBody
- */
-export interface SnapTradeRegisterUserRequestBody {
-    /**
-     * 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 SnapTradeRegisterUserRequestBody
-     */
-    'userId': string;
-}

package/dist/models/snap-trade-register-user-request-body.js

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

package/dist/models/status.d.ts

@@ -1,26 +0,0 @@
-/**
- * Status of API
- * @export
- * @interface Status
- */
-export interface Status {
-    [key: string]: any;
-    /**
-     *
-     * @type {number}
-     * @memberof Status
-     */
-    'version'?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof Status
-     */
-    'timestamp'?: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Status
-     */
-    'online'?: boolean;
-}

package/dist/models/status.js

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

package/dist/models/stock-instrument-figi-instrument.d.ts

@@ -1,19 +0,0 @@
-/**
- *
- * @export
- * @interface StockInstrumentFigiInstrument
- */
-export interface StockInstrumentFigiInstrument {
-    /**
-     * This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
-     * @type {string}
-     * @memberof StockInstrumentFigiInstrument
-     */
-    'figi_code'?: string | null;
-    /**
-     * This enables users to link multiple FIGIs for the same security in order to obtain an aggregated view across all countries and all exchanges. For example, `AAPL` has a different FIGI for each exchange/trading venue it is traded on. The `figi_share_class` is the same for all of these FIGIs. See section 1.4.3 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information.
-     * @type {string}
-     * @memberof StockInstrumentFigiInstrument
-     */
-    'figi_share_class'?: string | null;
-}

package/dist/models/stock-instrument-figi-instrument.js

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

package/dist/models/stock-instrument.d.ts

@@ -1,59 +0,0 @@
-import { StockInstrumentFigiInstrument } from './stock-instrument-figi-instrument';
-/**
- * Security instrument metadata for stock positions.
- * @export
- * @interface StockInstrument
- */
-export interface StockInstrument {
-    [key: string]: any;
-    /**
-     * Type of security instrument.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'kind': StockInstrumentKindEnum;
-    /**
-     * Unique identifier for the instrument.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'id': string;
-    /**
-     * The formatted trading symbol for the security.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'symbol': string;
-    /**
-     * The raw symbol without any exchange suffix.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'raw_symbol': string;
-    /**
-     * Human-readable description of the security.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'description'?: string | null;
-    /**
-     * ISO-4217 currency code for the security listing.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'currency'?: string | null;
-    /**
-     * Exchange MIC code or exchange code for the security.
-     * @type {string}
-     * @memberof StockInstrument
-     */
-    'exchange'?: string | null;
-    /**
-     *
-     * @type {StockInstrumentFigiInstrument}
-     * @memberof StockInstrument
-     */
-    'figi_instrument'?: StockInstrumentFigiInstrument | null;
-}
-type StockInstrumentKindEnum = 'stock';
-export {};

package/dist/models/stock-instrument.js

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

package/dist/models/stop-loss.d.ts

@@ -1,20 +0,0 @@
-/**
- * Takes in string value for stop_price and limit_price. stop_price is required, limit_price is optional
- * @export
- * @interface StopLoss
- */
-export interface StopLoss {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof StopLoss
-     */
-    'stop_price'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof StopLoss
-     */
-    'limit_price'?: string | null;
-}

package/dist/models/stop-loss.js

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

package/dist/models/strategy-order-record.d.ts

@@ -1,77 +0,0 @@
-import { OptionStrategy } from './option-strategy';
-/**
- * Strategy order record
- * @export
- * @interface StrategyOrderRecord
- */
-export interface StrategyOrderRecord {
-    [key: string]: any;
-    /**
-     *
-     * @type {OptionStrategy}
-     * @memberof StrategyOrderRecord
-     */
-    'strategy'?: OptionStrategy;
-    /**
-     *
-     * @type {string}
-     * @memberof StrategyOrderRecord
-     */
-    'status'?: StrategyOrderRecordStatusEnum;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyOrderRecord
-     */
-    'filled_quantity'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyOrderRecord
-     */
-    'open_quantity'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyOrderRecord
-     */
-    'closed_quantity'?: number;
-    /**
-     * Order Type potential values include (but are not limited to) - Limit - Market - StopLimit - Stop
-     * @type {string}
-     * @memberof StrategyOrderRecord
-     */
-    'order_type'?: string | null;
-    /**
-     * Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date
-     * @type {string}
-     * @memberof StrategyOrderRecord
-     */
-    'time_in_force'?: string;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof StrategyOrderRecord
-     */
-    'limit_price'?: number | null;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof StrategyOrderRecord
-     */
-    'execution_price'?: number | null;
-    /**
-     * Time
-     * @type {string}
-     * @memberof StrategyOrderRecord
-     */
-    'time_placed'?: string;
-    /**
-     * Time
-     * @type {string}
-     * @memberof StrategyOrderRecord
-     */
-    'time_updated'?: string;
-}
-type StrategyOrderRecordStatusEnum = 'PENDING' | 'ACCEPTED' | 'FAILED' | 'REJECTED' | 'CANCELED' | 'PARTIAL_CANCELED' | 'CANCEL_PENDING' | 'EXECUTED' | 'PARTIAL' | 'REPLACE_PENDING' | 'REPLACED' | 'STOPPED' | 'SUSPENDED' | 'EXPIRED' | 'QUEUED' | 'TRIGGERED' | 'ACTIVATED' | 'PENDING_RISK_REVIEW' | 'CONTINGENT_ORDER';
-export {};

package/dist/models/strategy-order-record.js

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

package/dist/models/strategy-quotes-greek.d.ts

@@ -1,38 +0,0 @@
-/**
- *
- * @export
- * @interface StrategyQuotesGreek
- */
-export interface StrategyQuotesGreek {
-    [key: string]: any;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotesGreek
-     */
-    'delta'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotesGreek
-     */
-    'gamma'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotesGreek
-     */
-    'theta'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotesGreek
-     */
-    'vega'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotesGreek
-     */
-    'rho'?: number;
-}

package/dist/models/strategy-quotes-greek.js

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

package/dist/models/strategy-quotes.d.ts

@@ -1,46 +0,0 @@
-import { OptionStrategy } from './option-strategy';
-import { StrategyQuotesGreek } from './strategy-quotes-greek';
-/**
- *
- * @export
- * @interface StrategyQuotes
- */
-export interface StrategyQuotes {
-    [key: string]: any;
-    /**
-     *
-     * @type {OptionStrategy}
-     * @memberof StrategyQuotes
-     */
-    'strategy'?: OptionStrategy;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof StrategyQuotes
-     */
-    'open_price'?: number | null;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof StrategyQuotes
-     */
-    'bid_price'?: number | null;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof StrategyQuotes
-     */
-    'ask_price'?: number | null;
-    /**
-     *
-     * @type {number}
-     * @memberof StrategyQuotes
-     */
-    'volatility'?: number;
-    /**
-     *
-     * @type {StrategyQuotesGreek}
-     * @memberof StrategyQuotes
-     */
-    'greek'?: StrategyQuotesGreek;
-}

package/dist/models/strategy-quotes.js

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

package/dist/models/sub-period-return-rate.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface SubPeriodReturnRate
- */
-export interface SubPeriodReturnRate {
-    [key: string]: any;
-    /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
-     * @type {string}
-     * @memberof SubPeriodReturnRate
-     */
-    'periodStart'?: string;
-    /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
-     * @type {string}
-     * @memberof SubPeriodReturnRate
-     */
-    'periodEnd'?: string;
-    /**
-     * The return rate for the given period
-     * @type {number}
-     * @memberof SubPeriodReturnRate
-     */
-    'rateOfReturn'?: number | null;
-}

package/dist/models/sub-period-return-rate.js

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

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

@@ -1,25 +0,0 @@
-/**
- * The currency in which the security is traded.
- * @export
- * @interface SymbolCurrency
- */
-export interface SymbolCurrency {
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof SymbolCurrency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof SymbolCurrency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof SymbolCurrency
-     */
-    'name'?: string;
-}

package/dist/models/symbol-currency.js

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

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

@@ -1,55 +0,0 @@
-/**
- * The exchange on which the security is listed and traded.
- * @export
- * @interface SymbolExchange
- */
-export interface SymbolExchange {
-    /**
-     * Unique ID for the exchange in SnapTrade.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'id'?: string;
-    /**
-     * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'code'?: string;
-    /**
-     * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'mic_code'?: string;
-    /**
-     * The full name of the exchange.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'name'?: string;
-    /**
-     * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'timezone'?: string;
-    /**
-     * The time when the exchange opens for trading.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'start_time'?: string;
-    /**
-     * The time when the exchange closes for trading.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'close_time'?: string;
-    /**
-     * The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
-     * @type {string}
-     * @memberof SymbolExchange
-     */
-    'suffix'?: string | null;
-}

package/dist/models/symbol-exchange.js

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

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

@@ -1,13 +0,0 @@
-/**
- *
- * @export
- * @interface SymbolQuery
- */
-export interface SymbolQuery {
-    /**
-     * The search query for symbols.
-     * @type {string}
-     * @memberof SymbolQuery
-     */
-    'substring'?: string;
-}

package/dist/models/symbol-query.js

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

package/dist/models/symbol.d.ts

@@ -1,66 +0,0 @@
-import { SecurityType } from './security-type';
-import { StockInstrumentFigiInstrument } from './stock-instrument-figi-instrument';
-import { SymbolCurrency } from './symbol-currency';
-import { SymbolExchange } from './symbol-exchange';
-/**
- * Uniquely describes a single security + exchange combination across all brokerages.
- * @export
- * @interface Symbol
- */
-export interface Symbol {
-    [key: string]: any;
-    /**
-     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof Symbol
-     */
-    'id'?: string;
-    /**
-     * The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
-     * @type {string}
-     * @memberof Symbol
-     */
-    'symbol'?: string;
-    /**
-     * The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
-     * @type {string}
-     * @memberof Symbol
-     */
-    'raw_symbol'?: string;
-    /**
-     * A human-readable description of the security. This is usually the company name or ETF name.
-     * @type {string}
-     * @memberof Symbol
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {SymbolCurrency}
-     * @memberof Symbol
-     */
-    'currency'?: SymbolCurrency;
-    /**
-     *
-     * @type {SymbolExchange}
-     * @memberof Symbol
-     */
-    'exchange'?: SymbolExchange;
-    /**
-     *
-     * @type {SecurityType}
-     * @memberof Symbol
-     */
-    'type'?: SecurityType;
-    /**
-     * This identifier is unique per security per trading venue. See section 1.4.1 of the [FIGI Standard](https://www.openfigi.com/assets/local/figi-allocation-rules.pdf) for more information. This value should be the same as the `figi_code` in the `figi_instrument` child property.
-     * @type {string}
-     * @memberof Symbol
-     */
-    'figi_code'?: string | null;
-    /**
-     *
-     * @type {StockInstrumentFigiInstrument}
-     * @memberof Symbol
-     */
-    'figi_instrument'?: StockInstrumentFigiInstrument | null;
-}

package/dist/models/symbol.js

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

package/dist/models/symbols-quotes-inner.d.ts

@@ -1,44 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- *
- * @export
- * @interface SymbolsQuotesInner
- */
-export interface SymbolsQuotesInner {
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof SymbolsQuotesInner
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     * The most recent trade price from the brokerage.
-     * @type {number}
-     * @memberof SymbolsQuotesInner
-     */
-    'last_trade_price'?: number;
-    /**
-     * The most recent bid price from the brokerage.
-     * @type {number}
-     * @memberof SymbolsQuotesInner
-     */
-    'bid_price'?: number;
-    /**
-     * The most recent price from the brokerage.
-     * @type {number}
-     * @memberof SymbolsQuotesInner
-     */
-    'ask_price'?: number;
-    /**
-     * The most recent bid size from the brokerage.
-     * @type {number}
-     * @memberof SymbolsQuotesInner
-     */
-    'bid_size'?: number;
-    /**
-     * The most recent ask size from the brokerage.
-     * @type {number}
-     * @memberof SymbolsQuotesInner
-     */
-    'ask_size'?: number;
-}

package/dist/models/symbols-quotes-inner.js

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