snaptrade-typescript-sdk 9.0.147 → 9.0.148

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.147-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.147)
9
+ [![npm](https://img.shields.io/badge/npm-v9.0.148-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.148)
10
10
  [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
11
11
 
12
12
  </div>
@@ -43,6 +43,8 @@ Connect brokerage accounts to your app for live positions and trading
43
43
  * [`snaptrade.connections.removeBrokerageAuthorization`](#snaptradeconnectionsremovebrokerageauthorization)
44
44
  * [`snaptrade.connections.returnRates`](#snaptradeconnectionsreturnrates)
45
45
  * [`snaptrade.connections.sessionEvents`](#snaptradeconnectionssessionevents)
46
+ * [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
47
+ * [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
46
48
  * [`snaptrade.options.getOptionsChain`](#snaptradeoptionsgetoptionschain)
47
49
  * [`snaptrade.options.listOptionHoldings`](#snaptradeoptionslistoptionholdings)
48
50
  * [`snaptrade.referenceData.getCurrencyExchangeRatePair`](#snaptradereferencedatagetcurrencyexchangeratepair)
@@ -1197,6 +1199,102 @@ Optional comma separated list of session IDs used to filter the request on speci
1197
1199
  ---
1198
1200
 
1199
1201
 
1202
+ ### `snaptrade.experimentalEndpoints.getUserAccountOrdersV2`<a id="snaptradeexperimentalendpointsgetuseraccountordersv2"></a>
1203
+
1204
+ Returns a list of recent orders in the specified account.
1205
+
1206
+ The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.
1207
+
1208
+ If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
1209
+
1210
+
1211
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1212
+
1213
+ ```typescript
1214
+ const getUserAccountOrdersV2Response =
1215
+ await snaptrade.experimentalEndpoints.getUserAccountOrdersV2({
1216
+ userId: "snaptrade-user-123",
1217
+ userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1218
+ state: "all",
1219
+ days: 30,
1220
+ accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1221
+ });
1222
+ ```
1223
+
1224
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1225
+
1226
+ ##### userId: `string`<a id="userid-string"></a>
1227
+
1228
+ ##### userSecret: `string`<a id="usersecret-string"></a>
1229
+
1230
+ ##### accountId: `string`<a id="accountid-string"></a>
1231
+
1232
+ ##### state: `'all' | 'open' | 'executed'`<a id="state-all--open--executed"></a>
1233
+
1234
+ defaults value is set to \"all\"
1235
+
1236
+ ##### days: `number`<a id="days-number"></a>
1237
+
1238
+ Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
1239
+
1240
+ #### 🔄 Return<a id="🔄-return"></a>
1241
+
1242
+ [AccountOrdersV2Response](./models/account-orders-v2-response.ts)
1243
+
1244
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1245
+
1246
+ `/accounts/{accountId}/orders/v2` `GET`
1247
+
1248
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1249
+
1250
+ ---
1251
+
1252
+
1253
+ ### `snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`<a id="snaptradeexperimentalendpointsgetuseraccountrecentordersv2"></a>
1254
+
1255
+ A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format.
1256
+ This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders.
1257
+ Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days.
1258
+ By default only returns executed orders, but that can be changed by setting *only_executed* to false.
1259
+ **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
1260
+
1261
+
1262
+ #### 🛠️ Usage<a id="🛠️-usage"></a>
1263
+
1264
+ ```typescript
1265
+ const getUserAccountRecentOrdersV2Response =
1266
+ await snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2({
1267
+ userId: "snaptrade-user-123",
1268
+ userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
1269
+ accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
1270
+ });
1271
+ ```
1272
+
1273
+ #### ⚙️ Parameters<a id="⚙️-parameters"></a>
1274
+
1275
+ ##### userId: `string`<a id="userid-string"></a>
1276
+
1277
+ ##### userSecret: `string`<a id="usersecret-string"></a>
1278
+
1279
+ ##### accountId: `string`<a id="accountid-string"></a>
1280
+
1281
+ ##### onlyExecuted: `boolean`<a id="onlyexecuted-boolean"></a>
1282
+
1283
+ Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
1284
+
1285
+ #### 🔄 Return<a id="🔄-return"></a>
1286
+
1287
+ [AccountOrdersV2Response](./models/account-orders-v2-response.ts)
1288
+
1289
+ #### 🌐 Endpoint<a id="🌐-endpoint"></a>
1290
+
1291
+ `/accounts/{accountId}/recentOrders/v2` `GET`
1292
+
1293
+ [🔙 **Back to Table of Contents**](#table-of-contents)
1294
+
1295
+ ---
1296
+
1297
+
1200
1298
  ### `snaptrade.options.getOptionsChain`<a id="snaptradeoptionsgetoptionschain"></a>
1201
1299
 
1202
1300
  Returns the option chain for the specified symbol in the specified account.
@@ -0,0 +1,171 @@
1
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
2
+ import { Configuration } from '../configuration';
3
+ import { RequestArgs, BaseAPI } from '../base';
4
+ import { AccountOrdersV2Response } from '../models';
5
+ /**
6
+ * ExperimentalEndpointsApi - axios parameter creator
7
+ * @export
8
+ */
9
+ export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?: Configuration) => {
10
+ /**
11
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
12
+ * @summary List account orders v2
13
+ * @param {string} userId
14
+ * @param {string} userSecret
15
+ * @param {string} accountId
16
+ * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \&quot;all\&quot;
17
+ * @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
18
+ * @param {*} [options] Override http request option.
19
+ * @throws {RequiredError}
20
+ */
21
+ getUserAccountOrdersV2: (userId: string, userSecret: string, accountId: string, state?: 'all' | 'open' | 'executed', days?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
22
+ /**
23
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
24
+ * @summary List account recent orders (V2, last 24 hours only)
25
+ * @param {string} userId
26
+ * @param {string} userSecret
27
+ * @param {string} accountId
28
+ * @param {boolean} [onlyExecuted] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ getUserAccountRecentOrdersV2: (userId: string, userSecret: string, accountId: string, onlyExecuted?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
+ };
34
+ /**
35
+ * ExperimentalEndpointsApi - functional programming interface
36
+ * @export
37
+ */
38
+ export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration) => {
39
+ /**
40
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
41
+ * @summary List account orders v2
42
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
47
+ /**
48
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
49
+ * @summary List account recent orders (V2, last 24 hours only)
50
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrdersV2Response>>;
55
+ };
56
+ /**
57
+ * ExperimentalEndpointsApi - factory interface
58
+ * @export
59
+ */
60
+ export declare const ExperimentalEndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
61
+ /**
62
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
63
+ * @summary List account orders v2
64
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
65
+ * @param {*} [options] Override http request option.
66
+ * @throws {RequiredError}
67
+ */
68
+ getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
69
+ /**
70
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
71
+ * @summary List account recent orders (V2, last 24 hours only)
72
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
77
+ };
78
+ /**
79
+ * Request parameters for getUserAccountOrdersV2 operation in ExperimentalEndpointsApi.
80
+ * @export
81
+ * @interface ExperimentalEndpointsApiGetUserAccountOrdersV2Request
82
+ */
83
+ export type ExperimentalEndpointsApiGetUserAccountOrdersV2Request = {
84
+ /**
85
+ *
86
+ * @type {string}
87
+ * @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
88
+ */
89
+ readonly userId: string;
90
+ /**
91
+ *
92
+ * @type {string}
93
+ * @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
94
+ */
95
+ readonly userSecret: string;
96
+ /**
97
+ *
98
+ * @type {string}
99
+ * @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
100
+ */
101
+ readonly accountId: string;
102
+ /**
103
+ * defaults value is set to \"all\"
104
+ * @type {'all' | 'open' | 'executed'}
105
+ * @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
106
+ */
107
+ readonly state?: 'all' | 'open' | 'executed';
108
+ /**
109
+ * Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
110
+ * @type {number}
111
+ * @memberof ExperimentalEndpointsApiGetUserAccountOrdersV2
112
+ */
113
+ readonly days?: number;
114
+ };
115
+ /**
116
+ * Request parameters for getUserAccountRecentOrdersV2 operation in ExperimentalEndpointsApi.
117
+ * @export
118
+ * @interface ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request
119
+ */
120
+ export type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request = {
121
+ /**
122
+ *
123
+ * @type {string}
124
+ * @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
125
+ */
126
+ readonly userId: string;
127
+ /**
128
+ *
129
+ * @type {string}
130
+ * @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
131
+ */
132
+ readonly userSecret: string;
133
+ /**
134
+ *
135
+ * @type {string}
136
+ * @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
137
+ */
138
+ readonly accountId: string;
139
+ /**
140
+ * Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
141
+ * @type {boolean}
142
+ * @memberof ExperimentalEndpointsApiGetUserAccountRecentOrdersV2
143
+ */
144
+ readonly onlyExecuted?: boolean;
145
+ };
146
+ /**
147
+ * ExperimentalEndpointsApiGenerated - object-oriented interface
148
+ * @export
149
+ * @class ExperimentalEndpointsApiGenerated
150
+ * @extends {BaseAPI}
151
+ */
152
+ export declare class ExperimentalEndpointsApiGenerated extends BaseAPI {
153
+ /**
154
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
155
+ * @summary List account orders v2
156
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ * @memberof ExperimentalEndpointsApiGenerated
160
+ */
161
+ getUserAccountOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrdersV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrdersV2Response, any>>;
162
+ /**
163
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
164
+ * @summary List account recent orders (V2, last 24 hours only)
165
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ * @memberof ExperimentalEndpointsApiGenerated
169
+ */
170
+ getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrdersV2Response, any>>;
171
+ }
@@ -0,0 +1,259 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /*
5
+ SnapTrade
6
+
7
+ Connect brokerage accounts to your app for live positions and trading
8
+
9
+ The version of the OpenAPI document: 1.0.0
10
+ Contact: api@snaptrade.com
11
+
12
+ NOTE: This file is auto generated by Konfig (https://konfigthis.com).
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ Object.defineProperty(exports, "__esModule", { value: true });
24
+ exports.ExperimentalEndpointsApiGenerated = exports.ExperimentalEndpointsApiFactory = exports.ExperimentalEndpointsApiFp = exports.ExperimentalEndpointsApiAxiosParamCreator = void 0;
25
+ const axios_1 = require("axios");
26
+ // Some imports not used depending on template conditions
27
+ // @ts-ignore
28
+ const common_1 = require("../common");
29
+ // @ts-ignore
30
+ const base_1 = require("../base");
31
+ const requestBeforeHook_1 = require("../requestBeforeHook");
32
+ /**
33
+ * ExperimentalEndpointsApi - axios parameter creator
34
+ * @export
35
+ */
36
+ const ExperimentalEndpointsApiAxiosParamCreator = function (configuration) {
37
+ return {
38
+ /**
39
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
40
+ * @summary List account orders v2
41
+ * @param {string} userId
42
+ * @param {string} userSecret
43
+ * @param {string} accountId
44
+ * @param {'all' | 'open' | 'executed'} [state] defaults value is set to \&quot;all\&quot;
45
+ * @param {number} [days] Number of days in the past to fetch the most recent orders. Defaults to the last 30 days if no value is passed in.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ getUserAccountOrdersV2: (userId, userSecret, accountId, state, days, options = {}) => __awaiter(this, void 0, void 0, function* () {
50
+ // verify required parameter 'userId' is not null or undefined
51
+ (0, common_1.assertParamExists)('getUserAccountOrdersV2', 'userId', userId);
52
+ // verify required parameter 'userSecret' is not null or undefined
53
+ (0, common_1.assertParamExists)('getUserAccountOrdersV2', 'userSecret', userSecret);
54
+ // verify required parameter 'accountId' is not null or undefined
55
+ (0, common_1.assertParamExists)('getUserAccountOrdersV2', 'accountId', accountId);
56
+ const localVarPath = `/accounts/{accountId}/orders/v2`
57
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
58
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
59
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
60
+ let baseOptions;
61
+ if (configuration) {
62
+ baseOptions = configuration.baseOptions;
63
+ }
64
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
65
+ const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
66
+ const localVarQueryParameter = {};
67
+ // authentication PartnerClientId required
68
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
69
+ // authentication PartnerSignature required
70
+ yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
71
+ // authentication PartnerTimestamp required
72
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
73
+ if (userId !== undefined) {
74
+ localVarQueryParameter['userId'] = userId;
75
+ }
76
+ if (userSecret !== undefined) {
77
+ localVarQueryParameter['userSecret'] = userSecret;
78
+ }
79
+ if (state !== undefined) {
80
+ localVarQueryParameter['state'] = state;
81
+ }
82
+ if (days !== undefined) {
83
+ localVarQueryParameter['days'] = days;
84
+ }
85
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
86
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
87
+ (0, requestBeforeHook_1.requestBeforeHook)({
88
+ queryParameters: localVarQueryParameter,
89
+ requestConfig: localVarRequestOptions,
90
+ path: localVarPath,
91
+ configuration,
92
+ pathTemplate: '/accounts/{accountId}/orders/v2',
93
+ httpMethod: 'GET'
94
+ });
95
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
96
+ return {
97
+ url: (0, common_1.toPathString)(localVarUrlObj),
98
+ options: localVarRequestOptions,
99
+ };
100
+ }),
101
+ /**
102
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
103
+ * @summary List account recent orders (V2, last 24 hours only)
104
+ * @param {string} userId
105
+ * @param {string} userSecret
106
+ * @param {string} accountId
107
+ * @param {boolean} [onlyExecuted] Defaults to true. Indicates if request should fetch only executed orders. Set to false to retrieve non executed orders as well
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ getUserAccountRecentOrdersV2: (userId, userSecret, accountId, onlyExecuted, options = {}) => __awaiter(this, void 0, void 0, function* () {
112
+ // verify required parameter 'userId' is not null or undefined
113
+ (0, common_1.assertParamExists)('getUserAccountRecentOrdersV2', 'userId', userId);
114
+ // verify required parameter 'userSecret' is not null or undefined
115
+ (0, common_1.assertParamExists)('getUserAccountRecentOrdersV2', 'userSecret', userSecret);
116
+ // verify required parameter 'accountId' is not null or undefined
117
+ (0, common_1.assertParamExists)('getUserAccountRecentOrdersV2', 'accountId', accountId);
118
+ const localVarPath = `/accounts/{accountId}/recentOrders/v2`
119
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
120
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
121
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
122
+ let baseOptions;
123
+ if (configuration) {
124
+ baseOptions = configuration.baseOptions;
125
+ }
126
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
127
+ const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
128
+ const localVarQueryParameter = {};
129
+ // authentication PartnerClientId required
130
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
131
+ // authentication PartnerSignature required
132
+ yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
133
+ // authentication PartnerTimestamp required
134
+ yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
135
+ if (userId !== undefined) {
136
+ localVarQueryParameter['userId'] = userId;
137
+ }
138
+ if (userSecret !== undefined) {
139
+ localVarQueryParameter['userSecret'] = userSecret;
140
+ }
141
+ if (onlyExecuted !== undefined) {
142
+ localVarQueryParameter['only_executed'] = onlyExecuted;
143
+ }
144
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
145
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
146
+ (0, requestBeforeHook_1.requestBeforeHook)({
147
+ queryParameters: localVarQueryParameter,
148
+ requestConfig: localVarRequestOptions,
149
+ path: localVarPath,
150
+ configuration,
151
+ pathTemplate: '/accounts/{accountId}/recentOrders/v2',
152
+ httpMethod: 'GET'
153
+ });
154
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
155
+ return {
156
+ url: (0, common_1.toPathString)(localVarUrlObj),
157
+ options: localVarRequestOptions,
158
+ };
159
+ }),
160
+ };
161
+ };
162
+ exports.ExperimentalEndpointsApiAxiosParamCreator = ExperimentalEndpointsApiAxiosParamCreator;
163
+ /**
164
+ * ExperimentalEndpointsApi - functional programming interface
165
+ * @export
166
+ */
167
+ const ExperimentalEndpointsApiFp = function (configuration) {
168
+ const localVarAxiosParamCreator = (0, exports.ExperimentalEndpointsApiAxiosParamCreator)(configuration);
169
+ return {
170
+ /**
171
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
172
+ * @summary List account orders v2
173
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ getUserAccountOrdersV2(requestParameters, options) {
178
+ return __awaiter(this, void 0, void 0, function* () {
179
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOrdersV2(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.state, requestParameters.days, options);
180
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
181
+ });
182
+ },
183
+ /**
184
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
185
+ * @summary List account recent orders (V2, last 24 hours only)
186
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ getUserAccountRecentOrdersV2(requestParameters, options) {
191
+ return __awaiter(this, void 0, void 0, function* () {
192
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountRecentOrdersV2(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.onlyExecuted, options);
193
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
194
+ });
195
+ },
196
+ };
197
+ };
198
+ exports.ExperimentalEndpointsApiFp = ExperimentalEndpointsApiFp;
199
+ /**
200
+ * ExperimentalEndpointsApi - factory interface
201
+ * @export
202
+ */
203
+ const ExperimentalEndpointsApiFactory = function (configuration, basePath, axios) {
204
+ const localVarFp = (0, exports.ExperimentalEndpointsApiFp)(configuration);
205
+ return {
206
+ /**
207
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
208
+ * @summary List account orders v2
209
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ */
213
+ getUserAccountOrdersV2(requestParameters, options) {
214
+ return localVarFp.getUserAccountOrdersV2(requestParameters, options).then((request) => request(axios, basePath));
215
+ },
216
+ /**
217
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
218
+ * @summary List account recent orders (V2, last 24 hours only)
219
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ getUserAccountRecentOrdersV2(requestParameters, options) {
224
+ return localVarFp.getUserAccountRecentOrdersV2(requestParameters, options).then((request) => request(axios, basePath));
225
+ },
226
+ };
227
+ };
228
+ exports.ExperimentalEndpointsApiFactory = ExperimentalEndpointsApiFactory;
229
+ /**
230
+ * ExperimentalEndpointsApiGenerated - object-oriented interface
231
+ * @export
232
+ * @class ExperimentalEndpointsApiGenerated
233
+ * @extends {BaseAPI}
234
+ */
235
+ class ExperimentalEndpointsApiGenerated extends base_1.BaseAPI {
236
+ /**
237
+ * Returns a list of recent orders in the specified account. The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg. If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
238
+ * @summary List account orders v2
239
+ * @param {ExperimentalEndpointsApiGetUserAccountOrdersV2Request} requestParameters Request parameters.
240
+ * @param {*} [options] Override http request option.
241
+ * @throws {RequiredError}
242
+ * @memberof ExperimentalEndpointsApiGenerated
243
+ */
244
+ getUserAccountOrdersV2(requestParameters, options) {
245
+ return (0, exports.ExperimentalEndpointsApiFp)(this.configuration).getUserAccountOrdersV2(requestParameters, options).then((request) => request(this.axios, this.basePath));
246
+ }
247
+ /**
248
+ * A lightweight endpoint that returns a list of orders executed in the last 24 hours in the specified account using the V2 order format. This endpoint is realtime and can be used to quickly check if account state has recently changed due to an execution, or check status of recently placed orders. Differs from /orders in that it is realtime, and only checks the last 24 hours as opposed to the last 30 days. By default only returns executed orders, but that can be changed by setting *only_executed* to false. **Because of the cost of realtime requests, each call to this endpoint incurs an additional charge. You can find the exact cost for your API key on the [Customer Dashboard billing page](https://dashboard.snaptrade.com/settings/billing)**
249
+ * @summary List account recent orders (V2, last 24 hours only)
250
+ * @param {ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request} requestParameters Request parameters.
251
+ * @param {*} [options] Override http request option.
252
+ * @throws {RequiredError}
253
+ * @memberof ExperimentalEndpointsApiGenerated
254
+ */
255
+ getUserAccountRecentOrdersV2(requestParameters, options) {
256
+ return (0, exports.ExperimentalEndpointsApiFp)(this.configuration).getUserAccountRecentOrdersV2(requestParameters, options).then((request) => request(this.axios, this.basePath));
257
+ }
258
+ }
259
+ exports.ExperimentalEndpointsApiGenerated = ExperimentalEndpointsApiGenerated;
@@ -0,0 +1,4 @@
1
+ import { ExperimentalEndpointsApiGenerated } from "./experimental-endpoints-api-generated";
2
+ export * from "./experimental-endpoints-api-generated";
3
+ export declare class ExperimentalEndpointsApi extends ExperimentalEndpointsApiGenerated {
4
+ }
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.ExperimentalEndpointsApi = void 0;
18
+ const experimental_endpoints_api_generated_1 = require("./experimental-endpoints-api-generated");
19
+ __exportStar(require("./experimental-endpoints-api-generated"), exports);
20
+ class ExperimentalEndpointsApi extends experimental_endpoints_api_generated_1.ExperimentalEndpointsApiGenerated {
21
+ }
22
+ exports.ExperimentalEndpointsApi = ExperimentalEndpointsApi;
package/dist/api.d.ts CHANGED
@@ -2,6 +2,7 @@ export * from './api/account-information-api';
2
2
  export * from './api/api-status-api';
3
3
  export * from './api/authentication-api';
4
4
  export * from './api/connections-api';
5
+ export * from './api/experimental-endpoints-api';
5
6
  export * from './api/options-api';
6
7
  export * from './api/reference-data-api';
7
8
  export * from './api/trading-api';
package/dist/api.js CHANGED
@@ -30,6 +30,7 @@ __exportStar(require("./api/account-information-api"), exports);
30
30
  __exportStar(require("./api/api-status-api"), exports);
31
31
  __exportStar(require("./api/authentication-api"), exports);
32
32
  __exportStar(require("./api/connections-api"), exports);
33
+ __exportStar(require("./api/experimental-endpoints-api"), exports);
33
34
  __exportStar(require("./api/options-api"), exports);
34
35
  __exportStar(require("./api/reference-data-api"), exports);
35
36
  __exportStar(require("./api/trading-api"), exports);