snaptrade-typescript-sdk 9.0.34 → 9.0.36

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

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

@@ -1,5 +1,5 @@
 /**
- * Total value of this account (includes cash, equity, fixed income, etc)
+ * Total market value of this account (includes cash, equity, fixed income, etc). This value is directly obtained from the brokerage and should reflect the most accurate value of the account.
  * @export
  * @interface AccountBalanceTotal
  */

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

@@ -1,8 +1,8 @@
+import { Account } from './account';
 import { AccountOrderRecord } from './account-order-record';
 import { Balance } from './balance';
 import { OptionsPosition } from './options-position';
 import { Position } from './position';
-import { SnapTradeHoldingsAccountAccountId } from './snap-trade-holdings-account-account-id';
 import { SnapTradeHoldingsTotalValue } from './snap-trade-holdings-total-value';
 /**
  * A wrapper object containing holdings information for a single account.
@@ -13,10 +13,10 @@ export interface AccountHoldingsAccount {
     [key: string]: any;
     /**
      *
-     * @type {SnapTradeHoldingsAccountAccountId}
+     * @type {Account}
      * @memberof AccountHoldingsAccount
      */
-    'account'?: SnapTradeHoldingsAccountAccountId;
+    'account'?: Account;
     /**
      * 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>}

package/dist/models/account-order-record-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';
 /**
  * Contains information about the security that the order is for. This field is only present for stock/ETF/crypto/mutual fund orders. For option orders, this field will be null and the `option_symbol` field will be populated.
  * @export
@@ -35,16 +35,16 @@ export interface AccountOrderRecordUniversalSymbol {
     'description'?: string | null;
     /**
      *
-     * @type {UniversalSymbolCurrency}
+     * @type {SymbolCurrency}
      * @memberof AccountOrderRecordUniversalSymbol
      */
-    'currency': UniversalSymbolCurrency;
+    'currency': SymbolCurrency;
     /**
      *
-     * @type {UniversalSymbolExchange}
+     * @type {SymbolExchange}
      * @memberof AccountOrderRecordUniversalSymbol
      */
-    'exchange'?: UniversalSymbolExchange;
+    'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}

package/dist/models/account-order-record.d.ts

@@ -94,7 +94,7 @@ export interface AccountOrderRecord {
      */
     'order_type'?: string | null;
     /**
-     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value.   - `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.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.
+     * The Time in Force type for the order. This field indicates how long the order will remain active before it is executed or expires. We try our best to map brokerage time in force values to the following. When mapping fails, we will return the brokerage\'s time in force value.   - `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.   - `IOC` - Immediate Or Cancel. The order must be executed immediately. Any portion of the order that cannot be filled immediately will be canceled.   - `GTD` - Good Til Date. The order is valid until the specified date.   - `MOO` - Market On Open. The order is to be executed at the day\'s opening price.   - `EHP` - Extended Hours P.M. The order is to be placed during extended hour trading, after markets close.
      * @type {string}
      * @memberof AccountOrderRecord
      */

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

@@ -1,25 +1,25 @@
 import { AccountSyncStatus } from './account-sync-status';
 /**
- * SnapTradeUser Investment Account
+ * A single brokerage account at a financial institution.
  * @export
  * @interface AccountSimple
  */
 export interface AccountSimple {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
      * @type {string}
      * @memberof AccountSimple
      */
     'id'?: 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 AccountSimple
      */
     'name'?: string;
     /**
-     *
+     * The account number assigned by the financial institution.
      * @type {string}
      * @memberof AccountSimple
      */

package/dist/models/account-sync-status.d.ts

@@ -1,7 +1,7 @@
 import { HoldingsStatus } from './holdings-status';
 import { TransactionsStatus } from './transactions-status';
 /**
- * Status of account
+ * Contains status update for the account sync process between SnapTrade and the brokerage.
  * @export
  * @interface AccountSyncStatus
  */

package/dist/models/account.d.ts

@@ -1,58 +1,60 @@
 import { AccountBalance } from './account-balance';
 import { AccountSyncStatus } from './account-sync-status';
 /**
- * SnapTradeUser Investment Account
+ * A single brokerage account at a financial institution.
  * @export
  * @interface Account
  */
 export interface Account {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade. This ID should not change for as long as the connection stays active. If the connection is deleted and re-added, a new account ID will be generated. If you want a stable identifier for the account, use the `number` field.
      * @type {string}
      * @memberof Account
      */
     'id'?: string;
     /**
-     *
+     * Unique identifier for the connection (brokerage authorization). This is the UUID used to reference the connection in SnapTrade.
      * @type {string}
      * @memberof Account
      */
     'brokerage_authorization'?: string;
     /**
-     *
+     * Portfolio Group ID. Portfolio Groups have been deprecated. Please contact support if you have a usecase for it.
      * @type {string}
      * @memberof Account
+     * @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 Account
      */
-    'name'?: string;
+    'name'?: string | null;
     /**
-     *
+     * The account number assigned by the financial institution.
      * @type {string}
      * @memberof Account
      */
     'number'?: string;
     /**
-     *
+     * The name of the financial institution that holds the account.
      * @type {string}
      * @memberof Account
      */
     'institution_name'?: 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 Account
      */
     'created_date'?: string;
     /**
-     *
+     * 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 Account
+     * @deprecated
      */
     'meta'?: {
         [key: string]: any;

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

@@ -0,0 +1,25 @@
+/**
+ * The currency of the balance. This applies to both `cash` and `buying_power`.
+ * @export
+ * @interface BalanceCurrency
+ */
+export interface BalanceCurrency {
+    /**
+     * Unique identifier for the currency. This is the UUID used to reference the currency in SnapTrade.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'id'?: string;
+    /**
+     * The ISO-4217 currency code for the currency.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'code'?: string;
+    /**
+     * A human-friendly name of the currency.
+     * @type {string}
+     * @memberof BalanceCurrency
+     */
+    'name'?: string;
+}

package/dist/models/balance.d.ts

@@ -1,4 +1,4 @@
-import { Currency } from './currency';
+import { BalanceCurrency } from './balance-currency';
 /**
  * Holds balance information for a single currency in an account.
  * @export
@@ -8,10 +8,10 @@ export interface Balance {
     [key: string]: any;
     /**
      *
-     * @type {Currency}
+     * @type {BalanceCurrency}
      * @memberof Balance
      */
-    'currency'?: Currency;
+    'currency'?: BalanceCurrency;
     /**
      * The amount of available cash in the account denominated in the currency of the `currency` field.
      * @type {number}

package/dist/models/delete-user-response.d.ts

@@ -1,16 +1,22 @@
 /**
- * Response when delete user is successful
+ *
  * @export
  * @interface DeleteUserResponse
  */
 export interface DeleteUserResponse {
     [key: string]: any;
     /**
-     * Delete status
+     * This is always `deleted` when a user is queued for deletion.
      * @type {string}
      * @memberof DeleteUserResponse
      */
     'status'?: string;
+    /**
+     * Human friendly message about the deletion status.
+     * @type {string}
+     * @memberof DeleteUserResponse
+     */
+    'detail'?: string;
     /**
      * SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
      * @type {string}

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

@@ -1,19 +1,19 @@
 /**
- * Status of account holdings sync
+ * Status of account holdings sync. SnapTrade syncs holdings from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all holdings (positions, balances, recent orders, and transactions) immediately after the connection is established. 2. Daily sync - Once a day SnapTrade refreshes all holdings from the brokerage. 3. Manual sync - You can trigger a refresh of holdings with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
  * @export
  * @interface HoldingsStatus
  */
 export interface HoldingsStatus {
     /**
-     *
+     * Indicates if the initial sync of holdings has been completed. For accounts with a large number of positions/orders/transactions, the initial sync may take a while to complete.
      * @type {boolean}
      * @memberof HoldingsStatus
      */
     'initial_sync_completed'?: boolean;
     /**
-     * Date in ISO 8601 format or null (YYYY-MM-DD HH:MM:SS.mmmmmmTZ)
+     * The last time holdings were successfully synced by SnapTrade.
      * @type {string}
      * @memberof HoldingsStatus
      */
-    'last_successful_sync'?: string | null;
+    'last_successful_sync'?: string;
 }

package/dist/models/index.d.ts

@@ -10,9 +10,9 @@ export * from './account-order-record-universal-symbol';
 export * from './account-simple';
 export * from './account-sync-status';
 export * from './action-strict';
-export * from './amount';
 export * from './authentication-login-snap-trade-user200-response';
 export * from './balance';
+export * from './balance-currency';
 export * from './brokerage';
 export * from './brokerage-authorization';
 export * from './brokerage-authorization-disabled-confirmation';
@@ -70,8 +70,6 @@ export * from './position-symbol';
 export * from './security-type';
 export * from './session-event';
 export * from './snap-trade-holdings-account';
-export * from './snap-trade-holdings-account-account-id';
-export * from './snap-trade-holdings-account-account-id-balance';
 export * from './snap-trade-holdings-total-value';
 export * from './snap-trade-login-user-request-body';
 export * from './snap-trade-register-user-request-body';
@@ -81,6 +79,8 @@ export * from './strategy-quotes';
 export * from './strategy-quotes-greek';
 export * from './sub-period-return-rate';
 export * from './symbol';
+export * from './symbol-currency';
+export * from './symbol-exchange';
 export * from './symbol-figi-instrument';
 export * from './symbol-query';
 export * from './symbols-quotes-inner';
@@ -92,8 +92,9 @@ 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 './universal-symbol-currency';
-export * from './universal-symbol-exchange';
 export * from './user-idand-secret';
 export * from './validated-trade-body';

package/dist/models/index.js

@@ -26,9 +26,9 @@ __exportStar(require("./account-order-record-universal-symbol"), exports);
 __exportStar(require("./account-simple"), exports);
 __exportStar(require("./account-sync-status"), exports);
 __exportStar(require("./action-strict"), exports);
-__exportStar(require("./amount"), exports);
 __exportStar(require("./authentication-login-snap-trade-user200-response"), exports);
 __exportStar(require("./balance"), exports);
+__exportStar(require("./balance-currency"), exports);
 __exportStar(require("./brokerage"), exports);
 __exportStar(require("./brokerage-authorization"), exports);
 __exportStar(require("./brokerage-authorization-disabled-confirmation"), exports);
@@ -86,8 +86,6 @@ __exportStar(require("./position-symbol"), exports);
 __exportStar(require("./security-type"), exports);
 __exportStar(require("./session-event"), exports);
 __exportStar(require("./snap-trade-holdings-account"), exports);
-__exportStar(require("./snap-trade-holdings-account-account-id"), exports);
-__exportStar(require("./snap-trade-holdings-account-account-id-balance"), exports);
 __exportStar(require("./snap-trade-holdings-total-value"), exports);
 __exportStar(require("./snap-trade-login-user-request-body"), exports);
 __exportStar(require("./snap-trade-register-user-request-body"), exports);
@@ -97,6 +95,8 @@ __exportStar(require("./strategy-quotes"), exports);
 __exportStar(require("./strategy-quotes-greek"), exports);
 __exportStar(require("./sub-period-return-rate"), exports);
 __exportStar(require("./symbol"), exports);
+__exportStar(require("./symbol-currency"), exports);
+__exportStar(require("./symbol-exchange"), exports);
 __exportStar(require("./symbol-figi-instrument"), exports);
 __exportStar(require("./symbol-query"), exports);
 __exportStar(require("./symbols-quotes-inner"), exports);
@@ -108,8 +108,9 @@ __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("./universal-symbol-currency"), exports);
-__exportStar(require("./universal-symbol-exchange"), exports);
 __exportStar(require("./user-idand-secret"), exports);
 __exportStar(require("./validated-trade-body"), exports);

package/dist/models/login-redirect-uri.d.ts

@@ -5,13 +5,13 @@
  */
 export interface LoginRedirectURI {
     /**
-     *
-     * @type {any}
+     * Connection Portal link to redirect user to connect a brokerage account.
+     * @type {string}
      * @memberof LoginRedirectURI
      */
-    'redirectURI'?: any;
+    'redirectURI'?: string;
     /**
-     *
+     * ID to identify the connection portal session.
      * @type {string}
      * @memberof LoginRedirectURI
      */

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

@@ -5,37 +5,37 @@
  */
 export interface SnapTradeLoginUserRequestBody {
     /**
-     * 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.
+     * Slug of the brokerage to connect the user to. See [the integrations page](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=3cfea70ef4254afc89704e47275a7a9a&pvs=4) for a list of supported brokerages and their slugs.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'broker'?: string;
     /**
-     * When set to True, user will be redirected back to the partner\'s site instead of the connection portal
+     * When set to `true`, user will be redirected back to the partner\'s site instead of the connection portal. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
      * @type {boolean}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'immediateRedirect'?: boolean;
     /**
-     * URL to redirect the user to after the user connects their brokerage account
+     * URL to redirect the user to after the user connects their brokerage account. This parameter is ignored if the connection portal is loaded inside an iframe. See the [guide on ways to integrate the connection portal](https://docs.snaptrade.com/docs/implement-connection-portal) for more information.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'customRedirect'?: string;
     /**
-     * The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See ‘Reconnecting Accounts’ for more information.
+     * The UUID of the brokerage connection to be reconnected. This parameter should be left empty unless you are reconnecting a disabled connection. See the [guide on fixing broken connections](https://docs.snaptrade.com/docs/fix-broken-connections) for more information.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'reconnect'?: string;
     /**
-     * Sets whether the connection should be read or trade
+     * Sets whether the connection should be read-only or trade-enabled.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */
     'connectionType'?: SnapTradeLoginUserRequestBodyConnectionTypeEnum;
     /**
-     * Sets the version of the connection portal to render, with a default to \'v3\'
+     * Sets the version of the connection portal to render.
      * @type {string}
      * @memberof SnapTradeLoginUserRequestBody
      */

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

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

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

@@ -1,55 +1,55 @@
 /**
  * The exchange on which the security is listed and traded.
  * @export
- * @interface UniversalSymbolExchange
+ * @interface SymbolExchange
  */
-export interface UniversalSymbolExchange {
+export interface SymbolExchange {
     /**
      * Unique ID for the exchange in SnapTrade.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'id'?: string;
     /**
      * A short name for the exchange. For standardized exchange code, please us the `mic_code` field.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'code'?: string;
     /**
      * The [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) (MIC) for the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'mic_code'?: string;
     /**
      * The full name of the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'name'?: string;
     /**
      * The timezone for the trading hours (`start_time` and `close_time`) of the exchange.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'timezone'?: string;
     /**
      * The time when the exchange opens for trading.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'start_time'?: string;
     /**
      * The time when the exchange closes for trading.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'close_time'?: string;
     /**
      * The suffix to be appended to the symbol when trading on this exchange. For example, the suffix for the Toronto Stock Exchange is `.TO`. See `UniversalSymbol->symbol` and `UniversalSymbol->raw_symbol` for more detail.
      * @type {string}
-     * @memberof UniversalSymbolExchange
+     * @memberof SymbolExchange
      */
     'suffix'?: string | null;
 }

package/dist/models/symbol.d.ts

@@ -1,50 +1,50 @@
-import { Currency } from './currency';
-import { Exchange } from './exchange';
 import { SecurityType } from './security-type';
+import { SymbolCurrency } from './symbol-currency';
+import { SymbolExchange } from './symbol-exchange';
 import { SymbolFigiInstrument } from './symbol-figi-instrument';
 /**
- * Symbol
+ * Uniquely describes a single security + exchange combination across all brokerages.
  * @export
  * @interface Symbol
  */
 export interface Symbol {
     [key: string]: any;
     /**
-     *
+     * Unique identifier for the symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
      * @type {string}
      * @memberof Symbol
      */
     '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 Symbol
      */
     '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 Symbol
      */
     'raw_symbol'?: string;
     /**
-     *
+     * A human-readable description of the security. This is usually the company name or ETF name.
      * @type {string}
      * @memberof Symbol
      */
-    'name'?: string;
+    'description'?: string | null;
     /**
      *
-     * @type {Currency}
+     * @type {SymbolCurrency}
      * @memberof Symbol
      */
-    'currency'?: Currency;
+    'currency'?: SymbolCurrency;
     /**
      *
-     * @type {Exchange}
+     * @type {SymbolExchange}
      * @memberof Symbol
      */
-    'exchange'?: Exchange;
+    'exchange'?: SymbolExchange;
     /**
      *
      * @type {SecurityType}
@@ -52,7 +52,7 @@ export interface Symbol {
      */
     '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 Symbol
      */

package/dist/models/transactions-status.d.ts

@@ -1,25 +1,25 @@
 /**
- * Status of account transaction sync
+ * Status of account transaction sync. SnapTrade syncs transactions from the brokerage under the following conditions: 1. Initial connection - SnapTrade syncs all transactions from the brokerage account as far back as the brokerage allows. Check [our integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=6fab8012ade6441fa0c6d9af9c55ce3a) for details on how far back we sync for each brokerage. 2. Daily sync - Once a day SnapTrade syncs new transactions from the brokerage. 3. Manual sync - You can retrigger an incremental sync of transactions with the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint.
  * @export
  * @interface TransactionsStatus
  */
 export interface TransactionsStatus {
     /**
-     *
+     * Indicates if the initial sync of transactions has been completed. For accounts with a large number of transactions, the initial sync may take a while to complete.
      * @type {boolean}
      * @memberof TransactionsStatus
      */
     'initial_sync_completed'?: boolean;
     /**
-     * Date in YYYY-MM-DD format or null
+     * All transactions up to this date have been successfully synced. Please note that this is not the date of the last transaction, nor the last time SnapTrade attempted to sync transactions.
      * @type {string}
      * @memberof TransactionsStatus
      */
-    'last_successful_sync'?: string | null;
+    'last_successful_sync'?: string;
     /**
-     * Date in YYYY-MM-DD format or null
+     * The date of the first transaction in the account known to SnapTrade. It\'s possible that the account has transactions before this date, but they are not known to SnapTrade.
      * @type {string}
      * @memberof TransactionsStatus
      */
-    'first_transaction_date'?: string | null;
+    'first_transaction_date'?: string;
 }