snaptrade-typescript-sdk 9.0.199 → 10.0.1

package/dist/models/model402-brokerage-auth-disabled-response.js

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

package/dist/models/model403-failed-request-response.d.ts

@@ -1,20 +0,0 @@
-/**
- * Example for failed request response
- * @export
- * @interface Model403FailedRequestResponse
- */
-export interface Model403FailedRequestResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model403FailedRequestResponse
-     */
-    'default_detail'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model403FailedRequestResponse
-     */
-    'default_code'?: any;
-}

package/dist/models/model403-failed-request-response.js

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

package/dist/models/model403-feature-not-enabled-response.d.ts

@@ -1,20 +0,0 @@
-/**
- * Example for failed request response
- * @export
- * @interface Model403FeatureNotEnabledResponse
- */
-export interface Model403FeatureNotEnabledResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model403FeatureNotEnabledResponse
-     */
-    'detail'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model403FeatureNotEnabledResponse
-     */
-    'default_code'?: any;
-}

package/dist/models/model403-feature-not-enabled-response.js

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

package/dist/models/model404-failed-request-response.d.ts

@@ -1,20 +0,0 @@
-/**
- * Example for failed request response
- * @export
- * @interface Model404FailedRequestResponse
- */
-export interface Model404FailedRequestResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model404FailedRequestResponse
-     */
-    'default_detail'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model404FailedRequestResponse
-     */
-    'default_code'?: any;
-}

package/dist/models/model404-failed-request-response.js

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

package/dist/models/model425-failed-request-response.d.ts

@@ -1,20 +0,0 @@
-/**
- * Example for failed request response
- * @export
- * @interface Model425FailedRequestResponse
- */
-export interface Model425FailedRequestResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model425FailedRequestResponse
-     */
-    'detail'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model425FailedRequestResponse
-     */
-    'code'?: any;
-}

package/dist/models/model425-failed-request-response.js

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

package/dist/models/model500-unexpected-exception-response.d.ts

@@ -1,26 +0,0 @@
-/**
- * Example for a response that failed for unexpected reasons
- * @export
- * @interface Model500UnexpectedExceptionResponse
- */
-export interface Model500UnexpectedExceptionResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model500UnexpectedExceptionResponse
-     */
-    'detail'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model500UnexpectedExceptionResponse
-     */
-    'status_code'?: any;
-    /**
-     *
-     * @type {any}
-     * @memberof Model500UnexpectedExceptionResponse
-     */
-    'code'?: any;
-}

package/dist/models/model500-unexpected-exception-response.js

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

package/dist/models/monthly-dividends.d.ts

@@ -1,21 +0,0 @@
-import { DividendAtDate } from './dividend-at-date';
-/**
- *
- * @export
- * @interface MonthlyDividends
- */
-export interface MonthlyDividends {
-    [key: string]: any;
-    /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
-     * @type {string}
-     * @memberof MonthlyDividends
-     */
-    'date'?: string;
-    /**
-     *
-     * @type {Array<DividendAtDate>}
-     * @memberof MonthlyDividends
-     */
-    'dividends'?: Array<DividendAtDate>;
-}

package/dist/models/monthly-dividends.js

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

package/dist/models/mutual-fund-instrument.d.ts

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

package/dist/models/mutual-fund-instrument.js

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

package/dist/models/net-contributions.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface NetContributions
- */
-export interface NetContributions {
-    [key: string]: any;
-    /**
-     * Date used to specify timeframe for a reporting call (in YYYY-MM-DD format). These dates are inclusive.
-     * @type {string}
-     * @memberof NetContributions
-     */
-    'date'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof NetContributions
-     */
-    'contributions'?: number | null;
-    /**
-     *
-     * @type {string}
-     * @memberof NetContributions
-     */
-    'currency'?: string;
-}

package/dist/models/net-contributions.js

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

package/dist/models/net-dividend.d.ts

@@ -1,27 +0,0 @@
-import { UniversalSymbol } from './universal-symbol';
-/**
- * Object representing total dividends received during a timeframe
- * @export
- * @interface NetDividend
- */
-export interface NetDividend {
-    [key: string]: any;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof NetDividend
-     */
-    'symbol'?: UniversalSymbol;
-    /**
-     *
-     * @type {number}
-     * @memberof NetDividend
-     */
-    'amount'?: number | null;
-    /**
-     *
-     * @type {string}
-     * @memberof NetDividend
-     */
-    'currency'?: string;
-}

package/dist/models/net-dividend.js

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

package/dist/models/notional-value.d.ts

@@ -1,6 +0,0 @@
-/**
- * @type NotionalValue
- * Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://support.snaptrade.com/brokerages-table?v=e7bbcbf9f272441593f93decde660687) for more information.
- * @export
- */
-export type NotionalValue = number | string;

package/dist/models/notional-value.js

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

package/dist/models/option-brokerage-symbol.d.ts

@@ -1,29 +0,0 @@
-import { OptionsSymbol } from './options-symbol';
-/**
- * Uniquely describes a security for the option position within an account. The distinction between this and the `option_symbol` child property is that this object is specific to a position within an account, while the `option_symbol` child property is universal across all brokerage accounts. The caller should rely on the `option_symbol` child property for most use cases.
- * @export
- * @interface OptionBrokerageSymbol
- */
-export interface OptionBrokerageSymbol {
-    [key: string]: any;
-    /**
-     *
-     * @type {OptionsSymbol}
-     * @memberof OptionBrokerageSymbol
-     */
-    'option_symbol'?: OptionsSymbol;
-    /**
-     * 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 OptionBrokerageSymbol
-     * @deprecated
-     */
-    'id'?: string;
-    /**
-     * This field is deprecated and the caller should use the `option_symbol` child property\'s `description` instead.
-     * @type {string}
-     * @memberof OptionBrokerageSymbol
-     * @deprecated
-     */
-    'description'?: string;
-}

package/dist/models/option-brokerage-symbol.js

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

package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
- */
-export interface OptionChainInnerChainPerRootInnerChainPerStrikePriceInner {
-    [key: string]: any;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
-     */
-    'strikePrice'?: number | null;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
-     */
-    'callSymbolId'?: number | null;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionChainInnerChainPerRootInnerChainPerStrikePriceInner
-     */
-    'putSymbolId'?: number | null;
-}

package/dist/models/option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner.js

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

package/dist/models/option-chain-inner-chain-per-root-inner.d.ts

@@ -1,27 +0,0 @@
-import { OptionChainInnerChainPerRootInnerChainPerStrikePriceInner } from './option-chain-inner-chain-per-root-inner-chain-per-strike-price-inner';
-/**
- *
- * @export
- * @interface OptionChainInnerChainPerRootInner
- */
-export interface OptionChainInnerChainPerRootInner {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionChainInnerChainPerRootInner
-     */
-    'optionRoot'?: string;
-    /**
-     *
-     * @type {Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>}
-     * @memberof OptionChainInnerChainPerRootInner
-     */
-    'chainPerStrikePrice'?: Array<OptionChainInnerChainPerRootInnerChainPerStrikePriceInner>;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionChainInnerChainPerRootInner
-     */
-    'multiplier'?: number;
-}

package/dist/models/option-chain-inner-chain-per-root-inner.js

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

package/dist/models/option-chain-inner.d.ts

@@ -1,39 +0,0 @@
-import { OptionChainInnerChainPerRootInner } from './option-chain-inner-chain-per-root-inner';
-/**
- *
- * @export
- * @interface OptionChainInner
- */
-export interface OptionChainInner {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionChainInner
-     */
-    'expiryDate'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionChainInner
-     */
-    'description'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionChainInner
-     */
-    'listingExchange'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionChainInner
-     */
-    'optionExerciseType'?: string;
-    /**
-     *
-     * @type {Array<OptionChainInnerChainPerRootInner>}
-     * @memberof OptionChainInner
-     */
-    'chainPerRoot'?: Array<OptionChainInnerChainPerRootInner>;
-}

package/dist/models/option-chain-inner.js

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

package/dist/models/option-impact.d.ts

@@ -1,28 +0,0 @@
-/**
- * Estimated cash change and fees for an option order before it is placed.
- * @export
- * @interface OptionImpact
- */
-export interface OptionImpact {
-    [key: string]: any;
-    /**
-     * Estimated cash change for the order, before fees.
-     * @type {string}
-     * @memberof OptionImpact
-     */
-    'estimated_cash_change'?: string;
-    /**
-     * Direction of the cash change. CREDIT means cash is received, DEBIT means cash is paid out, EVEN means no cash changes hands. UNKNOWN if the direction cannot be determined from the request.
-     * @type {string}
-     * @memberof OptionImpact
-     */
-    'cash_change_direction'?: OptionImpactCashChangeDirectionEnum;
-    /**
-     * Estimated total transaction fees and commissions for the order.
-     * @type {string}
-     * @memberof OptionImpact
-     */
-    'estimated_fee_total'?: string;
-}
-type OptionImpactCashChangeDirectionEnum = 'CREDIT' | 'DEBIT' | 'EVEN' | 'UNKNOWN';
-export {};

package/dist/models/option-impact.js

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

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

@@ -1,60 +0,0 @@
-import { UnderlyingOptionInstrument } from './underlying-option-instrument';
-/**
- * Option instrument metadata for a V2 position.
- * @export
- * @interface OptionInstrument
- */
-export interface OptionInstrument {
-    [key: string]: any;
-    /**
-     * Type of security instrument.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'kind': OptionInstrumentKindEnum;
-    /**
-     * Unique identifier for the option instrument.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'id': string;
-    /**
-     * OCC symbol for the option contract.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'symbol': string;
-    /**
-     * Whether the contract is a call or put.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'option_type': OptionInstrumentOptionTypeEnum;
-    /**
-     * Strike price for the option contract.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'strike_price': string;
-    /**
-     * Expiration date of the option contract.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'expiration_date': string;
-    /**
-     * Human-readable description of the option contract.
-     * @type {string}
-     * @memberof OptionInstrument
-     */
-    'description'?: string | null;
-    /**
-     *
-     * @type {UnderlyingOptionInstrument}
-     * @memberof OptionInstrument
-     */
-    'underlying': UnderlyingOptionInstrument;
-}
-type OptionInstrumentKindEnum = 'option';
-type OptionInstrumentOptionTypeEnum = 'CALL' | 'PUT';
-export {};

package/dist/models/option-instrument.js

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

package/dist/models/option-leg.d.ts

@@ -1,28 +0,0 @@
-/**
- * Option Leg
- * @export
- * @interface OptionLeg
- */
-export interface OptionLeg {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionLeg
-     */
-    'action'?: OptionLegActionEnum;
-    /**
-     * Obtained from calling options chain endpoint (option_id)
-     * @type {string}
-     * @memberof OptionLeg
-     */
-    'option_symbol_id'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionLeg
-     */
-    'quantity'?: number;
-}
-type OptionLegActionEnum = 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' | 'SELL_TO_OPEN' | 'SELL_TO_CLOSE';
-export {};

package/dist/models/option-leg.js

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

package/dist/models/option-quote-greeks.d.ts

@@ -1,32 +0,0 @@
-/**
- * The Greeks for the option contract.
- * @export
- * @interface OptionQuoteGreeks
- */
-export interface OptionQuoteGreeks {
-    [key: string]: any;
-    /**
-     * Delta represents the rate of change between the option\'s price and a $1 change in the underlying asset\'s price.
-     * @type {number}
-     * @memberof OptionQuoteGreeks
-     */
-    'delta'?: number;
-    /**
-     * Gamma represents the rate of change between an option\'s delta and the underlying asset\'s price.
-     * @type {number}
-     * @memberof OptionQuoteGreeks
-     */
-    'gamma'?: number;
-    /**
-     * Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option\'s time decay.
-     * @type {number}
-     * @memberof OptionQuoteGreeks
-     */
-    'theta'?: number;
-    /**
-     * Vega represents the rate of change between an option\'s value and the underlying asset\'s implied volatility.
-     * @type {number}
-     * @memberof OptionQuoteGreeks
-     */
-    'vega'?: number;
-}

package/dist/models/option-quote-greeks.js

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

package/dist/models/option-quote.d.ts

@@ -1,39 +0,0 @@
-import { OptionQuoteGreeks } from './option-quote-greeks';
-/**
- * Real-time quote for a single option contract.
- * @export
- * @interface OptionQuote
- */
-export interface OptionQuote {
-    [key: string]: any;
-    /**
-     * The OCC-formatted option symbol.
-     * @type {string}
-     * @memberof OptionQuote
-     */
-    'symbol'?: string;
-    /**
-     * The derived synthetic price of the contract.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'synthetic_price'?: number;
-    /**
-     * The implied volatility of the option contract.
-     * @type {number}
-     * @memberof OptionQuote
-     */
-    'implied_volatility'?: number;
-    /**
-     * The timestamp of the last update for the option quote.
-     * @type {string}
-     * @memberof OptionQuote
-     */
-    'timestamp'?: string | null;
-    /**
-     *
-     * @type {OptionQuoteGreeks}
-     * @memberof OptionQuote
-     */
-    'greeks'?: OptionQuoteGreeks;
-}

package/dist/models/option-quote.js

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