snaptrade-typescript-sdk 8.20.0 → 8.21.0

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.
Files changed (9) hide show
  1. package/README.md +15 -15
  2. package/dist/api/account-information-api-generated.d.ts +16 -16
  3. package/dist/api/account-information-api-generated.js +16 -16
  4. package/dist/api/authentication-api-generated.d.ts +20 -20
  5. package/dist/api/authentication-api-generated.js +20 -20
  6. package/dist/api/reference-data-api-generated.d.ts +20 -20
  7. package/dist/api/reference-data-api-generated.js +20 -20
  8. package/dist/configuration.js +1 -1
  9. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # snaptrade-typescript-sdk@8.20.0
1
+ # snaptrade-typescript-sdk@8.21.0
2
2
 
3
3
  Connect brokerage accounts to your app for live positions and trading
4
4
  ## Installing
@@ -101,20 +101,20 @@ All URIs are relative to *https://api.snaptrade.com/api/v1*
101
101
 
102
102
  Class | Method | HTTP request | Description
103
103
  ------------ | ------------- | ------------- | -------------
104
- *AccountInformationApi* | [**getAllUserHoldings**](docs/AccountInformationApi.md#getAllUserHoldings) | **GET** /holdings | List all accounts for the user, plus balances and positions for each account.
105
- *AccountInformationApi* | [**getUserAccountBalance**](docs/AccountInformationApi.md#getUserAccountBalance) | **GET** /accounts/{accountId}/balances | Get all cash balances of an investment account
104
+ *AccountInformationApi* | [**getAllUserHoldings**](docs/AccountInformationApi.md#getAllUserHoldings) | **GET** /holdings | List all accounts for the user, plus balances, positions, and orders for each account.
105
+ *AccountInformationApi* | [**getUserAccountBalance**](docs/AccountInformationApi.md#getUserAccountBalance) | **GET** /accounts/{accountId}/balances | List account balances
106
106
  *AccountInformationApi* | [**getUserAccountDetails**](docs/AccountInformationApi.md#getUserAccountDetails) | **GET** /accounts/{accountId} | Return details of a specific investment account
107
107
  *AccountInformationApi* | [**getUserAccountOrders**](docs/AccountInformationApi.md#getUserAccountOrders) | **GET** /accounts/{accountId}/orders | Get all history of orders placed in account
108
- *AccountInformationApi* | [**getUserAccountPositions**](docs/AccountInformationApi.md#getUserAccountPositions) | **GET** /accounts/{accountId}/positions | Get all positions of an investment account
108
+ *AccountInformationApi* | [**getUserAccountPositions**](docs/AccountInformationApi.md#getUserAccountPositions) | **GET** /accounts/{accountId}/positions | List account positions
109
109
  *AccountInformationApi* | [**getUserHoldings**](docs/AccountInformationApi.md#getUserHoldings) | **GET** /accounts/{accountId}/holdings | List balances, positions and orders for the specified account.
110
- *AccountInformationApi* | [**listUserAccounts**](docs/AccountInformationApi.md#listUserAccounts) | **GET** /accounts | List all investment accounts for the user
110
+ *AccountInformationApi* | [**listUserAccounts**](docs/AccountInformationApi.md#listUserAccounts) | **GET** /accounts | List accounts
111
111
  *AccountInformationApi* | [**updateUserAccount**](docs/AccountInformationApi.md#updateUserAccount) | **PUT** /accounts/{accountId} | Update details of an investment account
112
112
  *ApiStatusApi* | [**check**](docs/ApiStatusApi.md#check) | **GET** / | Get API Status
113
- *AuthenticationApi* | [**deleteSnapTradeUser**](docs/AuthenticationApi.md#deleteSnapTradeUser) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
114
- *AuthenticationApi* | [**getUserJWT**](docs/AuthenticationApi.md#getUserJWT) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
115
- *AuthenticationApi* | [**listSnapTradeUsers**](docs/AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you\'ve registered on our platform
116
- *AuthenticationApi* | [**loginSnapTradeUser**](docs/AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
117
- *AuthenticationApi* | [**registerSnapTradeUser**](docs/AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations
113
+ *AuthenticationApi* | [**deleteSnapTradeUser**](docs/AuthenticationApi.md#deleteSnapTradeUser) | **DELETE** /snapTrade/deleteUser | Delete SnapTrade user
114
+ *AuthenticationApi* | [**getUserJWT**](docs/AuthenticationApi.md#getUserJWT) | **GET** /snapTrade/encryptedJWT | Generate encrypted JWT token
115
+ *AuthenticationApi* | [**listSnapTradeUsers**](docs/AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers | List SnapTrade users
116
+ *AuthenticationApi* | [**loginSnapTradeUser**](docs/AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login | Login user & generate connection link
117
+ *AuthenticationApi* | [**registerSnapTradeUser**](docs/AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser | Create SnapTrade user
118
118
  *ConnectionsApi* | [**detailBrokerageAuthorization**](docs/ConnectionsApi.md#detailBrokerageAuthorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
119
119
  *ConnectionsApi* | [**listBrokerageAuthorizations**](docs/ConnectionsApi.md#listBrokerageAuthorizations) | **GET** /authorizations | List all brokerage authorizations for the user
120
120
  *ConnectionsApi* | [**removeBrokerageAuthorization**](docs/ConnectionsApi.md#removeBrokerageAuthorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
@@ -128,14 +128,14 @@ Class | Method | HTTP request | Description
128
128
  *ReferenceDataApi* | [**getCurrencyExchangeRatePair**](docs/ReferenceDataApi.md#getCurrencyExchangeRatePair) | **GET** /currencies/rates/{currencyPair} | Return the exchange rate of a currency pair
129
129
  *ReferenceDataApi* | [**getPartnerInfo**](docs/ReferenceDataApi.md#getPartnerInfo) | **GET** /snapTrade/partners | Get metadata related to Snaptrade partner
130
130
  *ReferenceDataApi* | [**getSecurityTypes**](docs/ReferenceDataApi.md#getSecurityTypes) | **GET** /securityTypes | List of all security types.
131
- *ReferenceDataApi* | [**getStockExchanges**](docs/ReferenceDataApi.md#getStockExchanges) | **GET** /exchanges | Return list of stock exchanges on Passiv and their suffixes
131
+ *ReferenceDataApi* | [**getStockExchanges**](docs/ReferenceDataApi.md#getStockExchanges) | **GET** /exchanges | List exchanges
132
132
  *ReferenceDataApi* | [**getSymbols**](docs/ReferenceDataApi.md#getSymbols) | **POST** /symbols | Search for symbols
133
133
  *ReferenceDataApi* | [**getSymbolsByTicker**](docs/ReferenceDataApi.md#getSymbolsByTicker) | **GET** /symbols/{ticker} | Get details of a symbol by the ticker
134
134
  *ReferenceDataApi* | [**listAllBrokerageAuthorizationType**](docs/ReferenceDataApi.md#listAllBrokerageAuthorizationType) | **GET** /brokerageAuthorizationTypes | List of all brokerage authorization types
135
- *ReferenceDataApi* | [**listAllBrokerages**](docs/ReferenceDataApi.md#listAllBrokerages) | **GET** /brokerages | List of all brokerages.
136
- *ReferenceDataApi* | [**listAllCurrencies**](docs/ReferenceDataApi.md#listAllCurrencies) | **GET** /currencies | List of all supported currencies
137
- *ReferenceDataApi* | [**listAllCurrenciesRates**](docs/ReferenceDataApi.md#listAllCurrenciesRates) | **GET** /currencies/rates | Return the exchange rates of all supported currencies
138
- *ReferenceDataApi* | [**symbolSearchUserAccount**](docs/ReferenceDataApi.md#symbolSearchUserAccount) | **POST** /accounts/{accountId}/symbols | Search for symbols that are supported by a brokerage account using a substring
135
+ *ReferenceDataApi* | [**listAllBrokerages**](docs/ReferenceDataApi.md#listAllBrokerages) | **GET** /brokerages | List brokerages
136
+ *ReferenceDataApi* | [**listAllCurrencies**](docs/ReferenceDataApi.md#listAllCurrencies) | **GET** /currencies | List currencies
137
+ *ReferenceDataApi* | [**listAllCurrenciesRates**](docs/ReferenceDataApi.md#listAllCurrenciesRates) | **GET** /currencies/rates | List currency exchange rates
138
+ *ReferenceDataApi* | [**symbolSearchUserAccount**](docs/ReferenceDataApi.md#symbolSearchUserAccount) | **POST** /accounts/{accountId}/symbols | Search for symbols available in an account
139
139
  *TradingApi* | [**cancelUserAccountOrder**](docs/TradingApi.md#cancelUserAccountOrder) | **POST** /accounts/{accountId}/orders/cancel | Cancel open order in account
140
140
  *TradingApi* | [**getOrderImpact**](docs/TradingApi.md#getOrderImpact) | **POST** /trade/impact | Check impact of trades on account.
141
141
  *TradingApi* | [**getUserAccountQuotes**](docs/TradingApi.md#getUserAccountQuotes) | **GET** /accounts/{accountId}/quotes | Get symbol quotes
package/dist/api/account-information-api-generated.d.ts CHANGED
@@ -24,7 +24,7 @@ import { Position } from '../models';
24
24
  export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
25
25
  /**
26
26
  *
27
- * @summary List all accounts for the user, plus balances and positions for each account.
27
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
28
28
  * @param {string} userId
29
29
  * @param {string} userSecret
30
30
  * @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -34,7 +34,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
34
34
  getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
36
  *
37
- * @summary Get all cash balances of an investment account
37
+ * @summary List account balances
38
38
  * @param {string} userId
39
39
  * @param {string} userSecret
40
40
  * @param {string} accountId The ID of the account get positions.
@@ -65,7 +65,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
65
65
  getUserAccountOrders: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
66
  /**
67
67
  *
68
- * @summary Get all positions of an investment account
68
+ * @summary List account positions
69
69
  * @param {string} userId
70
70
  * @param {string} userSecret
71
71
  * @param {string} accountId The ID of the account get positions.
@@ -85,7 +85,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
85
85
  getUserHoldings: (accountId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
86
86
  /**
87
87
  *
88
- * @summary List all investment accounts for the user
88
+ * @summary List accounts
89
89
  * @param {string} userId
90
90
  * @param {string} userSecret
91
91
  * @param {*} [options] Override http request option.
@@ -110,7 +110,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
110
110
  export declare const AccountInformationApiFp: (configuration?: Configuration) => {
111
111
  /**
112
112
  *
113
- * @summary List all accounts for the user, plus balances and positions for each account.
113
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
114
114
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
115
115
  * @param {*} [options] Override http request option.
116
116
  * @throws {RequiredError}
@@ -118,7 +118,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
118
118
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
119
119
  /**
120
120
  *
121
- * @summary Get all cash balances of an investment account
121
+ * @summary List account balances
122
122
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
123
123
  * @param {*} [options] Override http request option.
124
124
  * @throws {RequiredError}
@@ -142,7 +142,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
142
142
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountOrderRecord>>>;
143
143
  /**
144
144
  *
145
- * @summary Get all positions of an investment account
145
+ * @summary List account positions
146
146
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
147
147
  * @param {*} [options] Override http request option.
148
148
  * @throws {RequiredError}
@@ -158,7 +158,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
158
158
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountHoldingsAccount>>;
159
159
  /**
160
160
  *
161
- * @summary List all investment accounts for the user
161
+ * @summary List accounts
162
162
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
163
163
  * @param {*} [options] Override http request option.
164
164
  * @throws {RequiredError}
@@ -180,7 +180,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
180
180
  export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
181
181
  /**
182
182
  *
183
- * @summary List all accounts for the user, plus balances and positions for each account.
183
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
184
184
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
185
185
  * @param {*} [options] Override http request option.
186
186
  * @throws {RequiredError}
@@ -188,7 +188,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
188
188
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
189
189
  /**
190
190
  *
191
- * @summary Get all cash balances of an investment account
191
+ * @summary List account balances
192
192
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
193
193
  * @param {*} [options] Override http request option.
194
194
  * @throws {RequiredError}
@@ -212,7 +212,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
212
212
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountOrderRecord>>;
213
213
  /**
214
214
  *
215
- * @summary Get all positions of an investment account
215
+ * @summary List account positions
216
216
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
217
217
  * @param {*} [options] Override http request option.
218
218
  * @throws {RequiredError}
@@ -228,7 +228,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
228
228
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<AccountHoldingsAccount>;
229
229
  /**
230
230
  *
231
- * @summary List all investment accounts for the user
231
+ * @summary List accounts
232
232
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
233
233
  * @param {*} [options] Override http request option.
234
234
  * @throws {RequiredError}
@@ -452,7 +452,7 @@ export type AccountInformationApiUpdateUserAccountRequest = {
452
452
  export declare class AccountInformationApiGenerated extends BaseAPI {
453
453
  /**
454
454
  *
455
- * @summary List all accounts for the user, plus balances and positions for each account.
455
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
456
456
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
457
457
  * @param {*} [options] Override http request option.
458
458
  * @throws {RequiredError}
@@ -461,7 +461,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
461
461
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
462
462
  /**
463
463
  *
464
- * @summary Get all cash balances of an investment account
464
+ * @summary List account balances
465
465
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
466
466
  * @param {*} [options] Override http request option.
467
467
  * @throws {RequiredError}
@@ -488,7 +488,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
488
488
  getUserAccountOrders(requestParameters: AccountInformationApiGetUserAccountOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord[], any>>;
489
489
  /**
490
490
  *
491
- * @summary Get all positions of an investment account
491
+ * @summary List account positions
492
492
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
493
493
  * @param {*} [options] Override http request option.
494
494
  * @throws {RequiredError}
@@ -506,7 +506,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
506
506
  getUserHoldings(requestParameters: AccountInformationApiGetUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldingsAccount, any>>;
507
507
  /**
508
508
  *
509
- * @summary List all investment accounts for the user
509
+ * @summary List accounts
510
510
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
511
511
  * @param {*} [options] Override http request option.
512
512
  * @throws {RequiredError}
package/dist/api/account-information-api-generated.js CHANGED
@@ -37,7 +37,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
39
  *
40
- * @summary List all accounts for the user, plus balances and positions for each account.
40
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
43
43
  * @param {string} [brokerageAuthorizations] Optional. Comma seperated list of authorization IDs (only use if filtering is needed on one or more authorizations).
@@ -90,7 +90,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
90
90
  }),
91
91
  /**
92
92
  *
93
- * @summary Get all cash balances of an investment account
93
+ * @summary List account balances
94
94
  * @param {string} userId
95
95
  * @param {string} userSecret
96
96
  * @param {string} accountId The ID of the account get positions.
@@ -253,7 +253,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
253
253
  }),
254
254
  /**
255
255
  *
256
- * @summary Get all positions of an investment account
256
+ * @summary List account positions
257
257
  * @param {string} userId
258
258
  * @param {string} userSecret
259
259
  * @param {string} accountId The ID of the account get positions.
@@ -359,7 +359,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
359
359
  }),
360
360
  /**
361
361
  *
362
- * @summary List all investment accounts for the user
362
+ * @summary List accounts
363
363
  * @param {string} userId
364
364
  * @param {string} userSecret
365
365
  * @param {*} [options] Override http request option.
@@ -471,7 +471,7 @@ const AccountInformationApiFp = function (configuration) {
471
471
  return {
472
472
  /**
473
473
  *
474
- * @summary List all accounts for the user, plus balances and positions for each account.
474
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
475
475
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
476
476
  * @param {*} [options] Override http request option.
477
477
  * @throws {RequiredError}
@@ -484,7 +484,7 @@ const AccountInformationApiFp = function (configuration) {
484
484
  },
485
485
  /**
486
486
  *
487
- * @summary Get all cash balances of an investment account
487
+ * @summary List account balances
488
488
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
489
489
  * @param {*} [options] Override http request option.
490
490
  * @throws {RequiredError}
@@ -523,7 +523,7 @@ const AccountInformationApiFp = function (configuration) {
523
523
  },
524
524
  /**
525
525
  *
526
- * @summary Get all positions of an investment account
526
+ * @summary List account positions
527
527
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
528
528
  * @param {*} [options] Override http request option.
529
529
  * @throws {RequiredError}
@@ -549,7 +549,7 @@ const AccountInformationApiFp = function (configuration) {
549
549
  },
550
550
  /**
551
551
  *
552
- * @summary List all investment accounts for the user
552
+ * @summary List accounts
553
553
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
554
554
  * @param {*} [options] Override http request option.
555
555
  * @throws {RequiredError}
@@ -585,7 +585,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
585
585
  return {
586
586
  /**
587
587
  *
588
- * @summary List all accounts for the user, plus balances and positions for each account.
588
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
589
589
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
590
590
  * @param {*} [options] Override http request option.
591
591
  * @throws {RequiredError}
@@ -595,7 +595,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
595
595
  },
596
596
  /**
597
597
  *
598
- * @summary Get all cash balances of an investment account
598
+ * @summary List account balances
599
599
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
600
600
  * @param {*} [options] Override http request option.
601
601
  * @throws {RequiredError}
@@ -625,7 +625,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
625
625
  },
626
626
  /**
627
627
  *
628
- * @summary Get all positions of an investment account
628
+ * @summary List account positions
629
629
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
630
630
  * @param {*} [options] Override http request option.
631
631
  * @throws {RequiredError}
@@ -645,7 +645,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
645
645
  },
646
646
  /**
647
647
  *
648
- * @summary List all investment accounts for the user
648
+ * @summary List accounts
649
649
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
650
650
  * @param {*} [options] Override http request option.
651
651
  * @throws {RequiredError}
@@ -675,7 +675,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
675
675
  class AccountInformationApiGenerated extends base_1.BaseAPI {
676
676
  /**
677
677
  *
678
- * @summary List all accounts for the user, plus balances and positions for each account.
678
+ * @summary List all accounts for the user, plus balances, positions, and orders for each account.
679
679
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
680
680
  * @param {*} [options] Override http request option.
681
681
  * @throws {RequiredError}
@@ -686,7 +686,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
686
686
  }
687
687
  /**
688
688
  *
689
- * @summary Get all cash balances of an investment account
689
+ * @summary List account balances
690
690
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
691
691
  * @param {*} [options] Override http request option.
692
692
  * @throws {RequiredError}
@@ -719,7 +719,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
719
719
  }
720
720
  /**
721
721
  *
722
- * @summary Get all positions of an investment account
722
+ * @summary List account positions
723
723
  * @param {AccountInformationApiGetUserAccountPositionsRequest} requestParameters Request parameters.
724
724
  * @param {*} [options] Override http request option.
725
725
  * @throws {RequiredError}
@@ -741,7 +741,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
741
741
  }
742
742
  /**
743
743
  *
744
- * @summary List all investment accounts for the user
744
+ * @summary List accounts
745
745
  * @param {AccountInformationApiListUserAccountsRequest} requestParameters Request parameters.
746
746
  * @param {*} [options] Override http request option.
747
747
  * @throws {RequiredError}
package/dist/api/authentication-api-generated.d.ts CHANGED
@@ -24,7 +24,7 @@ import { UserIDandSecret } from '../models';
24
24
  export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
25
25
  /**
26
26
  *
27
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
27
+ * @summary Delete SnapTrade user
28
28
  * @param {string} userId
29
29
  * @param {*} [options] Override http request option.
30
30
  * @throws {RequiredError}
@@ -32,7 +32,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
32
32
  deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
33
  /**
34
34
  *
35
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
35
+ * @summary Generate encrypted JWT token
36
36
  * @param {string} userId
37
37
  * @param {string} userSecret
38
38
  * @param {*} [options] Override http request option.
@@ -41,14 +41,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
41
41
  getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
42
  /**
43
43
  *
44
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
44
+ * @summary List SnapTrade users
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
47
47
  */
48
48
  listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
49
  /**
50
50
  *
51
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
51
+ * @summary Login user & generate connection link
52
52
  * @param {string} userId
53
53
  * @param {string} userSecret
54
54
  * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
@@ -58,7 +58,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
58
58
  loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
59
  /**
60
60
  *
61
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
61
+ * @summary Create SnapTrade user
62
62
  * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
@@ -72,7 +72,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
72
72
  export declare const AuthenticationApiFp: (configuration?: Configuration) => {
73
73
  /**
74
74
  *
75
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
75
+ * @summary Delete SnapTrade user
76
76
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
77
77
  * @param {*} [options] Override http request option.
78
78
  * @throws {RequiredError}
@@ -80,7 +80,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
80
80
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
81
81
  /**
82
82
  *
83
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
83
+ * @summary Generate encrypted JWT token
84
84
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
85
85
  * @param {*} [options] Override http request option.
86
86
  * @throws {RequiredError}
@@ -88,14 +88,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
88
88
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
89
89
  /**
90
90
  *
91
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
91
+ * @summary List SnapTrade users
92
92
  * @param {*} [options] Override http request option.
93
93
  * @throws {RequiredError}
94
94
  */
95
95
  listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
96
96
  /**
97
97
  *
98
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
98
+ * @summary Login user & generate connection link
99
99
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
100
100
  * @param {*} [options] Override http request option.
101
101
  * @throws {RequiredError}
@@ -103,7 +103,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
103
103
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
104
104
  /**
105
105
  *
106
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
106
+ * @summary Create SnapTrade user
107
107
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
108
108
  * @param {*} [options] Override http request option.
109
109
  * @throws {RequiredError}
@@ -117,7 +117,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
117
117
  export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
118
118
  /**
119
119
  *
120
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
120
+ * @summary Delete SnapTrade user
121
121
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
122
122
  * @param {*} [options] Override http request option.
123
123
  * @throws {RequiredError}
@@ -125,7 +125,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
125
125
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
126
126
  /**
127
127
  *
128
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
128
+ * @summary Generate encrypted JWT token
129
129
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
130
130
  * @param {*} [options] Override http request option.
131
131
  * @throws {RequiredError}
@@ -133,14 +133,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
133
133
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
134
134
  /**
135
135
  *
136
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
136
+ * @summary List SnapTrade users
137
137
  * @param {*} [options] Override http request option.
138
138
  * @throws {RequiredError}
139
139
  */
140
140
  listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
141
141
  /**
142
142
  *
143
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
143
+ * @summary Login user & generate connection link
144
144
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
145
145
  * @param {*} [options] Override http request option.
146
146
  * @throws {RequiredError}
@@ -148,7 +148,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
148
148
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
149
149
  /**
150
150
  *
151
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
151
+ * @summary Create SnapTrade user
152
152
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
153
153
  * @param {*} [options] Override http request option.
154
154
  * @throws {RequiredError}
@@ -221,7 +221,7 @@ export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegist
221
221
  export declare class AuthenticationApiGenerated extends BaseAPI {
222
222
  /**
223
223
  *
224
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
224
+ * @summary Delete SnapTrade user
225
225
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
226
226
  * @param {*} [options] Override http request option.
227
227
  * @throws {RequiredError}
@@ -230,7 +230,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
230
230
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
231
231
  /**
232
232
  *
233
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
233
+ * @summary Generate encrypted JWT token
234
234
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
235
235
  * @param {*} [options] Override http request option.
236
236
  * @throws {RequiredError}
@@ -239,7 +239,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
239
239
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
240
240
  /**
241
241
  *
242
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
242
+ * @summary List SnapTrade users
243
243
  * @param {*} [options] Override http request option.
244
244
  * @throws {RequiredError}
245
245
  * @memberof AuthenticationApiGenerated
@@ -247,7 +247,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
247
247
  listSnapTradeUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
248
248
  /**
249
249
  *
250
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
250
+ * @summary Login user & generate connection link
251
251
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
252
252
  * @param {*} [options] Override http request option.
253
253
  * @throws {RequiredError}
@@ -256,7 +256,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
256
256
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
257
257
  /**
258
258
  *
259
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
259
+ * @summary Create SnapTrade user
260
260
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
package/dist/api/authentication-api-generated.js CHANGED
@@ -37,7 +37,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
39
  *
40
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
40
+ * @summary Delete SnapTrade user
41
41
  * @param {string} userId
42
42
  * @param {*} [options] Override http request option.
43
43
  * @throws {RequiredError}
@@ -80,7 +80,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
80
80
  }),
81
81
  /**
82
82
  *
83
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
83
+ * @summary Generate encrypted JWT token
84
84
  * @param {string} userId
85
85
  * @param {string} userSecret
86
86
  * @param {*} [options] Override http request option.
@@ -129,7 +129,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
129
129
  }),
130
130
  /**
131
131
  *
132
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
132
+ * @summary List SnapTrade users
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
135
135
  */
@@ -166,7 +166,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
166
166
  }),
167
167
  /**
168
168
  *
169
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
169
+ * @summary Login user & generate connection link
170
170
  * @param {string} userId
171
171
  * @param {string} userSecret
172
172
  * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
@@ -219,7 +219,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
219
219
  }),
220
220
  /**
221
221
  *
222
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
222
+ * @summary Create SnapTrade user
223
223
  * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
224
224
  * @param {*} [options] Override http request option.
225
225
  * @throws {RequiredError}
@@ -272,7 +272,7 @@ const AuthenticationApiFp = function (configuration) {
272
272
  return {
273
273
  /**
274
274
  *
275
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
275
+ * @summary Delete SnapTrade user
276
276
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
277
277
  * @param {*} [options] Override http request option.
278
278
  * @throws {RequiredError}
@@ -285,7 +285,7 @@ const AuthenticationApiFp = function (configuration) {
285
285
  },
286
286
  /**
287
287
  *
288
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
288
+ * @summary Generate encrypted JWT token
289
289
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
290
290
  * @param {*} [options] Override http request option.
291
291
  * @throws {RequiredError}
@@ -298,7 +298,7 @@ const AuthenticationApiFp = function (configuration) {
298
298
  },
299
299
  /**
300
300
  *
301
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
301
+ * @summary List SnapTrade users
302
302
  * @param {*} [options] Override http request option.
303
303
  * @throws {RequiredError}
304
304
  */
@@ -310,7 +310,7 @@ const AuthenticationApiFp = function (configuration) {
310
310
  },
311
311
  /**
312
312
  *
313
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
313
+ * @summary Login user & generate connection link
314
314
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
315
315
  * @param {*} [options] Override http request option.
316
316
  * @throws {RequiredError}
@@ -323,7 +323,7 @@ const AuthenticationApiFp = function (configuration) {
323
323
  },
324
324
  /**
325
325
  *
326
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
326
+ * @summary Create SnapTrade user
327
327
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
328
328
  * @param {*} [options] Override http request option.
329
329
  * @throws {RequiredError}
@@ -346,7 +346,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
346
346
  return {
347
347
  /**
348
348
  *
349
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
349
+ * @summary Delete SnapTrade user
350
350
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
351
351
  * @param {*} [options] Override http request option.
352
352
  * @throws {RequiredError}
@@ -356,7 +356,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
356
356
  },
357
357
  /**
358
358
  *
359
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
359
+ * @summary Generate encrypted JWT token
360
360
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
361
361
  * @param {*} [options] Override http request option.
362
362
  * @throws {RequiredError}
@@ -366,7 +366,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
366
366
  },
367
367
  /**
368
368
  *
369
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
369
+ * @summary List SnapTrade users
370
370
  * @param {*} [options] Override http request option.
371
371
  * @throws {RequiredError}
372
372
  */
@@ -375,7 +375,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
375
375
  },
376
376
  /**
377
377
  *
378
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
378
+ * @summary Login user & generate connection link
379
379
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
380
380
  * @param {*} [options] Override http request option.
381
381
  * @throws {RequiredError}
@@ -385,7 +385,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
385
385
  },
386
386
  /**
387
387
  *
388
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
388
+ * @summary Create SnapTrade user
389
389
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
390
390
  * @param {*} [options] Override http request option.
391
391
  * @throws {RequiredError}
@@ -405,7 +405,7 @@ exports.AuthenticationApiFactory = AuthenticationApiFactory;
405
405
  class AuthenticationApiGenerated extends base_1.BaseAPI {
406
406
  /**
407
407
  *
408
- * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
408
+ * @summary Delete SnapTrade user
409
409
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
410
410
  * @param {*} [options] Override http request option.
411
411
  * @throws {RequiredError}
@@ -416,7 +416,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
416
416
  }
417
417
  /**
418
418
  *
419
- * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
419
+ * @summary Generate encrypted JWT token
420
420
  * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
421
421
  * @param {*} [options] Override http request option.
422
422
  * @throws {RequiredError}
@@ -427,7 +427,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
427
427
  }
428
428
  /**
429
429
  *
430
- * @summary Get a list of all SnapTrade users you\'ve registered on our platform
430
+ * @summary List SnapTrade users
431
431
  * @param {*} [options] Override http request option.
432
432
  * @throws {RequiredError}
433
433
  * @memberof AuthenticationApiGenerated
@@ -437,7 +437,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
437
437
  }
438
438
  /**
439
439
  *
440
- * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
440
+ * @summary Login user & generate connection link
441
441
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
442
442
  * @param {*} [options] Override http request option.
443
443
  * @throws {RequiredError}
@@ -448,7 +448,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
448
448
  }
449
449
  /**
450
450
  *
451
- * @summary Register user with SnapTrade in order to create secure brokerage authorizations
451
+ * @summary Create SnapTrade user
452
452
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
453
453
  * @param {*} [options] Override http request option.
454
454
  * @throws {RequiredError}
package/dist/api/reference-data-api-generated.d.ts CHANGED
@@ -49,7 +49,7 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
49
49
  getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
50
  /**
51
51
  *
52
- * @summary Return list of stock exchanges on Passiv and their suffixes
52
+ * @summary List exchanges
53
53
  * @param {*} [options] Override http request option.
54
54
  * @throws {RequiredError}
55
55
  */
@@ -81,28 +81,28 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
81
81
  listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
82
  /**
83
83
  *
84
- * @summary List of all brokerages.
84
+ * @summary List brokerages
85
85
  * @param {*} [options] Override http request option.
86
86
  * @throws {RequiredError}
87
87
  */
88
88
  listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
89
89
  /**
90
90
  *
91
- * @summary List of all supported currencies
91
+ * @summary List currencies
92
92
  * @param {*} [options] Override http request option.
93
93
  * @throws {RequiredError}
94
94
  */
95
95
  listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
96
96
  /**
97
97
  *
98
- * @summary Return the exchange rates of all supported currencies
98
+ * @summary List currency exchange rates
99
99
  * @param {*} [options] Override http request option.
100
100
  * @throws {RequiredError}
101
101
  */
102
102
  listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
103
103
  /**
104
104
  *
105
- * @summary Search for symbols that are supported by a brokerage account using a substring
105
+ * @summary Search for symbols available in an account
106
106
  * @param {string} userId
107
107
  * @param {string} userSecret
108
108
  * @param {string} accountId The ID of the account get positions.
@@ -141,7 +141,7 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
141
141
  getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
142
142
  /**
143
143
  *
144
- * @summary Return list of stock exchanges on Passiv and their suffixes
144
+ * @summary List exchanges
145
145
  * @param {*} [options] Override http request option.
146
146
  * @throws {RequiredError}
147
147
  */
@@ -172,28 +172,28 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
172
172
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
173
173
  /**
174
174
  *
175
- * @summary List of all brokerages.
175
+ * @summary List brokerages
176
176
  * @param {*} [options] Override http request option.
177
177
  * @throws {RequiredError}
178
178
  */
179
179
  listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
180
180
  /**
181
181
  *
182
- * @summary List of all supported currencies
182
+ * @summary List currencies
183
183
  * @param {*} [options] Override http request option.
184
184
  * @throws {RequiredError}
185
185
  */
186
186
  listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
187
187
  /**
188
188
  *
189
- * @summary Return the exchange rates of all supported currencies
189
+ * @summary List currency exchange rates
190
190
  * @param {*} [options] Override http request option.
191
191
  * @throws {RequiredError}
192
192
  */
193
193
  listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
194
194
  /**
195
195
  *
196
- * @summary Search for symbols that are supported by a brokerage account using a substring
196
+ * @summary Search for symbols available in an account
197
197
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
198
198
  * @param {*} [options] Override http request option.
199
199
  * @throws {RequiredError}
@@ -229,7 +229,7 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
229
229
  getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
230
230
  /**
231
231
  *
232
- * @summary Return list of stock exchanges on Passiv and their suffixes
232
+ * @summary List exchanges
233
233
  * @param {*} [options] Override http request option.
234
234
  * @throws {RequiredError}
235
235
  */
@@ -260,28 +260,28 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
260
260
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
261
261
  /**
262
262
  *
263
- * @summary List of all brokerages.
263
+ * @summary List brokerages
264
264
  * @param {*} [options] Override http request option.
265
265
  * @throws {RequiredError}
266
266
  */
267
267
  listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
268
268
  /**
269
269
  *
270
- * @summary List of all supported currencies
270
+ * @summary List currencies
271
271
  * @param {*} [options] Override http request option.
272
272
  * @throws {RequiredError}
273
273
  */
274
274
  listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
275
275
  /**
276
276
  *
277
- * @summary Return the exchange rates of all supported currencies
277
+ * @summary List currency exchange rates
278
278
  * @param {*} [options] Override http request option.
279
279
  * @throws {RequiredError}
280
280
  */
281
281
  listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
282
282
  /**
283
283
  *
284
- * @summary Search for symbols that are supported by a brokerage account using a substring
284
+ * @summary Search for symbols available in an account
285
285
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
286
286
  * @param {*} [options] Override http request option.
287
287
  * @throws {RequiredError}
@@ -398,7 +398,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
398
398
  getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
399
399
  /**
400
400
  *
401
- * @summary Return list of stock exchanges on Passiv and their suffixes
401
+ * @summary List exchanges
402
402
  * @param {*} [options] Override http request option.
403
403
  * @throws {RequiredError}
404
404
  * @memberof ReferenceDataApiGenerated
@@ -433,7 +433,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
433
433
  listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
434
434
  /**
435
435
  *
436
- * @summary List of all brokerages.
436
+ * @summary List brokerages
437
437
  * @param {*} [options] Override http request option.
438
438
  * @throws {RequiredError}
439
439
  * @memberof ReferenceDataApiGenerated
@@ -441,7 +441,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
441
441
  listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
442
442
  /**
443
443
  *
444
- * @summary List of all supported currencies
444
+ * @summary List currencies
445
445
  * @param {*} [options] Override http request option.
446
446
  * @throws {RequiredError}
447
447
  * @memberof ReferenceDataApiGenerated
@@ -449,7 +449,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
449
449
  listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
450
450
  /**
451
451
  *
452
- * @summary Return the exchange rates of all supported currencies
452
+ * @summary List currency exchange rates
453
453
  * @param {*} [options] Override http request option.
454
454
  * @throws {RequiredError}
455
455
  * @memberof ReferenceDataApiGenerated
@@ -457,7 +457,7 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
457
457
  listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
458
458
  /**
459
459
  *
460
- * @summary Search for symbols that are supported by a brokerage account using a substring
460
+ * @summary Search for symbols available in an account
461
461
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
462
462
  * @param {*} [options] Override http request option.
463
463
  * @throws {RequiredError}
package/dist/api/reference-data-api-generated.js CHANGED
@@ -152,7 +152,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
152
152
  }),
153
153
  /**
154
154
  *
155
- * @summary Return list of stock exchanges on Passiv and their suffixes
155
+ * @summary List exchanges
156
156
  * @param {*} [options] Override http request option.
157
157
  * @throws {RequiredError}
158
158
  */
@@ -316,7 +316,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
316
316
  }),
317
317
  /**
318
318
  *
319
- * @summary List of all brokerages.
319
+ * @summary List brokerages
320
320
  * @param {*} [options] Override http request option.
321
321
  * @throws {RequiredError}
322
322
  */
@@ -353,7 +353,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
353
353
  }),
354
354
  /**
355
355
  *
356
- * @summary List of all supported currencies
356
+ * @summary List currencies
357
357
  * @param {*} [options] Override http request option.
358
358
  * @throws {RequiredError}
359
359
  */
@@ -390,7 +390,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
390
390
  }),
391
391
  /**
392
392
  *
393
- * @summary Return the exchange rates of all supported currencies
393
+ * @summary List currency exchange rates
394
394
  * @param {*} [options] Override http request option.
395
395
  * @throws {RequiredError}
396
396
  */
@@ -427,7 +427,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
427
427
  }),
428
428
  /**
429
429
  *
430
- * @summary Search for symbols that are supported by a brokerage account using a substring
430
+ * @summary Search for symbols available in an account
431
431
  * @param {string} userId
432
432
  * @param {string} userSecret
433
433
  * @param {string} accountId The ID of the account get positions.
@@ -531,7 +531,7 @@ const ReferenceDataApiFp = function (configuration) {
531
531
  },
532
532
  /**
533
533
  *
534
- * @summary Return list of stock exchanges on Passiv and their suffixes
534
+ * @summary List exchanges
535
535
  * @param {*} [options] Override http request option.
536
536
  * @throws {RequiredError}
537
537
  */
@@ -582,7 +582,7 @@ const ReferenceDataApiFp = function (configuration) {
582
582
  },
583
583
  /**
584
584
  *
585
- * @summary List of all brokerages.
585
+ * @summary List brokerages
586
586
  * @param {*} [options] Override http request option.
587
587
  * @throws {RequiredError}
588
588
  */
@@ -594,7 +594,7 @@ const ReferenceDataApiFp = function (configuration) {
594
594
  },
595
595
  /**
596
596
  *
597
- * @summary List of all supported currencies
597
+ * @summary List currencies
598
598
  * @param {*} [options] Override http request option.
599
599
  * @throws {RequiredError}
600
600
  */
@@ -606,7 +606,7 @@ const ReferenceDataApiFp = function (configuration) {
606
606
  },
607
607
  /**
608
608
  *
609
- * @summary Return the exchange rates of all supported currencies
609
+ * @summary List currency exchange rates
610
610
  * @param {*} [options] Override http request option.
611
611
  * @throws {RequiredError}
612
612
  */
@@ -618,7 +618,7 @@ const ReferenceDataApiFp = function (configuration) {
618
618
  },
619
619
  /**
620
620
  *
621
- * @summary Search for symbols that are supported by a brokerage account using a substring
621
+ * @summary Search for symbols available in an account
622
622
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
623
623
  * @param {*} [options] Override http request option.
624
624
  * @throws {RequiredError}
@@ -669,7 +669,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
669
669
  },
670
670
  /**
671
671
  *
672
- * @summary Return list of stock exchanges on Passiv and their suffixes
672
+ * @summary List exchanges
673
673
  * @param {*} [options] Override http request option.
674
674
  * @throws {RequiredError}
675
675
  */
@@ -708,7 +708,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
708
708
  },
709
709
  /**
710
710
  *
711
- * @summary List of all brokerages.
711
+ * @summary List brokerages
712
712
  * @param {*} [options] Override http request option.
713
713
  * @throws {RequiredError}
714
714
  */
@@ -717,7 +717,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
717
717
  },
718
718
  /**
719
719
  *
720
- * @summary List of all supported currencies
720
+ * @summary List currencies
721
721
  * @param {*} [options] Override http request option.
722
722
  * @throws {RequiredError}
723
723
  */
@@ -726,7 +726,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
726
726
  },
727
727
  /**
728
728
  *
729
- * @summary Return the exchange rates of all supported currencies
729
+ * @summary List currency exchange rates
730
730
  * @param {*} [options] Override http request option.
731
731
  * @throws {RequiredError}
732
732
  */
@@ -735,7 +735,7 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
735
735
  },
736
736
  /**
737
737
  *
738
- * @summary Search for symbols that are supported by a brokerage account using a substring
738
+ * @summary Search for symbols available in an account
739
739
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
740
740
  * @param {*} [options] Override http request option.
741
741
  * @throws {RequiredError}
@@ -786,7 +786,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
786
786
  }
787
787
  /**
788
788
  *
789
- * @summary Return list of stock exchanges on Passiv and their suffixes
789
+ * @summary List exchanges
790
790
  * @param {*} [options] Override http request option.
791
791
  * @throws {RequiredError}
792
792
  * @memberof ReferenceDataApiGenerated
@@ -829,7 +829,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
829
829
  }
830
830
  /**
831
831
  *
832
- * @summary List of all brokerages.
832
+ * @summary List brokerages
833
833
  * @param {*} [options] Override http request option.
834
834
  * @throws {RequiredError}
835
835
  * @memberof ReferenceDataApiGenerated
@@ -839,7 +839,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
839
839
  }
840
840
  /**
841
841
  *
842
- * @summary List of all supported currencies
842
+ * @summary List currencies
843
843
  * @param {*} [options] Override http request option.
844
844
  * @throws {RequiredError}
845
845
  * @memberof ReferenceDataApiGenerated
@@ -849,7 +849,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
849
849
  }
850
850
  /**
851
851
  *
852
- * @summary Return the exchange rates of all supported currencies
852
+ * @summary List currency exchange rates
853
853
  * @param {*} [options] Override http request option.
854
854
  * @throws {RequiredError}
855
855
  * @memberof ReferenceDataApiGenerated
@@ -859,7 +859,7 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
859
859
  }
860
860
  /**
861
861
  *
862
- * @summary Search for symbols that are supported by a brokerage account using a substring
862
+ * @summary Search for symbols available in an account
863
863
  * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
864
864
  * @param {*} [options] Override http request option.
865
865
  * @throws {RequiredError}
package/dist/configuration.js CHANGED
@@ -32,7 +32,7 @@ class Configuration {
32
32
  this.accessToken = param.accessToken;
33
33
  this.basePath = param.basePath;
34
34
  this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
35
- this.userAgent = param.userAgent === undefined ? "Konfig/8.20.0/typescript" : param.userAgent;
35
+ this.userAgent = param.userAgent === undefined ? "Konfig/8.21.0/typescript" : param.userAgent;
36
36
  this.formDataCtor = param.formDataCtor;
37
37
  }
38
38
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "snaptrade-typescript-sdk",
3
- "version": "8.20.0",
3
+ "version": "8.21.0",
4
4
  "description": "Client for SnapTrade",
5
5
  "author": "Konfig",
6
6
  "engines": {