snaptrade-typescript-sdk 9.0.199 → 10.0.1

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

@@ -1,15 +0,0 @@
-import { CryptoOrderPreviewEstimatedFee } from './crypto-order-preview-estimated-fee';
-/**
- * Preview of an order.
- * @export
- * @interface CryptoOrderPreview
- */
-export interface CryptoOrderPreview {
-    [key: string]: any;
-    /**
-     *
-     * @type {CryptoOrderPreviewEstimatedFee}
-     * @memberof CryptoOrderPreview
-     */
-    'estimated_fee'?: CryptoOrderPreviewEstimatedFee;
-}

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

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

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

@@ -1,22 +0,0 @@
-/**
- *
- * @export
- * @interface CryptoTradingInstrument
- */
-export interface CryptoTradingInstrument {
-    [key: string]: any;
-    /**
-     * The instrument\'s trading ticker symbol
-     * @type {string}
-     * @memberof CryptoTradingInstrument
-     */
-    'symbol': string;
-    /**
-     * The instrument\'s type
-     * @type {string}
-     * @memberof CryptoTradingInstrument
-     */
-    'type': CryptoTradingInstrumentTypeEnum;
-}
-type CryptoTradingInstrumentTypeEnum = 'CRYPTOCURRENCY' | 'CRYPTOCURRENCY_PAIR';
-export {};

package/dist/models/crypto-trading-instrument.js

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

package/dist/models/cryptocurrency-pair-quote.d.ts

@@ -1,32 +0,0 @@
-/**
- *
- * @export
- * @interface CryptocurrencyPairQuote
- */
-export interface CryptocurrencyPairQuote {
-    [key: string]: any;
-    /**
-     * The highest price a buyer is willing to pay.
-     * @type {string}
-     * @memberof CryptocurrencyPairQuote
-     */
-    'bid': string;
-    /**
-     * The lowest price a seller is willing to accept.
-     * @type {string}
-     * @memberof CryptocurrencyPairQuote
-     */
-    'ask': string;
-    /**
-     * The market mid price.
-     * @type {string}
-     * @memberof CryptocurrencyPairQuote
-     */
-    'mid'?: string;
-    /**
-     * The timestamp of the quote.
-     * @type {string}
-     * @memberof CryptocurrencyPairQuote
-     */
-    'timestamp'?: string;
-}

package/dist/models/cryptocurrency-pair-quote.js

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

package/dist/models/cryptocurrency-pair.d.ts

@@ -1,32 +0,0 @@
-/**
- * A cryptocurrency pair instrument.
- * @export
- * @interface CryptocurrencyPair
- */
-export interface CryptocurrencyPair {
-    [key: string]: any;
-    /**
-     * Cryptocurrency pair instrument symbol
-     * @type {string}
-     * @memberof CryptocurrencyPair
-     */
-    'symbol'?: string;
-    /**
-     * The base currency of a pair (e.g., \"BTC\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes.
-     * @type {string}
-     * @memberof CryptocurrencyPair
-     */
-    'base': string;
-    /**
-     * The quote currency of a pair (e.g., \"USD\" in BTC/USD). Either fiat or cryptocurrency symbol, for fiat use ISO-4217 codes.
-     * @type {string}
-     * @memberof CryptocurrencyPair
-     */
-    'quote': string;
-    /**
-     *
-     * @type {string}
-     * @memberof CryptocurrencyPair
-     */
-    'increment'?: string | null;
-}

package/dist/models/cryptocurrency-pair.js

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

package/dist/models/currency.d.ts

@@ -1,26 +0,0 @@
-/**
- * Describes a currency object.
- * @export
- * @interface Currency
- */
-export interface Currency {
-    [key: string]: any;
-    /**
-     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
-     * @type {string}
-     * @memberof Currency
-     */
-    'id'?: string;
-    /**
-     * The ISO-4217 currency code for the currency.
-     * @type {string}
-     * @memberof Currency
-     */
-    'code'?: string;
-    /**
-     * A human-friendly name of the currency.
-     * @type {string}
-     * @memberof Currency
-     */
-    'name'?: string;
-}

package/dist/models/currency.js

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

package/dist/models/delete-connection-confirmation.d.ts

@@ -1,20 +0,0 @@
-/**
- * Confirmation that a task has been scheduled to delete the connection.
- * @export
- * @interface DeleteConnectionConfirmation
- */
-export interface DeleteConnectionConfirmation {
-    [key: string]: any;
-    /**
-     * Connection queued for deletion; please wait for webhook for confirmation.
-     * @type {string}
-     * @memberof DeleteConnectionConfirmation
-     */
-    'detail'?: string;
-    /**
-     * The ID of the connection (brokerage authorization) that was scheduled for deletion.
-     * @type {string}
-     * @memberof DeleteConnectionConfirmation
-     */
-    'connection_id'?: string;
-}

package/dist/models/delete-connection-confirmation.js

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

package/dist/models/delete-user-response.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface DeleteUserResponse
- */
-export interface DeleteUserResponse {
-    [key: string]: any;
-    /**
-     * This is always `deleted` when a user is queued for deletion.
-     * @type {string}
-     * @memberof DeleteUserResponse
-     */
-    'status'?: string;
-    /**
-     * Human friendly message about the deletion status.
-     * @type {string}
-     * @memberof DeleteUserResponse
-     */
-    'detail'?: string;
-    /**
-     * 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 DeleteUserResponse
-     */
-    'userId'?: string;
-}

package/dist/models/delete-user-response.js

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

package/dist/models/dividend-at-date.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface DividendAtDate
- */
-export interface DividendAtDate {
-    [key: string]: any;
-    /**
-     * The ticker of the symbol that the dividend came from
-     * @type {string}
-     * @memberof DividendAtDate
-     */
-    'symbol'?: string | null;
-    /**
-     * The amount received from the dividend
-     * @type {number}
-     * @memberof DividendAtDate
-     */
-    'amount'?: number | null;
-    /**
-     * The currency of the amount
-     * @type {string}
-     * @memberof DividendAtDate
-     */
-    'currency'?: string;
-}

package/dist/models/dividend-at-date.js

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

package/dist/models/encrypted-response-encrypted-message-data.d.ts

@@ -1,26 +0,0 @@
-/**
- *
- * @export
- * @interface EncryptedResponseEncryptedMessageData
- */
-export interface EncryptedResponseEncryptedMessageData {
-    [key: string]: any;
-    /**
-     *
-     * @type {string}
-     * @memberof EncryptedResponseEncryptedMessageData
-     */
-    'encryptedMessage'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof EncryptedResponseEncryptedMessageData
-     */
-    'tag'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof EncryptedResponseEncryptedMessageData
-     */
-    'nonce'?: string;
-}

package/dist/models/encrypted-response-encrypted-message-data.js

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

package/dist/models/encrypted-response.d.ts

@@ -1,20 +0,0 @@
-import { EncryptedResponseEncryptedMessageData } from './encrypted-response-encrypted-message-data';
-/**
- * This response consists of 2 different components that must be decrypted to obtain the decrypted message  * Decrypting the encryptedSharedKey    The encrypted shared key is a shared key that was randomly generated by SnapTrade and encrypted using the users SSH public key provided when registering the user   It is needed to decrypt the message in step 2.    To decrypt the shared key, the user should have access to their SSH private key stored locally in their device    An example Python code on how to decrypt the shared key is shown below    ```   def decrypt_rsa_message(self, encrypted_message):       from Crypto.Cipher import PKCS1_OAEP       from Crypto.PublicKey import RSA       from base64 import b64decode        f = open(\'private.pem\', \'r\')       private_key = RSA.import_key(f.read())       cipher = PKCS1_OAEP.new(private_key)        return cipher.decrypt(b64decode(encrypted_message.encode())).decode()   ```  * Decrypting the encryptedMessageData     The data meant to be returned by an endpoint can be obtained by decrypting the encrypted message     An encrypted message is a message that is encrypted using AES - MODE OCB with the shared key obtained in step one    An example code to decrypt the encrypted message is shown below    ```   def decrypt_aes_message(self, shared_key, encrypted_message):       from Crypto.Cipher import AES       from base64 import b64decode        encrypted_msg = b64decode(encrypted_message[\"encryptedMessage\"].encode())       tag = b64decode(encrypted_message[\"tag\"].encode())       nonce = b64decode(encrypted_message[\"nonce\"].encode())       cipher = AES.new(shared_key.encode(), AES.MODE_OCB, nonce=nonce)        return cipher.decrypt_and_verify(encrypted_msg, tag).decode()   ```
- * @export
- * @interface EncryptedResponse
- */
-export interface EncryptedResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof EncryptedResponse
-     */
-    'encryptedSharedKey'?: string;
-    /**
-     *
-     * @type {EncryptedResponseEncryptedMessageData}
-     * @memberof EncryptedResponse
-     */
-    'encryptedMessageData'?: EncryptedResponseEncryptedMessageData;
-}

package/dist/models/encrypted-response.js

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

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

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

package/dist/models/etf-instrument.js

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

package/dist/models/exchange-rate-pairs.d.ts

@@ -1,27 +0,0 @@
-import { Currency } from './currency';
-/**
- * The exchange rate of a pair of currencies
- * @export
- * @interface ExchangeRatePairs
- */
-export interface ExchangeRatePairs {
-    [key: string]: any;
-    /**
-     *
-     * @type {Currency}
-     * @memberof ExchangeRatePairs
-     */
-    'src'?: Currency;
-    /**
-     *
-     * @type {Currency}
-     * @memberof ExchangeRatePairs
-     */
-    'dst'?: Currency;
-    /**
-     *
-     * @type {number}
-     * @memberof ExchangeRatePairs
-     */
-    'exchange_rate'?: number;
-}

package/dist/models/exchange-rate-pairs.js

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

package/dist/models/exchange.d.ts

@@ -1,56 +0,0 @@
-/**
- * Describes a single stock or crypto exchange.
- * @export
- * @interface Exchange
- */
-export interface Exchange {
-    [key: string]: any;
-    /**
-     * Unique ID for the exchange in SnapTrade.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'id'?: string;
-    /**
-     * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'code'?: string;
-    /**
-     * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'mic_code'?: string;
-    /**
-     * The full name of the exchange.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'name'?: string;
-    /**
-     * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'timezone'?: string;
-    /**
-     * The time when the exchange opens for trading.
-     * @type {string}
-     * @memberof Exchange
-     */
-    'start_time'?: string;
-    /**
-     * The time when the exchange closes for trading.
-     * @type {string}
-     * @memberof Exchange
-     */
-    '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 Exchange
-     */
-    'suffix'?: string | null;
-}

package/dist/models/exchange.js

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

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

@@ -1,20 +0,0 @@
-/**
- * Financial Instrument Global Identifier (FIGI) information for the security. See [OpenFIGI](https://www.openfigi.com/) for more information.
- * @export
- * @interface FigiInstrument
- */
-export interface FigiInstrument {
-    [key: string]: any;
-    /**
-     * 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 FigiInstrument
-     */
-    '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 FigiInstrument
-     */
-    'figi_share_class'?: string | null;
-}

package/dist/models/figi-instrument.js

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

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

@@ -1,64 +0,0 @@
-/**
- * Future instrument metadata for a V2 position.
- * @export
- * @interface FutureInstrument
- */
-export interface FutureInstrument {
-    [key: string]: any;
-    /**
-     * Type of security instrument.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'kind': FutureInstrumentKindEnum;
-    /**
-     * Unique identifier for the future instrument.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'id': string;
-    /**
-     * Display symbol for the future contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'symbol': string;
-    /**
-     * Root symbol for the future contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'root_symbol': string;
-    /**
-     * Exchange expiration code for the contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'expiration_code': string;
-    /**
-     * Expiration date of the contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'expiration_date'?: string | null;
-    /**
-     * Multiplier for the future contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'multiplier'?: string | null;
-    /**
-     * ISO-4217 currency code for the contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'currency'?: string | null;
-    /**
-     * Exchange MIC code or exchange code for the contract.
-     * @type {string}
-     * @memberof FutureInstrument
-     */
-    'exchange'?: string | null;
-}
-type FutureInstrumentKindEnum = 'future';
-export {};

package/dist/models/future-instrument.js

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

package/dist/models/holdings-status.d.ts

@@ -1,19 +0,0 @@
-/**
- * Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
- * @export
- * @interface HoldingsStatus
- */
-export interface HoldingsStatus {
-    /**
-     * Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
-     * @type {boolean}
-     * @memberof HoldingsStatus
-     */
-    'initial_sync_completed'?: boolean;
-    /**
-     * The last time holdings were successfully synced by SnapTrade.
-     * @type {string}
-     * @memberof HoldingsStatus
-     */
-    'last_successful_sync'?: string | null;
-}

package/dist/models/holdings-status.js

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