snaptrade-typescript-sdk 8.29.4 → 8.29.6

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v8.29.4-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/8.29.4)
+[![npm](https://img.shields.io/badge/npm-v8.29.6-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/8.29.6)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -558,6 +558,10 @@ const getUserJWTResponse = await snaptrade.authentication.getUserJWT({
 
 ##### userSecret: `string`<a id="usersecret-string"></a>
 
+#### 🔄 Return<a id="🔄-return"></a>
+
+[EncryptedResponse](./models/encrypted-response.ts)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/snapTrade/encryptedJWT` `GET`
@@ -603,6 +607,7 @@ const loginSnapTradeUserResponse =
     customRedirect: "https://snaptrade.com",
     reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
     connectionType: "read",
+    connectionPortalVersion: "v2",
   });
 ```
 
@@ -626,12 +631,20 @@ URL to redirect the user to after the user connects their brokerage account
 
 ##### reconnect: `string`<a id="reconnect-string"></a>
 
-The UUID of the brokerage connection to be reconnected
+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.
 
 ##### connectionType: `string`<a id="connectiontype-string"></a>
 
 Sets whether the connection should be read or trade
 
+##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
+
+Sets the version of the connection portal to render, with a default to \\\'v2\\\'
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AuthenticationLoginSnapTradeUser200Response](./models/authentication-login-snap-trade-user200-response.ts)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/snapTrade/login` `POST`
@@ -806,6 +819,10 @@ Optional comma seperated list of user IDs used to filter the request on specific
 
 Optional comma seperated list of session IDs used to filter the request on specific users
 
+#### 🔄 Return<a id="🔄-return"></a>
+
+[ConnectionsSessionEvents200ResponseInner](./models/connections-session-events200-response-inner.ts)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/sessionEvents` `GET`
@@ -874,8 +891,7 @@ const getOptionStrategyResponse = await snaptrade.options.getOptionStrategy({
 
 ##### underlying_symbol_id: `string`<a id="underlying_symbol_id-string"></a>
 
-##### legs: `OptionLeg`<a id="legs-optionleg"></a>
-            [`OptionLeg`](./models/option-leg.ts)[]
+##### legs: [`OptionLeg`](./models/option-leg.ts)[]<a id="legs-optionlegmodelsoption-legts"></a>
 
 ##### strategy_type: `string`<a id="strategy_type-string"></a>
 
@@ -929,6 +945,10 @@ The ID of the account to get the options chain from.
 
 Universal symbol ID if symbol
 
+#### 🔄 Return<a id="🔄-return"></a>
+
+[OptionChainInner](./models/option-chain-inner.ts)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/accounts/{accountId}/optionsChain` `GET`
@@ -1522,6 +1542,10 @@ The ID of the account to get quotes.
 
 Should be set to True if providing tickers.
 
+#### 🔄 Return<a id="🔄-return"></a>
+
+[SymbolsQuotesInner](./models/symbols-quotes-inner.ts)
+
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
 `/accounts/{accountId}/quotes` `GET`
@@ -1671,7 +1695,7 @@ The ID of trade object obtained from trade/impact endpoint
 
 ### `snaptrade.transactionsAndReporting.getActivities`<a id="snaptradetransactionsandreportinggetactivities"></a>
 
-Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 
@@ -1727,7 +1751,7 @@ Optional comma seperated list of types to filter activities by. This is not an e
 
 ### `snaptrade.transactionsAndReporting.getReportingCustomRange`<a id="snaptradetransactionsandreportinggetreportingcustomrange"></a>
 
-Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
 
 #### 🛠️ Usage<a id="🛠️-usage"></a>
 

package/dist/api/transactions-and-reporting-api-generated.d.ts

@@ -9,7 +9,7 @@ import { UniversalActivity } from '../models';
  */
 export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+     * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {string} userId
      * @param {string} userSecret
@@ -23,7 +23,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
      */
     getActivities: (userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, accounts?: string, brokerageAuthorizations?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
      * @param {string | Date} startDate
      * @param {string | Date} endDate
@@ -43,7 +43,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
  */
 export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+     * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -51,7 +51,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
      */
     getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
     /**
-     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
      * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -65,7 +65,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
  */
 export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+     * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -73,7 +73,7 @@ export declare const TransactionsAndReportingApiFactory: (configuration?: Config
      */
     getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
     /**
-     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
      * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -187,7 +187,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
  */
 export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+     * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -196,7 +196,7 @@ export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
      */
     getActivities(requestParameters: TransactionsAndReportingApiGetActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
     /**
-     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
      * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/transactions-and-reporting-api-generated.js

@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+         * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
          * @summary Get transaction history for a user
          * @param {string} userId
          * @param {string} userSecret
@@ -109,7 +109,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
          * @summary Get performance information for a specific timeframe
          * @param {string | Date} startDate
          * @param {string | Date} endDate
@@ -196,7 +196,7 @@ const TransactionsAndReportingApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.TransactionsAndReportingApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+         * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
          * @summary Get transaction history for a user
          * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -209,7 +209,7 @@ const TransactionsAndReportingApiFp = function (configuration) {
             });
         },
         /**
-         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
          * @summary Get performance information for a specific timeframe
          * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -232,7 +232,7 @@ const TransactionsAndReportingApiFactory = function (configuration, basePath, ax
     const localVarFp = (0, exports.TransactionsAndReportingApiFp)(configuration);
     return {
         /**
-         * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+         * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
          * @summary Get transaction history for a user
          * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -242,7 +242,7 @@ const TransactionsAndReportingApiFactory = function (configuration, basePath, ax
             return localVarFp.getActivities(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+         * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
          * @summary Get performance information for a specific timeframe
          * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -262,7 +262,7 @@ exports.TransactionsAndReportingApiFactory = TransactionsAndReportingApiFactory;
  */
 class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
     /**
-     * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
+     * Returns activities (transactions) for a user. Specifying start and end date is highly recommended for better performance
      * @summary Get transaction history for a user
      * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -273,7 +273,7 @@ class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
         return (0, exports.TransactionsAndReportingApiFp)(this.configuration).getActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Total Equity Timeframe and Rate of Returns are experimental and should not be trusted to be 100% accurate
+     * Returns performance information (contributions, dividends, rate of return, etc) for a specific timeframe. Please note that Total Equity Timeframe and Rate of Returns are experimental features. Please contact support@snaptrade.com if you notice any inconsistencies.
      * @summary Get performance information for a specific timeframe
      * @param {TransactionsAndReportingApiGetReportingCustomRangeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.