snaptrade-typescript-sdk 9.0.76 → 9.0.78

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.76/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.78/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/{universal-activity-currency.d.ts → account-universal-activity-currency.d.ts}

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

package/dist/models/{universal-activity-option-symbol.d.ts → account-universal-activity-option-symbol.d.ts}

@@ -2,51 +2,51 @@ 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
+ * @interface AccountUniversalActivityOptionSymbol
  */
-export interface UniversalActivityOptionSymbol {
+export interface AccountUniversalActivityOptionSymbol {
     /**
      * 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
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     'id': string;
     /**
      * The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
      * @type {string}
-     * @memberof UniversalActivityOptionSymbol
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     'ticker': string;
     /**
      * The type of option. Either \"CALL\" or \"PUT\".
      * @type {string}
-     * @memberof UniversalActivityOptionSymbol
+     * @memberof AccountUniversalActivityOptionSymbol
      */
-    'option_type': UniversalActivityOptionSymbolOptionTypeEnum;
+    'option_type': AccountUniversalActivityOptionSymbolOptionTypeEnum;
     /**
      * The option strike price.
      * @type {number}
-     * @memberof UniversalActivityOptionSymbol
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     'strike_price': number;
     /**
      * The option expiration date.
      * @type {string}
-     * @memberof UniversalActivityOptionSymbol
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     '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
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     'is_mini_option'?: boolean;
     /**
      *
      * @type {UnderlyingSymbol}
-     * @memberof UniversalActivityOptionSymbol
+     * @memberof AccountUniversalActivityOptionSymbol
      */
     'underlying_symbol': UnderlyingSymbol;
 }
-type UniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
+type AccountUniversalActivityOptionSymbolOptionTypeEnum = 'CALL' | 'PUT';
 export {};

package/dist/models/{universal-activity-symbol.d.ts → account-universal-activity-symbol.d.ts}

@@ -5,61 +5,61 @@ 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
+ * @interface AccountUniversalActivitySymbol
  */
-export interface UniversalActivitySymbol {
+export interface AccountUniversalActivitySymbol {
     /**
      * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
      * @type {string}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     '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
+     * @memberof AccountUniversalActivitySymbol
      */
     '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
+     * @memberof AccountUniversalActivitySymbol
      */
     'raw_symbol'?: string;
     /**
      * A human-readable description of the security. This is usually the company name or ETF name.
      * @type {string}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     'description'?: string | null;
     /**
      *
      * @type {SymbolCurrency}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     'currency'?: SymbolCurrency;
     /**
      *
      * @type {SymbolExchange}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     '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
+     * @memberof AccountUniversalActivitySymbol
      */
     'figi_code'?: string | null;
     /**
      *
      * @type {SymbolFigiInstrument}
-     * @memberof UniversalActivitySymbol
+     * @memberof AccountUniversalActivitySymbol
      */
     'figi_instrument'?: SymbolFigiInstrument | null;
 }

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

@@ -0,0 +1,107 @@
+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.
+     * @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.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info.   - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info.   - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
+     * @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://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 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

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

package/dist/models/index.d.ts

@@ -9,6 +9,10 @@ export * from './account-order-record-status';
 export * from './account-order-record-universal-symbol';
 export * from './account-simple';
 export * from './account-sync-status';
+export * from './account-universal-activity';
+export * from './account-universal-activity-currency';
+export * from './account-universal-activity-option-symbol';
+export * from './account-universal-activity-symbol';
 export * from './action-strict';
 export * from './action-strict-with-options';
 export * from './authentication-login-snap-trade-user200-response';
@@ -68,6 +72,8 @@ export * from './options-position';
 export * from './options-position-currency';
 export * from './options-symbol';
 export * from './order-type-strict';
+export * from './paginated-universal-activity';
+export * from './pagination-details';
 export * from './partner-data';
 export * from './past-value';
 export * from './performance-custom';
@@ -103,9 +109,6 @@ export * from './underlying-symbol';
 export * from './underlying-symbol-exchange';
 export * from './underlying-symbol-type';
 export * from './universal-activity';
-export * from './universal-activity-currency';
-export * from './universal-activity-option-symbol';
-export * from './universal-activity-symbol';
 export * from './universal-symbol';
 export * from './user-idand-secret';
 export * from './validated-trade-body';

package/dist/models/index.js

@@ -25,6 +25,10 @@ __exportStar(require("./account-order-record-status"), exports);
 __exportStar(require("./account-order-record-universal-symbol"), exports);
 __exportStar(require("./account-simple"), exports);
 __exportStar(require("./account-sync-status"), exports);
+__exportStar(require("./account-universal-activity"), exports);
+__exportStar(require("./account-universal-activity-currency"), exports);
+__exportStar(require("./account-universal-activity-option-symbol"), exports);
+__exportStar(require("./account-universal-activity-symbol"), exports);
 __exportStar(require("./action-strict"), exports);
 __exportStar(require("./action-strict-with-options"), exports);
 __exportStar(require("./authentication-login-snap-trade-user200-response"), exports);
@@ -84,6 +88,8 @@ __exportStar(require("./options-position"), exports);
 __exportStar(require("./options-position-currency"), exports);
 __exportStar(require("./options-symbol"), exports);
 __exportStar(require("./order-type-strict"), exports);
+__exportStar(require("./paginated-universal-activity"), exports);
+__exportStar(require("./pagination-details"), exports);
 __exportStar(require("./partner-data"), exports);
 __exportStar(require("./past-value"), exports);
 __exportStar(require("./performance-custom"), exports);
@@ -119,9 +125,6 @@ __exportStar(require("./underlying-symbol"), exports);
 __exportStar(require("./underlying-symbol-exchange"), exports);
 __exportStar(require("./underlying-symbol-type"), exports);
 __exportStar(require("./universal-activity"), exports);
-__exportStar(require("./universal-activity-currency"), exports);
-__exportStar(require("./universal-activity-option-symbol"), exports);
-__exportStar(require("./universal-activity-symbol"), exports);
 __exportStar(require("./universal-symbol"), exports);
 __exportStar(require("./user-idand-secret"), exports);
 __exportStar(require("./validated-trade-body"), exports);

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

@@ -0,0 +1,22 @@
+import { AccountUniversalActivity } from './account-universal-activity';
+import { PaginationDetails } from './pagination-details';
+/**
+ * A paginated list of UniversalActivity objects.
+ * @export
+ * @interface PaginatedUniversalActivity
+ */
+export interface PaginatedUniversalActivity {
+    [key: string]: any;
+    /**
+     *
+     * @type {Array<AccountUniversalActivity>}
+     * @memberof PaginatedUniversalActivity
+     */
+    'data'?: Array<AccountUniversalActivity>;
+    /**
+     *
+     * @type {PaginationDetails}
+     * @memberof PaginatedUniversalActivity
+     */
+    'pagination'?: PaginationDetails;
+}

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

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

package/dist/models/pagination-details.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Details about the pagination of the results.
+ * @export
+ * @interface PaginationDetails
+ */
+export interface PaginationDetails {
+    [key: string]: any;
+    /**
+     * The starting point of the paginated results.
+     * @type {number}
+     * @memberof PaginationDetails
+     */
+    'offset'?: number;
+    /**
+     * The maximum number of items to return in the response.
+     * @type {number}
+     * @memberof PaginationDetails
+     */
+    'limit'?: number;
+}

package/dist/models/pagination-details.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 { UniversalActivityCurrency } from './universal-activity-currency';
-import { UniversalActivityOptionSymbol } from './universal-activity-option-symbol';
-import { UniversalActivitySymbol } from './universal-activity-symbol';
+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
@@ -23,16 +23,16 @@ export interface UniversalActivity {
     'account'?: AccountSimple;
     /**
      *
-     * @type {UniversalActivitySymbol}
+     * @type {AccountUniversalActivitySymbol}
      * @memberof UniversalActivity
      */
-    'symbol'?: UniversalActivitySymbol | null;
+    'symbol'?: AccountUniversalActivitySymbol | null;
     /**
      *
-     * @type {UniversalActivityOptionSymbol}
+     * @type {AccountUniversalActivityOptionSymbol}
      * @memberof UniversalActivity
      */
-    'option_symbol'?: UniversalActivityOptionSymbol | null;
+    'option_symbol'?: AccountUniversalActivityOptionSymbol | null;
     /**
      * The price of the security for the transaction. This is mostly applicable to `BUY`, `SELL`, and `DIVIDEND` transactions.
      * @type {number}
@@ -53,10 +53,10 @@ export interface UniversalActivity {
     'amount'?: number | null;
     /**
      *
-     * @type {UniversalActivityCurrency}
+     * @type {AccountUniversalActivityCurrency}
      * @memberof UniversalActivity
      */
-    'currency'?: UniversalActivityCurrency;
+    '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.   - `INTEREST` - Interest deposited into the account.   - `FEE` - Fee withdrawn from the account.   - `OPTIONEXPIRATION` - Option expiration event. `option_symbol` contains the related option contract info.   - `OPTIONASSIGNMENT` - Option assignment event. `option_symbol` contains the related option contract info.   - `OPTIONEXERCISE` - Option exercise event. `option_symbol` contains the related option contract info.
      * @type {string}

package/dist/operationParameterMap.js

@@ -19,6 +19,12 @@ exports.operationParameterMap = {
             {
                 name: 'endDate'
             },
+            {
+                name: 'offset'
+            },
+            {
+                name: 'limit'
+            },
             {
                 name: 'type'
             },

package/package.json

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