snaptrade-typescript-sdk 9.0.30 → 9.0.32

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.30/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/9.0.32/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/models/account-balance-total.d.ts

@@ -5,13 +5,13 @@
  */
 export interface AccountBalanceTotal {
     /**
-     *
+     * Total value denominated in the currency of the `currency` field.
      * @type {number}
      * @memberof AccountBalanceTotal
      */
     'amount'?: number;
     /**
-     *
+     * The ISO-4217 currency code for the amount.
      * @type {string}
      * @memberof AccountBalanceTotal
      */

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

@@ -1,6 +1,6 @@
 import { AccountBalanceTotal } from './account-balance-total';
 /**
- * Balance of the account
+ * Contains balance related information for the account.
  * @export
  * @interface AccountBalance
  */

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

@@ -5,7 +5,7 @@ import { Position } from './position';
 import { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
 import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
 /**
- * Account Holdings with Account ID
+ * A wrapper object containing holdings information for a single account
  * @export
  * @interface AccountHoldingsAccount
  */
@@ -18,25 +18,25 @@ export interface AccountHoldingsAccount {
      */
     'account'?: SnapTradeHoldingsAccountAccountId;
     /**
-     *
+     * List of balances for the account. Each element of the list has a distinct currency. Some brokerages like Questrade [allows holding multiple currencies in the same account](https://www.questrade.com/learning/questrade-basics/balances-and-reports/understanding-your-account-balances).
      * @type {Array<Balance>}
      * @memberof AccountHoldingsAccount
      */
     'balances'?: Array<Balance> | null;
     /**
-     *
+     * List of stock/ETF/crypto/mutual fund positions in the account.
      * @type {Array<Position>}
      * @memberof AccountHoldingsAccount
      */
     'positions'?: Array<Position> | null;
     /**
-     *
+     * List of option positions in the account.
      * @type {Array<OptionsPosition>}
      * @memberof AccountHoldingsAccount
      */
     'option_positions'?: Array<OptionsPosition> | null;
     /**
-     *
+     * List of recent orders in the account, including both pending and executed orders.
      * @type {Array<AccountOrderRecord>}
      * @memberof AccountHoldingsAccount
      */

package/dist/models/amount.d.ts

@@ -5,13 +5,13 @@
  */
 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
      */

package/dist/models/balance.d.ts

@@ -1,6 +1,6 @@
 import { Currency } from './currency';
 /**
- * Account Balance
+ * Holds balance information for a single currency in an account.
  * @export
  * @interface Balance
  */
@@ -13,13 +13,13 @@ export interface Balance {
      */
     'currency'?: Currency;
     /**
-     *
+     * The amount of available cash in the account denominated in the currency of the `currency` field.
      * @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
      */

package/dist/models/currency.d.ts

@@ -1,24 +1,24 @@
 /**
- * Currency
+ * 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
      */

package/dist/models/index.d.ts

@@ -70,7 +70,6 @@ export * from './option-leg';
 export * from './option-strategy';
 export * from './option-strategy-legs-inner';
 export * from './options-get-option-strategy-request';
-export * from './options-holdings';
 export * from './options-place-option-strategy-request';
 export * from './options-position';
 export * from './options-position-currency';

package/dist/models/index.js

@@ -86,7 +86,6 @@ __exportStar(require("./option-leg"), exports);
 __exportStar(require("./option-strategy"), exports);
 __exportStar(require("./option-strategy-legs-inner"), exports);
 __exportStar(require("./options-get-option-strategy-request"), exports);
-__exportStar(require("./options-holdings"), exports);
 __exportStar(require("./options-place-option-strategy-request"), exports);
 __exportStar(require("./options-position"), exports);
 __exportStar(require("./options-position-currency"), exports);

package/dist/models/options-position-currency.d.ts

@@ -5,19 +5,19 @@
  */
 export interface OptionsPositionCurrency {
     /**
-     *
+     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
      * @type {string}
      * @memberof OptionsPositionCurrency
      */
     'id'?: string;
     /**
-     *
+     * The ISO-4217 currency code for the currency.
      * @type {string}
      * @memberof OptionsPositionCurrency
      */
     'code'?: string;
     /**
-     *
+     * A human-friendly name of the currency.
      * @type {string}
      * @memberof OptionsPositionCurrency
      */

package/dist/models/options-position.d.ts

@@ -1,7 +1,7 @@
 import { OptionBrokerageSymbol } from './option-brokerage-symbol';
 import { OptionsPositionCurrency } from './options-position-currency';
 /**
- * Option Holdings
+ * Describes a single option position in an account.
  * @export
  * @interface OptionsPosition
  */
@@ -14,13 +14,13 @@ export interface OptionsPosition {
      */
     'symbol'?: OptionBrokerageSymbol;
     /**
-     * Trade Price if limit or stop limit order
+     * Last known market price for the option contract. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
      * @type {number}
      * @memberof OptionsPosition
      */
     'price'?: number | null;
     /**
-     *
+     * The number of contracts for this option position.
      * @type {number}
      * @memberof OptionsPosition
      */
@@ -32,7 +32,7 @@ export interface OptionsPosition {
      */
     'currency'?: OptionsPositionCurrency | null;
     /**
-     * Average purchase price for this position
+     * Cost basis _per contract_ of this option position. To get the cost basis _per share_, divide this value by the number of shares per contract (usually 100).
      * @type {number}
      * @memberof OptionsPosition
      */

package/dist/models/position.d.ts

@@ -1,6 +1,6 @@
 import { PositionSymbol } from './position-symbol';
 /**
- * Account Position
+ * Describes a single stock/ETF/crypto/mutual fund position in an account.
  * @export
  * @interface Position
  */
@@ -13,31 +13,32 @@ export interface Position {
      */
     'symbol'?: PositionSymbol;
     /**
-     *
+     * The number of shares of the position. This can be fractional or integer units.
      * @type {number}
      * @memberof Position
      */
     'units'?: number | null;
     /**
-     * Last known market price for the symbol
+     * Last known market price for the symbol. The freshness of this price depends on the brokerage. Some brokerages provide real-time prices, while others provide delayed prices. It is recommended that you rely on your own third-party market data provider for most up to date prices.
      * @type {number}
      * @memberof Position
      */
     'price'?: number | null;
     /**
-     *
+     * The profit or loss on the position since it was opened. This is calculated as the difference between the current market value of the position and the total cost of the position. It is recommended to calculate this value using the average purchase price and the current market price yourself, instead of relying on this field.
      * @type {number}
      * @memberof Position
      */
     'open_pnl'?: number | null;
     /**
-     * Deprecated, use the units field for both fractional and integer units going forward
+     * Deprecated, use the `units` field for both fractional and integer units going forward
      * @type {number}
      * @memberof Position
+     * @deprecated
      */
     'fractional_units'?: number | null;
     /**
-     * Average purchase price for this position. Either returned by the underlying broker or calculated using historical transactions.
+     * Cost basis _per share_ of this position.
      * @type {number}
      * @memberof Position
      */

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

@@ -1,44 +1,45 @@
 import { CashRestriction } from './cash-restriction';
 import { SnapTradeHoldingsAccountAccountIdBalance } from './snap-trade-holdings-account-account-id-balance';
 /**
- * Holdings with account ID
+ * 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
      */
@@ -50,21 +51,23 @@ export interface 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<CashRestriction>}
      * @memberof SnapTradeHoldingsAccountAccountId
+     * @deprecated
      */
     'cash_restrictions'?: Array<CashRestriction>;
     /**
-     * Time
+     * 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
      */

package/dist/models/snap-trade-holdings-total-value.d.ts

@@ -1,18 +1,18 @@
 /**
- * Calculated based on the sum of the values of account positions and cash balances
+ * The total market value of the account. Note that this field is calculated based on the sum of the values of account positions and cash balances known to SnapTrade. It may not be accurate if the brokerage account has holdings that SnapTrade is not aware of. For example, if the brokerage account holds assets that SnapTrade does not support, the total value may be underreported. To get the brokerage reported total market value of the account, refer to `account.balance.total`.
  * @export
  * @interface SnapTradeHoldingsTotalValue
  */
 export interface SnapTradeHoldingsTotalValue {
     [key: string]: any;
     /**
-     *
+     * Total value denominated in the currency of the `currency` field.
      * @type {number}
      * @memberof SnapTradeHoldingsTotalValue
      */
     'value'?: number | null;
     /**
-     *
+     * The ISO-4217 currency code for the amount.
      * @type {string}
      * @memberof SnapTradeHoldingsTotalValue
      */

package/dist/models/snap-trade-login-user-request-body.d.ts

@@ -5,7 +5,7 @@
  */
 export interface SnapTradeLoginUserRequestBody {
     /**
-     * Slug of the brokerage to connect the user to
+     * Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
@@ -35,7 +35,7 @@ export interface SnapTradeLoginUserRequestBody {
      */
     'connectionType'?: SnapTradeLoginUserRequestBodyConnectionTypeEnum;
     /**
-     * Sets the version of the connection portal to render, with a default to \'v2\'
+     * Sets the version of the connection portal to render, with a default to \'v3\'
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */

package/package.json

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

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

@@ -1,46 +0,0 @@
-import { Currency } from './currency';
-import { OptionsSymbol } from './options-symbol';
-/**
- * Option Holdings
- * @export
- * @interface OptionsHoldings
- */
-export interface OptionsHoldings {
-    [key: string]: any;
-    /**
-     * Options information
-     * @type {string}
-     * @memberof OptionsHoldings
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OptionsHoldings
-     */
-    'symbol'?: string;
-    /**
-     *
-     * @type {OptionsSymbol}
-     * @memberof OptionsHoldings
-     */
-    'option_symbol'?: OptionsSymbol;
-    /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
-     * @memberof OptionsHoldings
-     */
-    'price'?: number | null;
-    /**
-     *
-     * @type {Currency}
-     * @memberof OptionsHoldings
-     */
-    'currency'?: Currency;
-    /**
-     * Average purchase price for this position
-     * @type {number}
-     * @memberof OptionsHoldings
-     */
-    'average_purchase_price'?: number | null;
-}

package/dist/models/options-holdings.js

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