snaptrade-typescript-sdk 9.0.29 → 9.0.31

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.29-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.29)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.31-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.31)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -28,7 +28,6 @@ Connect brokerage accounts to your app for live positions and trading
28
28
  * [`snaptrade.accountInformation.updateUserAccount`](#snaptradeaccountinformationupdateuseraccount)
29
29
  * [`snaptrade.apiStatus.check`](#snaptradeapistatuscheck)
30
30
  * [`snaptrade.authentication.deleteSnapTradeUser`](#snaptradeauthenticationdeletesnaptradeuser)
31
- * [`snaptrade.authentication.getUserJWT`](#snaptradeauthenticationgetuserjwt)
32
31
  * [`snaptrade.authentication.listSnapTradeUsers`](#snaptradeauthenticationlistsnaptradeusers)
33
32
  * [`snaptrade.authentication.loginSnapTradeUser`](#snaptradeauthenticationloginsnaptradeuser)
34
33
  * [`snaptrade.authentication.registerSnapTradeUser`](#snaptradeauthenticationregistersnaptradeuser)
@@ -181,8 +180,10 @@ main();
181
180
  ### `snaptrade.accountInformation.getAllUserHoldings`<a id="snaptradeaccountinformationgetalluserholdings"></a>
182
181
  ![Deprecated](https://img.shields.io/badge/deprecated-yellow)
183
182
 
184
- Lists balances, positions and orders for the specified account. The data returned is similar to
185
- the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
183
+ **Deprecated, please use the account-specific holdings endpoint instead.**
184
+
185
+ List all accounts for the user, plus balances, positions, and orders for each
186
+ account.
186
187
 
187
188
 
188
189
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -548,40 +549,6 @@ const deleteSnapTradeUserResponse =
548
549
  ---
549
550
 
550
551
 
551
- ### `snaptrade.authentication.getUserJWT`<a id="snaptradeauthenticationgetuserjwt"></a>
552
-
553
- This API is available to ClientIDs which have opted to use encrypted
554
- JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
555
-
556
-
557
- #### 🛠️ Usage<a id="🛠️-usage"></a>
558
-
559
- ```typescript
560
- const getUserJWTResponse = await snaptrade.authentication.getUserJWT({
561
- userId: "snaptrade-user-123",
562
- userSecret: "USERSECRET123",
563
- });
564
- ```
565
-
566
- #### ⚙️ Parameters<a id="⚙️-parameters"></a>
567
-
568
- ##### userId: `string`<a id="userid-string"></a>
569
-
570
- ##### userSecret: `string`<a id="usersecret-string"></a>
571
-
572
- #### 🔄 Return<a id="🔄-return"></a>
573
-
574
- [EncryptedResponse](./models/encrypted-response.ts)
575
-
576
- #### 🌐 Endpoint<a id="🌐-endpoint"></a>
577
-
578
- `/snapTrade/encryptedJWT` `GET`
579
-
580
- [🔙 **Back to Table of Contents**](#table-of-contents)
581
-
582
- ---
583
-
584
-
585
552
  ### `snaptrade.authentication.listSnapTradeUsers`<a id="snaptradeauthenticationlistsnaptradeusers"></a>
586
553
 
587
554
  Returns a list of users you've registered over the SnapTrade API.
@@ -630,7 +597,7 @@ const loginSnapTradeUserResponse =
630
597
 
631
598
  ##### broker: `string`<a id="broker-string"></a>
632
599
 
633
- Slug of the brokerage to connect the user to
600
+ Slug of the brokerage to connect the user to. See [this document](https://snaptrade.notion.site/SnapTrade-Brokerage-Integrations-f83946a714a84c3caf599f6a945f0ead) for a list of supported brokerages and their slugs.
634
601
 
635
602
  ##### immediateRedirect: `boolean`<a id="immediateredirect-boolean"></a>
636
603
 
@@ -650,7 +617,7 @@ Sets whether the connection should be read or trade
650
617
 
651
618
  ##### connectionPortalVersion: `string`<a id="connectionportalversion-string"></a>
652
619
 
653
- Sets the version of the connection portal to render, with a default to \\\'v2\\\'
620
+ Sets the version of the connection portal to render, with a default to \\\'v3\\\'
654
621
 
655
622
  #### 🔄 Return<a id="🔄-return"></a>
656
623
 
@@ -667,8 +634,8 @@ Sets the version of the connection portal to render, with a default to \\\'v2\\\
667
634
 
668
635
  ### `snaptrade.authentication.registerSnapTradeUser`<a id="snaptradeauthenticationregistersnaptradeuser"></a>
669
636
 
670
- Registers a new SnapTrade user under your ClientID.
671
- Most SnapTrade operations require a user to be passed as a parameter.
637
+ Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database.
638
+ Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
672
639
 
673
640
 
674
641
  #### 🛠️ Usage<a id="🛠️-usage"></a>
@@ -849,7 +816,7 @@ const listBrokerageAuthorizationsResponse =
849
816
 
850
817
  ### `snaptrade.connections.refreshBrokerageAuthorization`<a id="snaptradeconnectionsrefreshbrokerageauthorization"></a>
851
818
 
852
- Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
819
+ Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
853
820
 
854
821
  #### 🛠️ Usage<a id="🛠️-usage"></a>
855
822
 
@@ -1623,7 +1590,7 @@ Trade time in force examples: * FOK - Fill Or Kill * Day - Day * GTC - Goo
1623
1590
 
1624
1591
  ### `snaptrade.trading.getUserAccountQuotes`<a id="snaptradetradinggetuseraccountquotes"></a>
1625
1592
 
1626
- Returns live quote(s) from the brokerage for the specified symbol(s).
1593
+ Returns quote(s) from the brokerage for the specified symbol(s).
1627
1594
 
1628
1595
  #### 🛠️ Usage<a id="🛠️-usage"></a>
1629
1596
 
@@ -13,7 +13,7 @@ import { Position } from '../models';
13
13
  */
14
14
  export declare const AccountInformationApiAxiosParamCreator: (configuration?: Configuration) => {
15
15
  /**
16
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
16
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
17
17
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
18
18
  * @param {string} userId
19
19
  * @param {string} userSecret
@@ -101,7 +101,7 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
101
101
  */
102
102
  export declare const AccountInformationApiFp: (configuration?: Configuration) => {
103
103
  /**
104
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
104
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
105
105
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
106
106
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
107
107
  * @param {*} [options] Override http request option.
@@ -172,7 +172,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
172
172
  */
173
173
  export declare const AccountInformationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
174
174
  /**
175
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
175
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
176
176
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
177
177
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
178
178
  * @param {*} [options] Override http request option.
@@ -451,7 +451,7 @@ export type AccountInformationApiUpdateUserAccountRequest = {
451
451
  */
452
452
  export declare class AccountInformationApiGenerated extends BaseAPI {
453
453
  /**
454
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
454
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
455
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.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const AccountInformationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
39
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
40
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
@@ -491,7 +491,7 @@ const AccountInformationApiFp = function (configuration) {
491
491
  const localVarAxiosParamCreator = (0, exports.AccountInformationApiAxiosParamCreator)(configuration);
492
492
  return {
493
493
  /**
494
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
494
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
495
495
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
496
496
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
497
497
  * @param {*} [options] Override http request option.
@@ -606,7 +606,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
606
606
  const localVarFp = (0, exports.AccountInformationApiFp)(configuration);
607
607
  return {
608
608
  /**
609
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
609
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
610
610
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
611
611
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
612
612
  * @param {*} [options] Override http request option.
@@ -697,7 +697,7 @@ exports.AccountInformationApiFactory = AccountInformationApiFactory;
697
697
  */
698
698
  class AccountInformationApiGenerated extends base_1.BaseAPI {
699
699
  /**
700
- * Lists balances, positions and orders for the specified account. The data returned is similar to the data returned over the more fine-grained **positions**, **orders** and **balances** endpoints.
700
+ * **Deprecated, please use the account-specific holdings endpoint instead.** List all accounts for the user, plus balances, positions, and orders for each account.
701
701
  * @summary List all accounts for the user, plus balances, positions, and orders for each account.
702
702
  * @param {AccountInformationApiGetAllUserHoldingsRequest} requestParameters Request parameters.
703
703
  * @param {*} [options] Override http request option.
@@ -3,7 +3,6 @@ import { Configuration } from '../configuration';
3
3
  import { RequestArgs, BaseAPI } from '../base';
4
4
  import { AuthenticationLoginSnapTradeUser200Response } from '../models';
5
5
  import { DeleteUserResponse } from '../models';
6
- import { EncryptedResponse } from '../models';
7
6
  import { SnapTradeLoginUserRequestBody } from '../models';
8
7
  import { SnapTradeRegisterUserRequestBody } from '../models';
9
8
  import { UserIDandSecret } from '../models';
@@ -20,15 +19,6 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
20
19
  * @throws {RequiredError}
21
20
  */
22
21
  deleteSnapTradeUser: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
23
- /**
24
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
25
- * @summary Generate encrypted JWT token
26
- * @param {string} userId
27
- * @param {string} userSecret
28
- * @param {*} [options] Override http request option.
29
- * @throws {RequiredError}
30
- */
31
- getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
22
  /**
33
23
  * Returns a list of users you\'ve registered over the SnapTrade API.
34
24
  * @summary List SnapTrade users
@@ -47,7 +37,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
47
37
  */
48
38
  loginSnapTradeUser: (userId: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
39
  /**
50
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
40
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
51
41
  * @summary Create SnapTrade user
52
42
  * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
53
43
  * @param {*} [options] Override http request option.
@@ -76,14 +66,6 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
76
66
  * @throws {RequiredError}
77
67
  */
78
68
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
79
- /**
80
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
81
- * @summary Generate encrypted JWT token
82
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
83
- * @param {*} [options] Override http request option.
84
- * @throws {RequiredError}
85
- */
86
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
87
69
  /**
88
70
  * Returns a list of users you\'ve registered over the SnapTrade API.
89
71
  * @summary List SnapTrade users
@@ -100,7 +82,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
100
82
  */
101
83
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
102
84
  /**
103
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
85
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
104
86
  * @summary Create SnapTrade user
105
87
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
106
88
  * @param {*} [options] Override http request option.
@@ -129,14 +111,6 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
129
111
  * @throws {RequiredError}
130
112
  */
131
113
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
132
- /**
133
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
134
- * @summary Generate encrypted JWT token
135
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
136
- * @param {*} [options] Override http request option.
137
- * @throws {RequiredError}
138
- */
139
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
140
114
  /**
141
115
  * Returns a list of users you\'ve registered over the SnapTrade API.
142
116
  * @summary List SnapTrade users
@@ -153,7 +127,7 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
153
127
  */
154
128
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
155
129
  /**
156
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
130
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
157
131
  * @summary Create SnapTrade user
158
132
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
159
133
  * @param {*} [options] Override http request option.
@@ -182,25 +156,6 @@ export type AuthenticationApiDeleteSnapTradeUserRequest = {
182
156
  */
183
157
  readonly userId: string;
184
158
  };
185
- /**
186
- * Request parameters for getUserJWT operation in AuthenticationApi.
187
- * @export
188
- * @interface AuthenticationApiGetUserJWTRequest
189
- */
190
- export type AuthenticationApiGetUserJWTRequest = {
191
- /**
192
- *
193
- * @type {string}
194
- * @memberof AuthenticationApiGetUserJWT
195
- */
196
- readonly userId: string;
197
- /**
198
- *
199
- * @type {string}
200
- * @memberof AuthenticationApiGetUserJWT
201
- */
202
- readonly userSecret: string;
203
- };
204
159
  /**
205
160
  * Request parameters for loginSnapTradeUser operation in AuthenticationApi.
206
161
  * @export
@@ -248,15 +203,6 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
248
203
  * @memberof AuthenticationApiGenerated
249
204
  */
250
205
  deleteSnapTradeUser(requestParameters: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
251
- /**
252
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
253
- * @summary Generate encrypted JWT token
254
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
255
- * @param {*} [options] Override http request option.
256
- * @throws {RequiredError}
257
- * @memberof AuthenticationApiGenerated
258
- */
259
- getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
260
206
  /**
261
207
  * Returns a list of users you\'ve registered over the SnapTrade API.
262
208
  * @summary List SnapTrade users
@@ -275,7 +221,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
275
221
  */
276
222
  loginSnapTradeUser(requestParameters: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
277
223
  /**
278
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
224
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
279
225
  * @summary Create SnapTrade user
280
226
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
281
227
  * @param {*} [options] Override http request option.
@@ -80,57 +80,6 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
80
80
  options: localVarRequestOptions,
81
81
  };
82
82
  }),
83
- /**
84
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
85
- * @summary Generate encrypted JWT token
86
- * @param {string} userId
87
- * @param {string} userSecret
88
- * @param {*} [options] Override http request option.
89
- * @throws {RequiredError}
90
- */
91
- getUserJWT: (userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
92
- // verify required parameter 'userId' is not null or undefined
93
- (0, common_1.assertParamExists)('getUserJWT', 'userId', userId);
94
- // verify required parameter 'userSecret' is not null or undefined
95
- (0, common_1.assertParamExists)('getUserJWT', 'userSecret', userSecret);
96
- const localVarPath = `/snapTrade/encryptedJWT`;
97
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
98
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
99
- let baseOptions;
100
- if (configuration) {
101
- baseOptions = configuration.baseOptions;
102
- }
103
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
104
- const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
105
- const localVarQueryParameter = {};
106
- // authentication PartnerClientId required
107
- yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
108
- // authentication PartnerSignature required
109
- yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
110
- // authentication PartnerTimestamp required
111
- yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
112
- if (userId !== undefined) {
113
- localVarQueryParameter['userId'] = userId;
114
- }
115
- if (userSecret !== undefined) {
116
- localVarQueryParameter['userSecret'] = userSecret;
117
- }
118
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
119
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
120
- (0, requestBeforeHook_1.requestBeforeHook)({
121
- queryParameters: localVarQueryParameter,
122
- requestConfig: localVarRequestOptions,
123
- path: localVarPath,
124
- configuration,
125
- pathTemplate: '/snapTrade/encryptedJWT',
126
- httpMethod: 'GET'
127
- });
128
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
129
- return {
130
- url: (0, common_1.toPathString)(localVarUrlObj),
131
- options: localVarRequestOptions,
132
- };
133
- }),
134
83
  /**
135
84
  * Returns a list of users you\'ve registered over the SnapTrade API.
136
85
  * @summary List SnapTrade users
@@ -226,7 +175,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
226
175
  };
227
176
  }),
228
177
  /**
229
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
178
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
230
179
  * @summary Create SnapTrade user
231
180
  * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
232
181
  * @param {*} [options] Override http request option.
@@ -338,19 +287,6 @@ const AuthenticationApiFp = function (configuration) {
338
287
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
339
288
  });
340
289
  },
341
- /**
342
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
343
- * @summary Generate encrypted JWT token
344
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
345
- * @param {*} [options] Override http request option.
346
- * @throws {RequiredError}
347
- */
348
- getUserJWT(requestParameters, options) {
349
- return __awaiter(this, void 0, void 0, function* () {
350
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserJWT(requestParameters.userId, requestParameters.userSecret, options);
351
- return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
352
- });
353
- },
354
290
  /**
355
291
  * Returns a list of users you\'ve registered over the SnapTrade API.
356
292
  * @summary List SnapTrade users
@@ -385,7 +321,7 @@ const AuthenticationApiFp = function (configuration) {
385
321
  });
386
322
  },
387
323
  /**
388
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
324
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
389
325
  * @summary Create SnapTrade user
390
326
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
391
327
  * @param {*} [options] Override http request option.
@@ -437,16 +373,6 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
437
373
  deleteSnapTradeUser(requestParameters, options) {
438
374
  return localVarFp.deleteSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
439
375
  },
440
- /**
441
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
442
- * @summary Generate encrypted JWT token
443
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
444
- * @param {*} [options] Override http request option.
445
- * @throws {RequiredError}
446
- */
447
- getUserJWT(requestParameters, options) {
448
- return localVarFp.getUserJWT(requestParameters, options).then((request) => request(axios, basePath));
449
- },
450
376
  /**
451
377
  * Returns a list of users you\'ve registered over the SnapTrade API.
452
378
  * @summary List SnapTrade users
@@ -467,7 +393,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
467
393
  return localVarFp.loginSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
468
394
  },
469
395
  /**
470
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
396
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
471
397
  * @summary Create SnapTrade user
472
398
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
473
399
  * @param {*} [options] Override http request option.
@@ -507,17 +433,6 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
507
433
  deleteSnapTradeUser(requestParameters, options) {
508
434
  return (0, exports.AuthenticationApiFp)(this.configuration).deleteSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
509
435
  }
510
- /**
511
- * This API is available to ClientIDs which have opted to use encrypted JWTs (JSON Web Tokens) instead of standard SnapTrade signature verification.
512
- * @summary Generate encrypted JWT token
513
- * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
514
- * @param {*} [options] Override http request option.
515
- * @throws {RequiredError}
516
- * @memberof AuthenticationApiGenerated
517
- */
518
- getUserJWT(requestParameters, options) {
519
- return (0, exports.AuthenticationApiFp)(this.configuration).getUserJWT(requestParameters, options).then((request) => request(this.axios, this.basePath));
520
- }
521
436
  /**
522
437
  * Returns a list of users you\'ve registered over the SnapTrade API.
523
438
  * @summary List SnapTrade users
@@ -540,7 +455,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
540
455
  return (0, exports.AuthenticationApiFp)(this.configuration).loginSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
541
456
  }
542
457
  /**
543
- * Registers a new SnapTrade user under your ClientID. Most SnapTrade operations require a user to be passed as a parameter.
458
+ * Registers a new SnapTrade user under your ClientID. A user secret will be automatically generated for you and must be properly stored in your database. Most SnapTrade operations require a user ID and user secret to be passed as a parameter.
544
459
  * @summary Create SnapTrade user
545
460
  * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
546
461
  * @param {*} [options] Override http request option.
@@ -40,7 +40,7 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
40
40
  */
41
41
  listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
42
  /**
43
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
43
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
44
44
  * @summary Refresh holdings for a connection
45
45
  * @param {string} authorizationId The ID of a brokerage authorization object.
46
46
  * @param {string} userId
@@ -100,7 +100,7 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
100
100
  */
101
101
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
102
102
  /**
103
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
103
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
104
104
  * @summary Refresh holdings for a connection
105
105
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
106
106
  * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
154
154
  */
155
155
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
156
156
  /**
157
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
157
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
158
158
  * @summary Refresh holdings for a connection
159
159
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
160
160
  * @param {*} [options] Override http request option.
@@ -357,7 +357,7 @@ export declare class ConnectionsApiGenerated extends BaseAPI {
357
357
  */
358
358
  listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
359
359
  /**
360
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
360
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
361
361
  * @summary Refresh holdings for a connection
362
362
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
363
363
  * @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 authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
200
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. 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 The ID of a brokerage authorization object.
203
203
  * @param {string} userId
@@ -409,7 +409,7 @@ const ConnectionsApiFp = function (configuration) {
409
409
  });
410
410
  },
411
411
  /**
412
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
412
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. 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.
@@ -488,7 +488,7 @@ const ConnectionsApiFactory = function (configuration, basePath, axios) {
488
488
  return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
489
489
  },
490
490
  /**
491
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
491
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
492
492
  * @summary Refresh holdings for a connection
493
493
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
494
494
  * @param {*} [options] Override http request option.
@@ -561,7 +561,7 @@ class ConnectionsApiGenerated extends base_1.BaseAPI {
561
561
  return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
562
562
  }
563
563
  /**
564
- * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes
564
+ * Trigger a holdings update for all accounts under this authorization. Updates will be queued asynchronously. ACCOUNT_HOLDINGS_UPDATED webhook will be sent once the sync completes. Please contact support for access as this endpoint is not enabled by default
565
565
  * @summary Refresh holdings for a connection
566
566
  * @param {ConnectionsApiRefreshBrokerageAuthorizationRequest} requestParameters Request parameters.
567
567
  * @param {*} [options] Override http request option.
@@ -34,7 +34,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
34
34
  */
35
35
  getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
- * Returns live quote(s) from the brokerage for the specified symbol(s).
37
+ * Returns quote(s) from the brokerage for the specified symbol(s).
38
38
  * @summary Get symbol quotes
39
39
  * @param {string} userId
40
40
  * @param {string} userSecret
@@ -89,7 +89,7 @@ export declare const TradingApiFp: (configuration?: Configuration) => {
89
89
  */
90
90
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
91
91
  /**
92
- * Returns live quote(s) from the brokerage for the specified symbol(s).
92
+ * Returns quote(s) from the brokerage for the specified symbol(s).
93
93
  * @summary Get symbol quotes
94
94
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
95
95
  * @param {*} [options] Override http request option.
@@ -135,7 +135,7 @@ export declare const TradingApiFactory: (configuration?: Configuration, basePath
135
135
  */
136
136
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
137
137
  /**
138
- * Returns live quote(s) from the brokerage for the specified symbol(s).
138
+ * Returns quote(s) from the brokerage for the specified symbol(s).
139
139
  * @summary Get symbol quotes
140
140
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
141
141
  * @param {*} [options] Override http request option.
@@ -310,7 +310,7 @@ export declare class TradingApiGenerated extends BaseAPI {
310
310
  */
311
311
  getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
312
312
  /**
313
- * Returns live quote(s) from the brokerage for the specified symbol(s).
313
+ * Returns quote(s) from the brokerage for the specified symbol(s).
314
314
  * @summary Get symbol quotes
315
315
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
316
316
  * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
154
154
  };
155
155
  }),
156
156
  /**
157
- * Returns live quote(s) from the brokerage for the specified symbol(s).
157
+ * Returns quote(s) from the brokerage for the specified symbol(s).
158
158
  * @summary Get symbol quotes
159
159
  * @param {string} userId
160
160
  * @param {string} userSecret
@@ -385,7 +385,7 @@ const TradingApiFp = function (configuration) {
385
385
  });
386
386
  },
387
387
  /**
388
- * Returns live quote(s) from the brokerage for the specified symbol(s).
388
+ * Returns quote(s) from the brokerage for the specified symbol(s).
389
389
  * @summary Get symbol quotes
390
390
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
391
391
  * @param {*} [options] Override http request option.
@@ -468,7 +468,7 @@ const TradingApiFactory = function (configuration, basePath, axios) {
468
468
  return localVarFp.getOrderImpact(requestParameters, options).then((request) => request(axios, basePath));
469
469
  },
470
470
  /**
471
- * Returns live quote(s) from the brokerage for the specified symbol(s).
471
+ * Returns quote(s) from the brokerage for the specified symbol(s).
472
472
  * @summary Get symbol quotes
473
473
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
474
474
  * @param {*} [options] Override http request option.
@@ -530,7 +530,7 @@ class TradingApiGenerated extends base_1.BaseAPI {
530
530
  return (0, exports.TradingApiFp)(this.configuration).getOrderImpact(requestParameters, options).then((request) => request(this.axios, this.basePath));
531
531
  }
532
532
  /**
533
- * Returns live quote(s) from the brokerage for the specified symbol(s).
533
+ * Returns quote(s) from the brokerage for the specified symbol(s).
534
534
  * @summary Get symbol quotes
535
535
  * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
536
536
  * @param {*} [options] Override http request option.