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.
@@ -31,8 +31,8 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
31
31
  */
32
32
  getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
33
  /**
34
- *
35
- * @summary List of all security types.
34
+ * List security types available on SnapTrade.
35
+ * @summary List of all security types
36
36
  * @param {*} [options] Override http request option.
37
37
  * @throws {RequiredError}
38
38
  */
@@ -95,7 +95,7 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
95
95
  * @summary Search for symbols available in an account
96
96
  * @param {string} userId
97
97
  * @param {string} userSecret
98
- * @param {string} accountId The ID of the account get positions.
98
+ * @param {string} accountId The ID of the account to search for symbols within.
99
99
  * @param {SymbolQuery} [symbolQuery]
100
100
  * @param {*} [options] Override http request option.
101
101
  * @throws {RequiredError}
@@ -123,8 +123,8 @@ export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
123
123
  */
124
124
  getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
125
125
  /**
126
- *
127
- * @summary List of all security types.
126
+ * List security types available on SnapTrade.
127
+ * @summary List of all security types
128
128
  * @param {*} [options] Override http request option.
129
129
  * @throws {RequiredError}
130
130
  */
@@ -211,8 +211,8 @@ export declare const ReferenceDataApiFactory: (configuration?: Configuration, ba
211
211
  */
212
212
  getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
213
213
  /**
214
- *
215
- * @summary List of all security types.
214
+ * List security types available on SnapTrade.
215
+ * @summary List of all security types
216
216
  * @param {*} [options] Override http request option.
217
217
  * @throws {RequiredError}
218
218
  */
@@ -348,7 +348,7 @@ export type ReferenceDataApiSymbolSearchUserAccountRequest = {
348
348
  */
349
349
  readonly userSecret: string;
350
350
  /**
351
- * The ID of the account get positions.
351
+ * The ID of the account to search for symbols within.
352
352
  * @type {string}
353
353
  * @memberof ReferenceDataApiSymbolSearchUserAccount
354
354
  */
@@ -379,8 +379,8 @@ export declare class ReferenceDataApiGenerated extends BaseAPI {
379
379
  */
380
380
  getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
381
381
  /**
382
- *
383
- * @summary List of all security types.
382
+ * List security types available on SnapTrade.
383
+ * @summary List of all security types
384
384
  * @param {*} [options] Override http request option.
385
385
  * @throws {RequiredError}
386
386
  * @memberof ReferenceDataApiGenerated
@@ -114,8 +114,8 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
114
114
  };
115
115
  }),
116
116
  /**
117
- *
118
- * @summary List of all security types.
117
+ * List security types available on SnapTrade.
118
+ * @summary List of all security types
119
119
  * @param {*} [options] Override http request option.
120
120
  * @throws {RequiredError}
121
121
  */
@@ -430,7 +430,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
430
430
  * @summary Search for symbols available in an account
431
431
  * @param {string} userId
432
432
  * @param {string} userSecret
433
- * @param {string} accountId The ID of the account get positions.
433
+ * @param {string} accountId The ID of the account to search for symbols within.
434
434
  * @param {SymbolQuery} [symbolQuery]
435
435
  * @param {*} [options] Override http request option.
436
436
  * @throws {RequiredError}
@@ -518,8 +518,8 @@ const ReferenceDataApiFp = function (configuration) {
518
518
  });
519
519
  },
520
520
  /**
521
- *
522
- * @summary List of all security types.
521
+ * List security types available on SnapTrade.
522
+ * @summary List of all security types
523
523
  * @param {*} [options] Override http request option.
524
524
  * @throws {RequiredError}
525
525
  */
@@ -659,8 +659,8 @@ const ReferenceDataApiFactory = function (configuration, basePath, axios) {
659
659
  return localVarFp.getPartnerInfo(options).then((request) => request(axios, basePath));
660
660
  },
661
661
  /**
662
- *
663
- * @summary List of all security types.
662
+ * List security types available on SnapTrade.
663
+ * @summary List of all security types
664
664
  * @param {*} [options] Override http request option.
665
665
  * @throws {RequiredError}
666
666
  */
@@ -775,8 +775,8 @@ class ReferenceDataApiGenerated extends base_1.BaseAPI {
775
775
  return (0, exports.ReferenceDataApiFp)(this.configuration).getPartnerInfo(options).then((request) => request(this.axios, this.basePath));
776
776
  }
777
777
  /**
778
- *
779
- * @summary List of all security types.
778
+ * List security types available on SnapTrade.
779
+ * @summary List of all security types
780
780
  * @param {*} [options] Override http request option.
781
781
  * @throws {RequiredError}
782
782
  * @memberof ReferenceDataApiGenerated
@@ -17,7 +17,7 @@ export declare const TradingApiAxiosParamCreator: (configuration?: Configuration
17
17
  * @summary Cancel open order in account
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 cancel the order in.
21
21
  * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
22
22
  * @param {*} [options] Override http request option.
23
23
  * @throws {RequiredError}
@@ -203,7 +203,7 @@ export type TradingApiCancelUserAccountOrderRequest = {
203
203
  */
204
204
  readonly userSecret: string;
205
205
  /**
206
- * The ID of the account get positions.
206
+ * The ID of the account to cancel the order in.
207
207
  * @type {string}
208
208
  * @memberof TradingApiCancelUserAccountOrder
209
209
  */
@@ -40,7 +40,7 @@ const TradingApiAxiosParamCreator = function (configuration) {
40
40
  * @summary Cancel open order in account
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 cancel the order in.
44
44
  * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
45
45
  * @param {*} [options] Override http request option.
46
46
  * @throws {RequiredError}
@@ -9,7 +9,7 @@ import { UniversalActivity } from '../models';
9
9
  */
10
10
  export declare const TransactionsAndReportingApiAxiosParamCreator: (configuration?: Configuration) => {
11
11
  /**
12
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
12
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
13
13
  * @summary Get transaction history for a user
14
14
  * @param {string} userId
15
15
  * @param {string} userSecret
@@ -43,7 +43,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
43
43
  */
44
44
  export declare const TransactionsAndReportingApiFp: (configuration?: Configuration) => {
45
45
  /**
46
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
46
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
47
47
  * @summary Get transaction history for a user
48
48
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
49
49
  * @param {*} [options] Override http request option.
@@ -65,7 +65,7 @@ export declare const TransactionsAndReportingApiFp: (configuration?: Configurati
65
65
  */
66
66
  export declare const TransactionsAndReportingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
67
67
  /**
68
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
68
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
69
69
  * @summary Get transaction history for a user
70
70
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
71
71
  * @param {*} [options] Override http request option.
@@ -187,7 +187,7 @@ export type TransactionsAndReportingApiGetReportingCustomRangeRequest = {
187
187
  */
188
188
  export declare class TransactionsAndReportingApiGenerated extends BaseAPI {
189
189
  /**
190
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
190
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
191
191
  * @summary Get transaction history for a user
192
192
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
193
193
  * @param {*} [options] Override http request option.
@@ -36,7 +36,7 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
36
36
  const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
37
37
  return {
38
38
  /**
39
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
39
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
40
40
  * @summary Get transaction history for a user
41
41
  * @param {string} userId
42
42
  * @param {string} userSecret
@@ -196,7 +196,7 @@ const TransactionsAndReportingApiFp = function (configuration) {
196
196
  const localVarAxiosParamCreator = (0, exports.TransactionsAndReportingApiAxiosParamCreator)(configuration);
197
197
  return {
198
198
  /**
199
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
199
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
200
200
  * @summary Get transaction history for a user
201
201
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
202
202
  * @param {*} [options] Override http request option.
@@ -232,7 +232,7 @@ const TransactionsAndReportingApiFactory = function (configuration, basePath, ax
232
232
  const localVarFp = (0, exports.TransactionsAndReportingApiFp)(configuration);
233
233
  return {
234
234
  /**
235
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
235
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
236
236
  * @summary Get transaction history for a user
237
237
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
238
238
  * @param {*} [options] Override http request option.
@@ -262,7 +262,7 @@ exports.TransactionsAndReportingApiFactory = TransactionsAndReportingApiFactory;
262
262
  */
263
263
  class TransactionsAndReportingApiGenerated extends base_1.BaseAPI {
264
264
  /**
265
- * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for automatic calls for better performance
265
+ * Returns activities (transactions) for a user. Specifing start and end date is highly recommended for better performance
266
266
  * @summary Get transaction history for a user
267
267
  * @param {TransactionsAndReportingApiGetActivitiesRequest} requestParameters Request parameters.
268
268
  * @param {*} [options] Override http request option.