snaptrade-typescript-sdk 9.0.199 → 10.0.1

package/dist/models/option-strategy-legs-inner.d.ts

@@ -1,31 +0,0 @@
-/**
- *
- * @export
- * @interface OptionStrategyLegsInner
- */
-export interface OptionStrategyLegsInner {
-    /**
-     *
-     * @type {string}
-     * @memberof OptionStrategyLegsInner
-     */
-    'option_symbol_id'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionStrategyLegsInner
-     */
-    'index'?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionStrategyLegsInner
-     */
-    'action'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionStrategyLegsInner
-     */
-    'quantity'?: number;
-}

package/dist/models/option-strategy-legs-inner.js

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

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

@@ -1,40 +0,0 @@
-import { OptionStrategyLegsInner } from './option-strategy-legs-inner';
-import { UniversalSymbol } from './universal-symbol';
-/**
- *
- * @export
- * @interface OptionStrategy
- */
-export interface OptionStrategy {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionStrategy
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {UniversalSymbol}
-     * @memberof OptionStrategy
-     */
-    'underlying_symbol_id'?: UniversalSymbol;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionStrategy
-     */
-    'strategy_type'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof OptionStrategy
-     */
-    'number_of_legs'?: number;
-    /**
-     *
-     * @type {Array<OptionStrategyLegsInner>}
-     * @memberof OptionStrategy
-     */
-    'legs'?: Array<OptionStrategyLegsInner>;
-}

package/dist/models/option-strategy.js

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

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

@@ -1,25 +0,0 @@
-/**
- * The currency of the price. This field is deprecated and will be removed in a future version. The currency of the price is determined by the currency of the underlying security.
- * @export
- * @interface OptionsPositionCurrency
- */
-export interface OptionsPositionCurrency {
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof OptionsPositionCurrency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof OptionsPositionCurrency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof OptionsPositionCurrency
-     */
-    'name'?: string;
-}

package/dist/models/options-position-currency.js

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

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

@@ -1,41 +0,0 @@
-import { OptionBrokerageSymbol } from './option-brokerage-symbol';
-import { OptionsPositionCurrency } from './options-position-currency';
-/**
- * Describes a single option position in an account.
- * @export
- * @interface OptionsPosition
- */
-export interface OptionsPosition {
-    [key: string]: any;
-    /**
-     *
-     * @type {OptionBrokerageSymbol}
-     * @memberof OptionsPosition
-     */
-    'symbol'?: OptionBrokerageSymbol;
-    /**
-     * Last known market price _per share_ of the option contract. 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 OptionsPosition
-     */
-    'price'?: number | null;
-    /**
-     * The number of contracts for this option position. A positive number indicates a long position, while a negative number indicates a short position.
-     * @type {number}
-     * @memberof OptionsPosition
-     */
-    'units'?: number;
-    /**
-     * Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100).
-     * @type {number}
-     * @memberof OptionsPosition
-     */
-    'average_purchase_price'?: number | null;
-    /**
-     *
-     * @type {OptionsPositionCurrency}
-     * @memberof OptionsPosition
-     * @deprecated
-     */
-    'currency'?: OptionsPositionCurrency | null;
-}

package/dist/models/options-position.js

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

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

@@ -1,53 +0,0 @@
-import { UnderlyingSymbol } from './underlying-symbol';
-/**
- * Uniquely describes an option security + exchange combination across all brokerages.
- * @export
- * @interface OptionsSymbol
- */
-export interface OptionsSymbol {
-    [key: string]: any;
-    /**
-     * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'id': string;
-    /**
-     * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'ticker': string;
-    /**
-     * The type of option. Either \"CALL\" or \"PUT\".
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'option_type': OptionsSymbolOptionTypeEnum;
-    /**
-     * The option strike price.
-     * @type {number}
-     * @memberof OptionsSymbol
-     */
-    'strike_price': number;
-    /**
-     * The option expiration date.
-     * @type {string}
-     * @memberof OptionsSymbol
-     */
-    'expiration_date': string;
-    /**
-     * Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
-     * @type {boolean}
-     * @memberof OptionsSymbol
-     */
-    'is_mini_option'?: boolean;
-    /**
-     *
-     * @type {UnderlyingSymbol}
-     * @memberof OptionsSymbol
-     */
-    'underlying_symbol': UnderlyingSymbol;
-}
-type OptionsSymbolOptionTypeEnum = 'CALL' | 'PUT';
-export {};

package/dist/models/options-symbol.js

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

package/dist/models/order-type-strict.d.ts

@@ -1,6 +0,0 @@
-/**
- * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
- * @export
- * @enum {string}
- */
-export type OrderTypeStrict = 'Limit' | 'Market' | 'StopLimit' | 'Stop';

package/dist/models/order-type-strict.js

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

package/dist/models/order-updated-response-order.d.ts

@@ -1,167 +0,0 @@
-import { AccountOrderRecordChildBrokerageOrderIds } from './account-order-record-child-brokerage-order-ids';
-import { AccountOrderRecordOptionSymbol } from './account-order-record-option-symbol';
-import { AccountOrderRecordQuoteCurrency } from './account-order-record-quote-currency';
-import { AccountOrderRecordQuoteUniversalSymbol } from './account-order-record-quote-universal-symbol';
-import { AccountOrderRecordStatus } from './account-order-record-status';
-import { AccountOrderRecordTrailingStop } from './account-order-record-trailing-stop';
-import { AccountOrderRecordUniversalSymbol } from './account-order-record-universal-symbol';
-/**
- *
- * @export
- * @interface OrderUpdatedResponseOrder
- */
-export interface OrderUpdatedResponseOrder {
-    /**
-     * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'brokerage_order_id'?: string;
-    /**
-     * The brokerage-assigned identifier that links all orders within a complex order (OCO, OTO, OTOCO) together. Null for non-complex orders or when the brokerage does not return a group identifier.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'brokerage_group_order_id'?: string | null;
-    /**
-     * The role of this order within a complex order group (OCO, OTO, OTOCO). Null for non-complex orders.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'order_role'?: OrderUpdatedResponseOrderOrderRoleEnum;
-    /**
-     * Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum. Possible values include:   - NONE   - PENDING   - ACCEPTED   - FAILED   - REJECTED   - CANCELED   - PARTIAL_CANCELED   - CANCEL_PENDING   - EXECUTED   - PARTIAL   - REPLACE_PENDING   - REPLACED   - EXPIRED   - QUEUED   - TRIGGERED   - ACTIVATED
-     * @type {AccountOrderRecordStatus}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'status'?: AccountOrderRecordStatus;
-    /**
-     *
-     * @type {AccountOrderRecordUniversalSymbol}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'universal_symbol'?: AccountOrderRecordUniversalSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordOptionSymbol}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'option_symbol'?: AccountOrderRecordOptionSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordQuoteUniversalSymbol}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'quote_universal_symbol'?: AccountOrderRecordQuoteUniversalSymbol;
-    /**
-     *
-     * @type {AccountOrderRecordQuoteCurrency}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'quote_currency'?: AccountOrderRecordQuoteCurrency;
-    /**
-     * The action describes the intent or side of a trade. This is usually `BUY` or `SELL` but can include other potential values like the following depending on the specific brokerage.   - BUY   - SELL   - BUY_COVER   - SELL_SHORT   - BUY_OPEN   - BUY_CLOSE   - SELL_OPEN   - SELL_CLOSE
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'action'?: string;
-    /**
-     * The total number of shares or contracts of the order. This should be the sum of the filled, canceled, and open quantities. Can be a decimal number for fractional shares.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'total_quantity'?: string | null;
-    /**
-     * The number of shares or contracts that are still open (waiting for execution). Can be a decimal number for fractional shares.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'open_quantity'?: string | null;
-    /**
-     * The number of shares or contracts that have been canceled. Can be a decimal number for fractional shares.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'canceled_quantity'?: string | null;
-    /**
-     * The number of shares or contracts that have been filled. Can be a decimal number for fractional shares.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'filled_quantity'?: string | null;
-    /**
-     * The price at which the order was executed. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'execution_price'?: number | null;
-    /**
-     * The limit price is maximum price one is willing to pay for a buy order or the minimum price one is willing to accept for a sell order. Should only apply to `Limit` and `StopLimit` orders. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'limit_price'?: number | null;
-    /**
-     * The stop price is the price at which a stop order is triggered. Should only apply to `Stop` and `StopLimit` orders. For option orders, this represents the price per share.
-     * @type {number}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'stop_price'?: number | null;
-    /**
-     *
-     * @type {AccountOrderRecordTrailingStop}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'trailing_stop'?: AccountOrderRecordTrailingStop | null;
-    /**
-     * The type of order placed. The most common values are `Market`, `Limit`, `Stop`, and `StopLimit`. We try our best to map brokerage order types to these values. When mapping fails, we will return the brokerage\'s order type value.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'order_type'?: string | null;
-    /**
-     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value.   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `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.   - `MOO` - Market On Open. The order is to be executed at the day\'s opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'time_in_force'?: string;
-    /**
-     * The time the order was placed. This is the time the order was submitted to the brokerage.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'time_placed'?: string;
-    /**
-     * The time the order was last updated in the brokerage system. This value is not always available from the brokerage.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'time_updated'?: string | null;
-    /**
-     * The time the order was executed in the brokerage system. This value is not always available from the brokerage.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'time_executed'?: string | null;
-    /**
-     * The time the order expires. This value is not always available from the brokerage.
-     * @type {string}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'expiry_date'?: string | null;
-    /**
-     * 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 OrderUpdatedResponseOrder
-     * @deprecated
-     */
-    'symbol'?: string;
-    /**
-     *
-     * @type {AccountOrderRecordChildBrokerageOrderIds}
-     * @memberof OrderUpdatedResponseOrder
-     */
-    'child_brokerage_order_ids'?: AccountOrderRecordChildBrokerageOrderIds | null;
-}
-type OrderUpdatedResponseOrderOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
-export {};

package/dist/models/order-updated-response-order.js

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

package/dist/models/order-updated-response.d.ts

@@ -1,21 +0,0 @@
-import { OrderUpdatedResponseOrder } from './order-updated-response-order';
-/**
- *
- * @export
- * @interface OrderUpdatedResponse
- */
-export interface OrderUpdatedResponse {
-    [key: string]: any;
-    /**
-     * Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
-     * @type {string}
-     * @memberof OrderUpdatedResponse
-     */
-    'brokerage_order_id': string;
-    /**
-     *
-     * @type {OrderUpdatedResponseOrder}
-     * @memberof OrderUpdatedResponse
-     */
-    'order'?: OrderUpdatedResponseOrder | null;
-}

package/dist/models/order-updated-response.js

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

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

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

package/dist/models/other-instrument.js

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

package/dist/models/paginated-universal-activity.d.ts

@@ -1,22 +0,0 @@
-import { AccountUniversalActivity } from './account-universal-activity';
-import { PaginationDetails } from './pagination-details';
-/**
- * A paginated list of UniversalActivity objects.
- * @export
- * @interface PaginatedUniversalActivity
- */
-export interface PaginatedUniversalActivity {
-    [key: string]: any;
-    /**
-     *
-     * @type {Array<AccountUniversalActivity>}
-     * @memberof PaginatedUniversalActivity
-     */
-    'data'?: Array<AccountUniversalActivity>;
-    /**
-     *
-     * @type {PaginationDetails}
-     * @memberof PaginatedUniversalActivity
-     */
-    'pagination'?: PaginationDetails;
-}

package/dist/models/paginated-universal-activity.js

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

package/dist/models/pagination-details.d.ts

@@ -1,26 +0,0 @@
-/**
- * Details about the pagination of the results.
- * @export
- * @interface PaginationDetails
- */
-export interface PaginationDetails {
-    [key: string]: any;
-    /**
-     * The starting point of the paginated results.
-     * @type {number}
-     * @memberof PaginationDetails
-     */
-    'offset'?: number;
-    /**
-     * The maximum number of items to return in the response.
-     * @type {number}
-     * @memberof PaginationDetails
-     */
-    'limit'?: number;
-    /**
-     * The total number of items available to be returned over the API.
-     * @type {number}
-     * @memberof PaginationDetails
-     */
-    'total'?: number;
-}

package/dist/models/pagination-details.js

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

package/dist/models/partner-data.d.ts

@@ -1,82 +0,0 @@
-import { Brokerage } from './brokerage';
-/**
- * Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
- * @export
- * @interface PartnerData
- */
-export interface PartnerData {
-    [key: string]: any;
-    /**
-     * A short, unique identifier for your company or product.
-     * @type {string}
-     * @memberof PartnerData
-     */
-    'slug'?: string;
-    /**
-     * Your company or product name.
-     * @type {string}
-     * @memberof PartnerData
-     */
-    'name'?: string;
-    /**
-     * URL to your company or product logo.
-     * @type {string}
-     * @memberof PartnerData
-     */
-    'logo_url'?: string;
-    /**
-     * Brokerages that can be accessed by your Client ID.
-     * @type {Array<Brokerage>}
-     * @memberof PartnerData
-     */
-    'allowed_brokerages'?: Array<Brokerage>;
-    /**
-     * Whether trading is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_trades'?: boolean;
-    /**
-     * Whether holdings data is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_holdings'?: boolean;
-    /**
-     * Whether account historical transactions is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_account_history'?: boolean;
-    /**
-     * Whether reference data is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_reference_data'?: boolean;
-    /**
-     * Whether portfolio management is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_portfolio_management'?: boolean;
-    /**
-     * Whether recent order history is enabled for your SnapTrade Client ID.
-     * @type {boolean}
-     * @memberof PartnerData
-     */
-    'can_access_orders'?: boolean;
-    /**
-     * URI to redirect user back to after user is done adding brokerage connections.
-     * @type {string}
-     * @memberof PartnerData
-     */
-    'redirect_uri'?: string;
-    /**
-     * Shows if pin is required by users to access connection page. This field has been deprecated.
-     * @type {boolean}
-     * @memberof PartnerData
-     * @deprecated
-     */
-    'pin_required'?: boolean;
-}

package/dist/models/partner-data.js

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

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

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

package/dist/models/past-value.js

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