snaptrade-typescript-sdk 9.0.38 → 9.0.40

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

package/dist/models/account.d.ts

@@ -14,7 +14,7 @@ export interface Account {
      */
     'id'?: string;
     /**
-     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
+     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof Account
      */
@@ -51,7 +51,7 @@ export interface Account {
      */
     'created_date'?: string;
     /**
-     * Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. Please use at your own risk.
+     * Additional information about the account, such as account type, status, etc. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
      * @type {{ [key: string]: any; }}
      * @memberof Account
      * @deprecated

package/dist/models/action-strict.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trade Action
+ * The action describes the intent or side of a trade. This is either `BUY` or `SELL`
  * @export
  * @enum {string}
  */

package/dist/models/brokerage-authorization-disabled-confirmation.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Confirmation that the connection has been disabled.
  * @export
  * @interface BrokerageAuthorizationDisabledConfirmation
  */

package/dist/models/brokerage-authorization-refresh-confirmation.d.ts

@@ -1,5 +1,5 @@
 /**
- *
+ * Confirmation that the syncs have been scheduled.
  * @export
  * @interface BrokerageAuthorizationRefreshConfirmation
  */

package/dist/models/brokerage-authorization.d.ts

@@ -1,27 +1,28 @@
 import { Brokerage } from './brokerage';
 /**
- *
+ * A single connection with a brokerage. Note that `Connection` and `Brokerage Authorization` are interchangeable, but the term `Connection` is preferred and used in the doc for consistency.  A connection is usually tied to a single login at a brokerage. A single connection can contain multiple brokerage accounts.  SnapTrade performs de-duping on connections for a given user. If the user has an existing connection with the brokerage, when connecting the brokerage with the same credentials, SnapTrade will return the existing connection instead of creating a new one.
  * @export
  * @interface BrokerageAuthorization
  */
 export interface BrokerageAuthorization {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the connection. This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'id'?: string;
     /**
-     * Time
+     * Timestamp of when the connection was established in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'created_date'?: string;
     /**
-     * Time
+     * Timestamp of when the connection was last updated in SnapTrade. This field is deprecated. Please let us know if you have a valid use case for this field.
      * @type {string}
      * @memberof BrokerageAuthorization
+     * @deprecated
      */
     'updated_date'?: string;
     /**
@@ -31,33 +32,34 @@ export interface BrokerageAuthorization {
      */
     'brokerage'?: Brokerage;
     /**
-     * Connection Name
+     * A short, human-readable name for the connection.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'name'?: string;
     /**
-     *
+     * Whether the connection is read-only or trade-enabled. A read-only connection can only be used to fetch data, while a trade-enabled connection can be used to place trades. Valid values are `read` and `trade`.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'type'?: string;
     /**
-     *
+     * Whether the connection is disabled. A disabled connection can no longer access the latest data from the brokerage, but will continue to return the last cached state. A connection can become disabled for many reasons and differs by brokerage. Here are some common scenarios:  - The user has changed their username or password at the brokerage. - The user has explicitly removed the access grant at the brokerage. - The session has expired at the brokerage and now requires explicit user re-authentication.  Please see [this guide](https://docs.snaptrade.com/docs/fix-broken-connections) on how to fix a disabled connection.
      * @type {boolean}
      * @memberof BrokerageAuthorization
      */
     'disabled'?: boolean;
     /**
-     * Disabled date
+     * Timestamp of when the connection was disabled in SnapTrade.
      * @type {string}
      * @memberof BrokerageAuthorization
      */
     'disabled_date'?: string | null;
     /**
-     * Additional data about brokerage authorization
+     * Additional data about the connection. This information is specific to the brokerage and there\'s no standard format for this data. This field is deprecated and subject to removal in a future version.
      * @type {{ [key: string]: any; }}
      * @memberof BrokerageAuthorization
+     * @deprecated
      */
     'meta'?: {
         [key: string]: any;

package/dist/models/brokerage-type.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of brokerage
+ * Type of brokerage. Currently supports traditional brokerages and crypto exchanges.
  * @export
  * @interface BrokerageType
  */

package/dist/models/brokerage.d.ts

@@ -1,17 +1,23 @@
 import { BrokerageType } from './brokerage-type';
 /**
- *
+ * Describes a brokerage that SnapTrade supports.
  * @export
  * @interface Brokerage
  */
 export interface Brokerage {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the brokerage firm. This is the UUID used to reference the brokerage in SnapTrade.
      * @type {string}
      * @memberof Brokerage
      */
     'id'?: string;
+    /**
+     * A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
+     * @type {string}
+     * @memberof Brokerage
+     */
+    'slug'?: string;
     /**
      * Full name of the brokerage.
      * @type {string}
@@ -25,95 +31,75 @@ export interface Brokerage {
      */
     'display_name'?: string;
     /**
-     *
+     * A brief description of the brokerage.
      * @type {string}
      * @memberof Brokerage
      */
     'description'?: string;
     /**
-     *
+     * URL to the brokerage\'s logo.
      * @type {string}
      * @memberof Brokerage
      */
     'aws_s3_logo_url'?: string;
     /**
-     *
+     * URL to the brokerage\'s logo in square format.
      * @type {string}
      * @memberof Brokerage
      */
     'aws_s3_square_logo_url'?: string | null;
     /**
-     *
+     * This field is deprecated.
      * @type {string}
      * @memberof Brokerage
+     * @deprecated
      */
     'open_url'?: string | null;
     /**
-     * A unique identifier for that brokerage. It is usually the name of the brokerage in capital letters and will never change.
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'slug'?: string;
-    /**
-     *
+     * URL to the brokerage\'s website.
      * @type {string}
      * @memberof Brokerage
      */
     'url'?: string;
     /**
-     *
+     * Whether the brokerage is enabled in SnapTrade. A disabled brokerage will not be available for new connections.
      * @type {boolean}
      * @memberof Brokerage
      */
     'enabled'?: boolean;
     /**
-     *
+     * Whether the brokerage is currently in maintenance mode. A brokerage in maintenance mode will not be available for new connections.
      * @type {boolean}
      * @memberof Brokerage
      */
     'maintenance_mode'?: boolean;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'allows_fractional_units'?: boolean | null;
     /**
-     *
+     * Whether the brokerage allows trading through SnapTrade.
      * @type {boolean}
      * @memberof Brokerage
      */
     'allows_trading'?: boolean | null;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'has_reporting'?: boolean | null;
     /**
-     *
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {boolean}
      * @memberof Brokerage
+     * @deprecated
      */
     'is_real_time_connection'?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'allows_trading_through_snaptrade_api'?: boolean | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Brokerage
-     */
-    'is_scraping_integration'?: boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof Brokerage
-     */
-    'default_currency'?: string;
     /**
      *
      * @type {BrokerageType}
@@ -121,9 +107,10 @@ export interface Brokerage {
      */
     'brokerage_type'?: BrokerageType;
     /**
-     * List of exchange ID supported by brokerage
+     * This field is deprecated. Please contact us if you have a valid use case for it.
      * @type {Array<any>}
      * @memberof Brokerage
+     * @deprecated
      */
     'exchanges'?: Array<any>;
 }

package/dist/models/index.d.ts

@@ -36,6 +36,7 @@ export * from './manual-trade-and-impact';
 export * from './manual-trade-balance';
 export * from './manual-trade-form';
 export * from './manual-trade-form-notional-value';
+export * from './manual-trade-impact';
 export * from './manual-trade-symbol';
 export * from './model400-failed-request-response';
 export * from './model401-failed-request-response';

package/dist/models/index.js

@@ -52,6 +52,7 @@ __exportStar(require("./manual-trade-and-impact"), exports);
 __exportStar(require("./manual-trade-balance"), exports);
 __exportStar(require("./manual-trade-form"), exports);
 __exportStar(require("./manual-trade-form-notional-value"), exports);
+__exportStar(require("./manual-trade-impact"), exports);
 __exportStar(require("./manual-trade-symbol"), exports);
 __exportStar(require("./model400-failed-request-response"), exports);
 __exportStar(require("./model401-failed-request-response"), exports);

package/dist/models/manual-trade-and-impact.d.ts

@@ -1,7 +1,8 @@
 import { ManualTrade } from './manual-trade';
 import { ManualTradeBalance } from './manual-trade-balance';
+import { ManualTradeImpact } from './manual-trade-impact';
 /**
- * Manual Trade and Impact object
+ *
  * @export
  * @interface ManualTradeAndImpact
  */
@@ -14,11 +15,11 @@ export interface ManualTradeAndImpact {
      */
     'trade'?: ManualTrade;
     /**
-     *
-     * @type {Array<ManualTrade>}
+     * List of impacts of the trade on the account. The list always contains one value at the moment.
+     * @type {Array<ManualTradeImpact>}
      * @memberof ManualTradeAndImpact
      */
-    'trade_impacts'?: Array<ManualTrade>;
+    'trade_impacts'?: Array<ManualTradeImpact>;
     /**
      *
      * @type {ManualTradeBalance}

package/dist/models/manual-trade-balance.d.ts

@@ -1,7 +1,7 @@
-import { Account } from './account';
+import { AccountSimple } from './account-simple';
 import { Currency } from './currency';
 /**
- * Balance
+ * Estimated remaining balance of the account after the trade is executed.
  * @export
  * @interface ManualTradeBalance
  */
@@ -9,10 +9,10 @@ export interface ManualTradeBalance {
     [key: string]: any;
     /**
      *
-     * @type {Account}
+     * @type {AccountSimple}
      * @memberof ManualTradeBalance
      */
-    'account'?: Account;
+    'account'?: AccountSimple;
     /**
      *
      * @type {Currency}
@@ -20,7 +20,7 @@ export interface ManualTradeBalance {
      */
     'currency'?: Currency;
     /**
-     * Cash
+     * Estimated amount of cash remaining in the account after the trade. At the moment this is the same as `remaining_cash` under `trade_impacts`.
      * @type {number}
      * @memberof ManualTradeBalance
      */

package/dist/models/manual-trade-form.d.ts

@@ -3,59 +3,59 @@ import { ManualTradeFormNotionalValue } from './manual-trade-form-notional-value
 import { OrderTypeStrict } from './order-type-strict';
 import { TimeInForceStrict } from './time-in-force-strict';
 /**
- * Manual Trade Form
+ * Inputs for placing an order with the brokerage.
  * @export
  * @interface ManualTradeForm
  */
 export interface ManualTradeForm {
     /**
-     *
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
      * @type {string}
      * @memberof ManualTradeForm
      */
-    'account_id'?: string;
+    'account_id': string;
     /**
-     * Trade Action
+     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`
      * @type {ActionStrict}
      * @memberof ManualTradeForm
      */
-    'action'?: ActionStrict;
+    'action': ActionStrict;
     /**
-     * Order Type
-     * @type {OrderTypeStrict}
+     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
+     * @type {string}
      * @memberof ManualTradeForm
      */
-    'order_type'?: OrderTypeStrict;
+    'universal_symbol_id': string;
     /**
-     * Trade Price if limit or stop limit order
-     * @type {number}
+     * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
+     * @type {OrderTypeStrict}
      * @memberof ManualTradeForm
      */
-    'price'?: number | null;
+    'order_type': OrderTypeStrict;
     /**
-     * Stop Price. If stop loss or stop limit order, the price to trigger the stop
-     * @type {number}
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
+     * @type {TimeInForceStrict}
      * @memberof ManualTradeForm
      */
-    'stop'?: number | null;
+    'time_in_force': TimeInForceStrict;
     /**
-     * Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled
-     * @type {TimeInForceStrict}
+     * The limit price for `Limit` and `StopLimit` orders.
+     * @type {number}
      * @memberof ManualTradeForm
      */
-    'time_in_force'?: TimeInForceStrict;
+    'price'?: number | null;
     /**
-     *
+     * The price at which a stop order is triggered for `Stop` and `StopLimit` orders.
      * @type {number}
      * @memberof ManualTradeForm
      */
-    'units'?: number | null;
+    'stop'?: number | null;
     /**
      *
-     * @type {string}
+     * @type {number}
      * @memberof ManualTradeForm
      */
-    'universal_symbol_id'?: string;
+    'units'?: number | null;
     /**
      *
      * @type {ManualTradeFormNotionalValue}

package/dist/models/manual-trade-impact.d.ts

@@ -0,0 +1,38 @@
+/**
+ *
+ * @export
+ * @interface ManualTradeImpact
+ */
+export interface ManualTradeImpact {
+    [key: string]: any;
+    /**
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+     * @type {string}
+     * @memberof ManualTradeImpact
+     */
+    'account'?: string;
+    /**
+     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+     * @type {string}
+     * @memberof ManualTradeImpact
+     */
+    'currency'?: string;
+    /**
+     * Estimated amount of cash remaining in the account after the trade.
+     * @type {number}
+     * @memberof ManualTradeImpact
+     */
+    'remaining_cash'?: number | null;
+    /**
+     * Estimated commission for the trade.
+     * @type {number}
+     * @memberof ManualTradeImpact
+     */
+    'estimated_commission'?: number | null;
+    /**
+     * Estimated foreign transaction fees for the trade.
+     * @type {number}
+     * @memberof ManualTradeImpact
+     */
+    'forex_fees'?: number | null;
+}

package/dist/models/manual-trade-impact.js

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

package/dist/models/manual-trade-symbol.d.ts

@@ -1,19 +1,20 @@
 import { Currency } from './currency';
 /**
- * Manual trade symbol object
+ * Information about the security for the order.
  * @export
  * @interface ManualTradeSymbol
  */
 export interface ManualTradeSymbol {
     [key: string]: any;
     /**
-     *
+     * A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
      * @type {string}
      * @memberof ManualTradeSymbol
+     * @deprecated
      */
     'brokerage_symbol_id'?: string;
     /**
-     *
+     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
      * @type {string}
      * @memberof ManualTradeSymbol
      */
@@ -25,21 +26,24 @@ export interface ManualTradeSymbol {
      */
     'currency'?: Currency;
     /**
-     *
+     * This field is deprecated and should not be used.
      * @type {string}
      * @memberof ManualTradeSymbol
+     * @deprecated
      */
     'local_id'?: string;
     /**
-     *
+     * This field is deprecated and should not be used.
      * @type {string}
      * @memberof ManualTradeSymbol
+     * @deprecated
      */
     'description'?: string | null;
     /**
-     *
+     * This field is deprecated and should not be used.
      * @type {string}
      * @memberof ManualTradeSymbol
+     * @deprecated
      */
     'symbol'?: string;
 }

package/dist/models/manual-trade.d.ts

@@ -1,37 +1,38 @@
 import { ActionStrict } from './action-strict';
 import { ManualTradeSymbol } from './manual-trade-symbol';
 import { OrderTypeStrict } from './order-type-strict';
+import { TimeInForceStrict } from './time-in-force-strict';
 /**
- * A manual trade object
+ * Contains the details of a submitted order.
  * @export
  * @interface ManualTrade
  */
 export interface ManualTrade {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the submitted order through SnapTrade.
      * @type {string}
      * @memberof ManualTrade
      */
     'id'?: string;
     /**
-     *
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
      * @type {string}
      * @memberof ManualTrade
      */
     'account'?: string;
     /**
-     * Order Type
+     * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
      * @type {OrderTypeStrict}
      * @memberof ManualTrade
      */
     'order_type'?: OrderTypeStrict;
     /**
-     * Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled   * GTD - Good Til Date
-     * @type {string}
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
+     * @type {TimeInForceStrict}
      * @memberof ManualTrade
      */
-    'time_in_force'?: string;
+    'time_in_force'?: TimeInForceStrict;
     /**
      *
      * @type {ManualTradeSymbol}
@@ -39,7 +40,7 @@ export interface ManualTrade {
      */
     'symbol'?: ManualTradeSymbol;
     /**
-     * Trade Action
+     * The action describes the intent or side of a trade. This is either `BUY` or `SELL`
      * @type {ActionStrict}
      * @memberof ManualTrade
      */

package/dist/models/notional-value.d.ts

@@ -1,6 +1,6 @@
 /**
  * @type NotionalValue
- * Dollar amount to trade. Cannot work with units. Can only work for market order types and day for time in force. **Only available for Alpaca, Alpaca Paper, and Robinhood.**
+ * Total notional amount for the order. Must be `null` if `units` is provided. Can only work with `Market` for `order_type` and `Day` for `time_in_force`. This is only available for certain brokerages. Please check the [integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=e7bbcbf9f272441593f93decde660687) for more information.
  * @export
  */
 export type NotionalValue = number | string;

package/dist/models/options-place-option-strategy-request.d.ts

@@ -7,13 +7,13 @@ import { TimeInForceStrict } from './time-in-force-strict';
  */
 export interface OptionsPlaceOptionStrategyRequest {
     /**
-     * Order Type
+     * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
      * @type {OrderTypeStrict}
      * @memberof OptionsPlaceOptionStrategyRequest
      */
     'order_type': OrderTypeStrict;
     /**
-     * Trade time in force examples:   * FOK - Fill Or Kill   * Day - Day   * GTC - Good Til Canceled
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. Here are the supported values:   - `Day` - Day. The order is valid only for the trading day on which it is placed.   - `GTC` - Good Til Canceled. The order is valid until it is executed or canceled.   - `FOK` - Fill Or Kill. The order must be executed in its entirety immediately or be canceled completely.
      * @type {TimeInForceStrict}
      * @memberof OptionsPlaceOptionStrategyRequest
      */

package/dist/models/order-type-strict.d.ts

@@ -1,5 +1,5 @@
 /**
- * Order Type
+ * The type of order to place.  - For `Limit` and `StopLimit` orders, the `price` field is required. - For `Stop` and `StopLimit` orders, the `stop` field is required.
  * @export
  * @enum {string}
  */