snaptrade-typescript-sdk 8.29.0 → 8.29.2

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.
@@ -24,11 +24,11 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
24
24
  */
25
25
  getAllUserHoldings: (userId: string, userSecret: string, brokerageAuthorizations?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
26
26
  /**
27
- *
27
+ * A list of account balances for the specified account (one per currency that the account holds).
28
28
  * @summary List account balances
29
29
  * @param {string} userId
30
30
  * @param {string} userSecret
31
- * @param {string} accountId The ID of the account get positions.
31
+ * @param {string} accountId The ID of the account to get balances.
32
32
  * @param {*} [options] Override http request option.
33
33
  * @throws {RequiredError}
34
34
  */
@@ -44,11 +44,11 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
44
44
  */
45
45
  getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
46
  /**
47
- *
47
+ * Fetch all recent orders from a user\'s account.
48
48
  * @summary Get history of orders placed in account
49
49
  * @param {string} userId
50
50
  * @param {string} userSecret
51
- * @param {string} accountId The ID of the account get positions.
51
+ * @param {string} accountId The ID of the account to get orders.
52
52
  * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \&quot;all\&quot;
53
53
  * @param {*} [options] Override http request option.
54
54
  * @throws {RequiredError}
@@ -59,14 +59,14 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
59
59
  * @summary List account positions
60
60
  * @param {string} userId
61
61
  * @param {string} userSecret
62
- * @param {string} accountId The ID of the account get positions.
62
+ * @param {string} accountId The ID of the account to get positions.
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
65
65
  */
66
66
  getUserAccountPositions: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
67
  /**
68
68
  *
69
- * @summary List balances, positions and orders for the specified account.
69
+ * @summary List balances, positions and orders for the specified account
70
70
  * @param {string} accountId The ID of the account to fetch holdings for.
71
71
  * @param {string} userId
72
72
  * @param {string} userSecret
@@ -109,7 +109,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
109
109
  */
110
110
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccountHoldings>>>;
111
111
  /**
112
- *
112
+ * A list of account balances for the specified account (one per currency that the account holds).
113
113
  * @summary List account balances
114
114
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
115
115
  * @param {*} [options] Override http request option.
@@ -125,7 +125,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
125
125
  */
126
126
  getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
127
127
  /**
128
- *
128
+ * Fetch all recent orders from a user\'s account.
129
129
  * @summary Get history of orders placed in account
130
130
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
131
131
  * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
142
142
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>;
143
143
  /**
144
144
  *
145
- * @summary List balances, positions and orders for the specified account.
145
+ * @summary List balances, positions and orders for the specified account
146
146
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
147
147
  * @param {*} [options] Override http request option.
148
148
  * @throws {RequiredError}
@@ -180,7 +180,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
180
180
  */
181
181
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AccountHoldings>>;
182
182
  /**
183
- *
183
+ * A list of account balances for the specified account (one per currency that the account holds).
184
184
  * @summary List account balances
185
185
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
186
186
  * @param {*} [options] Override http request option.
@@ -196,7 +196,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
196
196
  */
197
197
  getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
198
198
  /**
199
- *
199
+ * Fetch all recent orders from a user\'s account.
200
200
  * @summary Get history of orders placed in account
201
201
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
202
202
  * @param {*} [options] Override http request option.
@@ -213,7 +213,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
213
213
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<Position>>;
214
214
  /**
215
215
  *
216
- * @summary List balances, positions and orders for the specified account.
216
+ * @summary List balances, positions and orders for the specified account
217
217
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
218
218
  * @param {*} [options] Override http request option.
219
219
  * @throws {RequiredError}
@@ -280,7 +280,7 @@ export type AccountInformationApiGetUserAccountBalanceRequest = {
280
280
  */
281
281
  readonly userSecret: string;
282
282
  /**
283
- * The ID of the account get positions.
283
+ * The ID of the account to get balances.
284
284
  * @type {string}
285
285
  * @memberof AccountInformationApiGetUserAccountBalance
286
286
  */
@@ -330,7 +330,7 @@ export type AccountInformationApiGetUserAccountOrdersRequest = {
330
330
  */
331
331
  readonly userSecret: string;
332
332
  /**
333
- * The ID of the account get positions.
333
+ * The ID of the account to get orders.
334
334
  * @type {string}
335
335
  * @memberof AccountInformationApiGetUserAccountOrders
336
336
  */
@@ -361,7 +361,7 @@ export type AccountInformationApiGetUserAccountPositionsRequest = {
361
361
  */
362
362
  readonly userSecret: string;
363
363
  /**
364
- * The ID of the account get positions.
364
+ * The ID of the account to get positions.
365
365
  * @type {string}
366
366
  * @memberof AccountInformationApiGetUserAccountPositions
367
367
  */
@@ -454,7 +454,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
454
454
  */
455
455
  getAllUserHoldings(requestParameters: AccountInformationApiGetAllUserHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountHoldings[], any>>;
456
456
  /**
457
- *
457
+ * A list of account balances for the specified account (one per currency that the account holds).
458
458
  * @summary List account balances
459
459
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
460
460
  * @param {*} [options] Override http request option.
@@ -472,7 +472,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
472
472
  */
473
473
  getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
474
474
  /**
475
- *
475
+ * Fetch all recent orders from a user\'s account.
476
476
  * @summary Get history of orders placed in account
477
477
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
478
478
  * @param {*} [options] Override http request option.
@@ -491,7 +491,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
491
491
  getUserAccountPositions(requestParameters: AccountInformationApiGetUserAccountPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Position[], any>>;
492
492
  /**
493
493
  *
494
- * @summary List balances, positions and orders for the specified account.
494
+ * @summary List balances, positions and orders for the specified account
495
495
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
496
496
  * @param {*} [options] Override http request option.
497
497
  * @throws {RequiredError}
@@ -90,11 +90,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
90
90
  };
91
91
  }),
92
92
  /**
93
- *
93
+ * A list of account balances for the specified account (one per currency that the account holds).
94
94
  * @summary List account balances
95
95
  * @param {string} userId
96
96
  * @param {string} userSecret
97
- * @param {string} accountId The ID of the account get positions.
97
+ * @param {string} accountId The ID of the account to get balances.
98
98
  * @param {*} [options] Override http request option.
99
99
  * @throws {RequiredError}
100
100
  */
@@ -196,11 +196,11 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
196
196
  };
197
197
  }),
198
198
  /**
199
- *
199
+ * Fetch all recent orders from a user\'s account.
200
200
  * @summary Get history of orders placed in account
201
201
  * @param {string} userId
202
202
  * @param {string} userSecret
203
- * @param {string} accountId The ID of the account get positions.
203
+ * @param {string} accountId The ID of the account to get orders.
204
204
  * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \&quot;all\&quot;
205
205
  * @param {*} [options] Override http request option.
206
206
  * @throws {RequiredError}
@@ -257,7 +257,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
257
257
  * @summary List account positions
258
258
  * @param {string} userId
259
259
  * @param {string} userSecret
260
- * @param {string} accountId The ID of the account get positions.
260
+ * @param {string} accountId The ID of the account to get positions.
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
263
263
  */
@@ -307,7 +307,7 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
307
307
  }),
308
308
  /**
309
309
  *
310
- * @summary List balances, positions and orders for the specified account.
310
+ * @summary List balances, positions and orders for the specified account
311
311
  * @param {string} accountId The ID of the account to fetch holdings for.
312
312
  * @param {string} userId
313
313
  * @param {string} userSecret
@@ -485,7 +485,7 @@ const AccountInformationApiFp = function (configuration) {
485
485
  });
486
486
  },
487
487
  /**
488
- *
488
+ * A list of account balances for the specified account (one per currency that the account holds).
489
489
  * @summary List account balances
490
490
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
491
491
  * @param {*} [options] Override http request option.
@@ -511,7 +511,7 @@ const AccountInformationApiFp = function (configuration) {
511
511
  });
512
512
  },
513
513
  /**
514
- *
514
+ * Fetch all recent orders from a user\'s account.
515
515
  * @summary Get history of orders placed in account
516
516
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
517
517
  * @param {*} [options] Override http request option.
@@ -538,7 +538,7 @@ const AccountInformationApiFp = function (configuration) {
538
538
  },
539
539
  /**
540
540
  *
541
- * @summary List balances, positions and orders for the specified account.
541
+ * @summary List balances, positions and orders for the specified account
542
542
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
543
543
  * @param {*} [options] Override http request option.
544
544
  * @throws {RequiredError}
@@ -597,7 +597,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
597
597
  return localVarFp.getAllUserHoldings(requestParameters, options).then((request) => request(axios, basePath));
598
598
  },
599
599
  /**
600
- *
600
+ * A list of account balances for the specified account (one per currency that the account holds).
601
601
  * @summary List account balances
602
602
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
603
603
  * @param {*} [options] Override http request option.
@@ -617,7 +617,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
617
617
  return localVarFp.getUserAccountDetails(requestParameters, options).then((request) => request(axios, basePath));
618
618
  },
619
619
  /**
620
- *
620
+ * Fetch all recent orders from a user\'s account.
621
621
  * @summary Get history of orders placed in account
622
622
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
623
623
  * @param {*} [options] Override http request option.
@@ -638,7 +638,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
638
638
  },
639
639
  /**
640
640
  *
641
- * @summary List balances, positions and orders for the specified account.
641
+ * @summary List balances, positions and orders for the specified account
642
642
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
643
643
  * @param {*} [options] Override http request option.
644
644
  * @throws {RequiredError}
@@ -689,7 +689,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
689
689
  return (0, exports.AccountInformationApiFp)(this.configuration).getAllUserHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
690
690
  }
691
691
  /**
692
- *
692
+ * A list of account balances for the specified account (one per currency that the account holds).
693
693
  * @summary List account balances
694
694
  * @param {AccountInformationApiGetUserAccountBalanceRequest} requestParameters Request parameters.
695
695
  * @param {*} [options] Override http request option.
@@ -711,7 +711,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
711
711
  return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountDetails(requestParameters, options).then((request) => request(this.axios, this.basePath));
712
712
  }
713
713
  /**
714
- *
714
+ * Fetch all recent orders from a user\'s account.
715
715
  * @summary Get history of orders placed in account
716
716
  * @param {AccountInformationApiGetUserAccountOrdersRequest} requestParameters Request parameters.
717
717
  * @param {*} [options] Override http request option.
@@ -734,7 +734,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
734
734
  }
735
735
  /**
736
736
  *
737
- * @summary List balances, positions and orders for the specified account.
737
+ * @summary List balances, positions and orders for the specified account
738
738
  * @param {AccountInformationApiGetUserHoldingsRequest} requestParameters Request parameters.
739
739
  * @param {*} [options] Override http request option.
740
740
  * @throws {RequiredError}
@@ -13,7 +13,7 @@ import { UserIDandSecret } from '../models';
13
13
  */
14
14
  export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
15
15
  /**
16
- *
16
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
17
17
  * @summary Delete SnapTrade user
18
18
  * @param {string} userId
19
19
  * @param {*} [options] Override http request option.
@@ -30,14 +30,14 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
30
30
  */
31
31
  getUserJWT: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
32
  /**
33
- *
33
+ * Returns a list of users you\'ve registered over the SnapTrade API.
34
34
  * @summary List SnapTrade users
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
37
37
  */
38
38
  listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
39
39
  /**
40
- *
40
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
41
41
  * @summary Login user & generate connection link
42
42
  * @param {string} userId
43
43
  * @param {string} userSecret
@@ -61,7 +61,7 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
61
61
  */
62
62
  export declare const AuthenticationApiFp: (configuration?: Configuration) => {
63
63
  /**
64
- *
64
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
65
65
  * @summary Delete SnapTrade user
66
66
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
67
67
  * @param {*} [options] Override http request option.
@@ -77,14 +77,14 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
77
77
  */
78
78
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
79
79
  /**
80
- *
80
+ * Returns a list of users you\'ve registered over the SnapTrade API.
81
81
  * @summary List SnapTrade users
82
82
  * @param {*} [options] Override http request option.
83
83
  * @throws {RequiredError}
84
84
  */
85
85
  listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
86
86
  /**
87
- *
87
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
88
88
  * @summary Login user & generate connection link
89
89
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
90
90
  * @param {*} [options] Override http request option.
@@ -106,7 +106,7 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
106
106
  */
107
107
  export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
108
108
  /**
109
- *
109
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
110
110
  * @summary Delete SnapTrade user
111
111
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
112
112
  * @param {*} [options] Override http request option.
@@ -122,14 +122,14 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
122
122
  */
123
123
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
124
124
  /**
125
- *
125
+ * Returns a list of users you\'ve registered over the SnapTrade API.
126
126
  * @summary List SnapTrade users
127
127
  * @param {*} [options] Override http request option.
128
128
  * @throws {RequiredError}
129
129
  */
130
130
  listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
131
131
  /**
132
- *
132
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
133
133
  * @summary Login user & generate connection link
134
134
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
135
135
  * @param {*} [options] Override http request option.
@@ -210,7 +210,7 @@ export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegist
210
210
  */
211
211
  export declare class AuthenticationApiGenerated extends BaseAPI {
212
212
  /**
213
- *
213
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
214
214
  * @summary Delete SnapTrade user
215
215
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
216
216
  * @param {*} [options] Override http request option.
@@ -228,7 +228,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
228
228
  */
229
229
  getUserJWT(requestParameters: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
230
230
  /**
231
- *
231
+ * Returns a list of users you\'ve registered over the SnapTrade API.
232
232
  * @summary List SnapTrade users
233
233
  * @param {*} [options] Override http request option.
234
234
  * @throws {RequiredError}
@@ -236,7 +236,7 @@ export declare class AuthenticationApiGenerated extends BaseAPI {
236
236
  */
237
237
  listSnapTradeUsers(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
238
238
  /**
239
- *
239
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
240
240
  * @summary Login user & generate connection link
241
241
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
242
242
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const AuthenticationApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- *
39
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
40
40
  * @summary Delete SnapTrade user
41
41
  * @param {string} userId
42
42
  * @param {*} [options] Override http request option.
@@ -128,7 +128,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
128
128
  };
129
129
  }),
130
130
  /**
131
- *
131
+ * Returns a list of users you\'ve registered over the SnapTrade API.
132
132
  * @summary List SnapTrade users
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
@@ -165,7 +165,7 @@ const AuthenticationApiAxiosParamCreator = function (configuration) {
165
165
  };
166
166
  }),
167
167
  /**
168
- *
168
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
169
169
  * @summary Login user & generate connection link
170
170
  * @param {string} userId
171
171
  * @param {string} userSecret
@@ -271,7 +271,7 @@ const AuthenticationApiFp = function (configuration) {
271
271
  const localVarAxiosParamCreator = (0, exports.AuthenticationApiAxiosParamCreator)(configuration);
272
272
  return {
273
273
  /**
274
- *
274
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
275
275
  * @summary Delete SnapTrade user
276
276
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
277
277
  * @param {*} [options] Override http request option.
@@ -297,7 +297,7 @@ const AuthenticationApiFp = function (configuration) {
297
297
  });
298
298
  },
299
299
  /**
300
- *
300
+ * Returns a list of users you\'ve registered over the SnapTrade API.
301
301
  * @summary List SnapTrade users
302
302
  * @param {*} [options] Override http request option.
303
303
  * @throws {RequiredError}
@@ -309,7 +309,7 @@ const AuthenticationApiFp = function (configuration) {
309
309
  });
310
310
  },
311
311
  /**
312
- *
312
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
313
313
  * @summary Login user & generate connection link
314
314
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
315
315
  * @param {*} [options] Override http request option.
@@ -345,7 +345,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
345
345
  const localVarFp = (0, exports.AuthenticationApiFp)(configuration);
346
346
  return {
347
347
  /**
348
- *
348
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
349
349
  * @summary Delete SnapTrade user
350
350
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
351
351
  * @param {*} [options] Override http request option.
@@ -365,7 +365,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
365
365
  return localVarFp.getUserJWT(requestParameters, options).then((request) => request(axios, basePath));
366
366
  },
367
367
  /**
368
- *
368
+ * Returns a list of users you\'ve registered over the SnapTrade API.
369
369
  * @summary List SnapTrade users
370
370
  * @param {*} [options] Override http request option.
371
371
  * @throws {RequiredError}
@@ -374,7 +374,7 @@ const AuthenticationApiFactory = function (configuration, basePath, axios) {
374
374
  return localVarFp.listSnapTradeUsers(options).then((request) => request(axios, basePath));
375
375
  },
376
376
  /**
377
- *
377
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
378
378
  * @summary Login user & generate connection link
379
379
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
380
380
  * @param {*} [options] Override http request option.
@@ -404,7 +404,7 @@ exports.AuthenticationApiFactory = AuthenticationApiFactory;
404
404
  */
405
405
  class AuthenticationApiGenerated extends base_1.BaseAPI {
406
406
  /**
407
- *
407
+ * Deletes a user you\'ve registered over the SnapTrade API, and any data associated with them or their investment accounts.
408
408
  * @summary Delete SnapTrade user
409
409
  * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
410
410
  * @param {*} [options] Override http request option.
@@ -426,7 +426,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
426
426
  return (0, exports.AuthenticationApiFp)(this.configuration).getUserJWT(requestParameters, options).then((request) => request(this.axios, this.basePath));
427
427
  }
428
428
  /**
429
- *
429
+ * Returns a list of users you\'ve registered over the SnapTrade API.
430
430
  * @summary List SnapTrade users
431
431
  * @param {*} [options] Override http request option.
432
432
  * @throws {RequiredError}
@@ -436,7 +436,7 @@ class AuthenticationApiGenerated extends base_1.BaseAPI {
436
436
  return (0, exports.AuthenticationApiFp)(this.configuration).listSnapTradeUsers(options).then((request) => request(this.axios, this.basePath));
437
437
  }
438
438
  /**
439
- *
439
+ * Logs in a SnapTrade user and returns an authenticated connection portal URL for them to use to connect a brokerage account.
440
440
  * @summary Login user & generate connection link
441
441
  * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
442
442
  * @param {*} [options] Override http request option.
@@ -17,7 +17,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
17
17
  * @summary Creates an option strategy object that will be used to place an option strategy order
18
18
  * @param {string} userId
19
19
  * @param {string} userSecret
20
- * @param {string} accountId The ID of the account get positions.
20
+ * @param {string} accountId The ID of the account to create the option strategy object in.
21
21
  * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
22
22
  * @param {*} [options] Override http request option.
23
23
  * @throws {RequiredError}
@@ -28,7 +28,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
28
28
  * @summary Get the options chain
29
29
  * @param {string} userId
30
30
  * @param {string} userSecret
31
- * @param {string} accountId The ID of the account get positions.
31
+ * @param {string} accountId The ID of the account to get the options chain from.
32
32
  * @param {string} symbol Universal symbol ID if symbol
33
33
  * @param {*} [options] Override http request option.
34
34
  * @throws {RequiredError}
@@ -39,7 +39,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
39
39
  * @summary Get latest market data of option strategy
40
40
  * @param {string} userId
41
41
  * @param {string} userSecret
42
- * @param {string} accountId The ID of the account get positions.
42
+ * @param {string} accountId The ID of the account the strategy will be placed in.
43
43
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
44
44
  * @param {*} [options] Override http request option.
45
45
  * @throws {RequiredError}
@@ -50,7 +50,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
50
50
  * @summary Get the options holdings in the account
51
51
  * @param {string} userId
52
52
  * @param {string} userSecret
53
- * @param {string} accountId The ID of the account get positions.
53
+ * @param {string} accountId The ID of the account to fetch options holdings for.
54
54
  * @param {*} [options] Override http request option.
55
55
  * @throws {RequiredError}
56
56
  */
@@ -60,7 +60,7 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
60
60
  * @summary Place an option strategy order on the brokerage
61
61
  * @param {string} userId
62
62
  * @param {string} userSecret
63
- * @param {string} accountId The ID of the account get positions.
63
+ * @param {string} accountId The ID of the account to execute the strategy in.
64
64
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
65
65
  * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
66
66
  * @param {*} [options] Override http request option.
@@ -179,7 +179,7 @@ export type OptionsApiGetOptionStrategyRequest = {
179
179
  */
180
180
  readonly userSecret: string;
181
181
  /**
182
- * The ID of the account get positions.
182
+ * The ID of the account to create the option strategy object in.
183
183
  * @type {string}
184
184
  * @memberof OptionsApiGetOptionStrategy
185
185
  */
@@ -204,7 +204,7 @@ export type OptionsApiGetOptionsChainRequest = {
204
204
  */
205
205
  readonly userSecret: string;
206
206
  /**
207
- * The ID of the account get positions.
207
+ * The ID of the account to get the options chain from.
208
208
  * @type {string}
209
209
  * @memberof OptionsApiGetOptionsChain
210
210
  */
@@ -235,7 +235,7 @@ export type OptionsApiGetOptionsStrategyQuoteRequest = {
235
235
  */
236
236
  readonly userSecret: string;
237
237
  /**
238
- * The ID of the account get positions.
238
+ * The ID of the account the strategy will be placed in.
239
239
  * @type {string}
240
240
  * @memberof OptionsApiGetOptionsStrategyQuote
241
241
  */
@@ -266,7 +266,7 @@ export type OptionsApiListOptionHoldingsRequest = {
266
266
  */
267
267
  readonly userSecret: string;
268
268
  /**
269
- * The ID of the account get positions.
269
+ * The ID of the account to fetch options holdings for.
270
270
  * @type {string}
271
271
  * @memberof OptionsApiListOptionHoldings
272
272
  */
@@ -291,7 +291,7 @@ export type OptionsApiPlaceOptionStrategyRequest = {
291
291
  */
292
292
  readonly userSecret: string;
293
293
  /**
294
- * The ID of the account get positions.
294
+ * The ID of the account to execute the strategy in.
295
295
  * @type {string}
296
296
  * @memberof OptionsApiPlaceOptionStrategy
297
297
  */
@@ -40,7 +40,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
40
40
  * @summary Creates an option strategy object that will be used to place an option strategy order
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
43
- * @param {string} accountId The ID of the account get positions.
43
+ * @param {string} accountId The ID of the account to create the option strategy object in.
44
44
  * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
@@ -99,7 +99,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
99
99
  * @summary Get the options chain
100
100
  * @param {string} userId
101
101
  * @param {string} userSecret
102
- * @param {string} accountId The ID of the account get positions.
102
+ * @param {string} accountId The ID of the account to get the options chain from.
103
103
  * @param {string} symbol Universal symbol ID if symbol
104
104
  * @param {*} [options] Override http request option.
105
105
  * @throws {RequiredError}
@@ -158,7 +158,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
158
158
  * @summary Get latest market data of option strategy
159
159
  * @param {string} userId
160
160
  * @param {string} userSecret
161
- * @param {string} accountId The ID of the account get positions.
161
+ * @param {string} accountId The ID of the account the strategy will be placed in.
162
162
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
163
163
  * @param {*} [options] Override http request option.
164
164
  * @throws {RequiredError}
@@ -215,7 +215,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
215
215
  * @summary Get the options holdings in the account
216
216
  * @param {string} userId
217
217
  * @param {string} userSecret
218
- * @param {string} accountId The ID of the account get positions.
218
+ * @param {string} accountId The ID of the account to fetch options holdings for.
219
219
  * @param {*} [options] Override http request option.
220
220
  * @throws {RequiredError}
221
221
  */
@@ -268,7 +268,7 @@ const OptionsApiAxiosParamCreator = function (configuration) {
268
268
  * @summary Place an option strategy order on the brokerage
269
269
  * @param {string} userId
270
270
  * @param {string} userSecret
271
- * @param {string} accountId The ID of the account get positions.
271
+ * @param {string} accountId The ID of the account to execute the strategy in.
272
272
  * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
273
273
  * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
274
274
  * @param {*} [options] Override http request option.