snaptrade-typescript-sdk 5.0.0 → 6.1.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 (52) hide show
  1. package/.konfig/generate-id.txt +1 -1
  2. package/README.md +3 -5
  3. package/api/account-information-api.ts +136 -120
  4. package/api/api-disclaimer-api.ts +14 -19
  5. package/api/authentication-api.ts +37 -43
  6. package/api/connections-api.ts +46 -40
  7. package/api/error-logs-api.ts +12 -10
  8. package/api/options-api.ts +104 -108
  9. package/api/portfolio-management-api.ts +259 -253
  10. package/api/reference-data-api.ts +49 -53
  11. package/api/trading-api.ts +172 -185
  12. package/api/transactions-and-reporting-api.ts +64 -60
  13. package/client.ts +2 -0
  14. package/configuration.ts +1 -1
  15. package/dist/api/account-information-api.d.ts +112 -112
  16. package/dist/api/api-disclaimer-api.d.ts +10 -16
  17. package/dist/api/api-disclaimer-api.js +1 -1
  18. package/dist/api/authentication-api.d.ts +27 -40
  19. package/dist/api/authentication-api.js +2 -2
  20. package/dist/api/connections-api.d.ts +38 -38
  21. package/dist/api/error-logs-api.d.ts +10 -10
  22. package/dist/api/options-api.d.ts +82 -94
  23. package/dist/api/options-api.js +2 -2
  24. package/dist/api/portfolio-management-api.d.ts +214 -256
  25. package/dist/api/portfolio-management-api.js +7 -7
  26. package/dist/api/reference-data-api.d.ts +37 -50
  27. package/dist/api/reference-data-api.js +2 -2
  28. package/dist/api/trading-api.d.ts +131 -160
  29. package/dist/api/trading-api.js +10 -10
  30. package/dist/api/transactions-and-reporting-api.d.ts +52 -52
  31. package/dist/configuration.js +1 -1
  32. package/dist/models/index.d.ts +1 -0
  33. package/dist/models/index.js +1 -0
  34. package/dist/models/target-asset.d.ts +4 -2
  35. package/dist/models/trading-cancel-user-account-order-request.d.ts +24 -0
  36. package/dist/models/trading-cancel-user-account-order-request.js +15 -0
  37. package/docs/AccountInformationApi.md +72 -88
  38. package/docs/ApiDisclaimerApi.md +8 -12
  39. package/docs/ApiStatusApi.md +6 -7
  40. package/docs/AuthenticationApi.md +34 -48
  41. package/docs/ConnectionsApi.md +26 -32
  42. package/docs/ErrorLogsApi.md +8 -10
  43. package/docs/OptionsApi.md +55 -62
  44. package/docs/PortfolioManagementApi.md +229 -309
  45. package/docs/ReferenceDataApi.md +66 -93
  46. package/docs/TradingApi.md +88 -117
  47. package/docs/TransactionsAndReportingApi.md +26 -28
  48. package/index.test.ts +2 -4
  49. package/models/index.ts +1 -0
  50. package/models/target-asset.ts +2 -2
  51. package/models/trading-cancel-user-account-order-request.ts +29 -0
  52. package/package.json +1 -1
package/dist/api/connections-api.d.ts CHANGED
@@ -113,70 +113,70 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
113
113
  * @export
114
114
  * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
115
115
  */
116
- export interface ConnectionsApiDetailBrokerageAuthorizationRequest {
116
+ export type ConnectionsApiDetailBrokerageAuthorizationRequest = {
117
117
  /**
118
- * The ID of a brokerage authorization object.
119
- * @type {string}
120
- * @memberof ConnectionsApiDetailBrokerageAuthorization
121
- */
118
+ * The ID of a brokerage authorization object.
119
+ * @type {string}
120
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
121
+ */
122
122
  readonly authorizationId: string;
123
123
  /**
124
- *
125
- * @type {string}
126
- * @memberof ConnectionsApiDetailBrokerageAuthorization
127
- */
124
+ *
125
+ * @type {string}
126
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
127
+ */
128
128
  readonly userId: string;
129
129
  /**
130
- *
131
- * @type {string}
132
- * @memberof ConnectionsApiDetailBrokerageAuthorization
133
- */
130
+ *
131
+ * @type {string}
132
+ * @memberof ConnectionsApiDetailBrokerageAuthorization
133
+ */
134
134
  readonly userSecret: string;
135
- }
135
+ };
136
136
  /**
137
137
  * Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
138
138
  * @export
139
139
  * @interface ConnectionsApiListBrokerageAuthorizationsRequest
140
140
  */
141
- export interface ConnectionsApiListBrokerageAuthorizationsRequest {
141
+ export type ConnectionsApiListBrokerageAuthorizationsRequest = {
142
142
  /**
143
- *
144
- * @type {string}
145
- * @memberof ConnectionsApiListBrokerageAuthorizations
146
- */
143
+ *
144
+ * @type {string}
145
+ * @memberof ConnectionsApiListBrokerageAuthorizations
146
+ */
147
147
  readonly userId: string;
148
148
  /**
149
- *
150
- * @type {string}
151
- * @memberof ConnectionsApiListBrokerageAuthorizations
152
- */
149
+ *
150
+ * @type {string}
151
+ * @memberof ConnectionsApiListBrokerageAuthorizations
152
+ */
153
153
  readonly userSecret: string;
154
- }
154
+ };
155
155
  /**
156
156
  * Request parameters for removeBrokerageAuthorization operation in ConnectionsApi.
157
157
  * @export
158
158
  * @interface ConnectionsApiRemoveBrokerageAuthorizationRequest
159
159
  */
160
- export interface ConnectionsApiRemoveBrokerageAuthorizationRequest {
160
+ export type ConnectionsApiRemoveBrokerageAuthorizationRequest = {
161
161
  /**
162
- * The ID of the Authorization to delete.
163
- * @type {string}
164
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
165
- */
162
+ * The ID of the Authorization to delete.
163
+ * @type {string}
164
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
165
+ */
166
166
  readonly authorizationId: string;
167
167
  /**
168
- *
169
- * @type {string}
170
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
171
- */
168
+ *
169
+ * @type {string}
170
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
171
+ */
172
172
  readonly userId: string;
173
173
  /**
174
- *
175
- * @type {string}
176
- * @memberof ConnectionsApiRemoveBrokerageAuthorization
177
- */
174
+ *
175
+ * @type {string}
176
+ * @memberof ConnectionsApiRemoveBrokerageAuthorization
177
+ */
178
178
  readonly userSecret: string;
179
- }
179
+ };
180
180
  /**
181
181
  * ConnectionsApi - object-oriented interface
182
182
  * @export
package/dist/api/error-logs-api.d.ts CHANGED
@@ -61,20 +61,20 @@ export declare const ErrorLogsApiFactory: (configuration?: Configuration, basePa
61
61
  * @export
62
62
  * @interface ErrorLogsApiListUserErrorsRequest
63
63
  */
64
- export interface ErrorLogsApiListUserErrorsRequest {
64
+ export type ErrorLogsApiListUserErrorsRequest = {
65
65
  /**
66
- *
67
- * @type {string}
68
- * @memberof ErrorLogsApiListUserErrors
69
- */
66
+ *
67
+ * @type {string}
68
+ * @memberof ErrorLogsApiListUserErrors
69
+ */
70
70
  readonly userId: string;
71
71
  /**
72
- *
73
- * @type {string}
74
- * @memberof ErrorLogsApiListUserErrors
75
- */
72
+ *
73
+ * @type {string}
74
+ * @memberof ErrorLogsApiListUserErrors
75
+ */
76
76
  readonly userSecret: string;
77
- }
77
+ };
78
78
  /**
79
79
  * ErrorLogsApi - object-oriented interface
80
80
  * @export
package/dist/api/options-api.d.ts CHANGED
@@ -176,156 +176,144 @@ export declare const OptionsApiFactory: (configuration?: Configuration, basePath
176
176
  * @export
177
177
  * @interface OptionsApiGetOptionStrategyRequest
178
178
  */
179
- export interface OptionsApiGetOptionStrategyRequest {
179
+ export type OptionsApiGetOptionStrategyRequest = {
180
180
  /**
181
- *
182
- * @type {string}
183
- * @memberof OptionsApiGetOptionStrategy
184
- */
181
+ *
182
+ * @type {string}
183
+ * @memberof OptionsApiGetOptionStrategy
184
+ */
185
185
  readonly userId: string;
186
186
  /**
187
- *
188
- * @type {string}
189
- * @memberof OptionsApiGetOptionStrategy
190
- */
187
+ *
188
+ * @type {string}
189
+ * @memberof OptionsApiGetOptionStrategy
190
+ */
191
191
  readonly userSecret: string;
192
192
  /**
193
- * The ID of the account get positions.
194
- * @type {string}
195
- * @memberof OptionsApiGetOptionStrategy
196
- */
193
+ * The ID of the account get positions.
194
+ * @type {string}
195
+ * @memberof OptionsApiGetOptionStrategy
196
+ */
197
197
  readonly accountId: string;
198
- /**
199
- *
200
- * @type {OptionsGetOptionStrategyRequest}
201
- * @memberof OptionsApiGetOptionStrategy
202
- */
203
- readonly requestBody: OptionsGetOptionStrategyRequest;
204
- }
198
+ } & OptionsGetOptionStrategyRequest;
205
199
  /**
206
200
  * Request parameters for getOptionsChain operation in OptionsApi.
207
201
  * @export
208
202
  * @interface OptionsApiGetOptionsChainRequest
209
203
  */
210
- export interface OptionsApiGetOptionsChainRequest {
204
+ export type OptionsApiGetOptionsChainRequest = {
211
205
  /**
212
- *
213
- * @type {string}
214
- * @memberof OptionsApiGetOptionsChain
215
- */
206
+ *
207
+ * @type {string}
208
+ * @memberof OptionsApiGetOptionsChain
209
+ */
216
210
  readonly userId: string;
217
211
  /**
218
- *
219
- * @type {string}
220
- * @memberof OptionsApiGetOptionsChain
221
- */
212
+ *
213
+ * @type {string}
214
+ * @memberof OptionsApiGetOptionsChain
215
+ */
222
216
  readonly userSecret: string;
223
217
  /**
224
- * The ID of the account get positions.
225
- * @type {string}
226
- * @memberof OptionsApiGetOptionsChain
227
- */
218
+ * The ID of the account get positions.
219
+ * @type {string}
220
+ * @memberof OptionsApiGetOptionsChain
221
+ */
228
222
  readonly accountId: string;
229
223
  /**
230
- * Universal symbol ID if symbol
231
- * @type {string}
232
- * @memberof OptionsApiGetOptionsChain
233
- */
224
+ * Universal symbol ID if symbol
225
+ * @type {string}
226
+ * @memberof OptionsApiGetOptionsChain
227
+ */
234
228
  readonly symbol: string;
235
- }
229
+ };
236
230
  /**
237
231
  * Request parameters for getOptionsStrategyQuote operation in OptionsApi.
238
232
  * @export
239
233
  * @interface OptionsApiGetOptionsStrategyQuoteRequest
240
234
  */
241
- export interface OptionsApiGetOptionsStrategyQuoteRequest {
235
+ export type OptionsApiGetOptionsStrategyQuoteRequest = {
242
236
  /**
243
- *
244
- * @type {string}
245
- * @memberof OptionsApiGetOptionsStrategyQuote
246
- */
237
+ *
238
+ * @type {string}
239
+ * @memberof OptionsApiGetOptionsStrategyQuote
240
+ */
247
241
  readonly userId: string;
248
242
  /**
249
- *
250
- * @type {string}
251
- * @memberof OptionsApiGetOptionsStrategyQuote
252
- */
243
+ *
244
+ * @type {string}
245
+ * @memberof OptionsApiGetOptionsStrategyQuote
246
+ */
253
247
  readonly userSecret: string;
254
248
  /**
255
- * The ID of the account get positions.
256
- * @type {string}
257
- * @memberof OptionsApiGetOptionsStrategyQuote
258
- */
249
+ * The ID of the account get positions.
250
+ * @type {string}
251
+ * @memberof OptionsApiGetOptionsStrategyQuote
252
+ */
259
253
  readonly accountId: string;
260
254
  /**
261
- * Option strategy id obtained from response when creating option strategy object
262
- * @type {string}
263
- * @memberof OptionsApiGetOptionsStrategyQuote
264
- */
255
+ * Option strategy id obtained from response when creating option strategy object
256
+ * @type {string}
257
+ * @memberof OptionsApiGetOptionsStrategyQuote
258
+ */
265
259
  readonly optionStrategyId: string;
266
- }
260
+ };
267
261
  /**
268
262
  * Request parameters for listOptionHoldings operation in OptionsApi.
269
263
  * @export
270
264
  * @interface OptionsApiListOptionHoldingsRequest
271
265
  */
272
- export interface OptionsApiListOptionHoldingsRequest {
266
+ export type OptionsApiListOptionHoldingsRequest = {
273
267
  /**
274
- *
275
- * @type {string}
276
- * @memberof OptionsApiListOptionHoldings
277
- */
268
+ *
269
+ * @type {string}
270
+ * @memberof OptionsApiListOptionHoldings
271
+ */
278
272
  readonly userId: string;
279
273
  /**
280
- *
281
- * @type {string}
282
- * @memberof OptionsApiListOptionHoldings
283
- */
274
+ *
275
+ * @type {string}
276
+ * @memberof OptionsApiListOptionHoldings
277
+ */
284
278
  readonly userSecret: string;
285
279
  /**
286
- * The ID of the account get positions.
287
- * @type {string}
288
- * @memberof OptionsApiListOptionHoldings
289
- */
280
+ * The ID of the account get positions.
281
+ * @type {string}
282
+ * @memberof OptionsApiListOptionHoldings
283
+ */
290
284
  readonly accountId: string;
291
- }
285
+ };
292
286
  /**
293
287
  * Request parameters for placeOptionStrategy operation in OptionsApi.
294
288
  * @export
295
289
  * @interface OptionsApiPlaceOptionStrategyRequest
296
290
  */
297
- export interface OptionsApiPlaceOptionStrategyRequest {
291
+ export type OptionsApiPlaceOptionStrategyRequest = {
298
292
  /**
299
- *
300
- * @type {string}
301
- * @memberof OptionsApiPlaceOptionStrategy
302
- */
293
+ *
294
+ * @type {string}
295
+ * @memberof OptionsApiPlaceOptionStrategy
296
+ */
303
297
  readonly userId: string;
304
298
  /**
305
- *
306
- * @type {string}
307
- * @memberof OptionsApiPlaceOptionStrategy
308
- */
299
+ *
300
+ * @type {string}
301
+ * @memberof OptionsApiPlaceOptionStrategy
302
+ */
309
303
  readonly userSecret: string;
310
304
  /**
311
- * The ID of the account get positions.
312
- * @type {string}
313
- * @memberof OptionsApiPlaceOptionStrategy
314
- */
305
+ * The ID of the account get positions.
306
+ * @type {string}
307
+ * @memberof OptionsApiPlaceOptionStrategy
308
+ */
315
309
  readonly accountId: string;
316
310
  /**
317
- * Option strategy id obtained from response when creating option strategy object
318
- * @type {string}
319
- * @memberof OptionsApiPlaceOptionStrategy
320
- */
311
+ * Option strategy id obtained from response when creating option strategy object
312
+ * @type {string}
313
+ * @memberof OptionsApiPlaceOptionStrategy
314
+ */
321
315
  readonly optionStrategyId: string;
322
- /**
323
- *
324
- * @type {OptionsPlaceOptionStrategyRequest}
325
- * @memberof OptionsApiPlaceOptionStrategy
326
- */
327
- readonly requestBody: OptionsPlaceOptionStrategyRequest;
328
- }
316
+ } & OptionsPlaceOptionStrategyRequest;
329
317
  /**
330
318
  * OptionsApi - object-oriented interface
331
319
  * @export
package/dist/api/options-api.js CHANGED
@@ -501,7 +501,7 @@ var OptionsApiFp = function (configuration) {
501
501
  var localVarAxiosArgs;
502
502
  return __generator(this, function (_a) {
503
503
  switch (_a.label) {
504
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.requestBody, options)];
504
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters, options)];
505
505
  case 1:
506
506
  localVarAxiosArgs = _a.sent();
507
507
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -581,7 +581,7 @@ var OptionsApiFp = function (configuration) {
581
581
  var localVarAxiosArgs;
582
582
  return __generator(this, function (_a) {
583
583
  switch (_a.label) {
584
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.placeOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.optionStrategyId, requestParameters.requestBody, options)];
584
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.placeOptionStrategy(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.optionStrategyId, requestParameters, options)];
585
585
  case 1:
586
586
  localVarAxiosArgs = _a.sent();
587
587
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];