snaptrade-typescript-sdk 9.0.200 → 10.0.1

package/dist/models/brokerage-authorization.d.ts

@@ -1,73 +0,0 @@
-import { Brokerage } from './brokerage';
-/**
- * A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
- * @export
- * @interface BrokerageAuthorization
- */
-export interface BrokerageAuthorization {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     */
-    'id'?: string;
-    /**
-     * Timestamp of when the connection was established in SnapTrade.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     */
-    'created_date'?: string;
-    /**
-     *
-     * @type {Brokerage}
-     * @memberof BrokerageAuthorization
-     */
-    'brokerage'?: Brokerage;
-    /**
-     * A short, human-readable name for the connection.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     */
-    'name'?: string;
-    /**
-     * Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     */
-    'type'?: string;
-    /**
-     * Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
-     * @type {boolean}
-     * @memberof BrokerageAuthorization
-     */
-    'disabled'?: boolean;
-    /**
-     * Timestamp of when the connection was disabled in SnapTrade.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     */
-    'disabled_date'?: string | null;
-    /**
-     * Additional data about the connection. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
-     * @type {{ [key: string]: any; }}
-     * @memberof BrokerageAuthorization
-     * @deprecated
-     */
-    'meta'?: {
-        [key: string]: any;
-    };
-    /**
-     * Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
-     * @type {string}
-     * @memberof BrokerageAuthorization
-     * @deprecated
-     */
-    'updated_date'?: string;
-    /**
-     * Whether the connection is eligible for a payout. This is an experimental field that is NOT generally available for all partners. Do not use in production without speaking to the SnapTrade team.
-     * @type {boolean}
-     * @memberof BrokerageAuthorization
-     */
-    'is_eligible_for_payout'?: boolean;
-}

package/dist/models/brokerage-authorization.js

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

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

@@ -1,38 +0,0 @@
-/**
- *
- * @export
- * @interface BrokerageInstrument
- */
-export interface BrokerageInstrument {
-    [key: string]: any;
-    /**
-     * The instrument\'s trading symbol / ticker.
-     * @type {string}
-     * @memberof BrokerageInstrument
-     */
-    'symbol': string;
-    /**
-     * The MIC code of the exchange where the instrument is traded.
-     * @type {string}
-     * @memberof BrokerageInstrument
-     */
-    'exchange_mic'?: string | null;
-    /**
-     * Whether the instrument is tradeable through the brokerage. `null` if the tradeability is unknown.
-     * @type {boolean}
-     * @memberof BrokerageInstrument
-     */
-    'tradeable'?: boolean | null;
-    /**
-     * Whether the instrument allows fractional units. `null` if the fractionability is unknown.
-     * @type {boolean}
-     * @memberof BrokerageInstrument
-     */
-    'fractionable'?: boolean | null;
-    /**
-     * The universal symbol ID of the instrument. This is the ID used to reference the instrument in SnapTrade API calls.
-     * @type {string}
-     * @memberof BrokerageInstrument
-     */
-    'universal_symbol_id'?: string | null;
-}

package/dist/models/brokerage-instrument.js

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

package/dist/models/brokerage-instruments-response.d.ts

@@ -1,15 +0,0 @@
-import { BrokerageInstrument } from './brokerage-instrument';
-/**
- *
- * @export
- * @interface BrokerageInstrumentsResponse
- */
-export interface BrokerageInstrumentsResponse {
-    [key: string]: any;
-    /**
-     *
-     * @type {Array<BrokerageInstrument>}
-     * @memberof BrokerageInstrumentsResponse
-     */
-    'instruments'?: Array<BrokerageInstrument>;
-}

package/dist/models/brokerage-instruments-response.js

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

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

@@ -1,20 +0,0 @@
-/**
- * Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
- * @export
- * @interface BrokerageType
- */
-export interface BrokerageType {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageType
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageType
-     */
-    'name'?: string;
-}

package/dist/models/brokerage-type.js

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

package/dist/models/brokerage.d.ts

@@ -1,122 +0,0 @@
-import { BrokerageType } from './brokerage-type';
-/**
- * Describes a brokerage that SnapTrade supports.
- * @export
- * @interface Brokerage
- */
-export interface Brokerage {
-    [key: string]: any;
-    /**
-     * Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'id'?: string;
-    /**
-     * A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'slug'?: string;
-    /**
-     * Full name of the brokerage.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'name'?: string;
-    /**
-     * A display-friendly name of the brokerage.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'display_name'?: string;
-    /**
-     * A brief description of the brokerage.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'description'?: string;
-    /**
-     * URL to the brokerage\'s logo.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'aws_s3_logo_url'?: string;
-    /**
-     * URL to the brokerage\'s logo in square format.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'aws_s3_square_logo_url'?: string | null;
-    /**
-     * URL to the brokerage\'s website.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'url'?: string;
-    /**
-     * Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'enabled'?: boolean;
-    /**
-     * Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'maintenance_mode'?: boolean;
-    /**
-     * Whether the brokerage is currently degraded. A degraded brokerage may have reduced functionality or be experiencing technical issues.
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'is_degraded'?: boolean;
-    /**
-     * Whether the brokerage allows trading through SnapTrade.
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'allows_trading'?: boolean | null;
-    /**
-     * This field is deprecated. Please contact us if you have a valid use case for it.
-     * @type {boolean}
-     * @memberof Brokerage
-     * @deprecated
-     */
-    'allows_fractional_units'?: boolean | null;
-    /**
-     * This field is deprecated. Please contact us if you have a valid use case for it.
-     * @type {boolean}
-     * @memberof Brokerage
-     * @deprecated
-     */
-    'has_reporting'?: boolean | null;
-    /**
-     * This field is deprecated. Please contact us if you have a valid use case for it.
-     * @type {boolean}
-     * @memberof Brokerage
-     * @deprecated
-     */
-    'is_real_time_connection'?: boolean;
-    /**
-     *
-     * @type {BrokerageType}
-     * @memberof Brokerage
-     */
-    'brokerage_type'?: BrokerageType;
-    /**
-     * This field is deprecated. Please contact us if you have a valid use case for it.
-     * @type {Array<any>}
-     * @memberof Brokerage
-     * @deprecated
-     */
-    'exchanges'?: Array<any>;
-    /**
-     * This field is deprecated.
-     * @type {string}
-     * @memberof Brokerage
-     * @deprecated
-     */
-    'open_url'?: string | null;
-}

package/dist/models/brokerage.js

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

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

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

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

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

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

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

package/dist/models/cef-instrument.js

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

package/dist/models/child-brokerage-order-ids.d.ts

@@ -1,20 +0,0 @@
-/**
- *
- * @export
- * @interface ChildBrokerageOrderIDs
- */
-export interface ChildBrokerageOrderIDs {
-    [key: string]: any;
-    /**
-     * The brokerage order ID for the take profit leg of the bracket order
-     * @type {string}
-     * @memberof ChildBrokerageOrderIDs
-     */
-    'take_profit_order_id'?: string;
-    /**
-     * The brokerage order ID for the stop loss leg of the bracket order
-     * @type {string}
-     * @memberof ChildBrokerageOrderIDs
-     */
-    'stop_loss_order_id'?: string;
-}

package/dist/models/child-brokerage-order-ids.js

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

package/dist/models/complex-order-leg.d.ts

@@ -1,62 +0,0 @@
-import { ActionStrict } from './action-strict';
-import { OrderTypeStrict } from './order-type-strict';
-import { TimeInForceStrict } from './time-in-force-strict';
-import { TradingInstrument } from './trading-instrument';
-/**
- * A single leg within a complex order.
- * @export
- * @interface ComplexOrderLeg
- */
-export interface ComplexOrderLeg {
-    [key: string]: any;
-    /**
-     * The role of this leg within the complex order.
-     * @type {string}
-     * @memberof ComplexOrderLeg
-     */
-    'order_role': ComplexOrderLegOrderRoleEnum;
-    /**
-     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
-     * @type {ActionStrict}
-     * @memberof ComplexOrderLeg
-     */
-    'action': ActionStrict;
-    /**
-     *
-     * @type {TradingInstrument}
-     * @memberof ComplexOrderLeg
-     */
-    'instrument': TradingInstrument;
-    /**
-     * 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.
-     * @type {OrderTypeStrict}
-     * @memberof ComplexOrderLeg
-     */
-    'order_type': OrderTypeStrict;
-    /**
-     * Number of shares for the order. This can be a decimal for fractional orders. Must be `null` if `notional_value` is provided.
-     * @type {number}
-     * @memberof ComplexOrderLeg
-     */
-    'units': number;
-    /**
-     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `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.
-     * @type {TimeInForceStrict}
-     * @memberof ComplexOrderLeg
-     */
-    'time_in_force': TimeInForceStrict;
-    /**
-     * The limit price. Required when `order_type` is `Limit` or `StopLimit`.
-     * @type {number}
-     * @memberof ComplexOrderLeg
-     */
-    'price'?: number | null;
-    /**
-     * The stop trigger price. Required when `order_type` is `Stop` or `StopLimit`.
-     * @type {number}
-     * @memberof ComplexOrderLeg
-     */
-    'stop'?: number | null;
-}
-type ComplexOrderLegOrderRoleEnum = 'TRIGGER' | 'CONDITIONAL' | 'PEER';
-export {};

package/dist/models/complex-order-leg.js

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

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

@@ -1,22 +0,0 @@
-/**
- * Response returned after successfully placing a complex order. AccountOrderRecord rows for the legs are not created synchronously — they\'re hydrated by the next brokerage sync, and can be queried later using the returned `brokerage_group_order_id`.
- * @export
- * @interface ComplexOrderResponse
- */
-export interface ComplexOrderResponse {
-    [key: string]: any;
-    /**
-     * The complex order type that was placed.
-     * @type {string}
-     * @memberof ComplexOrderResponse
-     */
-    'type'?: ComplexOrderResponseTypeEnum;
-    /**
-     * The brokerage-assigned identifier that links all legs of this complex order together. Each leg will eventually appear as a separate AccountOrderRecord sharing this value. May be null if the brokerage does not return a group identifier.
-     * @type {string}
-     * @memberof ComplexOrderResponse
-     */
-    'brokerage_group_order_id'?: string | null;
-}
-type ComplexOrderResponseTypeEnum = 'OCO' | 'OTO' | 'OTOCO';
-export {};

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

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

package/dist/models/connections-session-events200-response-inner.d.ts

@@ -1,6 +0,0 @@
-import { SessionEvent } from './session-event';
-/**
- * @type ConnectionsSessionEvents200ResponseInner
- * @export
- */
-export type ConnectionsSessionEvents200ResponseInner = SessionEvent;

package/dist/models/connections-session-events200-response-inner.js

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

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

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

package/dist/models/crypto-instrument.js

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

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

@@ -1,66 +0,0 @@
-import { ActionStrict } from './action-strict';
-import { CryptoTradingInstrument } from './crypto-trading-instrument';
-/**
- *
- * @export
- * @interface CryptoOrderForm
- */
-export interface CryptoOrderForm {
-    /**
-     *
-     * @type {CryptoTradingInstrument}
-     * @memberof CryptoOrderForm
-     */
-    'instrument': CryptoTradingInstrument;
-    /**
-     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
-     * @type {ActionStrict}
-     * @memberof CryptoOrderForm
-     */
-    'side': ActionStrict;
-    /**
-     * The type of order to place.
-     * @type {string}
-     * @memberof CryptoOrderForm
-     */
-    'type': CryptoOrderFormTypeEnum;
-    /**
-     * 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 CryptoOrderForm
-     */
-    'time_in_force': CryptoOrderFormTimeInForceEnum;
-    /**
-     * The amount of the base currency to buy or sell.
-     * @type {string}
-     * @memberof CryptoOrderForm
-     */
-    'amount': string;
-    /**
-     * The limit price. Required if the order type is `LIMIT`, `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT`.
-     * @type {string}
-     * @memberof CryptoOrderForm
-     */
-    '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 CryptoOrderForm
-     */
-    '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 CryptoOrderForm
-     */
-    'post_only'?: boolean;
-    /**
-     * The expiration date of the order. Required if the time_in_force is `GTD`.
-     * @type {string}
-     * @memberof CryptoOrderForm
-     */
-    'expiration_date'?: string;
-}
-type CryptoOrderFormTypeEnum = 'MARKET' | 'LIMIT' | 'STOP_LOSS_MARKET' | 'STOP_LOSS_LIMIT' | 'TAKE_PROFIT_MARKET' | 'TAKE_PROFIT_LIMIT';
-type CryptoOrderFormTimeInForceEnum = 'GTC' | 'FOK' | 'IOC' | 'GTD';
-export {};

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

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

package/dist/models/crypto-order-preview-estimated-fee.d.ts

@@ -1,20 +0,0 @@
-/**
- * The estimated order fee.
- * @export
- * @interface CryptoOrderPreviewEstimatedFee
- */
-export interface CryptoOrderPreviewEstimatedFee {
-    [key: string]: any;
-    /**
-     * Symbol to identify a cryptocurrency or fiat currency on a crypto exchange. Fiat currencies symbols are ISO-4217 codes.
-     * @type {string}
-     * @memberof CryptoOrderPreviewEstimatedFee
-     */
-    'currency': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CryptoOrderPreviewEstimatedFee
-     */
-    'amount': string;
-}

package/dist/models/crypto-order-preview-estimated-fee.js

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