snaptrade-typescript-sdk 9.0.35 → 9.0.37

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.35",
+  "version": "9.0.37",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {