snaptrade-typescript-sdk 9.0.34 → 9.0.36

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

@@ -1,8 +1,8 @@
 import { Currency } from './currency';
+import { SymbolCurrency } from './symbol-currency';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
 import { UnderlyingSymbolExchange } from './underlying-symbol-exchange';
 import { UnderlyingSymbolType } from './underlying-symbol-type';
-import { UniversalSymbolCurrency } from './universal-symbol-currency';
 /**
  * Symbol object for the underlying security of an option.
  * @export
@@ -36,10 +36,10 @@ export interface UnderlyingSymbol {
     'description'?: string | null;
     /**
      *
-     * @type {UniversalSymbolCurrency}
+     * @type {SymbolCurrency}
      * @memberof UnderlyingSymbol
      */
-    'currency'?: UniversalSymbolCurrency;
+    'currency'?: SymbolCurrency;
     /**
      *
      * @type {UnderlyingSymbolExchange}

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

@@ -0,0 +1,25 @@
+/**
+ * The currency in which the transaction `price` and `amount` is denominated.
+ * @export
+ * @interface UniversalActivityCurrency
+ */
+export interface UniversalActivityCurrency {
+    /**
+     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+     * @type {string}
+     * @memberof UniversalActivityCurrency
+     */
+    'id'?: string;
+    /**
+     * The ISO-4217 currency code for the currency.
+     * @type {string}
+     * @memberof UniversalActivityCurrency
+     */
+    'code'?: string;
+    /**
+     * A human-friendly name of the currency.
+     * @type {string}
+     * @memberof UniversalActivityCurrency
+     */
+    'name'?: string;
+}

package/dist/models/universal-activity-option-symbol.d.ts

@@ -0,0 +1,52 @@
+import { UnderlyingSymbol } from './underlying-symbol';
+/**
+ * The option security for the transaction. The field is `null` if the transaction is not related to an option security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s option symbol. In cases where the brokerage option symbol is not recognized, the field will be set to `null`.
+ * @export
+ * @interface UniversalActivityOptionSymbol
+ */
+export interface UniversalActivityOptionSymbol {
+    /**
+     * Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'id': string;
+    /**
+     * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'ticker': string;
+    /**
+     * The type of option. Either \"CALL\" or \"PUT\".
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'option_type': UniversalActivityOptionSymbolOptionTypeEnum;
+    /**
+     * The option strike price.
+     * @type {number}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'strike_price': number;
+    /**
+     * The option expiration date.
+     * @type {string}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    '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 UniversalActivityOptionSymbol
+     */
+    'is_mini_option'?: boolean;
+    /**
+     *
+     * @type {UnderlyingSymbol}
+     * @memberof UniversalActivityOptionSymbol
+     */
+    'underlying_symbol': UnderlyingSymbol;
+}
+type UniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
+export {};

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

@@ -0,0 +1,65 @@
+import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
+import { SymbolFigiInstrument } from './symbol-figi-instrument';
+/**
+ * The security for the transaction. The field is `null` if the transaction is not related to a security (like a deposit, withdrawal, fee, etc). SnapTrade does a best effort to map the brokerage\'s symbol. In cases where the brokerage symbol is not recognized, the field will be set to `null`.
+ * @export
+ * @interface UniversalActivitySymbol
+ */
+export interface UniversalActivitySymbol {
+    /**
+     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'id'?: string;
+    /**
+     * The security\'s trading ticker symbol. For example \"AAPL\" for Apple Inc. We largely follow the [Yahoo Finance ticker format](https://help.yahoo.com/kb/SLN2310.html)(click on \"Yahoo Finance Market Coverage and Data Delays\"). For example, for securities traded on the Toronto Stock Exchange, the symbol has a \'.TO\' suffix. For securities traded on NASDAQ or NYSE, the symbol does not have a suffix.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'symbol'?: string;
+    /**
+     * The raw symbol is `symbol` with the exchange suffix removed. For example, if `symbol` is \"VAB.TO\", then `raw_symbol` is \"VAB\".
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'raw_symbol'?: string;
+    /**
+     * A human-readable description of the security. This is usually the company name or ETF name.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'description'?: string | null;
+    /**
+     *
+     * @type {SymbolCurrency}
+     * @memberof UniversalActivitySymbol
+     */
+    'currency'?: SymbolCurrency;
+    /**
+     *
+     * @type {SymbolExchange}
+     * @memberof UniversalActivitySymbol
+     */
+    'exchange'?: SymbolExchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof UniversalActivitySymbol
+     */
+    'type'?: SecurityType;
+    /**
+     * 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. This value should be the same as the `figi_code` in the `figi_instrument` child property.
+     * @type {string}
+     * @memberof UniversalActivitySymbol
+     */
+    'figi_code'?: string | null;
+    /**
+     *
+     * @type {SymbolFigiInstrument}
+     * @memberof UniversalActivitySymbol
+     */
+    'figi_instrument'?: SymbolFigiInstrument | null;
+}

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

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

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

@@ -1,7 +1,7 @@
 import { AccountSimple } from './account-simple';
-import { Currency } from './currency';
-import { OptionsSymbol } from './options-symbol';
-import { Symbol } from './symbol';
+import { UniversalActivityCurrency } from './universal-activity-currency';
+import { UniversalActivityOptionSymbol } from './universal-activity-option-symbol';
+import { UniversalActivitySymbol } from './universal-activity-symbol';
 /**
  * A transaction or activity from an institution
  * @export
@@ -10,7 +10,7 @@ import { Symbol } from './symbol';
 export interface UniversalActivity {
     [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 UniversalActivity
      */
@@ -23,92 +23,92 @@ export interface UniversalActivity {
     'account'?: AccountSimple;
     /**
      *
-     * @type {number}
+     * @type {UniversalActivitySymbol}
      * @memberof UniversalActivity
      */
-    'amount'?: number | null;
+    'symbol'?: UniversalActivitySymbol | null;
     /**
      *
-     * @type {Currency}
+     * @type {UniversalActivityOptionSymbol}
      * @memberof UniversalActivity
      */
-    'currency'?: Currency;
+    'option_symbol'?: UniversalActivityOptionSymbol | null;
     /**
-     *
-     * @type {string}
+     * The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
+     * @type {number}
      * @memberof UniversalActivity
      */
-    'description'?: string;
+    '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 UniversalActivity
      */
-    'fee'?: number;
+    'units'?: 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)
+     * 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 UniversalActivity
      */
-    'fx_rate'?: number | null;
+    'amount'?: number | null;
     /**
      *
-     * @type {string}
+     * @type {UniversalActivityCurrency}
      * @memberof UniversalActivity
      */
-    'institution'?: string;
+    'currency'?: UniversalActivityCurrency;
     /**
-     * If an option transaction, then it\'s type (BUY_TO_OPEN, SELL_TO_CLOSE, etc), otherwise empty string
+     * 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   - SELL   - DIVIDEND   - CONTRIBUTION   - WITHDRAWAL   - REI   - INTEREST   - FEE
      * @type {string}
      * @memberof UniversalActivity
      */
-    'option_type'?: string;
+    'type'?: string;
     /**
-     *
-     * @type {number}
+     * 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 UniversalActivity
      */
-    'price'?: number;
+    'option_type'?: string;
     /**
-     *
+     * A human-readable description of the transaction. This is usually the brokerage\'s description of the transaction.
      * @type {string}
      * @memberof UniversalActivity
      */
-    'settlement_date'?: string;
+    'description'?: 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
+     * 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://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?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 UniversalActivity
      */
-    'external_reference_id'?: string | null;
+    'trade_date'?: string | null;
     /**
-     *
-     * @type {Symbol}
+     * The date on which the transaction is settled.
+     * @type {string}
      * @memberof UniversalActivity
      */
-    'symbol'?: Symbol;
+    'settlement_date'?: string;
     /**
-     *
-     * @type {OptionsSymbol}
+     * Any fee associated with the transaction if provided by the brokerage.
+     * @type {number}
      * @memberof UniversalActivity
      */
-    'option_symbol'?: OptionsSymbol;
+    'fee'?: number;
     /**
-     *
-     * @type {string}
+     * 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 UniversalActivity
      */
-    'trade_date'?: string | null;
+    'fx_rate'?: number | null;
     /**
-     * Potential values include (but are not limited to) - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
+     * The institution that the transaction is associated with. This is usually the brokerage name.
      * @type {string}
      * @memberof UniversalActivity
      */
-    'type'?: string;
+    'institution'?: string;
     /**
-     * Usually but not necessarily an integer
-     * @type {number}
+     * 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 UniversalActivity
      */
-    'units'?: number;
+    'external_reference_id'?: string | null;
 }

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

@@ -1,8 +1,8 @@
 import { Currency } from './currency';
 import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
-import { UniversalSymbolCurrency } from './universal-symbol-currency';
-import { UniversalSymbolExchange } from './universal-symbol-exchange';
 /**
  * Uniquely describes a single security + exchange combination across all brokerages.
  * @export
@@ -36,16 +36,16 @@ export interface UniversalSymbol {
     'description'?: string | null;
     /**
      *
-     * @type {UniversalSymbolCurrency}
+     * @type {SymbolCurrency}
      * @memberof UniversalSymbol
      */
-    'currency': UniversalSymbolCurrency;
+    'currency': SymbolCurrency;
     /**
      *
-     * @type {UniversalSymbolExchange}
+     * @type {SymbolExchange}
      * @memberof UniversalSymbol
      */
-    'exchange'?: UniversalSymbolExchange;
+    'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}

package/dist/models/user-idand-secret.d.ts

@@ -11,7 +11,7 @@ export interface UserIDandSecret {
      */
     'userId'?: string;
     /**
-     * SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the SnapTrade API.
+     * SnapTrade User Secret randomly generated by SnapTrade. This is privileged information and if compromised, should be rotated via the [rotate user secret endpoint](/reference/Authentication/Authentication_resetSnapTradeUserSecret)
      * @type {string}
      * @memberof UserIDandSecret
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "9.0.34",
+  "version": "9.0.36",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {

package/dist/models/amount.d.ts

@@ -1,19 +0,0 @@
-/**
- * Total value of the account, as reported by the brokerage
- * @export
- * @interface Amount
- */
-export interface Amount {
-    /**
-     * Total value denominated in the currency of the `currency` field.
-     * @type {number}
-     * @memberof Amount
-     */
-    'amount'?: number;
-    /**
-     * The ISO-4217 currency code for the amount.
-     * @type {string}
-     * @memberof Amount
-     */
-    'currency'?: string;
-}

package/dist/models/snap-trade-holdings-account-account-id-balance.d.ts

@@ -1,14 +0,0 @@
-import { AccountBalanceTotal } from './account-balance-total';
-/**
- *
- * @export
- * @interface SnapTradeHoldingsAccountAccountIdBalance
- */
-export interface SnapTradeHoldingsAccountAccountIdBalance {
-    /**
-     *
-     * @type {AccountBalanceTotal}
-     * @memberof SnapTradeHoldingsAccountAccountIdBalance
-     */
-    'total'?: AccountBalanceTotal | null;
-}

package/dist/models/snap-trade-holdings-account-account-id.d.ts

@@ -1,74 +0,0 @@
-import { SnapTradeHoldingsAccountAccountIdBalance } from './snap-trade-holdings-account-account-id-balance';
-/**
- * A single brokerage account at a financial institution.
- * @export
- * @interface SnapTradeHoldingsAccountAccountId
- */
-export interface SnapTradeHoldingsAccountAccountId {
-    [key: string]: any;
-    /**
-     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'id'?: string;
-    /**
-     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'brokerage_authorization'?: string;
-    /**
-     * Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'portfolio_group'?: string;
-    /**
-     * A display name for the account. Either assigned by the user or by the financial institution itself. For certain institutions, SnapTrade appends the institution name to the account name for clarity.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'name'?: string | null;
-    /**
-     * The account number assigned by the financial institution.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'number'?: string;
-    /**
-     * The name of the financial institution that holds the account.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'institution_name'?: string;
-    /**
-     *
-     * @type {SnapTradeHoldingsAccountAccountIdBalance}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'balance'?: SnapTradeHoldingsAccountAccountIdBalance | null;
-    /**
-     * Additional information about the account, such as account type, status, etc. This information is specific to the financial institution and there\'s no standard format for this data. Please use at your own risk.
-     * @type {{ [key: string]: any; }}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'meta'?: {
-        [key: string]: any;
-    };
-    /**
-     * This field is deprecated.
-     * @type {Array<string>}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     * @deprecated
-     */
-    'cash_restrictions'?: Array<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 financial institution.
-     * @type {string}
-     * @memberof SnapTradeHoldingsAccountAccountId
-     */
-    'created_date'?: string;
-}