snaptrade-typescript-sdk 9.0.73 → 9.0.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  Connect brokerage accounts to your app for live positions and trading
8
8
 
9
- [![npm](https://img.shields.io/badge/npm-v9.0.73-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.73)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.75-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.75)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -18,6 +18,7 @@ Connect brokerage accounts to your app for live positions and trading
18
18
  - [Installation](#installation)
19
19
  - [Getting Started](#getting-started)
20
20
  - [Reference](#reference)
21
+ * [`snaptrade.accountInformation.getAccountActivities`](#snaptradeaccountinformationgetaccountactivities)
21
22
  * [`snaptrade.accountInformation.getAllUserHoldings`](#snaptradeaccountinformationgetalluserholdings)
22
23
  * [`snaptrade.accountInformation.getUserAccountBalance`](#snaptradeaccountinformationgetuseraccountbalance)
23
24
  * [`snaptrade.accountInformation.getUserAccountDetails`](#snaptradeaccountinformationgetuseraccountdetails)
@@ -180,6 +181,62 @@ main();
180
181
  ## Reference<a id="reference"></a>
181
182
 
182
183
 
184
+ ### `snaptrade.accountInformation.getAccountActivities`<a id="snaptradeaccountinformationgetaccountactivities"></a>
185
+
186
+ 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.
187
+
188
+ 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.
189
+
190
+ The data returned here is always cached and refreshed once a day.
191
+
192
+
193
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
194
+
195
+ ```typescript
196
+ const getAccountActivitiesResponse =
197
+ await snaptrade.accountInformation.getAccountActivities({
198
+ accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
199
+ startDate: "2022-01-24",
200
+ endDate: "2022-01-24",
201
+ type: "BUY,SELL,DIVIDEND",
202
+ userId: "snaptrade-user-123",
203
+ userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
204
+ });
205
+ ```
206
+
207
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
208
+
209
+ ##### accountId: `string`<a id="accountid-string"></a>
210
+
211
+ ##### userId: `string`<a id="userid-string"></a>
212
+
213
+ ##### userSecret: `string`<a id="usersecret-string"></a>
214
+
215
+ ##### startDate: `string | Date`<a id="startdate-string--date"></a>
216
+
217
+ 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`.
218
+
219
+ ##### endDate: `string | Date`<a id="enddate-string--date"></a>
220
+
221
+ 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`.
222
+
223
+ ##### type: `string`<a id="type-string"></a>
224
+
225
+ 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
226
+
227
+ #### 🔄 Return<a id="🔄-return"></a>
228
+
229
+ [UniversalActivity](./models/universal-activity.ts)
230
+
231
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
232
+
233
+ `/accounts/{accountId}/activities` `GET`
234
+
235
+ [🔙 **Back to Table of Contents**](#table-of-contents)
236
+
237
+ ---
238
+
239
+
183
240
  ### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
184
241
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
185
242
 
@@ -912,6 +969,7 @@ const listBrokerageAuthorizationsResponse =
912
969
  ### `snaptrade.connections.refreshBrokerageAuthorization`<a id="snaptradeconnectionsrefreshbrokerageauthorization"></a>
913
970
 
914
971
  Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection.
972
+ This endpoint will also trigger a transaction sync for the past day if one has not yet occured.
915
973
 
916
974
  *Please contact support for access as this endpoint is not enabled by default.*
917
975
 
@@ -1912,7 +1970,7 @@ Returns all historical transactions for the specified user and filtering criteri
1912
1970
 
1913
1971
  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.
1914
1972
 
1915
- The data returned here is always cached and refreshed once a day. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
1973
+ The data returned here is always cached and refreshed once a day.
1916
1974
 
1917
1975
 
1918
1976
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -9,11 +9,25 @@ import { Balance } from '../models';
9
9
  import { Position } from '../models';
10
10
  import { RateOfReturnResponse } from '../models';
11
11
  import { RecentOrdersResponse } from '../models';
12
+ import { UniversalActivity } from '../models';
12
13
  /**
13
14
  * AccountInformationApi - axios parameter creator
14
15
  * @export
15
16
  */
16
17
  export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
18
+ /**
19
+ * 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.
20
+ * @summary List account activities
21
+ * @param {string} accountId
22
+ * @param {string} userId
23
+ * @param {string} userSecret
24
+ * @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 &#x60;trade_date&#x60;.
25
+ * @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 &#x60;trade_date&#x60;.
26
+ * @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: - &#x60;BUY&#x60; - Asset bought. - &#x60;SELL&#x60; - Asset sold. - &#x60;DIVIDEND&#x60; - Dividend payout. - &#x60;CONTRIBUTION&#x60; - Cash contribution. - &#x60;WITHDRAWAL&#x60; - Cash withdrawal. - &#x60;REI&#x60; - Dividend reinvestment. - &#x60;INTEREST&#x60; - Interest deposited into the account. - &#x60;FEE&#x60; - Fee withdrawn from the account. - &#x60;OPTIONEXPIRATION&#x60; - Option expiration event. - &#x60;OPTIONASSIGNMENT&#x60; - Option assignment event. - &#x60;OPTIONEXERCISE&#x60; - Option exercise event. - &#x60;TRANSFER&#x60; - Transfer of assets from one account to another
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ getAccountActivities: (accountId: string, userId: string, userSecret: string, startDate?: string | Date, endDate?: string | Date, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
17
31
  /**
18
32
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
19
33
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -123,6 +137,14 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
123
137
  * @export
124
138
  */
125
139
  export declare const AccountInformationApiFp: (configuration?: Configuration) => {
140
+ /**
141
+ * 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.
142
+ * @summary List account activities
143
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalActivity>>>;
126
148
  /**
127
149
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
128
150
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -210,6 +232,14 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
210
232
  * @export
211
233
  */
212
234
  export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
235
+ /**
236
+ * 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.
237
+ * @summary List account activities
238
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalActivity>>;
213
243
  /**
214
244
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
215
245
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -292,6 +322,49 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
292
322
  */
293
323
  updateUserAccount(requestParameters: AccountInformationApiUpdateUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Account>>;
294
324
  };
325
+ /**
326
+ * Request parameters for getAccountActivities operation in AccountInformationApi.
327
+ * @export
328
+ * @interface AccountInformationApiGetAccountActivitiesRequest
329
+ */
330
+ export type AccountInformationApiGetAccountActivitiesRequest = {
331
+ /**
332
+ *
333
+ * @type {string}
334
+ * @memberof AccountInformationApiGetAccountActivities
335
+ */
336
+ readonly accountId: string;
337
+ /**
338
+ *
339
+ * @type {string}
340
+ * @memberof AccountInformationApiGetAccountActivities
341
+ */
342
+ readonly userId: string;
343
+ /**
344
+ *
345
+ * @type {string}
346
+ * @memberof AccountInformationApiGetAccountActivities
347
+ */
348
+ readonly userSecret: string;
349
+ /**
350
+ * 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`.
351
+ * @type {string | Date}
352
+ * @memberof AccountInformationApiGetAccountActivities
353
+ */
354
+ readonly startDate?: string | Date;
355
+ /**
356
+ * 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`.
357
+ * @type {string | Date}
358
+ * @memberof AccountInformationApiGetAccountActivities
359
+ */
360
+ readonly endDate?: string | Date;
361
+ /**
362
+ * 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
363
+ * @type {string}
364
+ * @memberof AccountInformationApiGetAccountActivities
365
+ */
366
+ readonly type?: string;
367
+ };
295
368
  /**
296
369
  * Request parameters for getAllUserHoldings operation in AccountInformationApi.
297
370
  * @export
@@ -561,6 +634,15 @@ export type AccountInformationApiUpdateUserAccountRequest = {
561
634
  * @extends {BaseAPI}
562
635
  */
563
636
  export declare class AccountInformationApiGenerated extends BaseAPI {
637
+ /**
638
+ * 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.
639
+ * @summary List account activities
640
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
641
+ * @param {*} [options] Override http request option.
642
+ * @throws {RequiredError}
643
+ * @memberof AccountInformationApiGenerated
644
+ */
645
+ getAccountActivities(requestParameters: AccountInformationApiGetAccountActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalActivity[], any>>;
564
646
  /**
565
647
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
566
648
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -35,6 +35,77 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
35
35
  */
36
36
  const AccountInformationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
+ /**
39
+ * 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.
40
+ * @summary List account activities
41
+ * @param {string} accountId
42
+ * @param {string} userId
43
+ * @param {string} userSecret
44
+ * @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 &#x60;trade_date&#x60;.
45
+ * @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 &#x60;trade_date&#x60;.
46
+ * @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: - &#x60;BUY&#x60; - Asset bought. - &#x60;SELL&#x60; - Asset sold. - &#x60;DIVIDEND&#x60; - Dividend payout. - &#x60;CONTRIBUTION&#x60; - Cash contribution. - &#x60;WITHDRAWAL&#x60; - Cash withdrawal. - &#x60;REI&#x60; - Dividend reinvestment. - &#x60;INTEREST&#x60; - Interest deposited into the account. - &#x60;FEE&#x60; - Fee withdrawn from the account. - &#x60;OPTIONEXPIRATION&#x60; - Option expiration event. - &#x60;OPTIONASSIGNMENT&#x60; - Option assignment event. - &#x60;OPTIONEXERCISE&#x60; - Option exercise event. - &#x60;TRANSFER&#x60; - Transfer of assets from one account to another
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getAccountActivities: (accountId, userId, userSecret, startDate, endDate, type, options = {}) => __awaiter(this, void 0, void 0, function* () {
51
+ // verify required parameter 'accountId' is not null or undefined
52
+ (0, common_1.assertParamExists)('getAccountActivities', 'accountId', accountId);
53
+ // verify required parameter 'userId' is not null or undefined
54
+ (0, common_1.assertParamExists)('getAccountActivities', 'userId', userId);
55
+ // verify required parameter 'userSecret' is not null or undefined
56
+ (0, common_1.assertParamExists)('getAccountActivities', 'userSecret', userSecret);
57
+ const localVarPath = `/accounts/{accountId}/activities`
58
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
59
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
60
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
61
+ let baseOptions;
62
+ if (configuration) {
63
+ baseOptions = configuration.baseOptions;
64
+ }
65
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
66
+ const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
67
+ const localVarQueryParameter = {};
68
+ // authentication PartnerClientId required
69
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
70
+ // authentication PartnerSignature required
71
+ yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
72
+ // authentication PartnerTimestamp required
73
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
74
+ if (startDate !== undefined) {
75
+ localVarQueryParameter['startDate'] = (startDate instanceof Date) ?
76
+ startDate.toISOString().substr(0, 10) :
77
+ startDate;
78
+ }
79
+ if (endDate !== undefined) {
80
+ localVarQueryParameter['endDate'] = (endDate instanceof Date) ?
81
+ endDate.toISOString().substr(0, 10) :
82
+ endDate;
83
+ }
84
+ if (type !== undefined) {
85
+ localVarQueryParameter['type'] = type;
86
+ }
87
+ if (userId !== undefined) {
88
+ localVarQueryParameter['userId'] = userId;
89
+ }
90
+ if (userSecret !== undefined) {
91
+ localVarQueryParameter['userSecret'] = userSecret;
92
+ }
93
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
94
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
95
+ (0, requestBeforeHook_1.requestBeforeHook)({
96
+ queryParameters: localVarQueryParameter,
97
+ requestConfig: localVarRequestOptions,
98
+ path: localVarPath,
99
+ configuration,
100
+ pathTemplate: '/accounts/{accountId}/activities',
101
+ httpMethod: 'GET'
102
+ });
103
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
104
+ return {
105
+ url: (0, common_1.toPathString)(localVarUrlObj),
106
+ options: localVarRequestOptions,
107
+ };
108
+ }),
38
109
  /**
39
110
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
40
111
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -604,6 +675,19 @@ exports.AccountInformationApiAxiosParamCreator = AccountInformationApiAxiosParam
604
675
  const AccountInformationApiFp = function (configuration) {
605
676
  const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
606
677
  return {
678
+ /**
679
+ * 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.
680
+ * @summary List account activities
681
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
682
+ * @param {*} [options] Override http request option.
683
+ * @throws {RequiredError}
684
+ */
685
+ getAccountActivities(requestParameters, options) {
686
+ return __awaiter(this, void 0, void 0, function* () {
687
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAccountActivities(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, requestParameters.startDate, requestParameters.endDate, requestParameters.type, options);
688
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
689
+ });
690
+ },
607
691
  /**
608
692
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
609
693
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -745,6 +829,16 @@ exports.AccountInformationApiFp = AccountInformationApiFp;
745
829
  const AccountInformationApiFactory = function (configuration, basePath, axios) {
746
830
  const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
747
831
  return {
832
+ /**
833
+ * 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.
834
+ * @summary List account activities
835
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
836
+ * @param {*} [options] Override http request option.
837
+ * @throws {RequiredError}
838
+ */
839
+ getAccountActivities(requestParameters, options) {
840
+ return localVarFp.getAccountActivities(requestParameters, options).then((request) => request(axios, basePath));
841
+ },
748
842
  /**
749
843
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
750
844
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -856,6 +950,17 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
856
950
  * @extends {BaseAPI}
857
951
  */
858
952
  class AccountInformationApiGenerated extends base_1.BaseAPI {
953
+ /**
954
+ * 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.
955
+ * @summary List account activities
956
+ * @param {AccountInformationApiGetAccountActivitiesRequest} requestParameters Request parameters.
957
+ * @param {*} [options] Override http request option.
958
+ * @throws {RequiredError}
959
+ * @memberof AccountInformationApiGenerated
960
+ */
961
+ getAccountActivities(requestParameters, options) {
962
+ return (0, exports.AccountInformationApiFp)(this.configuration).getAccountActivities(requestParameters, options).then((request) => request(this.axios, this.basePath));
963
+ }
859
964
  /**
860
965
  * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
861
966
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
@@ -41,7 +41,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
41
41
  */
42
42
  listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
43
  /**
44
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
44
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
45
45
  * @summary Refresh holdings for a connection
46
46
  * @param {string} authorizationId
47
47
  * @param {string} userId
@@ -111,7 +111,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
111
111
  */
112
112
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
113
113
  /**
114
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
114
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
115
115
  * @summary Refresh holdings for a connection
116
116
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
117
117
  * @param {*} [options] Override http request option.
@@ -173,7 +173,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
173
173
  */
174
174
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
175
175
  /**
176
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
176
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
177
177
  * @summary Refresh holdings for a connection
178
178
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
179
179
  * @param {*} [options] Override http request option.
@@ -409,7 +409,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
409
409
  */
410
410
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
411
411
  /**
412
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
412
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
413
413
  * @summary Refresh holdings for a connection
414
414
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
415
415
  * @param {*} [options] Override http request option.
@@ -197,7 +197,7 @@ const ConnectionsApiAxiosParamCreator = function (configuration) {
197
197
  };
198
198
  }),
199
199
  /**
200
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
200
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
201
201
  * @summary Refresh holdings for a connection
202
202
  * @param {string} authorizationId
203
203
  * @param {string} userId
@@ -464,7 +464,7 @@ const ConnectionsApiFp = function (configuration) {
464
464
  });
465
465
  },
466
466
  /**
467
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
467
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
468
468
  * @summary Refresh holdings for a connection
469
469
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
470
470
  * @param {*} [options] Override http request option.
@@ -556,7 +556,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
556
556
  return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
557
557
  },
558
558
  /**
559
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
559
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
560
560
  * @summary Refresh holdings for a connection
561
561
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
562
562
  * @param {*} [options] Override http request option.
@@ -639,7 +639,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
639
639
  return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
640
640
  }
641
641
  /**
642
- * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. *Please contact support for access as this endpoint is not enabled by default.*
642
+ * Trigger a holdings update for all accounts under this connection. Updates will be queued asynchronously. [`ACCOUNT_HOLDINGS_UPDATED` webhook](/docs/webhooks#webhooks-account_holdings_updated) will be sent once the sync completes for each account under the connection. This endpoint will also trigger a transaction sync for the past day if one has not yet occured. *Please contact support for access as this endpoint is not enabled by default.*
643
643
  * @summary Refresh holdings for a connection
644
644
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
645
645
  * @param {*} [options] Override http request option.
@@ -9,7 +9,7 @@ import { UniversalActivity } from '../models';
9
9
  */
10
10
  export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
11
11
  /**
12
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
12
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
13
13
  * @summary Get transaction history for a user
14
14
  * @param {string} userId
15
15
  * @param {string} userSecret
@@ -44,7 +44,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
44
44
  */
45
45
  export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
46
46
  /**
47
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
47
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
48
48
  * @summary Get transaction history for a user
49
49
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
50
50
  * @param {*} [options] Override http request option.
@@ -67,7 +67,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
67
67
  */
68
68
  export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
69
69
  /**
70
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
70
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
71
71
  * @summary Get transaction history for a user
72
72
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
73
73
  * @param {*} [options] Override http request option.
@@ -190,7 +190,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
190
190
  */
191
191
  export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
192
192
  /**
193
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
193
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
194
194
  * @summary Get transaction history for a user
195
195
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
196
196
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
39
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
40
40
  * @summary Get transaction history for a user
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
@@ -201,7 +201,7 @@ const TransactionsAndReportingApiFp = function (configuration) {
201
201
  const localVarAxiosParamCreator = (0, exports.TransactionsAndReportingApiAxiosParamCreator)(configuration);
202
202
  return {
203
203
  /**
204
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
204
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
205
205
  * @summary Get transaction history for a user
206
206
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
207
207
  * @param {*} [options] Override http request option.
@@ -238,7 +238,7 @@ const TransactionsAndReportingApiFactory = function (configuration, basePath, ax
238
238
  const localVarFp = (0, exports.TransactionsAndReportingApiFp)(configuration);
239
239
  return {
240
240
  /**
241
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
241
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
242
242
  * @summary Get transaction history for a user
243
243
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
244
244
  * @param {*} [options] Override http request option.
@@ -269,7 +269,7 @@ exports.TransactionsAndReportingApiFactory = TransactionsAndReportingApiFactory;
269
269
  */
270
270
  class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
271
271
  /**
272
- * Returns all historical transactions for the specified user and filtering criteria. 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. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
272
+ * Returns all historical transactions for the specified user and filtering criteria. 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.
273
273
  * @summary Get transaction history for a user
274
274
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
275
275
  * @param {*} [options] Override http request option.