snaptrade-typescript-sdk 9.0.76 → 9.0.78

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-v9.0.76-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.76)
+[![npm](https://img.shields.io/badge/npm-v9.0.78-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.78)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -183,9 +183,11 @@ main();
 
 ### `snaptrade.accountInformation.getAccountActivities`<a id="snaptradeaccountinformationgetaccountactivities"></a>
 
-Returns all historical transactions for the specified account. It's recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There's a max number of 10000 transactions returned per request.
+Returns all historical transactions for the specified account.
 
-There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.
+This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.
+
+Transaction are returned in reverse chronological order, using the `trade_date` field.
 
 The data returned here is always cached and refreshed once a day.
 
@@ -220,13 +222,21 @@ The start date (inclusive) of the transaction history to retrieve. If not provid
 
 The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
 
+##### offset: `number`<a id="offset-number"></a>
+
+An integer that specifies the starting point of the paginated results. Default is 0.
+
+##### limit: `number`<a id="limit-number"></a>
+
+An integer that specifies the maximum number of transactions to return. Default of 1000.
+
 ##### type: `string`<a id="type-string"></a>
 
 Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize 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.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another 
 
 #### 🔄 Return<a id="🔄-return"></a>
 
-[UniversalActivity](./models/universal-activity.ts)
+[PaginatedUniversalActivity](./models/paginated-universal-activity.ts)
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 

package/dist/api/account-information-api-generated.d.ts

@@ -6,28 +6,30 @@ import { AccountHoldings } from '../models';
 import { AccountHoldingsAccount } from '../models';
 import { AccountOrderRecord } from '../models';
 import { Balance } from '../models';
+import { PaginatedUniversalActivity } from '../models';
 import { Position } from '../models';
 import { RateOfReturnResponse } from '../models';
 import { RecentOrdersResponse } from '../models';
-import { UniversalActivity } from '../models';
 /**
  * AccountInformationApi - axios parameter creator
  * @export
  */
 export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+     * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
      * @summary List account activities
      * @param {string} accountId
      * @param {string} userId
      * @param {string} userSecret
      * @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
      * @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+     * @param {number} [offset] An integer that specifies the starting point of the paginated results. Default is 0.
+     * @param {number} [limit] An integer that specifies the maximum number of transactions to return. Default of 1000.
      * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize 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.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountActivities: (accountId: string, userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getAccountActivities: (accountId: string, userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, offset?: number, limit?: number, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -138,13 +140,13 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
  */
 export declare const AccountInformationApiFp: (configuration?: Configuration) => {
     /**
-     * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+     * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
      * @summary List account activities
      * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
+    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedUniversalActivity>>;
     /**
      * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -233,13 +235,13 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
  */
 export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+     * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
      * @summary List account activities
      * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
+    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<PaginatedUniversalActivity>;
     /**
      * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -359,6 +361,18 @@ export type AccountInformationApiGetAccountActivitiesRequest = {
     */
     readonly endDate?: string | Date;
     /**
+    * An integer that specifies the starting point of the paginated results. Default is 0.
+    * @type {number}
+    * @memberof AccountInformationApiGetAccountActivities
+    */
+    readonly offset?: number;
+    /**
+    * An integer that specifies the maximum number of transactions to return. Default of 1000.
+    * @type {number}
+    * @memberof AccountInformationApiGetAccountActivities
+    */
+    readonly limit?: number;
+    /**
     * Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize 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.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another
     * @type {string}
     * @memberof AccountInformationApiGetAccountActivities
@@ -635,14 +649,14 @@ export type AccountInformationApiUpdateUserAccountRequest = {
  */
 export declare class AccountInformationApiGenerated extends BaseAPI {
     /**
-     * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+     * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
      * @summary List account activities
      * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountInformationApiGenerated
      */
-    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
+    getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedUniversalActivity, any>>;
     /**
      * **Deprecated, please use the account-specific holdings endpoint instead.**  List all accounts for the user, plus balances, positions, and orders for each account.
      * @summary List all accounts for the user, plus balances, positions, and orders for each account.

package/dist/api/account-information-api-generated.js

@@ -36,18 +36,20 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const AccountInformationApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+         * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
          * @summary List account activities
          * @param {string} accountId
          * @param {string} userId
          * @param {string} userSecret
          * @param {string | Date} [startDate] The start date (inclusive) of the transaction history to retrieve. If not provided, the default is the first transaction known to SnapTrade based on `trade_date`.
          * @param {string | Date} [endDate] The end date (inclusive) of the transaction history to retrieve. If not provided, the default is the last transaction known to SnapTrade based on `trade_date`.
+         * @param {number} [offset] An integer that specifies the starting point of the paginated results. Default is 0.
+         * @param {number} [limit] An integer that specifies the maximum number of transactions to return. Default of 1000.
          * @param {string} [type] Optional comma separated list of transaction types to filter by. SnapTrade does a best effort to categorize 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.   - `OPTIONASSIGNMENT` - Option assignment event.   - `OPTIONEXERCISE` - Option exercise event.   - `TRANSFER` - Transfer of assets from one account to another
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getAccountActivities: (accountId, userId, userSecret, startDate, endDate, type, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getAccountActivities: (accountId, userId, userSecret, startDate, endDate, offset, limit, type, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'accountId' is not null or undefined
             (0, common_1.assertParamExists)('getAccountActivities', 'accountId', accountId);
             // verify required parameter 'userId' is not null or undefined
@@ -81,6 +83,12 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
                     endDate.toISOString().substr(0, 10) :
                     endDate;
             }
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
             if (type !== undefined) {
                 localVarQueryParameter['type'] = type;
             }
@@ -676,7 +684,7 @@ const AccountInformationApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+         * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
          * @summary List account activities
          * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -684,7 +692,7 @@ const AccountInformationApiFp = function (configuration) {
          */
         getAccountActivities(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getAccountActivities(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, requestParameters.startDate, requestParameters.endDate, requestParameters.type, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getAccountActivities(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, requestParameters.startDate, requestParameters.endDate, requestParameters.offset, requestParameters.limit, requestParameters.type, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -830,7 +838,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
     return {
         /**
-         * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+         * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
          * @summary List account activities
          * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -951,7 +959,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
  */
 class AccountInformationApiGenerated extends base_1.BaseAPI {
     /**
-     * Returns all historical transactions for the specified account. It\'s recommended to use `startDate` and `endDate` to paginate through the data, as the response may be very large for accounts with a long history and/or a lot of activity. There\'s a max number of 10000 transactions returned per request.  There is no guarantee to the ordering of the transactions returned. Please sort the transactions based on the `trade_date` field if you need them in a specific order.  The data returned here is always cached and refreshed once a day.
+     * Returns all historical transactions for the specified account.  This endpoint is paginated and will return a maximum of 1000 transactions per request. See the query parameters for pagination options.  Transaction are returned in reverse chronological order, using the `trade_date` field.  The data returned here is always cached and refreshed once a day.
      * @summary List account activities
      * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.