snaptrade-typescript-sdk 9.0.199 → 10.0.1

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

@@ -1,107 +0,0 @@
-import { AccountUniversalActivityCurrency } from './account-universal-activity-currency';
-import { AccountUniversalActivityOptionSymbol } from './account-universal-activity-option-symbol';
-import { AccountUniversalActivitySymbol } from './account-universal-activity-symbol';
-/**
- * A transaction or activity from an institution
- * @export
- * @interface AccountUniversalActivity
- */
-export interface AccountUniversalActivity {
-    [key: string]: any;
-    /**
-     * Unique identifier for the transaction. This is the ID used to reference the transaction in SnapTrade.  Please note that this ID _can_ change if the transaction is deleted and re-added. Under normal circumstances, SnapTrade does not delete transactions. The only time this would happen is if SnapTrade re-fetches and reprocesses the data from the brokerage, which is rare. If you require a stable ID, please let us know and we can work with you to provide one.
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {AccountUniversalActivitySymbol}
-     * @memberof AccountUniversalActivity
-     */
-    'symbol'?: AccountUniversalActivitySymbol | null;
-    /**
-     *
-     * @type {AccountUniversalActivityOptionSymbol}
-     * @memberof AccountUniversalActivity
-     */
-    'option_symbol'?: AccountUniversalActivityOptionSymbol | null;
-    /**
-     * The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions. For option transactions, this represents the price per share of the option contract.
-     * @type {number}
-     * @memberof AccountUniversalActivity
-     */
-    'price'?: number;
-    /**
-     * The number of units of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
-     * @type {number}
-     * @memberof AccountUniversalActivity
-     */
-    'units'?: number;
-    /**
-     * The amount of the transaction denominated in `currency`. This can be positive or negative. In general, transactions that positively affect the account balance (like sell, deposits, dividends, etc) will have a positive amount, while transactions that negatively affect the account balance (like buy, withdrawals, fees, etc) will have a negative amount.
-     * @type {number}
-     * @memberof AccountUniversalActivity
-     */
-    'amount'?: number | null;
-    /**
-     *
-     * @type {AccountUniversalActivityCurrency}
-     * @memberof AccountUniversalActivity
-     */
-    'currency'?: AccountUniversalActivityCurrency;
-    /**
-     * A string representing the type of transaction. SnapTrade does a best effort to categorize the brokerage transaction types into a common set of values. Here are some of the most popular values:   - `BUY` - Asset bought.   - `SELL` - Asset sold.   - `DIVIDEND` - Dividend payout.   - `CONTRIBUTION` - Cash contribution.   - `WITHDRAWAL` - Cash withdrawal.   - `REI` - Dividend reinvestment.   - `STOCK_DIVIDEND` - A type of dividend where a company distributes shares instead of cash   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `TAX` - A tax related fee.   - `OPTIONEXPIRATION` - Option expiration event.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of asset(s) from one account to another.   - `EXTERNAL_ASSET_TRANSFER_IN` - Incoming transfer of an asset from an external account to this account.   - `EXTERNAL_ASSET_TRANSFER_OUT` - Outgoing transfer of an asset from this account to an external account.   - `SPLIT` - A stock share split.   - `ADJUSTMENT` - A one time adjustment of the account\'s cash balance or shares of an asset
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'type'?: string;
-    /**
-     * If an option `BUY` or `SELL` transaction, this further specifies the type of action. The possible values are: - BUY_TO_OPEN - BUY_TO_CLOSE - SELL_TO_OPEN - SELL_TO_CLOSE
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'option_type'?: string;
-    /**
-     * A human-readable description of the transaction. This is usually the brokerage\'s description of the transaction.
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'description'?: string;
-    /**
-     * The recorded time for the transaction. The granularity of this timestamp depends on the brokerage. Some brokerages provide the exact time of the transaction, while others provide only the date. Please check the [integrations page](https://support.snaptrade.com/brokerages-table?v=6fab8012ade6441fa0c6d9af9c55ce3a) for the specific brokerage to see the granularity of the timestamps. Note that even though the field is named `trade_date`, it can represent any type of transaction, not just trades.
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'trade_date'?: string | null;
-    /**
-     * The date on which the transaction is settled.
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'settlement_date'?: string;
-    /**
-     * Any fee associated with the transaction if provided by the brokerage.
-     * @type {number}
-     * @memberof AccountUniversalActivity
-     */
-    'fee'?: number;
-    /**
-     * The forex conversion rate involved in the transaction if provided by the brokerage. Used in cases where securities of one currency are purchased in a different currency, and the forex conversion is automatic. In those cases, price, amount and fee will be in the top level currency (activity -> currency)
-     * @type {number}
-     * @memberof AccountUniversalActivity
-     */
-    'fx_rate'?: number | null;
-    /**
-     * The institution that the transaction is associated with. This is usually the brokerage name.
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'institution'?: string;
-    /**
-     * Reference ID from brokerage used to identify related transactions. For example if an order comprises of several transactions (buy, fee, fx), they can be grouped if they share the same `external_reference_id`
-     * @type {string}
-     * @memberof AccountUniversalActivity
-     */
-    'external_reference_id'?: string | null;
-}

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

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

package/dist/models/account-value-history-item.d.ts

@@ -1,20 +0,0 @@
-/**
- * The estimeated account value at a specific point in time.
- * @export
- * @interface AccountValueHistoryItem
- */
-export interface AccountValueHistoryItem {
-    [key: string]: any;
-    /**
-     * The date of the estimated account value
-     * @type {string}
-     * @memberof AccountValueHistoryItem
-     */
-    'date'?: string;
-    /**
-     * Estimate of the total market value of this account (includes cash, equity, fixed income, etc) at the given date.
-     * @type {string}
-     * @memberof AccountValueHistoryItem
-     */
-    'total_value'?: string;
-}

package/dist/models/account-value-history-item.js

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

package/dist/models/account-value-history-response.d.ts

@@ -1,21 +0,0 @@
-import { AccountValueHistoryItem } from './account-value-history-item';
-/**
- * The response to the account value history endpoint, containing a list of estimated account values at different points in time.
- * @export
- * @interface AccountValueHistoryResponse
- */
-export interface AccountValueHistoryResponse {
-    [key: string]: any;
-    /**
-     * List of estimated account values over time returned by the endpoint.
-     * @type {Array<AccountValueHistoryItem>}
-     * @memberof AccountValueHistoryResponse
-     */
-    'history'?: Array<AccountValueHistoryItem>;
-    /**
-     * The ISO-4217 currency code for the account values.
-     * @type {string}
-     * @memberof AccountValueHistoryResponse
-     */
-    'currency'?: string;
-}

package/dist/models/account-value-history-response.js

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

package/dist/models/account.d.ts

@@ -1,126 +0,0 @@
-import { AccountBalance } from './account-balance';
-import { AccountSyncStatus } from './account-sync-status';
-/**
- * A single account at a brokerage.
- * @export
- * @interface Account
- */
-export interface Account {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated.
-     * @type {string}
-     * @memberof Account
-     */
-    'id': string;
-    /**
-     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
-     * @type {string}
-     * @memberof Account
-     */
-    'brokerage_authorization': string;
-    /**
-     * A display name for the account. Either assigned by the user or by the brokerage itself. For certain brokerages, SnapTrade appends the brokerage name to the account name for clarity.
-     * @type {string}
-     * @memberof Account
-     */
-    'name': string | null;
-    /**
-     * The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
-     * @type {string}
-     * @memberof Account
-     */
-    'number': string;
-    /**
-     * A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
-     * @type {string}
-     * @memberof Account
-     */
-    'institution_account_id'?: string | null;
-    /**
-     * The name of the brokerage that holds the account.
-     * @type {string}
-     * @memberof Account
-     */
-    'institution_name': string;
-    /**
-     * Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was created in SnapTrade. This is _not_ the account opening date at the brokerage.
-     * @type {string}
-     * @memberof Account
-     */
-    'created_date': string;
-    /**
-     * Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was funded.
-     * @type {string}
-     * @memberof Account
-     */
-    'funding_date'?: string | null;
-    /**
-     * Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was opened at the brokerage.
-     * @type {string}
-     * @memberof Account
-     */
-    'opening_date'?: string | null;
-    /**
-     *
-     * @type {AccountSyncStatus}
-     * @memberof Account
-     */
-    'sync_status': AccountSyncStatus;
-    /**
-     *
-     * @type {AccountBalance}
-     * @memberof Account
-     */
-    'balance': AccountBalance;
-    /**
-     * The current status of the account. Can be either \"open\", \"closed\", \"archived\" or null if the status is unknown or not provided by the brokerage.
-     * @type {string}
-     * @memberof Account
-     */
-    'status'?: AccountStatusEnum;
-    /**
-     * The account type as provided by the brokerage
-     * @type {string}
-     * @memberof Account
-     */
-    'raw_type'?: string | null;
-    /**
-     * The category of the account, normalized across institutions. Returns `null` if the category could not be determined. Use this field to filter out non-investment accounts if your integration only supports trading / holdings flows. See [Filtering Accounts by Category](https://docs.snaptrade.com/docs/filtering-accounts-by-category) for more information. - `INVESTMENT`: A brokerage / investment account (equities, options, crypto, etc.). - `DEPOSIT`: A bank deposit account (checking, savings). - `LOC`: A line of credit account.
-     * @type {string}
-     * @memberof Account
-     */
-    'account_category'?: AccountAccountCategoryEnum;
-    /**
-     * Additional information about the account, such as account type, status, etc. 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 Account
-     * @deprecated
-     */
-    'meta'?: {
-        [key: string]: any;
-    };
-    /**
-     * Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a use case for it.
-     * @type {string}
-     * @memberof Account
-     * @deprecated
-     */
-    'portfolio_group'?: string | null;
-    /**
-     * This field is deprecated.
-     * @type {Array<string>}
-     * @memberof Account
-     * @deprecated
-     */
-    'cash_restrictions'?: Array<string>;
-    /**
-     * Indicates whether the account is a paper (simulated) trading account.
-     * @type {boolean}
-     * @memberof Account
-     */
-    'is_paper': boolean;
-}
-type AccountStatusEnum = 'open' | 'closed' | 'archived' | 'unavailable';
-type AccountAccountCategoryEnum = 'INVESTMENT' | 'DEPOSIT' | 'LOC';
-export {};

package/dist/models/account.js

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

package/dist/models/action-strict-with-options.d.ts

@@ -1,6 +0,0 @@
-/**
- * The action describes the intent or side of a trade. This is either `BUY` or `SELL` for Equity symbols or `BUY_TO_OPEN`, `BUY_TO_CLOSE`, `SELL_TO_OPEN` or `SELL_TO_CLOSE` for Options.
- * @export
- * @enum {string}
- */
-export type ActionStrictWithOptions = 'BUY' | 'SELL' | 'BUY_TO_OPEN' | 'BUY_TO_CLOSE' | 'SELL_TO_OPEN' | 'SELL_TO_CLOSE';

package/dist/models/action-strict-with-options.js

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

package/dist/models/action-strict.d.ts

@@ -1,6 +0,0 @@
-/**
- * The action describes the intent or side of a trade. This is either `BUY` or `SELL`.
- * @export
- * @enum {string}
- */
-export type ActionStrict = 'BUY' | 'SELL';

package/dist/models/action-strict.js

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

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

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

package/dist/models/adr-instrument.js

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

package/dist/models/all-account-positions-response.d.ts

@@ -1,15 +0,0 @@
-import { AccountPosition } from './account-position';
-/**
- * Information about all account positions.
- * @export
- * @interface AllAccountPositionsResponse
- */
-export interface AllAccountPositionsResponse {
-    [key: string]: any;
-    /**
-     * Positions returned for the request.
-     * @type {Array<AccountPosition>}
-     * @memberof AllAccountPositionsResponse
-     */
-    'results': Array<AccountPosition>;
-}

package/dist/models/all-account-positions-response.js

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

package/dist/models/authentication-login-snap-trade-user200-response.d.ts

@@ -1,7 +0,0 @@
-import { EncryptedResponse } from './encrypted-response';
-import { LoginRedirectURI } from './login-redirect-uri';
-/**
- * @type AuthenticationLoginSnapTradeUser200Response
- * @export
- */
-export type AuthenticationLoginSnapTradeUser200Response = EncryptedResponse | LoginRedirectURI;

package/dist/models/authentication-login-snap-trade-user200-response.js

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

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

@@ -1,25 +0,0 @@
-/**
- * The currency of the balance. This applies to both `cash` and `buying_power`.
- * @export
- * @interface BalanceCurrency
- */
-export interface BalanceCurrency {
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof BalanceCurrency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof BalanceCurrency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof BalanceCurrency
-     */
-    'name'?: string;
-}

package/dist/models/balance-currency.js

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

package/dist/models/balance.d.ts

@@ -1,27 +0,0 @@
-import { BalanceCurrency } from './balance-currency';
-/**
- * Holds balance information for a single currency in an account.
- * @export
- * @interface Balance
- */
-export interface Balance {
-    [key: string]: any;
-    /**
-     *
-     * @type {BalanceCurrency}
-     * @memberof Balance
-     */
-    'currency'?: BalanceCurrency;
-    /**
-     * The amount of available cash in the account denominated in the currency of the `currency` field. This value can be negative in a margin account with a margin balance. Money market funds will be included in this field, and also returned in positions endpoints with `cash_equivalent` = true
-     * @type {number}
-     * @memberof Balance
-     */
-    'cash'?: number | null;
-    /**
-     * Buying power only applies to margin accounts. For non-margin accounts, buying power should be the same as cash. Please note that this field is not always available for all brokerages.
-     * @type {number}
-     * @memberof Balance
-     */
-    'buying_power'?: number | null;
-}

package/dist/models/balance.js

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

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

@@ -1,14 +0,0 @@
-/**
- * Confirmation that the connection has been disabled.
- * @export
- * @interface BrokerageAuthorizationDisabledConfirmation
- */
-export interface BrokerageAuthorizationDisabledConfirmation {
-    [key: string]: any;
-    /**
-     * Connection disabled confirmation
-     * @type {string}
-     * @memberof BrokerageAuthorizationDisabledConfirmation
-     */
-    'detail'?: string;
-}

package/dist/models/brokerage-authorization-disabled-confirmation.js

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

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

@@ -1,14 +0,0 @@
-/**
- * Confirmation that the syncs have been scheduled.
- * @export
- * @interface BrokerageAuthorizationRefreshConfirmation
- */
-export interface BrokerageAuthorizationRefreshConfirmation {
-    [key: string]: any;
-    /**
-     * Refresh confirmation details
-     * @type {string}
-     * @memberof BrokerageAuthorizationRefreshConfirmation
-     */
-    'detail'?: string;
-}

package/dist/models/brokerage-authorization-refresh-confirmation.js

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

package/dist/models/brokerage-authorization-transactions-sync-confirmation.d.ts

@@ -1,14 +0,0 @@
-/**
- * Confirmation that the transaction syncs have been scheduled.
- * @export
- * @interface BrokerageAuthorizationTransactionsSyncConfirmation
- */
-export interface BrokerageAuthorizationTransactionsSyncConfirmation {
-    [key: string]: any;
-    /**
-     * Transactions sync confirmation details
-     * @type {string}
-     * @memberof BrokerageAuthorizationTransactionsSyncConfirmation
-     */
-    'detail'?: string;
-}

package/dist/models/brokerage-authorization-transactions-sync-confirmation.js

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

package/dist/models/brokerage-authorization-type-read-only-brokerage.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface BrokerageAuthorizationTypeReadOnlyBrokerage
- */
-export interface BrokerageAuthorizationTypeReadOnlyBrokerage {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
-     */
-    'id'?: string;
-    /**
-     * Full name of the brokerage.
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
-     */
-    'name'?: string;
-    /**
-     * A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnlyBrokerage
-     */
-    'slug'?: string;
-}

package/dist/models/brokerage-authorization-type-read-only-brokerage.js

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

package/dist/models/brokerage-authorization-type-read-only.d.ts

@@ -1,36 +0,0 @@
-import { BrokerageAuthorizationTypeReadOnlyBrokerage } from './brokerage-authorization-type-read-only-brokerage';
-/**
- *
- * @export
- * @interface BrokerageAuthorizationTypeReadOnly
- */
-export interface BrokerageAuthorizationTypeReadOnly {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnly
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnly
-     */
-    'type'?: BrokerageAuthorizationTypeReadOnlyTypeEnum;
-    /**
-     *
-     * @type {string}
-     * @memberof BrokerageAuthorizationTypeReadOnly
-     */
-    'auth_type'?: BrokerageAuthorizationTypeReadOnlyAuthTypeEnum;
-    /**
-     *
-     * @type {BrokerageAuthorizationTypeReadOnlyBrokerage}
-     * @memberof BrokerageAuthorizationTypeReadOnly
-     */
-    'brokerage'?: BrokerageAuthorizationTypeReadOnlyBrokerage;
-}
-type BrokerageAuthorizationTypeReadOnlyTypeEnum = 'read' | 'trade';
-type BrokerageAuthorizationTypeReadOnlyAuthTypeEnum = 'OAUTH' | 'SCRAPE' | 'UNOFFICIAL_API' | 'TOKEN';
-export {};

package/dist/models/brokerage-authorization-type-read-only.js

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