@orbis-systems/orbis-api-clients 0.3.1 → 0.4.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.
- package/dist/aesmidas/index.d.ts +3756 -0
- package/dist/aesmidas/index.d.ts.map +1 -0
- package/dist/aesmidas/index.esm.js +2 -0
- package/dist/aesmidas/index.esm.js.map +1 -0
- package/dist/aesmidas/index.js +2 -0
- package/dist/aesmidas/index.js.map +1 -0
- package/dist/index.d.ts +12 -26962
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +4255 -0
- package/dist/insight/index.d.ts.map +1 -0
- package/dist/insight/index.esm.js +2 -0
- package/dist/insight/index.esm.js.map +1 -0
- package/dist/insight/index.js +2 -0
- package/dist/insight/index.js.map +1 -0
- package/dist/middleware/index.d.ts +555 -0
- package/dist/middleware/index.d.ts.map +1 -0
- package/dist/middleware/index.esm.js +2 -0
- package/dist/middleware/index.esm.js.map +1 -0
- package/dist/middleware/index.js +2 -0
- package/dist/middleware/index.js.map +1 -0
- package/dist/orbis/index.d.ts +15336 -0
- package/dist/orbis/index.d.ts.map +1 -0
- package/dist/orbis/index.esm.js +2 -0
- package/dist/orbis/index.esm.js.map +1 -0
- package/dist/orbis/index.js +2 -0
- package/dist/orbis/index.js.map +1 -0
- package/dist/uma/index.d.ts +3859 -0
- package/dist/uma/index.d.ts.map +1 -0
- package/dist/uma/index.esm.js +2 -0
- package/dist/uma/index.esm.js.map +1 -0
- package/dist/uma/index.js +2 -0
- package/dist/uma/index.js.map +1 -0
- package/package.json +31 -24
|
@@ -0,0 +1,3756 @@
|
|
|
1
|
+
import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
|
|
2
|
+
interface BaseClientConfig<HandleError extends boolean = boolean> {
|
|
3
|
+
baseUrl: string;
|
|
4
|
+
errorHandling?: HandleError;
|
|
5
|
+
storage?: Storage;
|
|
6
|
+
defaultHeaders?: Record<string, string>;
|
|
7
|
+
defaultSecure?: boolean;
|
|
8
|
+
authDataStorageKey?: string;
|
|
9
|
+
onAxiosError?: (error: AxiosError) => void;
|
|
10
|
+
onError?: (error: unknown) => void;
|
|
11
|
+
}
|
|
12
|
+
enum ContentType {
|
|
13
|
+
Json = "application/json",
|
|
14
|
+
FormData = "multipart/form-data",
|
|
15
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
16
|
+
Text = "text/plain"
|
|
17
|
+
}
|
|
18
|
+
type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
|
|
19
|
+
secure?: boolean;
|
|
20
|
+
contentType?: ContentType;
|
|
21
|
+
};
|
|
22
|
+
type ResponseStatus = {
|
|
23
|
+
status: HttpStatusCode | -1;
|
|
24
|
+
statusText: string;
|
|
25
|
+
};
|
|
26
|
+
type SuccessClientResponse<Data = unknown> = ResponseStatus & {
|
|
27
|
+
success: true;
|
|
28
|
+
data: Data;
|
|
29
|
+
};
|
|
30
|
+
type ErrorClientResponse = ResponseStatus & {
|
|
31
|
+
success: false;
|
|
32
|
+
data?: any;
|
|
33
|
+
error: unknown;
|
|
34
|
+
};
|
|
35
|
+
type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
|
|
36
|
+
declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
|
|
37
|
+
protected readonly config: BaseClientConfig<HandleError>;
|
|
38
|
+
protected readonly axiosInstance: AxiosInstance;
|
|
39
|
+
protected readonly storage: Storage;
|
|
40
|
+
constructor(config: BaseClientConfig<HandleError>);
|
|
41
|
+
protected stringifyFormItem(formItem: unknown): string;
|
|
42
|
+
protected createFormData(input: Record<string, unknown>): FormData;
|
|
43
|
+
request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
44
|
+
get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
45
|
+
delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
46
|
+
head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
47
|
+
options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
48
|
+
post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
49
|
+
put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
50
|
+
patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
51
|
+
getAxios(): AxiosInstance;
|
|
52
|
+
setAuthData(data: AuthData | null): void;
|
|
53
|
+
getAuthData(): AuthData | null;
|
|
54
|
+
getConfig(): BaseClientConfig<HandleError>;
|
|
55
|
+
abstract prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
|
|
56
|
+
}
|
|
57
|
+
declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
|
|
58
|
+
protected readonly apiClient: ApiClient;
|
|
59
|
+
constructor(apiClient: ApiClient);
|
|
60
|
+
getApiClient(): ApiClient;
|
|
61
|
+
}
|
|
62
|
+
interface JwtClientConfig<HandleError extends boolean = boolean> extends BaseClientConfig<HandleError> {
|
|
63
|
+
authSchema?: string;
|
|
64
|
+
}
|
|
65
|
+
interface JwtAuthData {
|
|
66
|
+
accessToken: string;
|
|
67
|
+
refreshToken: string;
|
|
68
|
+
}
|
|
69
|
+
declare class JwtClient<HandleError extends boolean = boolean> extends BaseClient<HandleError, JwtAuthData> {
|
|
70
|
+
protected readonly config: JwtClientConfig<HandleError>;
|
|
71
|
+
constructor(config: JwtClientConfig<HandleError>);
|
|
72
|
+
getConfig(): JwtClientConfig<HandleError>;
|
|
73
|
+
prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
|
|
74
|
+
scheduleTokenRenewal(renewTokenCallback: () => Promise<JwtAuthData>): void;
|
|
75
|
+
cancelTokenRenewal(): void;
|
|
76
|
+
}
|
|
77
|
+
export interface AesMidasActionLog {
|
|
78
|
+
id?: string | null;
|
|
79
|
+
/** @format date-time */
|
|
80
|
+
log_time?: string;
|
|
81
|
+
level?: string | null;
|
|
82
|
+
user_id?: string | null;
|
|
83
|
+
action?: string | null;
|
|
84
|
+
ip_address?: string | null;
|
|
85
|
+
query_string?: string | null;
|
|
86
|
+
post_body?: string | null;
|
|
87
|
+
message?: string | null;
|
|
88
|
+
}
|
|
89
|
+
export interface AesMidasApplicationUser {
|
|
90
|
+
user_name?: string | null;
|
|
91
|
+
normalized_user_name?: string | null;
|
|
92
|
+
email?: string | null;
|
|
93
|
+
normalized_email?: string | null;
|
|
94
|
+
email_confirmed?: boolean;
|
|
95
|
+
password_hash?: string | null;
|
|
96
|
+
security_stamp?: string | null;
|
|
97
|
+
concurrency_stamp?: string | null;
|
|
98
|
+
phone_number?: string | null;
|
|
99
|
+
phone_number_confirmed?: boolean;
|
|
100
|
+
two_factor_enabled?: boolean;
|
|
101
|
+
/** @format date-time */
|
|
102
|
+
lockout_end?: string | null;
|
|
103
|
+
lockout_enabled?: boolean;
|
|
104
|
+
/** @format int32 */
|
|
105
|
+
access_failed_count?: number;
|
|
106
|
+
id?: string | null;
|
|
107
|
+
firm_id?: string | null;
|
|
108
|
+
source?: string | null;
|
|
109
|
+
user_type?: string | null;
|
|
110
|
+
}
|
|
111
|
+
export interface AesMidasApplicationUserResponsewithPagination {
|
|
112
|
+
/** @format int32 */
|
|
113
|
+
total_items?: number;
|
|
114
|
+
/** @format int32 */
|
|
115
|
+
total_pages?: number;
|
|
116
|
+
/** @format int32 */
|
|
117
|
+
current_pages?: number;
|
|
118
|
+
/** @format int32 */
|
|
119
|
+
page_size?: number;
|
|
120
|
+
data?: AesMidasApplicationUser[] | null;
|
|
121
|
+
}
|
|
122
|
+
export interface AesMidasBestQuote {
|
|
123
|
+
symbol?: string | null;
|
|
124
|
+
issue_market?: string | null;
|
|
125
|
+
/** @format double */
|
|
126
|
+
bid_px?: number;
|
|
127
|
+
/** @format int32 */
|
|
128
|
+
bid_sz?: number;
|
|
129
|
+
/** @format double */
|
|
130
|
+
ask_px?: number;
|
|
131
|
+
/** @format int32 */
|
|
132
|
+
ask_sz?: number;
|
|
133
|
+
quote_time?: string | null;
|
|
134
|
+
data_source?: string | null;
|
|
135
|
+
}
|
|
136
|
+
export interface AesMidasBollinger {
|
|
137
|
+
/** @format double */
|
|
138
|
+
sma?: number;
|
|
139
|
+
/** @format double */
|
|
140
|
+
standard_deviation?: number;
|
|
141
|
+
/** @format double */
|
|
142
|
+
upper_band?: number;
|
|
143
|
+
/** @format double */
|
|
144
|
+
lower_band?: number;
|
|
145
|
+
}
|
|
146
|
+
export interface AesMidasBond {
|
|
147
|
+
isin?: string | null;
|
|
148
|
+
cusip?: string | null;
|
|
149
|
+
/** @format int64 */
|
|
150
|
+
min_ask_size?: number | null;
|
|
151
|
+
/** @format int64 */
|
|
152
|
+
min_bid_size?: number | null;
|
|
153
|
+
/** @format double */
|
|
154
|
+
bid_yield?: number | null;
|
|
155
|
+
/** @format double */
|
|
156
|
+
ask_yield?: number | null;
|
|
157
|
+
/** @format double */
|
|
158
|
+
coupon_rate?: number | null;
|
|
159
|
+
/** @format double */
|
|
160
|
+
issue_size?: number | null;
|
|
161
|
+
/** @format double */
|
|
162
|
+
issue_price?: number | null;
|
|
163
|
+
/** @format double */
|
|
164
|
+
par_value?: number | null;
|
|
165
|
+
/** @format double */
|
|
166
|
+
accrued_interest?: number | null;
|
|
167
|
+
issuer?: string | null;
|
|
168
|
+
sector?: string | null;
|
|
169
|
+
description?: string | null;
|
|
170
|
+
description_short?: string | null;
|
|
171
|
+
type?: string | null;
|
|
172
|
+
issue_date?: string | null;
|
|
173
|
+
maturity_date?: string | null;
|
|
174
|
+
sp_rating?: string | null;
|
|
175
|
+
sp_rating_date?: string | null;
|
|
176
|
+
/** @format double */
|
|
177
|
+
duration?: number | null;
|
|
178
|
+
/** @format double */
|
|
179
|
+
coupon?: number | null;
|
|
180
|
+
coupon_frequency?: string | null;
|
|
181
|
+
coupon_type?: string | null;
|
|
182
|
+
next_coupon_date?: string | null;
|
|
183
|
+
callable?: boolean | null;
|
|
184
|
+
call_type?: string | null;
|
|
185
|
+
next_call_date?: string | null;
|
|
186
|
+
/** @format double */
|
|
187
|
+
next_call_price?: number | null;
|
|
188
|
+
convertible?: string | null;
|
|
189
|
+
insured?: boolean | null;
|
|
190
|
+
status?: string | null;
|
|
191
|
+
municipal_state?: string | null;
|
|
192
|
+
municipal_type?: string | null;
|
|
193
|
+
municipal_taxable_federal?: boolean | null;
|
|
194
|
+
purpose?: string | null;
|
|
195
|
+
bank_qualified?: boolean | null;
|
|
196
|
+
treasury_subtype?: string | null;
|
|
197
|
+
ticker?: string | null;
|
|
198
|
+
sinking_fund?: boolean | null;
|
|
199
|
+
a144?: string | null;
|
|
200
|
+
reg_s?: string | null;
|
|
201
|
+
private_placement?: string | null;
|
|
202
|
+
country_issue?: string | null;
|
|
203
|
+
country_domicile?: string | null;
|
|
204
|
+
day_count?: string | null;
|
|
205
|
+
first_coupon_date?: string | null;
|
|
206
|
+
last_coupon_date?: string | null;
|
|
207
|
+
updated_at?: string | null;
|
|
208
|
+
country_code?: string | null;
|
|
209
|
+
country?: string | null;
|
|
210
|
+
bond_warrant?: boolean | null;
|
|
211
|
+
/** @format double */
|
|
212
|
+
close_price?: number | null;
|
|
213
|
+
close_price_asof?: string | null;
|
|
214
|
+
close_ytw?: string | null;
|
|
215
|
+
/** @format double */
|
|
216
|
+
issue_minimum_denomination?: number | null;
|
|
217
|
+
puttable?: boolean | null;
|
|
218
|
+
currency?: string | null;
|
|
219
|
+
source?: string | null;
|
|
220
|
+
settlement_convention?: string | null;
|
|
221
|
+
}
|
|
222
|
+
export interface AesMidasBondReformat {
|
|
223
|
+
symbol?: string | null;
|
|
224
|
+
not_permissioned?: boolean;
|
|
225
|
+
not_found?: boolean;
|
|
226
|
+
delayed?: boolean;
|
|
227
|
+
source?: string | null;
|
|
228
|
+
isin?: string | null;
|
|
229
|
+
cusip?: string | null;
|
|
230
|
+
company_name?: string | null;
|
|
231
|
+
exchange?: string | null;
|
|
232
|
+
market_description?: string | null;
|
|
233
|
+
/** @format double */
|
|
234
|
+
high52week?: number | null;
|
|
235
|
+
/** @format double */
|
|
236
|
+
low52week?: number | null;
|
|
237
|
+
week52_high_date?: string | null;
|
|
238
|
+
week52_low_date?: string | null;
|
|
239
|
+
/** @format double */
|
|
240
|
+
calendar_year_high?: number | null;
|
|
241
|
+
/** @format double */
|
|
242
|
+
calendar_year_low?: number | null;
|
|
243
|
+
/** @format double */
|
|
244
|
+
precise_vwap?: number | null;
|
|
245
|
+
/** @format double */
|
|
246
|
+
vwap1?: number | null;
|
|
247
|
+
/** @format int32 */
|
|
248
|
+
precision?: number | null;
|
|
249
|
+
/** @format double */
|
|
250
|
+
dividend_yield?: number | null;
|
|
251
|
+
/** @format double */
|
|
252
|
+
price_earning_ratio?: number | null;
|
|
253
|
+
/** @format double */
|
|
254
|
+
day_high?: number | null;
|
|
255
|
+
/** @format int64 */
|
|
256
|
+
ask_size?: number | null;
|
|
257
|
+
/** @format double */
|
|
258
|
+
market_cap?: number | null;
|
|
259
|
+
/** @format double */
|
|
260
|
+
dividend_amount?: number | null;
|
|
261
|
+
/** @format double */
|
|
262
|
+
day_low?: number | null;
|
|
263
|
+
/** @format int64 */
|
|
264
|
+
volume?: number | null;
|
|
265
|
+
/** @format int64 */
|
|
266
|
+
average_volume30?: number | null;
|
|
267
|
+
trade_time?: string | null;
|
|
268
|
+
/** @format double */
|
|
269
|
+
trade_price?: number | null;
|
|
270
|
+
trade_region?: AesMidasRegion;
|
|
271
|
+
/** @format double */
|
|
272
|
+
open_interest?: number | null;
|
|
273
|
+
/** @format double */
|
|
274
|
+
opening_price?: number | null;
|
|
275
|
+
/** @format double */
|
|
276
|
+
change_percent?: number | null;
|
|
277
|
+
currency?: string | null;
|
|
278
|
+
/** @format int64 */
|
|
279
|
+
trade_size?: number | null;
|
|
280
|
+
/** @format double */
|
|
281
|
+
yesterday_close?: number | null;
|
|
282
|
+
/** @format int64 */
|
|
283
|
+
bid_size?: number | null;
|
|
284
|
+
/** @format double */
|
|
285
|
+
change?: number | null;
|
|
286
|
+
update_time?: string | null;
|
|
287
|
+
/** @format double */
|
|
288
|
+
ask?: number | null;
|
|
289
|
+
/** @format double */
|
|
290
|
+
bid?: number | null;
|
|
291
|
+
dividend_payment_date?: string | null;
|
|
292
|
+
dividend_ex_date?: string | null;
|
|
293
|
+
/** @format double */
|
|
294
|
+
last_price?: number | null;
|
|
295
|
+
/** @format double */
|
|
296
|
+
trailing12_months_eps?: number | null;
|
|
297
|
+
ask_region?: AesMidasRegion;
|
|
298
|
+
bid_region?: AesMidasRegion;
|
|
299
|
+
/** @format double */
|
|
300
|
+
total_cash_amount?: number | null;
|
|
301
|
+
/** @format double */
|
|
302
|
+
estimated_cash_amount?: number | null;
|
|
303
|
+
/** @format double */
|
|
304
|
+
dividend_rate?: number | null;
|
|
305
|
+
/** @format double */
|
|
306
|
+
beta?: number | null;
|
|
307
|
+
offering?: boolean;
|
|
308
|
+
/** @format double */
|
|
309
|
+
nav?: number | null;
|
|
310
|
+
/** @format double */
|
|
311
|
+
nav_price?: number | null;
|
|
312
|
+
/** @format double */
|
|
313
|
+
nav_change?: number | null;
|
|
314
|
+
/** @format double */
|
|
315
|
+
nav_yesterday_price?: number | null;
|
|
316
|
+
mutual_fund?: boolean;
|
|
317
|
+
/** @format int64 */
|
|
318
|
+
min_ask_size?: number | null;
|
|
319
|
+
/** @format int64 */
|
|
320
|
+
min_bid_size?: number | null;
|
|
321
|
+
/** @format double */
|
|
322
|
+
bid_yield?: number | null;
|
|
323
|
+
/** @format double */
|
|
324
|
+
ask_yield?: number | null;
|
|
325
|
+
bond?: boolean;
|
|
326
|
+
market_cap_classification?: string | null;
|
|
327
|
+
/** @format double */
|
|
328
|
+
coupon_rate?: number | null;
|
|
329
|
+
/** @format double */
|
|
330
|
+
issue_size?: number | null;
|
|
331
|
+
/** @format double */
|
|
332
|
+
issue_price?: number | null;
|
|
333
|
+
/** @format double */
|
|
334
|
+
par_value?: number | null;
|
|
335
|
+
/** @format double */
|
|
336
|
+
accrued_interest?: number | null;
|
|
337
|
+
option?: boolean;
|
|
338
|
+
call?: boolean;
|
|
339
|
+
put?: boolean;
|
|
340
|
+
in_the_money?: boolean;
|
|
341
|
+
put_or_call?: string | null;
|
|
342
|
+
underlying_symbol?: string | null;
|
|
343
|
+
root_symbol?: string | null;
|
|
344
|
+
underlying?: AesMidasLevel1Reformat;
|
|
345
|
+
expiration_date?: string | null;
|
|
346
|
+
/** @format int64 */
|
|
347
|
+
contract_size?: number;
|
|
348
|
+
/** @format double */
|
|
349
|
+
strike_price?: number;
|
|
350
|
+
greeks?: AesMidasOptionGreekReformat;
|
|
351
|
+
crypto?: boolean;
|
|
352
|
+
base_currency?: string | null;
|
|
353
|
+
fx?: boolean;
|
|
354
|
+
issuer?: string | null;
|
|
355
|
+
sector?: string | null;
|
|
356
|
+
description?: string | null;
|
|
357
|
+
description_short?: string | null;
|
|
358
|
+
type?: string | null;
|
|
359
|
+
issue_date?: string | null;
|
|
360
|
+
maturity_date?: string | null;
|
|
361
|
+
sp_rating?: string | null;
|
|
362
|
+
sp_rating_date?: string | null;
|
|
363
|
+
/** @format double */
|
|
364
|
+
duration?: number | null;
|
|
365
|
+
/** @format double */
|
|
366
|
+
coupon?: number | null;
|
|
367
|
+
coupon_frequency?: string | null;
|
|
368
|
+
coupon_type?: string | null;
|
|
369
|
+
next_coupon_date?: string | null;
|
|
370
|
+
callable?: boolean | null;
|
|
371
|
+
call_type?: string | null;
|
|
372
|
+
next_call_date?: string | null;
|
|
373
|
+
/** @format double */
|
|
374
|
+
next_call_price?: number | null;
|
|
375
|
+
convertible?: string | null;
|
|
376
|
+
insured?: boolean | null;
|
|
377
|
+
status?: string | null;
|
|
378
|
+
municipal_state?: string | null;
|
|
379
|
+
municipal_type?: string | null;
|
|
380
|
+
municipal_taxable_federal?: boolean | null;
|
|
381
|
+
purpose?: string | null;
|
|
382
|
+
bank_qualified?: boolean | null;
|
|
383
|
+
treasury_subtype?: string | null;
|
|
384
|
+
ticker?: string | null;
|
|
385
|
+
sinking_fund?: boolean | null;
|
|
386
|
+
a144?: string | null;
|
|
387
|
+
reg_s?: string | null;
|
|
388
|
+
private_placement?: string | null;
|
|
389
|
+
country_issue?: string | null;
|
|
390
|
+
country_domicile?: string | null;
|
|
391
|
+
day_count?: string | null;
|
|
392
|
+
first_coupon_date?: string | null;
|
|
393
|
+
last_coupon_date?: string | null;
|
|
394
|
+
updated_at?: string | null;
|
|
395
|
+
country_code?: string | null;
|
|
396
|
+
country?: string | null;
|
|
397
|
+
bond_warrant?: boolean | null;
|
|
398
|
+
/** @format double */
|
|
399
|
+
close_price?: number | null;
|
|
400
|
+
close_price_asof?: string | null;
|
|
401
|
+
close_ytw?: string | null;
|
|
402
|
+
/** @format double */
|
|
403
|
+
issue_minimum_denomination?: number | null;
|
|
404
|
+
puttable?: boolean | null;
|
|
405
|
+
}
|
|
406
|
+
export interface AesMidasCandelstick {
|
|
407
|
+
/** @format double */
|
|
408
|
+
open?: number;
|
|
409
|
+
/** @format double */
|
|
410
|
+
high?: number;
|
|
411
|
+
/** @format double */
|
|
412
|
+
low?: number;
|
|
413
|
+
/** @format double */
|
|
414
|
+
close?: number;
|
|
415
|
+
}
|
|
416
|
+
export interface AesMidasChangePasswordModel {
|
|
417
|
+
/** @minLength 1 */
|
|
418
|
+
user_id: string;
|
|
419
|
+
/** @minLength 1 */
|
|
420
|
+
old_password: string;
|
|
421
|
+
/** @minLength 1 */
|
|
422
|
+
new_password: string;
|
|
423
|
+
}
|
|
424
|
+
export interface AesMidasChartBar {
|
|
425
|
+
time?: string | null;
|
|
426
|
+
/** @format double */
|
|
427
|
+
open?: number;
|
|
428
|
+
/** @format double */
|
|
429
|
+
high?: number;
|
|
430
|
+
/** @format double */
|
|
431
|
+
low?: number;
|
|
432
|
+
/** @format double */
|
|
433
|
+
close?: number;
|
|
434
|
+
/** @format int64 */
|
|
435
|
+
volume?: number;
|
|
436
|
+
data_source?: string | null;
|
|
437
|
+
}
|
|
438
|
+
export interface AesMidasContractCounts {
|
|
439
|
+
firm_name?: string | null;
|
|
440
|
+
entitlement_name?: string | null;
|
|
441
|
+
firm?: AesMidasFirm;
|
|
442
|
+
entitlement?: AesMidasEntitlement;
|
|
443
|
+
/** @format int32 */
|
|
444
|
+
count?: number;
|
|
445
|
+
}
|
|
446
|
+
export interface AesMidasContractRecords {
|
|
447
|
+
user_entitlements?: AesMidasUserEntitlement[] | null;
|
|
448
|
+
user?: AesMidasApplicationUser;
|
|
449
|
+
user_information?: AesMidasUserInformation;
|
|
450
|
+
roles?: string[] | null;
|
|
451
|
+
}
|
|
452
|
+
export interface AesMidasContractRecordsResponsewithPagination {
|
|
453
|
+
/** @format int32 */
|
|
454
|
+
total_items?: number;
|
|
455
|
+
/** @format int32 */
|
|
456
|
+
total_pages?: number;
|
|
457
|
+
/** @format int32 */
|
|
458
|
+
current_pages?: number;
|
|
459
|
+
/** @format int32 */
|
|
460
|
+
page_size?: number;
|
|
461
|
+
data?: AesMidasContractRecords[] | null;
|
|
462
|
+
}
|
|
463
|
+
export interface AesMidasDataSource {
|
|
464
|
+
/** @minLength 1 */
|
|
465
|
+
name: string;
|
|
466
|
+
/** @format int32 */
|
|
467
|
+
entitlements?: number;
|
|
468
|
+
in_use: boolean;
|
|
469
|
+
/** @minLength 1 */
|
|
470
|
+
category: string;
|
|
471
|
+
/** @format int32 */
|
|
472
|
+
position_bit?: number;
|
|
473
|
+
description?: string | null;
|
|
474
|
+
}
|
|
475
|
+
export interface AesMidasDataSourceTally {
|
|
476
|
+
id?: string | null;
|
|
477
|
+
user?: AesMidasApplicationUser;
|
|
478
|
+
user_information?: AesMidasUserInformation;
|
|
479
|
+
user_data_config_history?: AesMidasUserDataConfigHistory;
|
|
480
|
+
}
|
|
481
|
+
export interface AesMidasDataSourceTallyCount {
|
|
482
|
+
firm_id?: string | null;
|
|
483
|
+
data_source_name?: string | null;
|
|
484
|
+
firm?: AesMidasFirm;
|
|
485
|
+
data_source?: AesMidasDataSource;
|
|
486
|
+
/** @format int32 */
|
|
487
|
+
count?: number;
|
|
488
|
+
}
|
|
489
|
+
export interface AesMidasDataSourceTallyResponsewithPagination {
|
|
490
|
+
/** @format int32 */
|
|
491
|
+
total_items?: number;
|
|
492
|
+
/** @format int32 */
|
|
493
|
+
total_pages?: number;
|
|
494
|
+
/** @format int32 */
|
|
495
|
+
current_pages?: number;
|
|
496
|
+
/** @format int32 */
|
|
497
|
+
page_size?: number;
|
|
498
|
+
data?: AesMidasDataSourceTally[] | null;
|
|
499
|
+
}
|
|
500
|
+
export interface AesMidasDayChart {
|
|
501
|
+
symbol?: string | null;
|
|
502
|
+
/** @format date */
|
|
503
|
+
chart_date?: string;
|
|
504
|
+
/** @format double */
|
|
505
|
+
open?: number;
|
|
506
|
+
/** @format double */
|
|
507
|
+
high?: number;
|
|
508
|
+
/** @format double */
|
|
509
|
+
low?: number;
|
|
510
|
+
/** @format double */
|
|
511
|
+
close?: number;
|
|
512
|
+
/** @format int64 */
|
|
513
|
+
volume?: number;
|
|
514
|
+
}
|
|
515
|
+
export interface AesMidasDayChartReformat {
|
|
516
|
+
date?: string | null;
|
|
517
|
+
/** @format double */
|
|
518
|
+
price?: number;
|
|
519
|
+
/** @format double */
|
|
520
|
+
opening?: number;
|
|
521
|
+
/** @format double */
|
|
522
|
+
high?: number;
|
|
523
|
+
/** @format double */
|
|
524
|
+
low?: number;
|
|
525
|
+
/** @format int64 */
|
|
526
|
+
volume?: number;
|
|
527
|
+
}
|
|
528
|
+
export interface AesMidasEntitlement {
|
|
529
|
+
/** @minLength 1 */
|
|
530
|
+
name: string;
|
|
531
|
+
/** @minLength 1 */
|
|
532
|
+
version: string;
|
|
533
|
+
pro_file_id?: string | null;
|
|
534
|
+
non_pro_file_id?: string | null;
|
|
535
|
+
description?: string | null;
|
|
536
|
+
}
|
|
537
|
+
export interface AesMidasEntitlementFile {
|
|
538
|
+
id?: string | null;
|
|
539
|
+
file_name?: string | null;
|
|
540
|
+
/** @minLength 1 */
|
|
541
|
+
mime_type: string;
|
|
542
|
+
/**
|
|
543
|
+
* @format byte
|
|
544
|
+
* @maxLength 16777215
|
|
545
|
+
*/
|
|
546
|
+
content: string;
|
|
547
|
+
/** @format date-time */
|
|
548
|
+
create_date_time?: string;
|
|
549
|
+
}
|
|
550
|
+
export interface AesMidasEntitlementBody {
|
|
551
|
+
entitlement: AesMidasEntitlement;
|
|
552
|
+
use_same_file?: boolean;
|
|
553
|
+
entitlement_file_pro?: AesMidasEntitlementFile;
|
|
554
|
+
entitlement_file_nonpro?: AesMidasEntitlementFile;
|
|
555
|
+
}
|
|
556
|
+
export interface AesMidasEquiductL1 {
|
|
557
|
+
symbol?: string | null;
|
|
558
|
+
comp_name?: string | null;
|
|
559
|
+
isin?: string | null;
|
|
560
|
+
currency?: string | null;
|
|
561
|
+
status?: string | null;
|
|
562
|
+
info_time?: string | null;
|
|
563
|
+
issue_market?: string | null;
|
|
564
|
+
market_name?: string | null;
|
|
565
|
+
market_desc?: string | null;
|
|
566
|
+
/** @format double */
|
|
567
|
+
bid_px?: number | null;
|
|
568
|
+
/** @format int32 */
|
|
569
|
+
bid_sz?: number | null;
|
|
570
|
+
/** @format double */
|
|
571
|
+
ask_px?: number | null;
|
|
572
|
+
/** @format int32 */
|
|
573
|
+
ask_sz?: number | null;
|
|
574
|
+
quote_time?: string | null;
|
|
575
|
+
bid_exch?: string | null;
|
|
576
|
+
ask_exch?: string | null;
|
|
577
|
+
}
|
|
578
|
+
export interface AesMidasExchanges {
|
|
579
|
+
exchange?: string | null;
|
|
580
|
+
code?: string | null;
|
|
581
|
+
short_code?: string | null;
|
|
582
|
+
country_code?: string | null;
|
|
583
|
+
region_code?: string | null;
|
|
584
|
+
currency?: string | null;
|
|
585
|
+
type?: string | null;
|
|
586
|
+
description?: string | null;
|
|
587
|
+
}
|
|
588
|
+
export interface AesMidasFirm {
|
|
589
|
+
firm_id?: string | null;
|
|
590
|
+
full_name?: string | null;
|
|
591
|
+
/** @format int32 */
|
|
592
|
+
status?: number;
|
|
593
|
+
source?: string | null;
|
|
594
|
+
/** @format int32 */
|
|
595
|
+
us_equity?: number;
|
|
596
|
+
nbbo_snapshot?: boolean;
|
|
597
|
+
/** @format int32 */
|
|
598
|
+
option?: number;
|
|
599
|
+
/** @format int32 */
|
|
600
|
+
indice?: number;
|
|
601
|
+
/** @format int32 */
|
|
602
|
+
international_market?: number;
|
|
603
|
+
crypto?: boolean;
|
|
604
|
+
futures?: boolean;
|
|
605
|
+
mutual_funds?: boolean;
|
|
606
|
+
vender_of_records?: boolean;
|
|
607
|
+
}
|
|
608
|
+
export interface AesMidasFirmEntitlement {
|
|
609
|
+
/** @minLength 1 */
|
|
610
|
+
firm_id: string;
|
|
611
|
+
/** @minLength 1 */
|
|
612
|
+
entitlement_name: string;
|
|
613
|
+
/** @format int32 */
|
|
614
|
+
status?: number;
|
|
615
|
+
/** @format date-time */
|
|
616
|
+
activate_time?: string | null;
|
|
617
|
+
/** @format date-time */
|
|
618
|
+
deactivate_time?: string | null;
|
|
619
|
+
version?: string | null;
|
|
620
|
+
}
|
|
621
|
+
export interface AesMidasFirmEntitlementHistory {
|
|
622
|
+
id?: string | null;
|
|
623
|
+
firm_id?: string | null;
|
|
624
|
+
entitlement_name?: string | null;
|
|
625
|
+
action?: string | null;
|
|
626
|
+
action_user_id?: string | null;
|
|
627
|
+
/** @format date-time */
|
|
628
|
+
action_time?: string;
|
|
629
|
+
version?: string | null;
|
|
630
|
+
}
|
|
631
|
+
export interface AesMidasFirmDefaultDataSetting {
|
|
632
|
+
firm_id?: string | null;
|
|
633
|
+
/** @format int32 */
|
|
634
|
+
quote_level?: number;
|
|
635
|
+
/** @format int32 */
|
|
636
|
+
quote_type?: number;
|
|
637
|
+
/** @format int32 */
|
|
638
|
+
us_equity?: number;
|
|
639
|
+
/** @format int32 */
|
|
640
|
+
nbbo_snapshot?: number;
|
|
641
|
+
/** @format int32 */
|
|
642
|
+
option?: number;
|
|
643
|
+
/** @format int32 */
|
|
644
|
+
indice?: number;
|
|
645
|
+
/** @format int32 */
|
|
646
|
+
international_market?: number;
|
|
647
|
+
/** @format int32 */
|
|
648
|
+
crypto?: number;
|
|
649
|
+
/** @format int32 */
|
|
650
|
+
futures?: number;
|
|
651
|
+
/** @format int32 */
|
|
652
|
+
mutual_funds?: number;
|
|
653
|
+
}
|
|
654
|
+
export interface AesMidasForexRate {
|
|
655
|
+
symbol?: string | null;
|
|
656
|
+
base_currency?: string | null;
|
|
657
|
+
quote_currency?: string | null;
|
|
658
|
+
/** @format double */
|
|
659
|
+
bid?: number | null;
|
|
660
|
+
/** @format double */
|
|
661
|
+
mid?: number | null;
|
|
662
|
+
/** @format double */
|
|
663
|
+
ask?: number | null;
|
|
664
|
+
/** @format double */
|
|
665
|
+
spread?: number | null;
|
|
666
|
+
time?: string | null;
|
|
667
|
+
}
|
|
668
|
+
export interface AesMidasForexReformat {
|
|
669
|
+
symbol?: string | null;
|
|
670
|
+
quote_currency?: string | null;
|
|
671
|
+
base_currency?: string | null;
|
|
672
|
+
fx?: boolean;
|
|
673
|
+
security_type?: string | null;
|
|
674
|
+
/** @format double */
|
|
675
|
+
yesterday_close?: number | null;
|
|
676
|
+
/** @format double */
|
|
677
|
+
last_price?: number | null;
|
|
678
|
+
update_time?: string | null;
|
|
679
|
+
trade_time?: string | null;
|
|
680
|
+
/** @format int32 */
|
|
681
|
+
precision?: number;
|
|
682
|
+
source?: string | null;
|
|
683
|
+
not_found?: boolean;
|
|
684
|
+
not_permissioned?: boolean;
|
|
685
|
+
}
|
|
686
|
+
export interface AesMidasForexTable {
|
|
687
|
+
base_currency?: string | null;
|
|
688
|
+
rates?: Record<string, number>;
|
|
689
|
+
}
|
|
690
|
+
export interface AesMidasFundWebQuote {
|
|
691
|
+
symbol?: string | null;
|
|
692
|
+
ut?: string | null;
|
|
693
|
+
/** @format double */
|
|
694
|
+
last_price?: number;
|
|
695
|
+
date_update?: string | null;
|
|
696
|
+
/** @format double */
|
|
697
|
+
today_change?: number;
|
|
698
|
+
/** @format double */
|
|
699
|
+
today_change_percent?: number;
|
|
700
|
+
/** @format double */
|
|
701
|
+
one_year_change_percent?: number;
|
|
702
|
+
cusip?: string | null;
|
|
703
|
+
}
|
|
704
|
+
export interface AesMidasICEEOD {
|
|
705
|
+
symbol?: string | null;
|
|
706
|
+
/** @format double */
|
|
707
|
+
closing_px?: number | null;
|
|
708
|
+
/** @format double */
|
|
709
|
+
last_px?: number | null;
|
|
710
|
+
isin?: string | null;
|
|
711
|
+
cusip?: string | null;
|
|
712
|
+
comp_name?: string | null;
|
|
713
|
+
comp_desc?: string | null;
|
|
714
|
+
currency?: string | null;
|
|
715
|
+
market_name?: string | null;
|
|
716
|
+
info_time?: string | null;
|
|
717
|
+
/** @format double */
|
|
718
|
+
bid_px?: number | null;
|
|
719
|
+
/** @format double */
|
|
720
|
+
ask_px?: number | null;
|
|
721
|
+
/** @format double */
|
|
722
|
+
open_px?: number | null;
|
|
723
|
+
/** @format int64 */
|
|
724
|
+
volume?: number | null;
|
|
725
|
+
/** @format double */
|
|
726
|
+
change?: number | null;
|
|
727
|
+
/** @format double */
|
|
728
|
+
change_percent?: number | null;
|
|
729
|
+
market_desc?: string | null;
|
|
730
|
+
/** @format double */
|
|
731
|
+
yest_close_px?: number | null;
|
|
732
|
+
}
|
|
733
|
+
export interface AesMidasIsinInfo {
|
|
734
|
+
isin?: string | null;
|
|
735
|
+
name_addr?: string | null;
|
|
736
|
+
primary_name?: string | null;
|
|
737
|
+
currency?: string | null;
|
|
738
|
+
tickers_info?: Record<string, string | null>;
|
|
739
|
+
}
|
|
740
|
+
export interface AesMidasLevel1 {
|
|
741
|
+
symbol?: string | null;
|
|
742
|
+
issue_market?: string | null;
|
|
743
|
+
/** @format double */
|
|
744
|
+
yest_close_px?: number;
|
|
745
|
+
/** @format int64 */
|
|
746
|
+
volume?: number;
|
|
747
|
+
/** @format double */
|
|
748
|
+
open_px?: number;
|
|
749
|
+
/** @format double */
|
|
750
|
+
high_px?: number;
|
|
751
|
+
/** @format double */
|
|
752
|
+
low_px?: number;
|
|
753
|
+
/** @format double */
|
|
754
|
+
closing_px?: number;
|
|
755
|
+
/** @format double */
|
|
756
|
+
ask_px?: number;
|
|
757
|
+
/** @format int32 */
|
|
758
|
+
ask_sz?: number;
|
|
759
|
+
/** @format double */
|
|
760
|
+
bid_px?: number;
|
|
761
|
+
/** @format int32 */
|
|
762
|
+
bid_sz?: number;
|
|
763
|
+
/** @format double */
|
|
764
|
+
last_px?: number;
|
|
765
|
+
/** @format double */
|
|
766
|
+
change?: number;
|
|
767
|
+
/** @format double */
|
|
768
|
+
change_percent?: number;
|
|
769
|
+
/** @format int32 */
|
|
770
|
+
column?: number;
|
|
771
|
+
trade_region?: string | null;
|
|
772
|
+
trade_region_name?: string | null;
|
|
773
|
+
/** @format double */
|
|
774
|
+
trade_px?: number;
|
|
775
|
+
/** @format int32 */
|
|
776
|
+
trade_sz?: number;
|
|
777
|
+
/** @format int32 */
|
|
778
|
+
condition?: number;
|
|
779
|
+
trade_time?: string | null;
|
|
780
|
+
/** @format double */
|
|
781
|
+
post_last_px?: number;
|
|
782
|
+
post_trade_time?: string | null;
|
|
783
|
+
comp_name?: string | null;
|
|
784
|
+
/** @format double */
|
|
785
|
+
pe_ratio?: number;
|
|
786
|
+
/** @format int64 */
|
|
787
|
+
avg_vol30d?: number;
|
|
788
|
+
/** @format double */
|
|
789
|
+
high52w_px?: number;
|
|
790
|
+
/** @format double */
|
|
791
|
+
low52w_px?: number;
|
|
792
|
+
/** @format double */
|
|
793
|
+
div_yield?: number;
|
|
794
|
+
/** @format double */
|
|
795
|
+
div_amt?: number;
|
|
796
|
+
pay_date?: string | null;
|
|
797
|
+
div_date_ex?: string | null;
|
|
798
|
+
/** @format int32 */
|
|
799
|
+
com_shrs_out?: number;
|
|
800
|
+
comp_desc?: string | null;
|
|
801
|
+
/** @format double */
|
|
802
|
+
mkt_cap?: number;
|
|
803
|
+
quote_time?: string | null;
|
|
804
|
+
info_time?: string | null;
|
|
805
|
+
/** @format double */
|
|
806
|
+
calendar_year_high?: number;
|
|
807
|
+
/** @format double */
|
|
808
|
+
calendar_year_low?: number;
|
|
809
|
+
calendar_year_high_date?: string | null;
|
|
810
|
+
calendar_year_low_date?: string | null;
|
|
811
|
+
/** @format double */
|
|
812
|
+
vwap?: number;
|
|
813
|
+
/** @format int32 */
|
|
814
|
+
yesterday_trade_volume?: number;
|
|
815
|
+
mic?: string | null;
|
|
816
|
+
status?: string | null;
|
|
817
|
+
isin?: string | null;
|
|
818
|
+
cusip?: string | null;
|
|
819
|
+
sedol?: string | null;
|
|
820
|
+
gics?: string | null;
|
|
821
|
+
/** @format double */
|
|
822
|
+
pre_last_px?: number;
|
|
823
|
+
pre_trade_time?: string | null;
|
|
824
|
+
bid_exch?: string | null;
|
|
825
|
+
ask_exch?: string | null;
|
|
826
|
+
instr_type?: string | null;
|
|
827
|
+
dividend_payment_date?: string | null;
|
|
828
|
+
dividend_ex_date?: string | null;
|
|
829
|
+
/** @format double */
|
|
830
|
+
dividend_rate?: number;
|
|
831
|
+
high52w_date?: string | null;
|
|
832
|
+
low52w_date?: string | null;
|
|
833
|
+
/** @format double */
|
|
834
|
+
fund_beta?: number;
|
|
835
|
+
market_name?: string | null;
|
|
836
|
+
market_desc?: string | null;
|
|
837
|
+
data_source?: string | null;
|
|
838
|
+
}
|
|
839
|
+
export interface AesMidasLevel1Reformat {
|
|
840
|
+
symbol?: string | null;
|
|
841
|
+
not_permissioned?: boolean;
|
|
842
|
+
not_found?: boolean;
|
|
843
|
+
delayed?: boolean;
|
|
844
|
+
source?: string | null;
|
|
845
|
+
isin?: string | null;
|
|
846
|
+
cusip?: string | null;
|
|
847
|
+
company_name?: string | null;
|
|
848
|
+
exchange?: string | null;
|
|
849
|
+
market_description?: string | null;
|
|
850
|
+
/** @format double */
|
|
851
|
+
high52week?: number | null;
|
|
852
|
+
/** @format double */
|
|
853
|
+
low52week?: number | null;
|
|
854
|
+
week52_high_date?: string | null;
|
|
855
|
+
week52_low_date?: string | null;
|
|
856
|
+
/** @format double */
|
|
857
|
+
calendar_year_high?: number | null;
|
|
858
|
+
/** @format double */
|
|
859
|
+
calendar_year_low?: number | null;
|
|
860
|
+
/** @format double */
|
|
861
|
+
precise_vwap?: number | null;
|
|
862
|
+
/** @format double */
|
|
863
|
+
vwap1?: number | null;
|
|
864
|
+
/** @format int32 */
|
|
865
|
+
precision?: number | null;
|
|
866
|
+
/** @format double */
|
|
867
|
+
dividend_yield?: number | null;
|
|
868
|
+
/** @format double */
|
|
869
|
+
price_earning_ratio?: number | null;
|
|
870
|
+
/** @format double */
|
|
871
|
+
day_high?: number | null;
|
|
872
|
+
/** @format int64 */
|
|
873
|
+
ask_size?: number | null;
|
|
874
|
+
/** @format double */
|
|
875
|
+
market_cap?: number | null;
|
|
876
|
+
/** @format double */
|
|
877
|
+
dividend_amount?: number | null;
|
|
878
|
+
/** @format double */
|
|
879
|
+
day_low?: number | null;
|
|
880
|
+
/** @format int64 */
|
|
881
|
+
volume?: number | null;
|
|
882
|
+
/** @format int64 */
|
|
883
|
+
average_volume30?: number | null;
|
|
884
|
+
trade_time?: string | null;
|
|
885
|
+
/** @format double */
|
|
886
|
+
trade_price?: number | null;
|
|
887
|
+
trade_region?: AesMidasRegion;
|
|
888
|
+
/** @format double */
|
|
889
|
+
open_interest?: number | null;
|
|
890
|
+
/** @format double */
|
|
891
|
+
opening_price?: number | null;
|
|
892
|
+
/** @format double */
|
|
893
|
+
change_percent?: number | null;
|
|
894
|
+
currency?: string | null;
|
|
895
|
+
/** @format int64 */
|
|
896
|
+
trade_size?: number | null;
|
|
897
|
+
/** @format double */
|
|
898
|
+
yesterday_close?: number | null;
|
|
899
|
+
/** @format int64 */
|
|
900
|
+
bid_size?: number | null;
|
|
901
|
+
/** @format double */
|
|
902
|
+
change?: number | null;
|
|
903
|
+
update_time?: string | null;
|
|
904
|
+
/** @format double */
|
|
905
|
+
ask?: number | null;
|
|
906
|
+
/** @format double */
|
|
907
|
+
bid?: number | null;
|
|
908
|
+
dividend_payment_date?: string | null;
|
|
909
|
+
dividend_ex_date?: string | null;
|
|
910
|
+
/** @format double */
|
|
911
|
+
last_price?: number | null;
|
|
912
|
+
/** @format double */
|
|
913
|
+
trailing12_months_eps?: number | null;
|
|
914
|
+
ask_region?: AesMidasRegion;
|
|
915
|
+
bid_region?: AesMidasRegion;
|
|
916
|
+
/** @format double */
|
|
917
|
+
total_cash_amount?: number | null;
|
|
918
|
+
/** @format double */
|
|
919
|
+
estimated_cash_amount?: number | null;
|
|
920
|
+
/** @format double */
|
|
921
|
+
dividend_rate?: number | null;
|
|
922
|
+
/** @format double */
|
|
923
|
+
beta?: number | null;
|
|
924
|
+
offering?: boolean;
|
|
925
|
+
/** @format double */
|
|
926
|
+
nav?: number | null;
|
|
927
|
+
/** @format double */
|
|
928
|
+
nav_price?: number | null;
|
|
929
|
+
/** @format double */
|
|
930
|
+
nav_change?: number | null;
|
|
931
|
+
/** @format double */
|
|
932
|
+
nav_yesterday_price?: number | null;
|
|
933
|
+
mutual_fund?: boolean;
|
|
934
|
+
/** @format int64 */
|
|
935
|
+
min_ask_size?: number | null;
|
|
936
|
+
/** @format int64 */
|
|
937
|
+
min_bid_size?: number | null;
|
|
938
|
+
/** @format double */
|
|
939
|
+
bid_yield?: number | null;
|
|
940
|
+
/** @format double */
|
|
941
|
+
ask_yield?: number | null;
|
|
942
|
+
bond?: boolean;
|
|
943
|
+
market_cap_classification?: string | null;
|
|
944
|
+
/** @format double */
|
|
945
|
+
coupon_rate?: number | null;
|
|
946
|
+
/** @format double */
|
|
947
|
+
issue_size?: number | null;
|
|
948
|
+
/** @format double */
|
|
949
|
+
issue_price?: number | null;
|
|
950
|
+
/** @format double */
|
|
951
|
+
par_value?: number | null;
|
|
952
|
+
/** @format double */
|
|
953
|
+
accrued_interest?: number | null;
|
|
954
|
+
option?: boolean;
|
|
955
|
+
call?: boolean;
|
|
956
|
+
put?: boolean;
|
|
957
|
+
in_the_money?: boolean;
|
|
958
|
+
put_or_call?: string | null;
|
|
959
|
+
underlying_symbol?: string | null;
|
|
960
|
+
root_symbol?: string | null;
|
|
961
|
+
underlying?: AesMidasLevel1Reformat;
|
|
962
|
+
expiration_date?: string | null;
|
|
963
|
+
/** @format int64 */
|
|
964
|
+
contract_size?: number;
|
|
965
|
+
/** @format double */
|
|
966
|
+
strike_price?: number;
|
|
967
|
+
greeks?: AesMidasOptionGreekReformat;
|
|
968
|
+
crypto?: boolean;
|
|
969
|
+
base_currency?: string | null;
|
|
970
|
+
fx?: boolean;
|
|
971
|
+
}
|
|
972
|
+
export interface AesMidasLoginModel {
|
|
973
|
+
/** @minLength 1 */
|
|
974
|
+
user_name: string;
|
|
975
|
+
/** @minLength 1 */
|
|
976
|
+
password: string;
|
|
977
|
+
}
|
|
978
|
+
export interface AesMidasMinuteChart {
|
|
979
|
+
symbol?: string | null;
|
|
980
|
+
/** @format date-time */
|
|
981
|
+
chart_time?: string;
|
|
982
|
+
/** @format double */
|
|
983
|
+
open?: number;
|
|
984
|
+
/** @format double */
|
|
985
|
+
high?: number;
|
|
986
|
+
/** @format double */
|
|
987
|
+
low?: number;
|
|
988
|
+
/** @format double */
|
|
989
|
+
close?: number;
|
|
990
|
+
/** @format int64 */
|
|
991
|
+
volume?: number;
|
|
992
|
+
}
|
|
993
|
+
export interface AesMidasMinuteChartReformat {
|
|
994
|
+
date?: string | null;
|
|
995
|
+
/** @format double */
|
|
996
|
+
price?: number;
|
|
997
|
+
/** @format double */
|
|
998
|
+
opening?: number;
|
|
999
|
+
/** @format double */
|
|
1000
|
+
high?: number;
|
|
1001
|
+
/** @format double */
|
|
1002
|
+
low?: number;
|
|
1003
|
+
/** @format int64 */
|
|
1004
|
+
volume?: number;
|
|
1005
|
+
change?: string | null;
|
|
1006
|
+
candelstick?: AesMidasCandelstick;
|
|
1007
|
+
bollinger?: AesMidasBollinger;
|
|
1008
|
+
sma?: AesMidasRsiSpan[] | null;
|
|
1009
|
+
ema?: AesMidasRsiSpan[] | null;
|
|
1010
|
+
}
|
|
1011
|
+
export interface AesMidasModifyEmailModel {
|
|
1012
|
+
/** @minLength 1 */
|
|
1013
|
+
user_id: string;
|
|
1014
|
+
/** @minLength 1 */
|
|
1015
|
+
email: string;
|
|
1016
|
+
}
|
|
1017
|
+
export interface AesMidasModifyPhoneNumberModel {
|
|
1018
|
+
/** @minLength 1 */
|
|
1019
|
+
user_id: string;
|
|
1020
|
+
/** @minLength 1 */
|
|
1021
|
+
phone_number: string;
|
|
1022
|
+
}
|
|
1023
|
+
export interface AesMidasMutualFund {
|
|
1024
|
+
symbol?: string | null;
|
|
1025
|
+
company_name?: string | null;
|
|
1026
|
+
/** @format double */
|
|
1027
|
+
nav_price?: number | null;
|
|
1028
|
+
/** @format double */
|
|
1029
|
+
nav_change?: number | null;
|
|
1030
|
+
/** @format double */
|
|
1031
|
+
nav_yesterday_price?: number | null;
|
|
1032
|
+
/** @format double */
|
|
1033
|
+
high52_week?: number | null;
|
|
1034
|
+
/** @format double */
|
|
1035
|
+
low52_week?: number | null;
|
|
1036
|
+
week52_high_date?: string | null;
|
|
1037
|
+
week52_low_date?: string | null;
|
|
1038
|
+
trade_time?: string | null;
|
|
1039
|
+
update_time?: string | null;
|
|
1040
|
+
}
|
|
1041
|
+
export interface AesMidasOccupation {
|
|
1042
|
+
name?: string | null;
|
|
1043
|
+
}
|
|
1044
|
+
export interface AesMidasOptionChain {
|
|
1045
|
+
symbol?: string | null;
|
|
1046
|
+
/** @format double */
|
|
1047
|
+
last_px?: number;
|
|
1048
|
+
/** @format double */
|
|
1049
|
+
last_chg?: number;
|
|
1050
|
+
/** @format double */
|
|
1051
|
+
bid_px?: number;
|
|
1052
|
+
/** @format int32 */
|
|
1053
|
+
bid_sz?: number;
|
|
1054
|
+
/** @format double */
|
|
1055
|
+
ask_px?: number;
|
|
1056
|
+
/** @format int32 */
|
|
1057
|
+
ask_sz?: number;
|
|
1058
|
+
/** @format int32 */
|
|
1059
|
+
vol?: number;
|
|
1060
|
+
/** @format int32 */
|
|
1061
|
+
open_inst?: number;
|
|
1062
|
+
data_source?: string | null;
|
|
1063
|
+
}
|
|
1064
|
+
export interface AesMidasOptionChainResponsewithPagination {
|
|
1065
|
+
/** @format int32 */
|
|
1066
|
+
total_items?: number;
|
|
1067
|
+
/** @format int32 */
|
|
1068
|
+
total_pages?: number;
|
|
1069
|
+
/** @format int32 */
|
|
1070
|
+
current_pages?: number;
|
|
1071
|
+
/** @format int32 */
|
|
1072
|
+
page_size?: number;
|
|
1073
|
+
data?: AesMidasOptionChain[] | null;
|
|
1074
|
+
}
|
|
1075
|
+
export interface AesMidasOptionGreek {
|
|
1076
|
+
/** @format double */
|
|
1077
|
+
delta?: number;
|
|
1078
|
+
/** @format double */
|
|
1079
|
+
gamma?: number;
|
|
1080
|
+
/** @format double */
|
|
1081
|
+
theta?: number;
|
|
1082
|
+
/** @format double */
|
|
1083
|
+
vega?: number;
|
|
1084
|
+
/** @format double */
|
|
1085
|
+
rho?: number;
|
|
1086
|
+
/** @format double */
|
|
1087
|
+
implied_volatility?: number;
|
|
1088
|
+
/** @format double */
|
|
1089
|
+
risk_free_rate?: number;
|
|
1090
|
+
not_found?: boolean;
|
|
1091
|
+
}
|
|
1092
|
+
export interface AesMidasOptionGreekReformat {
|
|
1093
|
+
/** @format double */
|
|
1094
|
+
delta?: number;
|
|
1095
|
+
/** @format double */
|
|
1096
|
+
gamma?: number;
|
|
1097
|
+
/** @format double */
|
|
1098
|
+
theta?: number;
|
|
1099
|
+
/** @format double */
|
|
1100
|
+
vega?: number;
|
|
1101
|
+
/** @format double */
|
|
1102
|
+
rho?: number;
|
|
1103
|
+
not_found?: boolean;
|
|
1104
|
+
}
|
|
1105
|
+
export interface AesMidasOptionL1 {
|
|
1106
|
+
symbol?: string | null;
|
|
1107
|
+
bid_exch?: string | null;
|
|
1108
|
+
/** @format double */
|
|
1109
|
+
bid_px?: number;
|
|
1110
|
+
/** @format int32 */
|
|
1111
|
+
bid_sz?: number;
|
|
1112
|
+
ask_exch?: string | null;
|
|
1113
|
+
/** @format double */
|
|
1114
|
+
ask_px?: number;
|
|
1115
|
+
/** @format int32 */
|
|
1116
|
+
ask_sz?: number;
|
|
1117
|
+
/** @format double */
|
|
1118
|
+
open_px?: number;
|
|
1119
|
+
/** @format double */
|
|
1120
|
+
high_px?: number;
|
|
1121
|
+
/** @format double */
|
|
1122
|
+
low_px?: number;
|
|
1123
|
+
/** @format double */
|
|
1124
|
+
yest_close_px?: number;
|
|
1125
|
+
/** @format double */
|
|
1126
|
+
last_px?: number;
|
|
1127
|
+
/** @format double */
|
|
1128
|
+
close_px?: number;
|
|
1129
|
+
/** @format int32 */
|
|
1130
|
+
volume?: number;
|
|
1131
|
+
/** @format int32 */
|
|
1132
|
+
open_inst?: number;
|
|
1133
|
+
quote_time?: string | null;
|
|
1134
|
+
underlying?: string | null;
|
|
1135
|
+
/** @format int32 */
|
|
1136
|
+
strike?: number;
|
|
1137
|
+
/** @format int32 */
|
|
1138
|
+
prime_share?: number;
|
|
1139
|
+
expire?: string | null;
|
|
1140
|
+
data_source?: string | null;
|
|
1141
|
+
}
|
|
1142
|
+
export interface AesMidasOptionL1WithGreeks {
|
|
1143
|
+
option_l1?: AesMidasOptionL1;
|
|
1144
|
+
option_greek?: AesMidasOptionGreek;
|
|
1145
|
+
}
|
|
1146
|
+
export interface AesMidasPagination {
|
|
1147
|
+
/** @format int32 */
|
|
1148
|
+
page_number?: number;
|
|
1149
|
+
/** @format int32 */
|
|
1150
|
+
page_size?: number;
|
|
1151
|
+
}
|
|
1152
|
+
export interface AesMidasPermission {
|
|
1153
|
+
/** @minLength 1 */
|
|
1154
|
+
user_name: string;
|
|
1155
|
+
/** @format int32 */
|
|
1156
|
+
num_symbol_per_query: number;
|
|
1157
|
+
/** @format int32 */
|
|
1158
|
+
num_query_per_sec: number;
|
|
1159
|
+
/** @format int32 */
|
|
1160
|
+
size_data_per_sec: number;
|
|
1161
|
+
/** @minLength 1 */
|
|
1162
|
+
allow_ip: string;
|
|
1163
|
+
level1: boolean;
|
|
1164
|
+
level2: boolean;
|
|
1165
|
+
}
|
|
1166
|
+
export interface AesMidasQueryLog {
|
|
1167
|
+
id?: string | null;
|
|
1168
|
+
/** @format date-time */
|
|
1169
|
+
log_time?: string;
|
|
1170
|
+
level?: string | null;
|
|
1171
|
+
user_id?: string | null;
|
|
1172
|
+
action?: string | null;
|
|
1173
|
+
ip_address?: string | null;
|
|
1174
|
+
query_string?: string | null;
|
|
1175
|
+
post_body?: string | null;
|
|
1176
|
+
message?: string | null;
|
|
1177
|
+
}
|
|
1178
|
+
export interface AesMidasQueryLogReport {
|
|
1179
|
+
id?: string | null;
|
|
1180
|
+
data_source?: string | null;
|
|
1181
|
+
user_id?: string | null;
|
|
1182
|
+
/** @format date-time */
|
|
1183
|
+
action_time?: string;
|
|
1184
|
+
symbol?: string | null;
|
|
1185
|
+
platform?: string | null;
|
|
1186
|
+
action?: string | null;
|
|
1187
|
+
}
|
|
1188
|
+
export interface AesMidasQueryPostBody {
|
|
1189
|
+
pagination?: AesMidasPagination;
|
|
1190
|
+
sorts?: AesMidasSort[] | null;
|
|
1191
|
+
}
|
|
1192
|
+
export interface AesMidasQuoddDelay {
|
|
1193
|
+
symbol?: string | null;
|
|
1194
|
+
/** @format double */
|
|
1195
|
+
yest_close_px?: number | null;
|
|
1196
|
+
/** @format int64 */
|
|
1197
|
+
volume?: number | null;
|
|
1198
|
+
/** @format double */
|
|
1199
|
+
open_px?: number | null;
|
|
1200
|
+
/** @format double */
|
|
1201
|
+
high_px?: number | null;
|
|
1202
|
+
/** @format double */
|
|
1203
|
+
low_px?: number | null;
|
|
1204
|
+
/** @format double */
|
|
1205
|
+
closing_px?: number | null;
|
|
1206
|
+
/** @format double */
|
|
1207
|
+
last_px?: number | null;
|
|
1208
|
+
/** @format double */
|
|
1209
|
+
trade_px?: number | null;
|
|
1210
|
+
/** @format int64 */
|
|
1211
|
+
trade_sz?: number | null;
|
|
1212
|
+
activity_timestamp?: string | null;
|
|
1213
|
+
currency?: string | null;
|
|
1214
|
+
/** @format double */
|
|
1215
|
+
ask_px?: number | null;
|
|
1216
|
+
/** @format int64 */
|
|
1217
|
+
ask_sz?: number | null;
|
|
1218
|
+
/** @format double */
|
|
1219
|
+
bid_px?: number | null;
|
|
1220
|
+
/** @format int64 */
|
|
1221
|
+
bid_sz?: number | null;
|
|
1222
|
+
cusip?: string | null;
|
|
1223
|
+
isin?: string | null;
|
|
1224
|
+
comp_name?: string | null;
|
|
1225
|
+
issue_market?: string | null;
|
|
1226
|
+
market_desc?: string | null;
|
|
1227
|
+
quote_time?: string | null;
|
|
1228
|
+
/** @format double */
|
|
1229
|
+
high52w_px?: number | null;
|
|
1230
|
+
/** @format double */
|
|
1231
|
+
low52w_px?: number | null;
|
|
1232
|
+
/** @format double */
|
|
1233
|
+
change?: number | null;
|
|
1234
|
+
/** @format double */
|
|
1235
|
+
change_percent?: number | null;
|
|
1236
|
+
status?: string | null;
|
|
1237
|
+
market_name?: string | null;
|
|
1238
|
+
}
|
|
1239
|
+
export interface AesMidasQuoddEOD {
|
|
1240
|
+
symbol?: string | null;
|
|
1241
|
+
info_time?: string | null;
|
|
1242
|
+
/** @format double */
|
|
1243
|
+
closing_px?: number | null;
|
|
1244
|
+
cusip?: string | null;
|
|
1245
|
+
/** @format double */
|
|
1246
|
+
change?: number | null;
|
|
1247
|
+
/** @format double */
|
|
1248
|
+
bid_px?: number | null;
|
|
1249
|
+
/** @format double */
|
|
1250
|
+
open_px?: number | null;
|
|
1251
|
+
/** @format double */
|
|
1252
|
+
low_px?: number | null;
|
|
1253
|
+
/** @format double */
|
|
1254
|
+
last_px?: number | null;
|
|
1255
|
+
/** @format double */
|
|
1256
|
+
high_px?: number | null;
|
|
1257
|
+
/** @format double */
|
|
1258
|
+
change_percent?: number | null;
|
|
1259
|
+
/** @format double */
|
|
1260
|
+
yest_close_px?: number | null;
|
|
1261
|
+
currency?: string | null;
|
|
1262
|
+
/** @format double */
|
|
1263
|
+
vwap?: number | null;
|
|
1264
|
+
issue_market?: string | null;
|
|
1265
|
+
/** @format double */
|
|
1266
|
+
ask_px?: number | null;
|
|
1267
|
+
isin?: string | null;
|
|
1268
|
+
comp_name?: string | null;
|
|
1269
|
+
/** @format int64 */
|
|
1270
|
+
volume?: number | null;
|
|
1271
|
+
sedol?: string | null;
|
|
1272
|
+
market_desc?: string | null;
|
|
1273
|
+
/** @format double */
|
|
1274
|
+
high52w_px?: number | null;
|
|
1275
|
+
/** @format double */
|
|
1276
|
+
low52w_px?: number | null;
|
|
1277
|
+
market_name?: string | null;
|
|
1278
|
+
}
|
|
1279
|
+
export interface AesMidasRegion {
|
|
1280
|
+
code?: string | null;
|
|
1281
|
+
description?: string | null;
|
|
1282
|
+
}
|
|
1283
|
+
export interface AesMidasRegionQuote {
|
|
1284
|
+
mmid?: string | null;
|
|
1285
|
+
flag?: string | null;
|
|
1286
|
+
/** @format double */
|
|
1287
|
+
bid_px?: number;
|
|
1288
|
+
/** @format int32 */
|
|
1289
|
+
bid_sz?: number;
|
|
1290
|
+
bid_time?: string | null;
|
|
1291
|
+
/** @format double */
|
|
1292
|
+
ask_px?: number;
|
|
1293
|
+
/** @format int32 */
|
|
1294
|
+
ask_sz?: number;
|
|
1295
|
+
ask_time?: string | null;
|
|
1296
|
+
data_source?: string | null;
|
|
1297
|
+
}
|
|
1298
|
+
export interface AesMidasRegisterModel {
|
|
1299
|
+
/** @minLength 1 */
|
|
1300
|
+
user_name: string;
|
|
1301
|
+
/** @minLength 1 */
|
|
1302
|
+
email: string;
|
|
1303
|
+
/** @minLength 1 */
|
|
1304
|
+
phone_number: string;
|
|
1305
|
+
/** @minLength 1 */
|
|
1306
|
+
password: string;
|
|
1307
|
+
firm_id?: string | null;
|
|
1308
|
+
}
|
|
1309
|
+
export interface AesMidasRsiSpan {
|
|
1310
|
+
/** @format int32 */
|
|
1311
|
+
span?: number;
|
|
1312
|
+
/** @format double */
|
|
1313
|
+
value?: number;
|
|
1314
|
+
}
|
|
1315
|
+
export interface AesMidasSignAgreement {
|
|
1316
|
+
/** @minLength 1 */
|
|
1317
|
+
user_id: string;
|
|
1318
|
+
/** @minLength 1 */
|
|
1319
|
+
entitlement_name: string;
|
|
1320
|
+
prof: boolean;
|
|
1321
|
+
/** @minLength 1 */
|
|
1322
|
+
signature: string;
|
|
1323
|
+
entitlement_file: AesMidasEntitlementFile;
|
|
1324
|
+
}
|
|
1325
|
+
export interface AesMidasSnapshot {
|
|
1326
|
+
symbol?: string | null;
|
|
1327
|
+
issue_market?: string | null;
|
|
1328
|
+
/** @format double */
|
|
1329
|
+
yest_close_px?: number;
|
|
1330
|
+
/** @format double */
|
|
1331
|
+
open_px?: number;
|
|
1332
|
+
/** @format double */
|
|
1333
|
+
high_px?: number;
|
|
1334
|
+
/** @format double */
|
|
1335
|
+
low_px?: number;
|
|
1336
|
+
/** @format double */
|
|
1337
|
+
closing_px?: number;
|
|
1338
|
+
/** @format double */
|
|
1339
|
+
last_px?: number;
|
|
1340
|
+
/** @format double */
|
|
1341
|
+
trade_px?: number;
|
|
1342
|
+
/** @format int32 */
|
|
1343
|
+
trade_sz?: number;
|
|
1344
|
+
/** @format int32 */
|
|
1345
|
+
volume?: number;
|
|
1346
|
+
data_source?: string | null;
|
|
1347
|
+
}
|
|
1348
|
+
export interface AesMidasSnapshotCount {
|
|
1349
|
+
firm_id?: string | null;
|
|
1350
|
+
exchange?: string;
|
|
1351
|
+
firm?: AesMidasFirm;
|
|
1352
|
+
exchange_details?: AesMidasExchanges;
|
|
1353
|
+
/** @format int32 */
|
|
1354
|
+
count?: number;
|
|
1355
|
+
}
|
|
1356
|
+
export interface AesMidasSnapshotReport {
|
|
1357
|
+
firm_id?: string | null;
|
|
1358
|
+
exchange?: string;
|
|
1359
|
+
user_id?: string | null;
|
|
1360
|
+
/** @format date-time */
|
|
1361
|
+
action_time?: string;
|
|
1362
|
+
symbol?: string | null;
|
|
1363
|
+
platform?: string | null;
|
|
1364
|
+
action?: string | null;
|
|
1365
|
+
}
|
|
1366
|
+
export interface AesMidasSnapshotReportResponsewithPagination {
|
|
1367
|
+
/** @format int32 */
|
|
1368
|
+
total_items?: number;
|
|
1369
|
+
/** @format int32 */
|
|
1370
|
+
total_pages?: number;
|
|
1371
|
+
/** @format int32 */
|
|
1372
|
+
current_pages?: number;
|
|
1373
|
+
/** @format int32 */
|
|
1374
|
+
page_size?: number;
|
|
1375
|
+
data?: AesMidasSnapshotReport[] | null;
|
|
1376
|
+
}
|
|
1377
|
+
export interface AesMidasSort {
|
|
1378
|
+
sort_by?: string | null;
|
|
1379
|
+
sort_order?: string | null;
|
|
1380
|
+
}
|
|
1381
|
+
export interface AesMidasSymbolSearchBody {
|
|
1382
|
+
symbol_include?: string[] | null;
|
|
1383
|
+
symbol_exclude?: string[] | null;
|
|
1384
|
+
stock_type_include?: string[] | null;
|
|
1385
|
+
stock_type_exclude?: string[] | null;
|
|
1386
|
+
company_name?: string | null;
|
|
1387
|
+
isin?: string | null;
|
|
1388
|
+
cusip?: string | null;
|
|
1389
|
+
/** @format int32 */
|
|
1390
|
+
market_cap_high?: number | null;
|
|
1391
|
+
/** @format int32 */
|
|
1392
|
+
market_cap_low?: number | null;
|
|
1393
|
+
/** @format double */
|
|
1394
|
+
pe_ratio_high?: number | null;
|
|
1395
|
+
/** @format double */
|
|
1396
|
+
pe_ratio_low?: number | null;
|
|
1397
|
+
/** @format double */
|
|
1398
|
+
dividend_percent_high?: number | null;
|
|
1399
|
+
/** @format double */
|
|
1400
|
+
dividend_percent_low?: number | null;
|
|
1401
|
+
/** @format date */
|
|
1402
|
+
dividend_pay_date_start?: string | null;
|
|
1403
|
+
/** @format date */
|
|
1404
|
+
dividend_pay_date_end?: string | null;
|
|
1405
|
+
/** @format date */
|
|
1406
|
+
dividend_ex_date_start?: string | null;
|
|
1407
|
+
/** @format date */
|
|
1408
|
+
dividend_ex_date_end?: string | null;
|
|
1409
|
+
mic_include?: string[] | null;
|
|
1410
|
+
mic_exclude?: string[] | null;
|
|
1411
|
+
/** @format double */
|
|
1412
|
+
last_price_high?: number | null;
|
|
1413
|
+
/** @format double */
|
|
1414
|
+
last_price_low?: number | null;
|
|
1415
|
+
/** @format int32 */
|
|
1416
|
+
volume_high?: number | null;
|
|
1417
|
+
/** @format int32 */
|
|
1418
|
+
volume_low?: number | null;
|
|
1419
|
+
/** @format double */
|
|
1420
|
+
yesterday_close_high?: number | null;
|
|
1421
|
+
/** @format double */
|
|
1422
|
+
yesterday_close_low?: number | null;
|
|
1423
|
+
/** @format int32 */
|
|
1424
|
+
average_volume_30d_high?: number | null;
|
|
1425
|
+
/** @format int32 */
|
|
1426
|
+
average_volume_30d_low?: number | null;
|
|
1427
|
+
/** @format double */
|
|
1428
|
+
price_change_high?: number | null;
|
|
1429
|
+
/** @format double */
|
|
1430
|
+
price_change_low?: number | null;
|
|
1431
|
+
/** @format double */
|
|
1432
|
+
price_change_percent_high?: number | null;
|
|
1433
|
+
/** @format double */
|
|
1434
|
+
price_change_percent_low?: number | null;
|
|
1435
|
+
/** @format double */
|
|
1436
|
+
dollar_volume_high?: number | null;
|
|
1437
|
+
/** @format double */
|
|
1438
|
+
dollar_volume_low?: number | null;
|
|
1439
|
+
/** @format double */
|
|
1440
|
+
open_gap_high?: number | null;
|
|
1441
|
+
/** @format double */
|
|
1442
|
+
open_gap_low?: number | null;
|
|
1443
|
+
/** @format double */
|
|
1444
|
+
close_gap_high?: number | null;
|
|
1445
|
+
/** @format double */
|
|
1446
|
+
close_gap_low?: number | null;
|
|
1447
|
+
inverse?: boolean | null;
|
|
1448
|
+
symbol_type?: string | null;
|
|
1449
|
+
leverage_include?: number[] | null;
|
|
1450
|
+
leverage_exclude?: number[] | null;
|
|
1451
|
+
industry_include?: number[] | null;
|
|
1452
|
+
industry_exclude?: number[] | null;
|
|
1453
|
+
sector_include?: number[] | null;
|
|
1454
|
+
sector_exclude?: number[] | null;
|
|
1455
|
+
sorts?: AesMidasSort[] | null;
|
|
1456
|
+
pagination?: AesMidasPagination;
|
|
1457
|
+
}
|
|
1458
|
+
export interface AesMidasSymbolSearchRecord {
|
|
1459
|
+
symbol?: string | null;
|
|
1460
|
+
stock_type?: string | null;
|
|
1461
|
+
company_name?: string | null;
|
|
1462
|
+
isin?: string | null;
|
|
1463
|
+
cusip?: string | null;
|
|
1464
|
+
/** @format int32 */
|
|
1465
|
+
market_cap?: number | null;
|
|
1466
|
+
/** @format double */
|
|
1467
|
+
pe_ratio?: number | null;
|
|
1468
|
+
/** @format double */
|
|
1469
|
+
dividend_percent?: number | null;
|
|
1470
|
+
/** @format date */
|
|
1471
|
+
dividend_pay_date?: string | null;
|
|
1472
|
+
/** @format date */
|
|
1473
|
+
dividend_ex_date?: string | null;
|
|
1474
|
+
mic?: string | null;
|
|
1475
|
+
/** @format double */
|
|
1476
|
+
last_price?: number | null;
|
|
1477
|
+
/** @format int32 */
|
|
1478
|
+
volume?: number | null;
|
|
1479
|
+
/** @format double */
|
|
1480
|
+
yesterday_close?: number | null;
|
|
1481
|
+
/** @format int32 */
|
|
1482
|
+
average_volume30d?: number | null;
|
|
1483
|
+
/** @format double */
|
|
1484
|
+
price_change?: number | null;
|
|
1485
|
+
/** @format double */
|
|
1486
|
+
price_change_percent?: number | null;
|
|
1487
|
+
/** @format double */
|
|
1488
|
+
dollar_volume?: number | null;
|
|
1489
|
+
/** @format double */
|
|
1490
|
+
open_gap?: number | null;
|
|
1491
|
+
/** @format double */
|
|
1492
|
+
close_gap?: number | null;
|
|
1493
|
+
/** @format int32 */
|
|
1494
|
+
leverage_ratio?: number | null;
|
|
1495
|
+
/** @format int32 */
|
|
1496
|
+
industry?: number | null;
|
|
1497
|
+
symbol_type?: string | null;
|
|
1498
|
+
inverse?: boolean | null;
|
|
1499
|
+
/** @format int32 */
|
|
1500
|
+
sector?: number | null;
|
|
1501
|
+
source?: string | null;
|
|
1502
|
+
}
|
|
1503
|
+
export interface AesMidasSymbolSearchRecordResponsewithPagination {
|
|
1504
|
+
/** @format int32 */
|
|
1505
|
+
total_items?: number;
|
|
1506
|
+
/** @format int32 */
|
|
1507
|
+
total_pages?: number;
|
|
1508
|
+
/** @format int32 */
|
|
1509
|
+
current_pages?: number;
|
|
1510
|
+
/** @format int32 */
|
|
1511
|
+
page_size?: number;
|
|
1512
|
+
data?: AesMidasSymbolSearchRecord[] | null;
|
|
1513
|
+
}
|
|
1514
|
+
export interface AesMidasTimeSell {
|
|
1515
|
+
symbol?: string | null;
|
|
1516
|
+
trade_region?: string | null;
|
|
1517
|
+
/** @format double */
|
|
1518
|
+
trade_px?: number | null;
|
|
1519
|
+
/** @format int32 */
|
|
1520
|
+
trade_sz?: number | null;
|
|
1521
|
+
/** @format double */
|
|
1522
|
+
last_px?: number | null;
|
|
1523
|
+
/** @format int32 */
|
|
1524
|
+
condition?: number | null;
|
|
1525
|
+
activity_timestamp?: string | null;
|
|
1526
|
+
/** @format int32 */
|
|
1527
|
+
volume?: number | null;
|
|
1528
|
+
/** @format double */
|
|
1529
|
+
change?: number | null;
|
|
1530
|
+
/** @format double */
|
|
1531
|
+
change_percent?: number | null;
|
|
1532
|
+
data_source?: string | null;
|
|
1533
|
+
}
|
|
1534
|
+
export interface AesMidasTop20 {
|
|
1535
|
+
/** @format int32 */
|
|
1536
|
+
level?: number;
|
|
1537
|
+
symbols?: string | null;
|
|
1538
|
+
/** @format int32 */
|
|
1539
|
+
type?: number;
|
|
1540
|
+
data_source?: string | null;
|
|
1541
|
+
}
|
|
1542
|
+
export interface AesMidasUMAB2BUser {
|
|
1543
|
+
allow_feedback?: boolean;
|
|
1544
|
+
created_at?: string | null;
|
|
1545
|
+
do_not_ask_mfa_again?: boolean;
|
|
1546
|
+
email?: string | null;
|
|
1547
|
+
email_verified?: boolean;
|
|
1548
|
+
/** @format int32 */
|
|
1549
|
+
id?: number;
|
|
1550
|
+
/** @format int32 */
|
|
1551
|
+
initiator_id?: number;
|
|
1552
|
+
first_name?: string | null;
|
|
1553
|
+
last_name?: string | null;
|
|
1554
|
+
locale?: AesMidasUMALocale;
|
|
1555
|
+
/** @format int32 */
|
|
1556
|
+
locale_id?: number;
|
|
1557
|
+
mfa_enabled?: boolean;
|
|
1558
|
+
phone?: string | null;
|
|
1559
|
+
phone_verified?: boolean;
|
|
1560
|
+
rep_code?: string | null;
|
|
1561
|
+
should_reset_password?: boolean;
|
|
1562
|
+
updated_at?: string | null;
|
|
1563
|
+
username?: string | null;
|
|
1564
|
+
big_avatar_url?: string | null;
|
|
1565
|
+
branches?: AesMidasUMABranch[] | null;
|
|
1566
|
+
firms?: AesMidasUMAUserFirm[] | null;
|
|
1567
|
+
has_access_to_all_firm_branches?: boolean;
|
|
1568
|
+
microservices?: AesMidasUMAUserMicroservice[] | null;
|
|
1569
|
+
mode?: string | null;
|
|
1570
|
+
permissions?: AesMidasUMAPermission[] | null;
|
|
1571
|
+
/** @format int32 */
|
|
1572
|
+
primary_firm_id?: number;
|
|
1573
|
+
roles?: AesMidasUMARole[] | null;
|
|
1574
|
+
small_avatar_url?: string | null;
|
|
1575
|
+
theme?: string | null;
|
|
1576
|
+
}
|
|
1577
|
+
export interface AesMidasUMAB2CUser {
|
|
1578
|
+
allow_feedback?: boolean;
|
|
1579
|
+
created_at?: string | null;
|
|
1580
|
+
do_not_ask_mfa_again?: boolean;
|
|
1581
|
+
email?: string | null;
|
|
1582
|
+
email_verified?: boolean;
|
|
1583
|
+
/** @format int32 */
|
|
1584
|
+
id?: number;
|
|
1585
|
+
/** @format int32 */
|
|
1586
|
+
initiator_id?: number;
|
|
1587
|
+
first_name?: string | null;
|
|
1588
|
+
last_name?: string | null;
|
|
1589
|
+
locale?: AesMidasUMALocale;
|
|
1590
|
+
/** @format int32 */
|
|
1591
|
+
locale_id?: number;
|
|
1592
|
+
mfa_enabled?: boolean;
|
|
1593
|
+
phone?: string | null;
|
|
1594
|
+
phone_verified?: boolean;
|
|
1595
|
+
rep_code?: string | null;
|
|
1596
|
+
should_reset_password?: boolean;
|
|
1597
|
+
updated_at?: string | null;
|
|
1598
|
+
username?: string | null;
|
|
1599
|
+
branches?: AesMidasUMABranch[] | null;
|
|
1600
|
+
firms?: AesMidasUMAUserFirm[] | null;
|
|
1601
|
+
microservices?: AesMidasUMAUserMicroservice[] | null;
|
|
1602
|
+
permissions?: AesMidasUMAPermission[] | null;
|
|
1603
|
+
roles?: AesMidasUMARole[] | null;
|
|
1604
|
+
}
|
|
1605
|
+
export interface AesMidasUMABranch {
|
|
1606
|
+
code?: string | null;
|
|
1607
|
+
/** @format int32 */
|
|
1608
|
+
firm_id?: number;
|
|
1609
|
+
/** @format int32 */
|
|
1610
|
+
id?: number;
|
|
1611
|
+
name?: string | null;
|
|
1612
|
+
slug?: string | null;
|
|
1613
|
+
}
|
|
1614
|
+
export interface AesMidasUMADomain {
|
|
1615
|
+
internal_domain?: string | null;
|
|
1616
|
+
internal_protocol?: string | null;
|
|
1617
|
+
public_path_prefix?: string | null;
|
|
1618
|
+
}
|
|
1619
|
+
export interface AesMidasUMAFirm {
|
|
1620
|
+
/** @format int32 */
|
|
1621
|
+
admins_count?: number;
|
|
1622
|
+
allow_b2c_email_notifications?: boolean;
|
|
1623
|
+
branches?: AesMidasUMABranch[] | null;
|
|
1624
|
+
/** @format int32 */
|
|
1625
|
+
branches_count?: number;
|
|
1626
|
+
created_at?: string | null;
|
|
1627
|
+
/** @format int32 */
|
|
1628
|
+
id?: number;
|
|
1629
|
+
last_status_change_at?: string | null;
|
|
1630
|
+
name?: string | null;
|
|
1631
|
+
slug?: string | null;
|
|
1632
|
+
status?: string | null;
|
|
1633
|
+
updated_at?: string | null;
|
|
1634
|
+
twilio_creds?: AesMidasUMATwilioCreds;
|
|
1635
|
+
}
|
|
1636
|
+
export interface AesMidasUMAFirmBasic {
|
|
1637
|
+
/** @format int32 */
|
|
1638
|
+
admins_count?: number;
|
|
1639
|
+
allow_b2c_email_notifications?: boolean;
|
|
1640
|
+
branches?: AesMidasUMABranch[] | null;
|
|
1641
|
+
/** @format int32 */
|
|
1642
|
+
branches_count?: number;
|
|
1643
|
+
created_at?: string | null;
|
|
1644
|
+
/** @format int32 */
|
|
1645
|
+
id?: number;
|
|
1646
|
+
last_status_change_at?: string | null;
|
|
1647
|
+
name?: string | null;
|
|
1648
|
+
slug?: string | null;
|
|
1649
|
+
status?: string | null;
|
|
1650
|
+
updated_at?: string | null;
|
|
1651
|
+
}
|
|
1652
|
+
export interface AesMidasUMALocale {
|
|
1653
|
+
/** @format int32 */
|
|
1654
|
+
id?: number;
|
|
1655
|
+
locale?: string | null;
|
|
1656
|
+
name?: string | null;
|
|
1657
|
+
}
|
|
1658
|
+
export interface AesMidasUMAMetadata {
|
|
1659
|
+
entities?: Record<string, any>;
|
|
1660
|
+
is_microservice_global?: boolean;
|
|
1661
|
+
}
|
|
1662
|
+
export interface AesMidasUMAPermission {
|
|
1663
|
+
assignment_group?: string | null;
|
|
1664
|
+
created_at?: string | null;
|
|
1665
|
+
/** @format int32 */
|
|
1666
|
+
id?: number;
|
|
1667
|
+
metadata?: AesMidasUMAMetadata;
|
|
1668
|
+
microservice?: AesMidasUMAUserMicroservice;
|
|
1669
|
+
/** @format int32 */
|
|
1670
|
+
microservice_id?: number;
|
|
1671
|
+
permission?: string | null;
|
|
1672
|
+
updated_at?: string | null;
|
|
1673
|
+
}
|
|
1674
|
+
export interface AesMidasUMARole {
|
|
1675
|
+
created_at?: string | null;
|
|
1676
|
+
firm?: AesMidasUMAFirmBasic;
|
|
1677
|
+
/** @format int32 */
|
|
1678
|
+
firm_id?: number;
|
|
1679
|
+
/** @format int32 */
|
|
1680
|
+
id?: number;
|
|
1681
|
+
microservice?: AesMidasUMAUserMicroservice;
|
|
1682
|
+
/** @format int32 */
|
|
1683
|
+
microservice_id?: number;
|
|
1684
|
+
name?: string | null;
|
|
1685
|
+
permissions?: AesMidasUMAPermission[] | null;
|
|
1686
|
+
type?: AesMidasUMARoleType;
|
|
1687
|
+
/** @format int32 */
|
|
1688
|
+
type_id?: number;
|
|
1689
|
+
updated_at?: string | null;
|
|
1690
|
+
}
|
|
1691
|
+
export interface AesMidasUMARoleType {
|
|
1692
|
+
color?: string | null;
|
|
1693
|
+
created_at?: string | null;
|
|
1694
|
+
/** @format int32 */
|
|
1695
|
+
id?: number;
|
|
1696
|
+
type?: string | null;
|
|
1697
|
+
updated_at?: string | null;
|
|
1698
|
+
}
|
|
1699
|
+
export interface AesMidasUMATwilioCreds {
|
|
1700
|
+
account_sid?: string | null;
|
|
1701
|
+
auth_token?: string | null;
|
|
1702
|
+
phone_number?: string | null;
|
|
1703
|
+
subaccount_sid?: string | null;
|
|
1704
|
+
}
|
|
1705
|
+
export interface AesMidasUMAUserFirm {
|
|
1706
|
+
/** @format int32 */
|
|
1707
|
+
admins_count?: number;
|
|
1708
|
+
allow_b2c_email_notifications?: boolean;
|
|
1709
|
+
branches?: AesMidasUMABranch[] | null;
|
|
1710
|
+
/** @format int32 */
|
|
1711
|
+
branches_count?: number;
|
|
1712
|
+
created_at?: string | null;
|
|
1713
|
+
/** @format int32 */
|
|
1714
|
+
id?: number;
|
|
1715
|
+
last_status_change_at?: string | null;
|
|
1716
|
+
name?: string | null;
|
|
1717
|
+
slug?: string | null;
|
|
1718
|
+
status?: string | null;
|
|
1719
|
+
updated_at?: string | null;
|
|
1720
|
+
have_access_to_all_firm_branches?: boolean;
|
|
1721
|
+
}
|
|
1722
|
+
export interface AesMidasUMAUserMicroservice {
|
|
1723
|
+
/** @format int32 */
|
|
1724
|
+
id?: number;
|
|
1725
|
+
is_active?: boolean;
|
|
1726
|
+
is_visible_on_admin_sidebar?: boolean;
|
|
1727
|
+
logo_url?: string | null;
|
|
1728
|
+
name?: string | null;
|
|
1729
|
+
slug?: string | null;
|
|
1730
|
+
created_at?: string | null;
|
|
1731
|
+
domains?: AesMidasUMADomain[] | null;
|
|
1732
|
+
updated_at?: string | null;
|
|
1733
|
+
}
|
|
1734
|
+
export interface AesMidasUserDataConfig {
|
|
1735
|
+
/** @minLength 1 */
|
|
1736
|
+
id: string;
|
|
1737
|
+
/** @format int32 */
|
|
1738
|
+
status?: number;
|
|
1739
|
+
/** @format int32 */
|
|
1740
|
+
user_level?: number;
|
|
1741
|
+
access_type?: string | null;
|
|
1742
|
+
quote_type?: boolean;
|
|
1743
|
+
note?: string | null;
|
|
1744
|
+
/** @format int32 */
|
|
1745
|
+
us_equity?: number;
|
|
1746
|
+
nbbo_snapshot?: boolean;
|
|
1747
|
+
/** @format int32 */
|
|
1748
|
+
option?: number;
|
|
1749
|
+
/** @format int32 */
|
|
1750
|
+
indice?: number;
|
|
1751
|
+
/** @format int32 */
|
|
1752
|
+
international_market?: number;
|
|
1753
|
+
crypto?: boolean;
|
|
1754
|
+
futures?: boolean;
|
|
1755
|
+
mutual_funds?: boolean;
|
|
1756
|
+
}
|
|
1757
|
+
export interface AesMidasUserDataConfigHistory {
|
|
1758
|
+
id?: string | null;
|
|
1759
|
+
user_id?: string | null;
|
|
1760
|
+
data_source_name?: string | null;
|
|
1761
|
+
activate?: boolean;
|
|
1762
|
+
/** @format date-time */
|
|
1763
|
+
action_time?: string;
|
|
1764
|
+
}
|
|
1765
|
+
export interface AesMidasUserDataConfigExtraInfo {
|
|
1766
|
+
user_data_config?: AesMidasUserDataConfig;
|
|
1767
|
+
user_name?: string | null;
|
|
1768
|
+
first_name?: string | null;
|
|
1769
|
+
last_name?: string | null;
|
|
1770
|
+
}
|
|
1771
|
+
export interface AesMidasUserEntitlement {
|
|
1772
|
+
/** @minLength 1 */
|
|
1773
|
+
user_id: string;
|
|
1774
|
+
/** @minLength 1 */
|
|
1775
|
+
entitlement_name: string;
|
|
1776
|
+
professional?: boolean;
|
|
1777
|
+
/** @format int32 */
|
|
1778
|
+
status?: number;
|
|
1779
|
+
/** @format date-time */
|
|
1780
|
+
activate_time?: string;
|
|
1781
|
+
/** @format date-time */
|
|
1782
|
+
deactivate_time?: string | null;
|
|
1783
|
+
signature?: string | null;
|
|
1784
|
+
version?: string | null;
|
|
1785
|
+
file_id?: string | null;
|
|
1786
|
+
}
|
|
1787
|
+
export interface AesMidasUserEntitlementHistory {
|
|
1788
|
+
id?: string | null;
|
|
1789
|
+
user_id?: string | null;
|
|
1790
|
+
entitlement_name?: string | null;
|
|
1791
|
+
professional?: boolean;
|
|
1792
|
+
action?: string | null;
|
|
1793
|
+
action_user_id?: string | null;
|
|
1794
|
+
/** @format date-time */
|
|
1795
|
+
action_time?: string;
|
|
1796
|
+
signature?: string | null;
|
|
1797
|
+
version?: string | null;
|
|
1798
|
+
/** @format int32 */
|
|
1799
|
+
status?: number;
|
|
1800
|
+
file_id?: string | null;
|
|
1801
|
+
}
|
|
1802
|
+
export interface AesMidasUserInformation {
|
|
1803
|
+
/** @minLength 1 */
|
|
1804
|
+
id: string;
|
|
1805
|
+
is_professional?: boolean | null;
|
|
1806
|
+
is_employee?: boolean;
|
|
1807
|
+
lock_professional?: boolean;
|
|
1808
|
+
license_number?: string | null;
|
|
1809
|
+
first_name?: string | null;
|
|
1810
|
+
middle_name?: string | null;
|
|
1811
|
+
last_name?: string | null;
|
|
1812
|
+
street1?: string | null;
|
|
1813
|
+
street2?: string | null;
|
|
1814
|
+
city?: string | null;
|
|
1815
|
+
state?: string | null;
|
|
1816
|
+
zip_code?: string | null;
|
|
1817
|
+
country?: string | null;
|
|
1818
|
+
employ_status?: string | null;
|
|
1819
|
+
employer_name?: string | null;
|
|
1820
|
+
employment_position?: string | null;
|
|
1821
|
+
employment_function?: string | null;
|
|
1822
|
+
employment_street1?: string | null;
|
|
1823
|
+
employment_street2?: string | null;
|
|
1824
|
+
employment_city?: string | null;
|
|
1825
|
+
employment_state?: string | null;
|
|
1826
|
+
employment_zip_code?: string | null;
|
|
1827
|
+
employment_country?: string | null;
|
|
1828
|
+
/** @format date-time */
|
|
1829
|
+
last_update_time?: string;
|
|
1830
|
+
}
|
|
1831
|
+
export interface AesMidasUserMultiConditionResultResponse {
|
|
1832
|
+
user?: AesMidasApplicationUser;
|
|
1833
|
+
firm?: AesMidasFirm;
|
|
1834
|
+
user_data_config?: AesMidasUserDataConfig;
|
|
1835
|
+
user_information?: AesMidasUserInformation;
|
|
1836
|
+
}
|
|
1837
|
+
export interface AesMidasUserMultiConditionResultResponseResponsewithPagination {
|
|
1838
|
+
/** @format int32 */
|
|
1839
|
+
total_items?: number;
|
|
1840
|
+
/** @format int32 */
|
|
1841
|
+
total_pages?: number;
|
|
1842
|
+
/** @format int32 */
|
|
1843
|
+
current_pages?: number;
|
|
1844
|
+
/** @format int32 */
|
|
1845
|
+
page_size?: number;
|
|
1846
|
+
data?: AesMidasUserMultiConditionResultResponse[] | null;
|
|
1847
|
+
}
|
|
1848
|
+
export class Entitlement<HandleError extends boolean = boolean> {
|
|
1849
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1850
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1851
|
+
/**
|
|
1852
|
+
* @description bitwise in Datasource: 1 UTP, 2 CTA, 3 CBOE1, 4 OPRA, 5 DJI, 6 SP500, 7 CAN, 8 SNAPSHOT
|
|
1853
|
+
* @tags Entitlement
|
|
1854
|
+
* @name GetEntitlementList
|
|
1855
|
+
* @summary Query all available Entitlements(agreements) in the system - All users - available in Microservice, POST with pagination and sort
|
|
1856
|
+
* @request GET:/api/entitlement/entitlement-list
|
|
1857
|
+
* @secure
|
|
1858
|
+
*/
|
|
1859
|
+
getEntitlementList(query?: {
|
|
1860
|
+
/**
|
|
1861
|
+
* entielement name, for example 'UTP'. Optional
|
|
1862
|
+
* @default ""
|
|
1863
|
+
*/
|
|
1864
|
+
name?: string;
|
|
1865
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement[], HandleError>>;
|
|
1866
|
+
/**
|
|
1867
|
+
* @tags Entitlement
|
|
1868
|
+
* @name GetEntitlement
|
|
1869
|
+
* @summary Query a specific Entitlement by unique EntitlementName - All users - available in Microservice
|
|
1870
|
+
* @request GET:/api/entitlement/entitlement
|
|
1871
|
+
* @secure
|
|
1872
|
+
*/
|
|
1873
|
+
getEntitlement(query?: {
|
|
1874
|
+
name?: string;
|
|
1875
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement, HandleError>>;
|
|
1876
|
+
/**
|
|
1877
|
+
* @description Files can be uploaded along with entitlement. File ids can be left blank, server will generate and update file ids to the entitlement.
|
|
1878
|
+
* @tags Entitlement
|
|
1879
|
+
* @name PostEntitlement
|
|
1880
|
+
* @summary Create a new Entitlement(Agreement) - Super admin - available in Microservice
|
|
1881
|
+
* @request POST:/api/entitlement/entitlement
|
|
1882
|
+
* @secure
|
|
1883
|
+
*/
|
|
1884
|
+
postEntitlement(data: AesMidasEntitlementBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement, HandleError>>;
|
|
1885
|
+
/**
|
|
1886
|
+
* @tags Entitlement
|
|
1887
|
+
* @name PutEntitlement
|
|
1888
|
+
* @summary Update an existing Entitlement - Super admin - available in Microservice
|
|
1889
|
+
* @request PUT:/api/entitlement/entitlement
|
|
1890
|
+
* @secure
|
|
1891
|
+
*/
|
|
1892
|
+
putEntitlement(data: AesMidasEntitlementBody, query?: {
|
|
1893
|
+
name?: string;
|
|
1894
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
1895
|
+
/**
|
|
1896
|
+
* @description If an entitlement is being used in a datasource, it cannot be deleted.
|
|
1897
|
+
* @tags Entitlement
|
|
1898
|
+
* @name DeleteEntitlement
|
|
1899
|
+
* @summary Delete an existing Entitlement - Super admin - available in Microservice
|
|
1900
|
+
* @request DELETE:/api/entitlement/entitlement
|
|
1901
|
+
* @secure
|
|
1902
|
+
*/
|
|
1903
|
+
deleteEntitlement(query?: {
|
|
1904
|
+
name?: string;
|
|
1905
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
1906
|
+
/**
|
|
1907
|
+
* @tags Entitlement
|
|
1908
|
+
* @name GetUserEntitlement
|
|
1909
|
+
* @summary Query a specific UserEntitlement by userid and eneitlement name - End user itself, or firm manager, or super admin - available in Microservice
|
|
1910
|
+
* @request GET:/api/entitlement/user-entitlement
|
|
1911
|
+
* @secure
|
|
1912
|
+
*/
|
|
1913
|
+
getUserEntitlement(query?: {
|
|
1914
|
+
user_id?: string;
|
|
1915
|
+
entitlement?: string;
|
|
1916
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement, HandleError>>;
|
|
1917
|
+
/**
|
|
1918
|
+
* @tags Entitlement
|
|
1919
|
+
* @name GetUserEntitlementList
|
|
1920
|
+
* @summary Query all UserEntitlements for a specific user - End user itself, or firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
1921
|
+
* @request GET:/api/entitlement/user-entitlement-list
|
|
1922
|
+
* @secure
|
|
1923
|
+
*/
|
|
1924
|
+
getUserEntitlementList(query?: {
|
|
1925
|
+
/** user_id, must fill out */
|
|
1926
|
+
user_id?: string;
|
|
1927
|
+
/** entitlement name, optional */
|
|
1928
|
+
entitlement?: string;
|
|
1929
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
|
|
1930
|
+
/**
|
|
1931
|
+
* @tags Entitlement
|
|
1932
|
+
* @name GetEntitlementUserList
|
|
1933
|
+
* @summary Query all UserEntitlements for a specific Entitlement - Super admin - available in Microservice, POST with pagination and sort
|
|
1934
|
+
* @request GET:/api/entitlement/entitlement-user-list
|
|
1935
|
+
* @secure
|
|
1936
|
+
*/
|
|
1937
|
+
getEntitlementUserList(query?: {
|
|
1938
|
+
entitlement?: string;
|
|
1939
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
|
|
1940
|
+
/**
|
|
1941
|
+
* @tags Entitlement
|
|
1942
|
+
* @name GetUserEntitlementHistory
|
|
1943
|
+
* @summary Query history for a UserEntitlement - Super admin - available in Microservice, POST with pagination and sort
|
|
1944
|
+
* @request GET:/api/entitlement/user-entitlement-history
|
|
1945
|
+
* @secure
|
|
1946
|
+
*/
|
|
1947
|
+
getUserEntitlementHistory(query?: {
|
|
1948
|
+
user_id?: string;
|
|
1949
|
+
entitlement?: string;
|
|
1950
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementHistory[], HandleError>>;
|
|
1951
|
+
/**
|
|
1952
|
+
* @description Create a new UserEntitlement if not existing previously. Update UserEntitlement if already exists.
|
|
1953
|
+
* @tags Entitlement
|
|
1954
|
+
* @name PutSignEntitlement
|
|
1955
|
+
* @summary Sign a UserEntitlement - All users - available in Microservice
|
|
1956
|
+
* @request PUT:/api/entitlement/sign-entitlement
|
|
1957
|
+
* @secure
|
|
1958
|
+
*/
|
|
1959
|
+
putSignEntitlement(data: AesMidasSignAgreement, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
1960
|
+
/**
|
|
1961
|
+
* @tags Entitlement
|
|
1962
|
+
* @name PutUnsignEntitlement
|
|
1963
|
+
* @summary Unsign a UserEntitlement - End user itself, or firm manager, or super admin - available in Microservice
|
|
1964
|
+
* @request PUT:/api/entitlement/unsign-entitlement
|
|
1965
|
+
* @secure
|
|
1966
|
+
*/
|
|
1967
|
+
putUnsignEntitlement(query?: {
|
|
1968
|
+
user_id?: string;
|
|
1969
|
+
entitlement?: string;
|
|
1970
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
1971
|
+
/**
|
|
1972
|
+
* @tags Entitlement
|
|
1973
|
+
* @name GetContractsCount
|
|
1974
|
+
* @summary For ViewTrade admin to Get contract counts for a specific firm and entitlement - Super admin - available in Microservice
|
|
1975
|
+
* @request GET:/api/entitlement/contracts-count
|
|
1976
|
+
* @secure
|
|
1977
|
+
*/
|
|
1978
|
+
getContractsCount(query?: {
|
|
1979
|
+
/** Three letter month name, for example 'Jan' */
|
|
1980
|
+
from_month?: string;
|
|
1981
|
+
/** for example '2024' */
|
|
1982
|
+
from_year?: string;
|
|
1983
|
+
/** Three letter month name, for example 'Jan' */
|
|
1984
|
+
to_month?: string;
|
|
1985
|
+
/** for example '2024' */
|
|
1986
|
+
to_year?: string;
|
|
1987
|
+
/** true/false, optional */
|
|
1988
|
+
professional?: boolean;
|
|
1989
|
+
/** true/false, optional */
|
|
1990
|
+
admin_or_manager?: boolean;
|
|
1991
|
+
/** true/false, optional */
|
|
1992
|
+
vendor_of_record?: boolean;
|
|
1993
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractCounts[], HandleError>>;
|
|
1994
|
+
/**
|
|
1995
|
+
* @tags Entitlement
|
|
1996
|
+
* @name PostContractsReport
|
|
1997
|
+
* @summary For ViewTrade admin to generate contract counts report for a specific firm and entitlement with paginition and sort - Super admin - available in Microservice
|
|
1998
|
+
* @request POST:/api/entitlement/contracts-report
|
|
1999
|
+
* @secure
|
|
2000
|
+
*/
|
|
2001
|
+
postContractsReport(data: AesMidasQueryPostBody, query?: {
|
|
2002
|
+
firm_id?: string;
|
|
2003
|
+
entitlement_name?: string;
|
|
2004
|
+
/** Three letter month name, for example 'Jan' */
|
|
2005
|
+
from_month?: string;
|
|
2006
|
+
from_year?: string;
|
|
2007
|
+
/** Three letter month name, for example 'Jan' */
|
|
2008
|
+
to_month?: string;
|
|
2009
|
+
to_year?: string;
|
|
2010
|
+
/** true/false, optional */
|
|
2011
|
+
professional?: boolean;
|
|
2012
|
+
/** true/false, optional */
|
|
2013
|
+
admin_or_manager?: boolean;
|
|
2014
|
+
/** true/false, optional */
|
|
2015
|
+
vendor_of_record?: boolean;
|
|
2016
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractRecordsResponsewithPagination, HandleError>>;
|
|
2017
|
+
/**
|
|
2018
|
+
* @tags Entitlement
|
|
2019
|
+
* @name GetFirmEntitlement
|
|
2020
|
+
* @summary Query a specific FirmEntitlement - Firm manager, or super admin - available in Microservice
|
|
2021
|
+
* @request GET:/api/entitlement/firm-entitlement
|
|
2022
|
+
* @secure
|
|
2023
|
+
*/
|
|
2024
|
+
getFirmEntitlement(query?: {
|
|
2025
|
+
firm_id?: string;
|
|
2026
|
+
entitlement?: string;
|
|
2027
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement, HandleError>>;
|
|
2028
|
+
/**
|
|
2029
|
+
* @tags Entitlement
|
|
2030
|
+
* @name PostFirmEntitlement
|
|
2031
|
+
* @summary Create a new FirmEntitlement - Super admin - available in Microservice
|
|
2032
|
+
* @request POST:/api/entitlement/firm-entitlement
|
|
2033
|
+
* @secure
|
|
2034
|
+
*/
|
|
2035
|
+
postFirmEntitlement(data: AesMidasFirmEntitlement, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement, HandleError>>;
|
|
2036
|
+
/**
|
|
2037
|
+
* @description Firm must have relevant data setting if need to active a FirmEntitlement./n!Caution! If de-active a FirmEntitlement, it will unsign all UserEntitlements in this firm for the relevant entitlement.
|
|
2038
|
+
* @tags Entitlement
|
|
2039
|
+
* @name PutFirmEntitlement
|
|
2040
|
+
* @summary Upadte an existing FirmEntitlement - Super admin - available in Microservice
|
|
2041
|
+
* @request PUT:/api/entitlement/firm-entitlement
|
|
2042
|
+
* @secure
|
|
2043
|
+
*/
|
|
2044
|
+
putFirmEntitlement(data: AesMidasFirmEntitlement, query?: {
|
|
2045
|
+
firm_id?: string;
|
|
2046
|
+
entitlement?: string;
|
|
2047
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2048
|
+
/**
|
|
2049
|
+
* @description !Caution! This action will unsign all UserEntitlements in this firm for the relevant entitlement.
|
|
2050
|
+
* @tags Entitlement
|
|
2051
|
+
* @name DeleteFirmEntitlement
|
|
2052
|
+
* @summary Delete an existing FirmEntitlement - Super admin - available in Microservice
|
|
2053
|
+
* @request DELETE:/api/entitlement/firm-entitlement
|
|
2054
|
+
* @secure
|
|
2055
|
+
*/
|
|
2056
|
+
deleteFirmEntitlement(query?: {
|
|
2057
|
+
firm_id?: string;
|
|
2058
|
+
entitlement?: string;
|
|
2059
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2060
|
+
/**
|
|
2061
|
+
* @tags Entitlement
|
|
2062
|
+
* @name GetFirmEntitlementList
|
|
2063
|
+
* @summary Query all FirmEntitlements for a specific firm - Firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
2064
|
+
* @request GET:/api/entitlement/firm-entitlement-list
|
|
2065
|
+
* @secure
|
|
2066
|
+
*/
|
|
2067
|
+
getFirmEntitlementList(query?: {
|
|
2068
|
+
/** firm id, must fill this parameter */
|
|
2069
|
+
firm_id?: string;
|
|
2070
|
+
/** entitlement name, option filter parameter */
|
|
2071
|
+
entitlement_name?: string;
|
|
2072
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
|
|
2073
|
+
/**
|
|
2074
|
+
* @tags Entitlement
|
|
2075
|
+
* @name GetEntitlementFirmList
|
|
2076
|
+
* @summary Query all FirmEntitlements for a specific Entitlement - Super admin - available in Microservice, POST with pagination and sort
|
|
2077
|
+
* @request GET:/api/entitlement/entitlement-firm-list
|
|
2078
|
+
* @secure
|
|
2079
|
+
*/
|
|
2080
|
+
getEntitlementFirmList(query?: {
|
|
2081
|
+
entitlement?: string;
|
|
2082
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
|
|
2083
|
+
/**
|
|
2084
|
+
* @tags Entitlement
|
|
2085
|
+
* @name GetFirmEntitlementHistory
|
|
2086
|
+
* @summary Query history of a specific FirmEntitlement - Super admin - available in Microservice, POST with pagination and sort
|
|
2087
|
+
* @request GET:/api/entitlement/firm-entitlement-history
|
|
2088
|
+
* @secure
|
|
2089
|
+
*/
|
|
2090
|
+
getFirmEntitlementHistory(query?: {
|
|
2091
|
+
firm_id?: string;
|
|
2092
|
+
entitlement?: string;
|
|
2093
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistory[], HandleError>>;
|
|
2094
|
+
}
|
|
2095
|
+
export class File<HandleError extends boolean = boolean> {
|
|
2096
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2097
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2098
|
+
/**
|
|
2099
|
+
* @tags File
|
|
2100
|
+
* @name PostUpload
|
|
2101
|
+
* @summary upload file - All users - available in Microservice
|
|
2102
|
+
* @request POST:/api/file/upload
|
|
2103
|
+
* @secure
|
|
2104
|
+
*/
|
|
2105
|
+
postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
2106
|
+
/**
|
|
2107
|
+
* @tags File
|
|
2108
|
+
* @name GetDownload
|
|
2109
|
+
* @summary download file by file id - All users - available in Microservice
|
|
2110
|
+
* @request GET:/api/file/download
|
|
2111
|
+
* @secure
|
|
2112
|
+
*/
|
|
2113
|
+
getDownload(query?: {
|
|
2114
|
+
file_id?: string;
|
|
2115
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
|
|
2116
|
+
}
|
|
2117
|
+
export class DataSource<HandleError extends boolean = boolean> {
|
|
2118
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2119
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2120
|
+
/**
|
|
2121
|
+
* @description All parameters are optional
|
|
2122
|
+
* @tags DataSource
|
|
2123
|
+
* @name GetDataSourceList
|
|
2124
|
+
* @summary Query all DataSources in the whole system with optional filters - All users - available in Microservice, POST with pagination and sort
|
|
2125
|
+
* @request GET:/api/datasource/data-source-list
|
|
2126
|
+
* @secure
|
|
2127
|
+
*/
|
|
2128
|
+
getDataSourceList(query?: {
|
|
2129
|
+
/** Datasource name */
|
|
2130
|
+
name?: string;
|
|
2131
|
+
/** entitlement name */
|
|
2132
|
+
entitlement?: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* 0 or 1
|
|
2135
|
+
* @format int32
|
|
2136
|
+
*/
|
|
2137
|
+
inuse?: number;
|
|
2138
|
+
/** category */
|
|
2139
|
+
category?: string;
|
|
2140
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource[], HandleError>>;
|
|
2141
|
+
/**
|
|
2142
|
+
* @tags DataSource
|
|
2143
|
+
* @name GetDataSource
|
|
2144
|
+
* @summary Query a specific DataSource by unique DataSource Name - All users - available in Microservice
|
|
2145
|
+
* @request GET:/api/datasource/data-source
|
|
2146
|
+
* @secure
|
|
2147
|
+
*/
|
|
2148
|
+
getDataSource(query?: {
|
|
2149
|
+
name?: string;
|
|
2150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2151
|
+
/**
|
|
2152
|
+
* @description Create a new DataSource with/without an existing Entitlement
|
|
2153
|
+
* @tags DataSource
|
|
2154
|
+
* @name PostDataSource
|
|
2155
|
+
* @summary Create a new DataSource - Super admin - available in Microservice
|
|
2156
|
+
* @request POST:/api/datasource/data-source
|
|
2157
|
+
* @secure
|
|
2158
|
+
*/
|
|
2159
|
+
postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2160
|
+
/**
|
|
2161
|
+
* @description If modification is Entitlement related, server will unsign old entitlement in firms and users
|
|
2162
|
+
* @tags DataSource
|
|
2163
|
+
* @name PutDataSource
|
|
2164
|
+
* @summary Update an existing DataSource - Super admin - available in Microservice
|
|
2165
|
+
* @request PUT:/api/datasource/data-source
|
|
2166
|
+
* @secure
|
|
2167
|
+
*/
|
|
2168
|
+
putDataSource(data: AesMidasDataSource, query?: {
|
|
2169
|
+
name?: string;
|
|
2170
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2171
|
+
/**
|
|
2172
|
+
* @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
|
|
2173
|
+
* @tags DataSource
|
|
2174
|
+
* @name DeleteDataSource
|
|
2175
|
+
* @summary Delete an existing DataSource - Super admin - available in Microservice
|
|
2176
|
+
* @request DELETE:/api/datasource/data-source
|
|
2177
|
+
* @secure
|
|
2178
|
+
*/
|
|
2179
|
+
deleteDataSource(query?: {
|
|
2180
|
+
name?: string;
|
|
2181
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2182
|
+
/**
|
|
2183
|
+
* @tags DataSource
|
|
2184
|
+
* @name GetDataSourceTallyCount
|
|
2185
|
+
* @summary For ViewTrade admin to generate data source tally report - Super admin - available in Microservice
|
|
2186
|
+
* @request GET:/api/datasource/data-source-tally-count
|
|
2187
|
+
* @secure
|
|
2188
|
+
*/
|
|
2189
|
+
getDataSourceTallyCount(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
|
|
2190
|
+
/**
|
|
2191
|
+
* @tags DataSource
|
|
2192
|
+
* @name PostDataSourceTallyReport
|
|
2193
|
+
* @summary For ViewTrade admin to generate data source tally report with Pagination and Sort - Super admin - available in Microservice
|
|
2194
|
+
* @request POST:/api/datasource/data-source-tally-report
|
|
2195
|
+
* @secure
|
|
2196
|
+
*/
|
|
2197
|
+
postDataSourceTallyReport(data: AesMidasQueryPostBody, query?: {
|
|
2198
|
+
data_source?: string;
|
|
2199
|
+
firm_id?: string;
|
|
2200
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
|
|
2201
|
+
}
|
|
2202
|
+
export class Firm<HandleError extends boolean = boolean> {
|
|
2203
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2204
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2205
|
+
/**
|
|
2206
|
+
* @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
|
|
2207
|
+
* @tags Firm
|
|
2208
|
+
* @name GetFirmList
|
|
2209
|
+
* @summary Query all Firms in the system - All users - available in Microservice, POST with pagination and sort
|
|
2210
|
+
For Microservice: only return 'UMA' source firms
|
|
2211
|
+
* @request GET:/api/firm/firm-list
|
|
2212
|
+
* @secure
|
|
2213
|
+
*/
|
|
2214
|
+
getFirmList(query?: {
|
|
2215
|
+
/** firm_id, optional */
|
|
2216
|
+
firm_id?: string;
|
|
2217
|
+
/** firm name, fuzzy search, optional */
|
|
2218
|
+
name?: string;
|
|
2219
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm[], HandleError>>;
|
|
2220
|
+
/**
|
|
2221
|
+
* @tags Firm
|
|
2222
|
+
* @name GetFirm
|
|
2223
|
+
* @summary Query a specific Firm by firmid(short name) - All users - available in Microservice
|
|
2224
|
+
* @request GET:/api/firm/firm
|
|
2225
|
+
* @secure
|
|
2226
|
+
*/
|
|
2227
|
+
getFirm(query?: {
|
|
2228
|
+
firm_id?: string;
|
|
2229
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
2230
|
+
/**
|
|
2231
|
+
* @tags Firm
|
|
2232
|
+
* @name PostFirm
|
|
2233
|
+
* @summary Create a new Firm - Super admin - available in Microservice
|
|
2234
|
+
* @request POST:/api/firm/firm
|
|
2235
|
+
* @secure
|
|
2236
|
+
*/
|
|
2237
|
+
postFirm(data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
2238
|
+
/**
|
|
2239
|
+
* @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
|
|
2240
|
+
* @tags Firm
|
|
2241
|
+
* @name PutFirm
|
|
2242
|
+
* @summary Update an existing Firm setting - Super admin - available in Microservice
|
|
2243
|
+
* @request PUT:/api/firm/firm
|
|
2244
|
+
* @secure
|
|
2245
|
+
*/
|
|
2246
|
+
putFirm(data: AesMidasFirm, query?: {
|
|
2247
|
+
firm_id?: string;
|
|
2248
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2249
|
+
/**
|
|
2250
|
+
* @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
|
|
2251
|
+
* @tags Firm
|
|
2252
|
+
* @name GetFirmDataAccess
|
|
2253
|
+
* @summary Get which data sources that a firm can access - All users - available in Microservice
|
|
2254
|
+
* @request GET:/api/firm/firm-data-access
|
|
2255
|
+
* @secure
|
|
2256
|
+
*/
|
|
2257
|
+
getFirmDataAccess(query?: {
|
|
2258
|
+
firm_id?: string;
|
|
2259
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
2260
|
+
/**
|
|
2261
|
+
* @tags Firm
|
|
2262
|
+
* @name GetUmaFirmList
|
|
2263
|
+
* @summary Get all firms from UMA - Super admin - available in Microservice, POST with pagination and sort
|
|
2264
|
+
* @request GET:/api/firm/uma-firm-list
|
|
2265
|
+
* @secure
|
|
2266
|
+
*/
|
|
2267
|
+
getUmaFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
|
|
2268
|
+
/**
|
|
2269
|
+
* @tags Firm
|
|
2270
|
+
* @name GetSystemFirmDefaultData
|
|
2271
|
+
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise - All users - available in Microservice
|
|
2272
|
+
* @request GET:/api/firm/system-firm-default-data
|
|
2273
|
+
* @secure
|
|
2274
|
+
*/
|
|
2275
|
+
getSystemFirmDefaultData(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
2276
|
+
/**
|
|
2277
|
+
* @tags Firm
|
|
2278
|
+
* @name PutSystemFirmDefaultData
|
|
2279
|
+
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise - Super admin - available in Microservice
|
|
2280
|
+
* @request PUT:/api/firm/system-firm-default-data
|
|
2281
|
+
* @secure
|
|
2282
|
+
*/
|
|
2283
|
+
putSystemFirmDefaultData(data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2284
|
+
/**
|
|
2285
|
+
* @tags Firm
|
|
2286
|
+
* @name GetFirmDefaultData
|
|
2287
|
+
* @summary Query a specific Firm Default Data Setting by firmid(short name) - All users - available in Microservice
|
|
2288
|
+
* @request GET:/api/firm/firm-default-data
|
|
2289
|
+
* @secure
|
|
2290
|
+
*/
|
|
2291
|
+
getFirmDefaultData(query?: {
|
|
2292
|
+
firm_id?: string;
|
|
2293
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
2294
|
+
/**
|
|
2295
|
+
* @description New default data must within firm data access availability
|
|
2296
|
+
* @tags Firm
|
|
2297
|
+
* @name PostFirmDefaultData
|
|
2298
|
+
* @summary Create Firm Default Data setting for a specific firm - Firm manager, or super admin - available in Microservice
|
|
2299
|
+
* @request POST:/api/firm/firm-default-data
|
|
2300
|
+
* @secure
|
|
2301
|
+
*/
|
|
2302
|
+
postFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
|
|
2303
|
+
firm_id?: string;
|
|
2304
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2305
|
+
/**
|
|
2306
|
+
* @description New default data must within firm data access availability
|
|
2307
|
+
* @tags Firm
|
|
2308
|
+
* @name PutFirmDefaultData
|
|
2309
|
+
* @summary Update an existing Firm Default Data setting - Firm manager, or super admin - available in Microservice
|
|
2310
|
+
* @request PUT:/api/firm/firm-default-data
|
|
2311
|
+
* @secure
|
|
2312
|
+
*/
|
|
2313
|
+
putFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
|
|
2314
|
+
firm_id?: string;
|
|
2315
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2316
|
+
}
|
|
2317
|
+
export class FundWebQuote<HandleError extends boolean = boolean> {
|
|
2318
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2319
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2320
|
+
/**
|
|
2321
|
+
* @tags FundWebQuote
|
|
2322
|
+
* @name GetFund
|
|
2323
|
+
* @summary Get a specific fund data - Internal use only - available in Microservice
|
|
2324
|
+
* @request GET:/api/fund/fund
|
|
2325
|
+
* @secure
|
|
2326
|
+
*/
|
|
2327
|
+
getFund(query?: {
|
|
2328
|
+
symbol?: string;
|
|
2329
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
|
|
2330
|
+
/**
|
|
2331
|
+
* @tags FundWebQuote
|
|
2332
|
+
* @name GetFundList
|
|
2333
|
+
* @summary Get all availabe fund data - Internal use only - available in Microservice
|
|
2334
|
+
* @request GET:/api/fund/fund-list
|
|
2335
|
+
* @secure
|
|
2336
|
+
*/
|
|
2337
|
+
getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
|
|
2338
|
+
}
|
|
2339
|
+
export class Log<HandleError extends boolean = boolean> {
|
|
2340
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2341
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2342
|
+
/**
|
|
2343
|
+
* @tags Log
|
|
2344
|
+
* @name GetDataQueryActionList
|
|
2345
|
+
* @summary Query all data query action list in the system - Super admin - available in Microservice
|
|
2346
|
+
* @request GET:/api/log/data-query-action-list
|
|
2347
|
+
* @secure
|
|
2348
|
+
*/
|
|
2349
|
+
getDataQueryActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
2350
|
+
/**
|
|
2351
|
+
* @tags Log
|
|
2352
|
+
* @name GetDataQueryLogByAction
|
|
2353
|
+
* @summary Query data query logs by a specific query and date range - Super admin - available in Microservice, POST with pagination and sort
|
|
2354
|
+
* @request GET:/api/log/data-query-log-by-action
|
|
2355
|
+
* @secure
|
|
2356
|
+
*/
|
|
2357
|
+
getDataQueryLogByAction(query?: {
|
|
2358
|
+
action?: string;
|
|
2359
|
+
'start_date(UTC)'?: string;
|
|
2360
|
+
'end_date(UTC)'?: string;
|
|
2361
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLog[], HandleError>>;
|
|
2362
|
+
/**
|
|
2363
|
+
* @tags Log
|
|
2364
|
+
* @name GetDataQueryLogByDataSource
|
|
2365
|
+
* @summary Query data query logs by a specific data source and date range and return for report - Super admin - available in Microservice, POST with pagination and sort
|
|
2366
|
+
* @request GET:/api/log/data-query-log-by-data-source
|
|
2367
|
+
* @secure
|
|
2368
|
+
*/
|
|
2369
|
+
getDataQueryLogByDataSource(query?: {
|
|
2370
|
+
data_source?: string;
|
|
2371
|
+
'start_date(UTC)'?: string;
|
|
2372
|
+
'end_date(UTC)'?: string;
|
|
2373
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReport[], HandleError>>;
|
|
2374
|
+
/**
|
|
2375
|
+
* @tags Log
|
|
2376
|
+
* @name GetSnapshotCount
|
|
2377
|
+
* @summary Query snapshot report counts - Super admin - available in Microservice
|
|
2378
|
+
* @request GET:/api/log/snapshot-count
|
|
2379
|
+
* @secure
|
|
2380
|
+
*/
|
|
2381
|
+
getSnapshotCount(query?: {
|
|
2382
|
+
/** start date, format(yyyy-MM-dd) */
|
|
2383
|
+
'start_date(UTC)'?: string;
|
|
2384
|
+
/** end date(will be count in), format(yyyy-MM-dd) */
|
|
2385
|
+
'end_date(UTC)'?: string;
|
|
2386
|
+
/** optional, if null, will count all; if true, will only count queries in market hour; if false, will only count queries out of market hour */
|
|
2387
|
+
market_hour_only?: boolean;
|
|
2388
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
|
|
2389
|
+
/**
|
|
2390
|
+
* @tags Log
|
|
2391
|
+
* @name PostSnapshotReport
|
|
2392
|
+
* @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin - available in Microservice
|
|
2393
|
+
* @request POST:/api/log/snapshot-report
|
|
2394
|
+
* @secure
|
|
2395
|
+
*/
|
|
2396
|
+
postSnapshotReport(data: AesMidasQueryPostBody, query?: {
|
|
2397
|
+
/** start date, format(yyyy-MM-dd) */
|
|
2398
|
+
'start_date(UTC)'?: string;
|
|
2399
|
+
/** end date, format(yyyy-MM-dd) */
|
|
2400
|
+
'end_date(UTC)'?: string;
|
|
2401
|
+
/** firm id */
|
|
2402
|
+
firm_id?: string;
|
|
2403
|
+
/** one letter that stands for exchange: A-AMEX,N-NYSE, Q-NSDQ,V-OTC, I-Index. */
|
|
2404
|
+
exchange?: string;
|
|
2405
|
+
/** optional, if null, will return records in whole day range; if true, will only return records in market hour; if false, will only return records out of market hour */
|
|
2406
|
+
market_hour_only?: boolean;
|
|
2407
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
|
|
2408
|
+
/**
|
|
2409
|
+
* @tags Log
|
|
2410
|
+
* @name GetModificationActionList
|
|
2411
|
+
* @summary Query all modification actions list in the system - Super admin - available in Microservice
|
|
2412
|
+
* @request GET:/api/log/modification-action-list
|
|
2413
|
+
* @secure
|
|
2414
|
+
*/
|
|
2415
|
+
getModificationActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
2416
|
+
/**
|
|
2417
|
+
* @tags Log
|
|
2418
|
+
* @name GetModificationLogByAction
|
|
2419
|
+
* @summary Query login/out and modification actions logs by a specific action and date range - Super admin - available in Microservice, POST with pagination and sort
|
|
2420
|
+
* @request GET:/api/log/modification-log-by-action
|
|
2421
|
+
* @secure
|
|
2422
|
+
*/
|
|
2423
|
+
getModificationLogByAction(query?: {
|
|
2424
|
+
/** To get available actions list, please call api/Log/modification-action-list. */
|
|
2425
|
+
action?: string;
|
|
2426
|
+
'start_date(UTC)'?: string;
|
|
2427
|
+
'end_date(UTC)'?: string;
|
|
2428
|
+
/**
|
|
2429
|
+
* optional
|
|
2430
|
+
* @default ""
|
|
2431
|
+
*/
|
|
2432
|
+
target_user?: string;
|
|
2433
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLog[], HandleError>>;
|
|
2434
|
+
}
|
|
2435
|
+
export class Permission<HandleError extends boolean = boolean> {
|
|
2436
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2437
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2438
|
+
/**
|
|
2439
|
+
* @tags Permission
|
|
2440
|
+
* @name PostPermission
|
|
2441
|
+
* @summary Create permission for a user - Internal use only - Super admin - available in Microservice
|
|
2442
|
+
* @request POST:/api/permission/permission
|
|
2443
|
+
* @secure
|
|
2444
|
+
*/
|
|
2445
|
+
postPermission(data: AesMidasPermission, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2446
|
+
/**
|
|
2447
|
+
* @tags Permission
|
|
2448
|
+
* @name GetPermission
|
|
2449
|
+
* @summary Get permission for a user - Internal use only - Super admin - available in Microservice
|
|
2450
|
+
* @request GET:/api/permission/permission
|
|
2451
|
+
* @secure
|
|
2452
|
+
*/
|
|
2453
|
+
getPermission(query?: {
|
|
2454
|
+
user_name?: string;
|
|
2455
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
|
|
2456
|
+
/**
|
|
2457
|
+
* @tags Permission
|
|
2458
|
+
* @name DeletePermission
|
|
2459
|
+
* @summary Delete permission for a user - Internal use only - Super admin - available in Microservice
|
|
2460
|
+
* @request DELETE:/api/permission/permission
|
|
2461
|
+
* @secure
|
|
2462
|
+
*/
|
|
2463
|
+
deletePermission(query?: {
|
|
2464
|
+
user_name?: string;
|
|
2465
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2466
|
+
}
|
|
2467
|
+
export class Quote<HandleError extends boolean = boolean> {
|
|
2468
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2469
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2470
|
+
/**
|
|
2471
|
+
* @tags Quote
|
|
2472
|
+
* @name PostSymbolSearch
|
|
2473
|
+
* @summary Symbol screener - All users - available in Microservice version
|
|
2474
|
+
* @request POST:/api/quote/symbol-search
|
|
2475
|
+
* @secure
|
|
2476
|
+
*/
|
|
2477
|
+
postSymbolSearch(data: AesMidasSymbolSearchBody, query?: {
|
|
2478
|
+
/**
|
|
2479
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2480
|
+
* @default false
|
|
2481
|
+
*/
|
|
2482
|
+
response_camel_case?: boolean;
|
|
2483
|
+
/** @default "" */
|
|
2484
|
+
user_name?: string;
|
|
2485
|
+
/** @default "" */
|
|
2486
|
+
platform?: string;
|
|
2487
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError>>;
|
|
2488
|
+
/**
|
|
2489
|
+
* @tags Quote
|
|
2490
|
+
* @name GetBestQuote
|
|
2491
|
+
* @summary Query Best Quote(Level 1 data) - All users - available in Microservice
|
|
2492
|
+
* @request GET:/api/quote/best-quote
|
|
2493
|
+
* @secure
|
|
2494
|
+
*/
|
|
2495
|
+
getBestQuote(query?: {
|
|
2496
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2497
|
+
symbols?: string;
|
|
2498
|
+
/**
|
|
2499
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2500
|
+
* @default false
|
|
2501
|
+
*/
|
|
2502
|
+
response_camel_case?: boolean;
|
|
2503
|
+
/**
|
|
2504
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2505
|
+
* @default ""
|
|
2506
|
+
*/
|
|
2507
|
+
user_name?: string;
|
|
2508
|
+
/** @default "" */
|
|
2509
|
+
platform?: string;
|
|
2510
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBestQuote[], HandleError>>;
|
|
2511
|
+
/**
|
|
2512
|
+
* @tags Quote
|
|
2513
|
+
* @name GetNbboSnapshot
|
|
2514
|
+
* @summary Query NBBO Snapshot - All users - available in Microservice
|
|
2515
|
+
* @request GET:/api/quote/nbbo-snapshot
|
|
2516
|
+
* @secure
|
|
2517
|
+
*/
|
|
2518
|
+
getNbboSnapshot(query?: {
|
|
2519
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2520
|
+
symbols?: string;
|
|
2521
|
+
/**
|
|
2522
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2523
|
+
* @default false
|
|
2524
|
+
*/
|
|
2525
|
+
response_camel_case?: boolean;
|
|
2526
|
+
/**
|
|
2527
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2528
|
+
* @default ""
|
|
2529
|
+
*/
|
|
2530
|
+
user_name?: string;
|
|
2531
|
+
/** @default "" */
|
|
2532
|
+
platform?: string;
|
|
2533
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
|
|
2534
|
+
/**
|
|
2535
|
+
* @tags Quote
|
|
2536
|
+
* @name GetLevel1
|
|
2537
|
+
* @summary Query full Level 1 data - All users - available in Microservice
|
|
2538
|
+
* @request GET:/api/quote/level1
|
|
2539
|
+
* @secure
|
|
2540
|
+
*/
|
|
2541
|
+
getLevel1(query?: {
|
|
2542
|
+
/** Allow multiple symbols, separated by ',' */
|
|
2543
|
+
symbols?: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2546
|
+
* @default false
|
|
2547
|
+
*/
|
|
2548
|
+
response_camel_case?: boolean;
|
|
2549
|
+
/**
|
|
2550
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2551
|
+
* @default ""
|
|
2552
|
+
*/
|
|
2553
|
+
user_name?: string;
|
|
2554
|
+
/** @default "" */
|
|
2555
|
+
platform?: string;
|
|
2556
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1[], HandleError>>;
|
|
2557
|
+
/**
|
|
2558
|
+
* @tags Quote
|
|
2559
|
+
* @name GetRegionQuotes
|
|
2560
|
+
* @summary Query Region Quotes from Tick data - All users - available in Microservice
|
|
2561
|
+
* @request GET:/api/quote/region-quotes
|
|
2562
|
+
* @secure
|
|
2563
|
+
*/
|
|
2564
|
+
getRegionQuotes(query?: {
|
|
2565
|
+
/** Allow one symbol */
|
|
2566
|
+
symbol?: string;
|
|
2567
|
+
/**
|
|
2568
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2569
|
+
* @default false
|
|
2570
|
+
*/
|
|
2571
|
+
response_camel_case?: boolean;
|
|
2572
|
+
/**
|
|
2573
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2574
|
+
* @default ""
|
|
2575
|
+
*/
|
|
2576
|
+
user_name?: string;
|
|
2577
|
+
/** @default "" */
|
|
2578
|
+
platform?: string;
|
|
2579
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
|
|
2580
|
+
/**
|
|
2581
|
+
* @tags Quote
|
|
2582
|
+
* @name GetTimeSale
|
|
2583
|
+
* @summary Query TimeSale from Tick data - All users - available in Microservice
|
|
2584
|
+
* @request GET:/api/quote/time-sale
|
|
2585
|
+
* @secure
|
|
2586
|
+
*/
|
|
2587
|
+
getTimeSale(query?: {
|
|
2588
|
+
/** Allow one symbol */
|
|
2589
|
+
symbol?: string;
|
|
2590
|
+
/**
|
|
2591
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2592
|
+
* @default false
|
|
2593
|
+
*/
|
|
2594
|
+
response_camel_case?: boolean;
|
|
2595
|
+
/**
|
|
2596
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2597
|
+
* @default ""
|
|
2598
|
+
*/
|
|
2599
|
+
user_name?: string;
|
|
2600
|
+
/** @default "" */
|
|
2601
|
+
platform?: string;
|
|
2602
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
2603
|
+
/**
|
|
2604
|
+
* @tags Quote
|
|
2605
|
+
* @name GetLastTrade
|
|
2606
|
+
* @summary Query Last Trade(Level 2 data) - All users - available in Microservice
|
|
2607
|
+
* @request GET:/api/quote/last-trade
|
|
2608
|
+
* @secure
|
|
2609
|
+
*/
|
|
2610
|
+
getLastTrade(query?: {
|
|
2611
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2612
|
+
symbols?: string;
|
|
2613
|
+
/**
|
|
2614
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2615
|
+
* @default false
|
|
2616
|
+
*/
|
|
2617
|
+
response_camel_case?: boolean;
|
|
2618
|
+
/**
|
|
2619
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2620
|
+
* @default ""
|
|
2621
|
+
*/
|
|
2622
|
+
user_name?: string;
|
|
2623
|
+
/** @default "" */
|
|
2624
|
+
platform?: string;
|
|
2625
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
2626
|
+
/**
|
|
2627
|
+
* @tags Quote
|
|
2628
|
+
* @name GetIntradayChart
|
|
2629
|
+
* @summary Query intra-day Day Chart and Minute Chart - All users - available in Microservice
|
|
2630
|
+
* @request GET:/api/quote/intraday-chart
|
|
2631
|
+
* @secure
|
|
2632
|
+
*/
|
|
2633
|
+
getIntradayChart(query?: {
|
|
2634
|
+
/** Allow one symbol */
|
|
2635
|
+
symbol?: string;
|
|
2636
|
+
/** 'D' for day chart, 'M' for minute chart */
|
|
2637
|
+
day_minute?: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2640
|
+
* @default false
|
|
2641
|
+
*/
|
|
2642
|
+
response_camel_case?: boolean;
|
|
2643
|
+
/**
|
|
2644
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2645
|
+
* @default ""
|
|
2646
|
+
*/
|
|
2647
|
+
user_name?: string;
|
|
2648
|
+
/** @default "" */
|
|
2649
|
+
platform?: string;
|
|
2650
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasChartBar[], HandleError>>;
|
|
2651
|
+
/**
|
|
2652
|
+
* @tags Quote
|
|
2653
|
+
* @name GetHistoricalDayChart
|
|
2654
|
+
* @summary Query Historical Day Chart - All users - available in Microservice
|
|
2655
|
+
* @request GET:/api/quote/historical-day-chart
|
|
2656
|
+
* @secure
|
|
2657
|
+
*/
|
|
2658
|
+
getHistoricalDayChart(query?: {
|
|
2659
|
+
/** Allow one symbol */
|
|
2660
|
+
symbol?: string;
|
|
2661
|
+
/**
|
|
2662
|
+
* Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
|
|
2663
|
+
* @default ""
|
|
2664
|
+
*/
|
|
2665
|
+
year?: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
|
|
2668
|
+
* @format int32
|
|
2669
|
+
* @default 0
|
|
2670
|
+
*/
|
|
2671
|
+
month?: number;
|
|
2672
|
+
/**
|
|
2673
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2674
|
+
* @default false
|
|
2675
|
+
*/
|
|
2676
|
+
response_camel_case?: boolean;
|
|
2677
|
+
/**
|
|
2678
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2679
|
+
* @default ""
|
|
2680
|
+
*/
|
|
2681
|
+
user_name?: string;
|
|
2682
|
+
/** @default "" */
|
|
2683
|
+
platform?: string;
|
|
2684
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
|
|
2685
|
+
/**
|
|
2686
|
+
* @tags Quote
|
|
2687
|
+
* @name GetHistoricalMinuteChart
|
|
2688
|
+
* @summary Query Historical Minute Chart - All users - available in Microservice
|
|
2689
|
+
* @request GET:/api/quote/historical-minute-chart
|
|
2690
|
+
* @secure
|
|
2691
|
+
*/
|
|
2692
|
+
getHistoricalMinuteChart(query?: {
|
|
2693
|
+
/** Allow one symbol */
|
|
2694
|
+
symbol?: string;
|
|
2695
|
+
/** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
|
|
2696
|
+
date?: string;
|
|
2697
|
+
/**
|
|
2698
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2699
|
+
* @default false
|
|
2700
|
+
*/
|
|
2701
|
+
response_camel_case?: boolean;
|
|
2702
|
+
/**
|
|
2703
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2704
|
+
* @default ""
|
|
2705
|
+
*/
|
|
2706
|
+
user_name?: string;
|
|
2707
|
+
/** @default "" */
|
|
2708
|
+
platform?: string;
|
|
2709
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMinuteChart[], HandleError>>;
|
|
2710
|
+
/**
|
|
2711
|
+
* @tags Quote
|
|
2712
|
+
* @name GetTop20
|
|
2713
|
+
* @summary Query Top20 data - All users - available in Microservice
|
|
2714
|
+
* @request GET:/api/quote/top-20
|
|
2715
|
+
* @secure
|
|
2716
|
+
*/
|
|
2717
|
+
getTop20(query?: {
|
|
2718
|
+
/**
|
|
2719
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2720
|
+
* @default false
|
|
2721
|
+
*/
|
|
2722
|
+
response_camel_case?: boolean;
|
|
2723
|
+
/** @default "" */
|
|
2724
|
+
user_name?: string;
|
|
2725
|
+
/** @default "" */
|
|
2726
|
+
platform?: string;
|
|
2727
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTop20[], HandleError>>;
|
|
2728
|
+
/**
|
|
2729
|
+
* @tags Quote
|
|
2730
|
+
* @name GetOptionChain
|
|
2731
|
+
* @summary Query Option Chain data - All users - available in Microservice
|
|
2732
|
+
* @request GET:/api/quote/option-chain
|
|
2733
|
+
* @secure
|
|
2734
|
+
*/
|
|
2735
|
+
getOptionChain(query?: {
|
|
2736
|
+
/** Allow one underlying symbol */
|
|
2737
|
+
underlying?: string;
|
|
2738
|
+
/**
|
|
2739
|
+
* optional
|
|
2740
|
+
* @format double
|
|
2741
|
+
* @default -1
|
|
2742
|
+
*/
|
|
2743
|
+
strike_low?: number;
|
|
2744
|
+
/**
|
|
2745
|
+
* optional
|
|
2746
|
+
* @format double
|
|
2747
|
+
* @default -1
|
|
2748
|
+
*/
|
|
2749
|
+
strike_high?: number;
|
|
2750
|
+
/**
|
|
2751
|
+
* optional
|
|
2752
|
+
* @format date-time
|
|
2753
|
+
*/
|
|
2754
|
+
'start_date(UTC)'?: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* optional
|
|
2757
|
+
* @format date-time
|
|
2758
|
+
*/
|
|
2759
|
+
'end_date(UTC)'?: string;
|
|
2760
|
+
/**
|
|
2761
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2762
|
+
* @default false
|
|
2763
|
+
*/
|
|
2764
|
+
response_camel_case?: boolean;
|
|
2765
|
+
/**
|
|
2766
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2767
|
+
* @default ""
|
|
2768
|
+
*/
|
|
2769
|
+
user_name?: string;
|
|
2770
|
+
/** @default "" */
|
|
2771
|
+
platform?: string;
|
|
2772
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChain[], HandleError>>;
|
|
2773
|
+
/**
|
|
2774
|
+
* @tags Quote
|
|
2775
|
+
* @name GetOptionChainWithPaging
|
|
2776
|
+
* @summary Query Option Chain data - All users - available in Microservice
|
|
2777
|
+
* @request GET:/api/quote/option-chain-with-paging
|
|
2778
|
+
* @secure
|
|
2779
|
+
*/
|
|
2780
|
+
getOptionChainWithPaging(data: AesMidasQueryPostBody, query?: {
|
|
2781
|
+
/** Allow one underlying symbol */
|
|
2782
|
+
underlying?: string;
|
|
2783
|
+
/**
|
|
2784
|
+
* optional
|
|
2785
|
+
* @format double
|
|
2786
|
+
* @default -1
|
|
2787
|
+
*/
|
|
2788
|
+
strike_low?: number;
|
|
2789
|
+
/**
|
|
2790
|
+
* optional
|
|
2791
|
+
* @format double
|
|
2792
|
+
* @default -1
|
|
2793
|
+
*/
|
|
2794
|
+
strike_high?: number;
|
|
2795
|
+
/**
|
|
2796
|
+
* optional
|
|
2797
|
+
* @format date-time
|
|
2798
|
+
*/
|
|
2799
|
+
'start_date(UTC)'?: string;
|
|
2800
|
+
/**
|
|
2801
|
+
* optional
|
|
2802
|
+
* @format date-time
|
|
2803
|
+
*/
|
|
2804
|
+
'end_date(UTC)'?: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2807
|
+
* @default false
|
|
2808
|
+
*/
|
|
2809
|
+
response_camel_case?: boolean;
|
|
2810
|
+
/**
|
|
2811
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2812
|
+
* @default ""
|
|
2813
|
+
*/
|
|
2814
|
+
user_name?: string;
|
|
2815
|
+
/** @default "" */
|
|
2816
|
+
platform?: string;
|
|
2817
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChainResponsewithPagination, HandleError>>;
|
|
2818
|
+
/**
|
|
2819
|
+
* @tags Quote
|
|
2820
|
+
* @name GetOptionLevel1
|
|
2821
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
2822
|
+
* @request GET:/api/quote/option-level1
|
|
2823
|
+
* @secure
|
|
2824
|
+
*/
|
|
2825
|
+
getOptionLevel1(query?: {
|
|
2826
|
+
/** Allow one option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
2827
|
+
option_name?: string;
|
|
2828
|
+
/**
|
|
2829
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2830
|
+
* @default false
|
|
2831
|
+
*/
|
|
2832
|
+
response_camel_case?: boolean;
|
|
2833
|
+
/**
|
|
2834
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2835
|
+
* @default ""
|
|
2836
|
+
*/
|
|
2837
|
+
user_name?: string;
|
|
2838
|
+
/** @default "" */
|
|
2839
|
+
platform?: string;
|
|
2840
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1, HandleError>>;
|
|
2841
|
+
/**
|
|
2842
|
+
* @tags Quote
|
|
2843
|
+
* @name GetOptionLevel1WithGreek
|
|
2844
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
2845
|
+
* @request GET:/api/quote/option-level1-with-greek
|
|
2846
|
+
* @secure
|
|
2847
|
+
*/
|
|
2848
|
+
getOptionLevel1WithGreek(query?: {
|
|
2849
|
+
/** Allow one option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
2850
|
+
option_name?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2853
|
+
* @default false
|
|
2854
|
+
*/
|
|
2855
|
+
response_camel_case?: boolean;
|
|
2856
|
+
/**
|
|
2857
|
+
* if include greek letter value in response
|
|
2858
|
+
* @default false
|
|
2859
|
+
*/
|
|
2860
|
+
include_greek?: boolean;
|
|
2861
|
+
/**
|
|
2862
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2863
|
+
* @default ""
|
|
2864
|
+
*/
|
|
2865
|
+
user_name?: string;
|
|
2866
|
+
/** @default "" */
|
|
2867
|
+
platform?: string;
|
|
2868
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks, HandleError>>;
|
|
2869
|
+
/**
|
|
2870
|
+
* @tags Quote
|
|
2871
|
+
* @name GetEquiductLevel1
|
|
2872
|
+
* @summary Query Equiduct Level 1 data - All users - available in Microservice
|
|
2873
|
+
* @request GET:/api/quote/equiduct-level1
|
|
2874
|
+
* @secure
|
|
2875
|
+
*/
|
|
2876
|
+
getEquiductLevel1(query?: {
|
|
2877
|
+
/** Allow multiple symbols, separated by ',' */
|
|
2878
|
+
symbols?: string;
|
|
2879
|
+
/**
|
|
2880
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2881
|
+
* @default false
|
|
2882
|
+
*/
|
|
2883
|
+
response_camel_case?: boolean;
|
|
2884
|
+
/**
|
|
2885
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2886
|
+
* @default ""
|
|
2887
|
+
*/
|
|
2888
|
+
user_name?: string;
|
|
2889
|
+
/** @default "" */
|
|
2890
|
+
platform?: string;
|
|
2891
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEquiductL1[], HandleError>>;
|
|
2892
|
+
/**
|
|
2893
|
+
* @tags Quote
|
|
2894
|
+
* @name GetBonds
|
|
2895
|
+
* @summary Query Bonds data - All users - available in Microservice
|
|
2896
|
+
* @request GET:/api/quote/bonds
|
|
2897
|
+
* @secure
|
|
2898
|
+
*/
|
|
2899
|
+
getBonds(query?: {
|
|
2900
|
+
/** ISIN, allow multiple query separated by ',' */
|
|
2901
|
+
isins?: string;
|
|
2902
|
+
/**
|
|
2903
|
+
* if response with camel case
|
|
2904
|
+
* @default false
|
|
2905
|
+
*/
|
|
2906
|
+
response_camel_case?: boolean;
|
|
2907
|
+
/** @default "" */
|
|
2908
|
+
platform?: string;
|
|
2909
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBond[], HandleError>>;
|
|
2910
|
+
/**
|
|
2911
|
+
* @tags Quote
|
|
2912
|
+
* @name GetBondsSearch
|
|
2913
|
+
* @summary Search bonds - All users - available in Microservice
|
|
2914
|
+
* @request GET:/api/quote/bonds-search
|
|
2915
|
+
* @secure
|
|
2916
|
+
*/
|
|
2917
|
+
getBondsSearch(query?: {
|
|
2918
|
+
/** search string */
|
|
2919
|
+
criteria?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* how many records that need to return, 20 is maximum
|
|
2922
|
+
* @format int32
|
|
2923
|
+
* @default 20
|
|
2924
|
+
*/
|
|
2925
|
+
limit?: number;
|
|
2926
|
+
/**
|
|
2927
|
+
* if return bonds quote. If false, will only return ISIN list
|
|
2928
|
+
* @default false
|
|
2929
|
+
*/
|
|
2930
|
+
loadQuotes?: boolean;
|
|
2931
|
+
/**
|
|
2932
|
+
* if response with camel case
|
|
2933
|
+
* @default false
|
|
2934
|
+
*/
|
|
2935
|
+
response_camel_case?: boolean;
|
|
2936
|
+
/** @default "" */
|
|
2937
|
+
platform?: string;
|
|
2938
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2939
|
+
/**
|
|
2940
|
+
* @tags Quote
|
|
2941
|
+
* @name GetMutualFunds
|
|
2942
|
+
* @summary Query Mutual Funds data - All users - available in Microservice
|
|
2943
|
+
* @request GET:/api/quote/mutual-funds
|
|
2944
|
+
* @secure
|
|
2945
|
+
*/
|
|
2946
|
+
getMutualFunds(query?: {
|
|
2947
|
+
/** symbol, allow multiple query separated by ',' */
|
|
2948
|
+
symbols?: string;
|
|
2949
|
+
/**
|
|
2950
|
+
* if response with camel case
|
|
2951
|
+
* @default false
|
|
2952
|
+
*/
|
|
2953
|
+
response_camel_case?: boolean;
|
|
2954
|
+
/** @default "" */
|
|
2955
|
+
platform?: string;
|
|
2956
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMutualFund[], HandleError>>;
|
|
2957
|
+
/**
|
|
2958
|
+
* @tags Quote
|
|
2959
|
+
* @name GetQuoddEod
|
|
2960
|
+
* @summary Query QUODD EOD data - All users - available in Microservice
|
|
2961
|
+
* @request GET:/api/quote/quodd-eod
|
|
2962
|
+
* @secure
|
|
2963
|
+
*/
|
|
2964
|
+
getQuoddEod(query?: {
|
|
2965
|
+
/** Allow multiple symbols, separated by ',' */
|
|
2966
|
+
symbols?: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2969
|
+
* @default false
|
|
2970
|
+
*/
|
|
2971
|
+
response_camel_case?: boolean;
|
|
2972
|
+
/**
|
|
2973
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2974
|
+
* @default ""
|
|
2975
|
+
*/
|
|
2976
|
+
user_name?: string;
|
|
2977
|
+
/** @default "" */
|
|
2978
|
+
platform?: string;
|
|
2979
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddEOD[], HandleError>>;
|
|
2980
|
+
/**
|
|
2981
|
+
* @tags Quote
|
|
2982
|
+
* @name GetQuoddDelay
|
|
2983
|
+
* @summary Query QUODD Delay data - All users - available in Microservice
|
|
2984
|
+
* @request GET:/api/quote/quodd-delay
|
|
2985
|
+
* @secure
|
|
2986
|
+
*/
|
|
2987
|
+
getQuoddDelay(query?: {
|
|
2988
|
+
/** Allow multiple symbols, separated by ',' */
|
|
2989
|
+
symbols?: string;
|
|
2990
|
+
/**
|
|
2991
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2992
|
+
* @default false
|
|
2993
|
+
*/
|
|
2994
|
+
response_camel_case?: boolean;
|
|
2995
|
+
/**
|
|
2996
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2997
|
+
* @default ""
|
|
2998
|
+
*/
|
|
2999
|
+
user_name?: string;
|
|
3000
|
+
/** @default "" */
|
|
3001
|
+
platform?: string;
|
|
3002
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddDelay[], HandleError>>;
|
|
3003
|
+
/**
|
|
3004
|
+
* @tags Quote
|
|
3005
|
+
* @name GetIceIsin
|
|
3006
|
+
* @summary Query ICE ISIN data - All users - available in Microservice
|
|
3007
|
+
* @request GET:/api/quote/ice-isin
|
|
3008
|
+
* @secure
|
|
3009
|
+
*/
|
|
3010
|
+
getIceIsin(query?: {
|
|
3011
|
+
/** Allow multiple isins, separated by ',' */
|
|
3012
|
+
isins?: string;
|
|
3013
|
+
/**
|
|
3014
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3015
|
+
* @default false
|
|
3016
|
+
*/
|
|
3017
|
+
response_camel_case?: boolean;
|
|
3018
|
+
/**
|
|
3019
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3020
|
+
* @default ""
|
|
3021
|
+
*/
|
|
3022
|
+
user_name?: string;
|
|
3023
|
+
/** @default "" */
|
|
3024
|
+
platform?: string;
|
|
3025
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasIsinInfo[], HandleError>>;
|
|
3026
|
+
/**
|
|
3027
|
+
* @tags Quote
|
|
3028
|
+
* @name GetIceEod
|
|
3029
|
+
* @summary Query ICE EOD data - All users - available in Microservice
|
|
3030
|
+
* @request GET:/api/quote/ice-eod
|
|
3031
|
+
* @secure
|
|
3032
|
+
*/
|
|
3033
|
+
getIceEod(query?: {
|
|
3034
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3035
|
+
symbols?: string;
|
|
3036
|
+
/**
|
|
3037
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3038
|
+
* @default false
|
|
3039
|
+
*/
|
|
3040
|
+
response_camel_case?: boolean;
|
|
3041
|
+
/**
|
|
3042
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3043
|
+
* @default ""
|
|
3044
|
+
*/
|
|
3045
|
+
user_name?: string;
|
|
3046
|
+
/** @default "" */
|
|
3047
|
+
platform?: string;
|
|
3048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasICEEOD[], HandleError>>;
|
|
3049
|
+
/**
|
|
3050
|
+
* @tags Quote
|
|
3051
|
+
* @name GetFxRate
|
|
3052
|
+
* @summary Query Forex data with symbols - All users - available in Microservice
|
|
3053
|
+
* @request GET:/api/quote/fx-rate
|
|
3054
|
+
* @secure
|
|
3055
|
+
*/
|
|
3056
|
+
getFxRate(query?: {
|
|
3057
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3058
|
+
symbols?: string;
|
|
3059
|
+
/**
|
|
3060
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3061
|
+
* @default false
|
|
3062
|
+
*/
|
|
3063
|
+
response_camel_case?: boolean;
|
|
3064
|
+
/**
|
|
3065
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3066
|
+
* @default ""
|
|
3067
|
+
*/
|
|
3068
|
+
user_name?: string;
|
|
3069
|
+
/** @default "" */
|
|
3070
|
+
platform?: string;
|
|
3071
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexRate[], HandleError>>;
|
|
3072
|
+
/**
|
|
3073
|
+
* @tags Quote
|
|
3074
|
+
* @name GetFxTable
|
|
3075
|
+
* @summary Query Forex table for one currency - All users - available in Microservice
|
|
3076
|
+
* @request GET:/api/quote/fx-table
|
|
3077
|
+
* @secure
|
|
3078
|
+
*/
|
|
3079
|
+
getFxTable(query?: {
|
|
3080
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3081
|
+
symbols?: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3084
|
+
* @default false
|
|
3085
|
+
*/
|
|
3086
|
+
response_camel_case?: boolean;
|
|
3087
|
+
/**
|
|
3088
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3089
|
+
* @default ""
|
|
3090
|
+
*/
|
|
3091
|
+
user_name?: string;
|
|
3092
|
+
/** @default "" */
|
|
3093
|
+
platform?: string;
|
|
3094
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexTable[], HandleError>>;
|
|
3095
|
+
}
|
|
3096
|
+
export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
3097
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3098
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3099
|
+
/**
|
|
3100
|
+
* @tags QuotesReformat
|
|
3101
|
+
* @name GetEquity
|
|
3102
|
+
* @summary Query full Level 1 data - All users - available in Microservice
|
|
3103
|
+
* @request GET:/api/quotes/equity
|
|
3104
|
+
* @secure
|
|
3105
|
+
*/
|
|
3106
|
+
getEquity(query?: {
|
|
3107
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3108
|
+
symbols?: string;
|
|
3109
|
+
/** @default "" */
|
|
3110
|
+
platform?: string;
|
|
3111
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3112
|
+
/**
|
|
3113
|
+
* @tags QuotesReformat
|
|
3114
|
+
* @name GetEquityIntraday
|
|
3115
|
+
* @summary Query intra-day and historical Minute Chart. If no days range provided, it return intraday chart. rsiSpan is no supported. All Volume is raw Volume. - All users - available in Microservice
|
|
3116
|
+
* @request GET:/api/quotes/equity/intraday
|
|
3117
|
+
* @secure
|
|
3118
|
+
*/
|
|
3119
|
+
getEquityIntraday(query?: {
|
|
3120
|
+
/** Allow one symbol */
|
|
3121
|
+
symbol?: string;
|
|
3122
|
+
/** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
|
|
3123
|
+
from?: string;
|
|
3124
|
+
/** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
|
|
3125
|
+
to?: string;
|
|
3126
|
+
/** @default "" */
|
|
3127
|
+
platform?: string;
|
|
3128
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3129
|
+
/**
|
|
3130
|
+
* @tags QuotesReformat
|
|
3131
|
+
* @name GetEquityHistorical
|
|
3132
|
+
* @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
|
|
3133
|
+
* @request GET:/api/quotes/equity/historical
|
|
3134
|
+
* @secure
|
|
3135
|
+
*/
|
|
3136
|
+
getEquityHistorical(query?: {
|
|
3137
|
+
/** Allow one symbol */
|
|
3138
|
+
symbol?: string;
|
|
3139
|
+
/** start date (MM/dd/yyyy) */
|
|
3140
|
+
start?: string;
|
|
3141
|
+
/** end date (MM/dd/yyyy) */
|
|
3142
|
+
end?: string;
|
|
3143
|
+
/**
|
|
3144
|
+
* If start and end are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). num specifies number of (y/m) back from current date
|
|
3145
|
+
* @default ""
|
|
3146
|
+
*/
|
|
3147
|
+
range?: string;
|
|
3148
|
+
/** @default "" */
|
|
3149
|
+
platform?: string;
|
|
3150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3151
|
+
/**
|
|
3152
|
+
* @tags QuotesReformat
|
|
3153
|
+
* @name GetSearch
|
|
3154
|
+
* @summary To search for a company and the exact ticker symbol is not known, use this endpoint for a string search. - All users - available in Microservice version
|
|
3155
|
+
* @request GET:/api/quotes/search
|
|
3156
|
+
* @secure
|
|
3157
|
+
*/
|
|
3158
|
+
getSearch(query?: {
|
|
3159
|
+
/** String to search for */
|
|
3160
|
+
criteria?: string;
|
|
3161
|
+
/**
|
|
3162
|
+
* Maximum number of results to return (default is 20)
|
|
3163
|
+
* @format int32
|
|
3164
|
+
* @default 20
|
|
3165
|
+
*/
|
|
3166
|
+
limit?: number;
|
|
3167
|
+
/**
|
|
3168
|
+
* Whether to load quotes for the results or not
|
|
3169
|
+
* @default false
|
|
3170
|
+
*/
|
|
3171
|
+
loadQuotes?: boolean;
|
|
3172
|
+
/** @default "" */
|
|
3173
|
+
platform?: string;
|
|
3174
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3175
|
+
/**
|
|
3176
|
+
* @tags QuotesReformat
|
|
3177
|
+
* @name GetOption
|
|
3178
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
3179
|
+
* @request GET:/api/quotes/option
|
|
3180
|
+
* @secure
|
|
3181
|
+
*/
|
|
3182
|
+
getOption(query?: {
|
|
3183
|
+
/** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
3184
|
+
symbols?: string;
|
|
3185
|
+
/**
|
|
3186
|
+
* if include greek letter value in response
|
|
3187
|
+
* @default false
|
|
3188
|
+
*/
|
|
3189
|
+
greeks?: boolean;
|
|
3190
|
+
/** @default "" */
|
|
3191
|
+
platform?: string;
|
|
3192
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3193
|
+
/**
|
|
3194
|
+
* @tags QuotesReformat
|
|
3195
|
+
* @name GetOptionChain
|
|
3196
|
+
* @summary Query Option Chain data - All users - available in Microservice
|
|
3197
|
+
* @request GET:/api/quotes/option/chain/{symbol}/{date}
|
|
3198
|
+
* @secure
|
|
3199
|
+
*/
|
|
3200
|
+
getOptionChain(symbol: string, date: string, query?: {
|
|
3201
|
+
/** @default "" */
|
|
3202
|
+
platform?: string;
|
|
3203
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3204
|
+
/**
|
|
3205
|
+
* @tags QuotesReformat
|
|
3206
|
+
* @name GetBonds
|
|
3207
|
+
* @summary Query Bonds data - All users - available in Microservice
|
|
3208
|
+
* @request GET:/api/quotes/bonds
|
|
3209
|
+
* @secure
|
|
3210
|
+
*/
|
|
3211
|
+
getBonds(query?: {
|
|
3212
|
+
/** ISIN, allow multiple query separated by ',' */
|
|
3213
|
+
identifiers?: string;
|
|
3214
|
+
/** @default "" */
|
|
3215
|
+
platform?: string;
|
|
3216
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3217
|
+
/**
|
|
3218
|
+
* @tags QuotesReformat
|
|
3219
|
+
* @name GetBondsSearch
|
|
3220
|
+
* @summary Search bonds - All users - available in Microservice
|
|
3221
|
+
* @request GET:/api/quotes/bonds/search
|
|
3222
|
+
* @secure
|
|
3223
|
+
*/
|
|
3224
|
+
getBondsSearch(query?: {
|
|
3225
|
+
/** search string */
|
|
3226
|
+
criteria?: string;
|
|
3227
|
+
/**
|
|
3228
|
+
* how many records that need to return, 20 is maximum
|
|
3229
|
+
* @format int32
|
|
3230
|
+
* @default 20
|
|
3231
|
+
*/
|
|
3232
|
+
limit?: number;
|
|
3233
|
+
/**
|
|
3234
|
+
* if return bonds quote. If false, will only return ISIN list
|
|
3235
|
+
* @default false
|
|
3236
|
+
*/
|
|
3237
|
+
loadQuotes?: boolean;
|
|
3238
|
+
/** @default "" */
|
|
3239
|
+
platform?: string;
|
|
3240
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3241
|
+
/**
|
|
3242
|
+
* @tags QuotesReformat
|
|
3243
|
+
* @name GetQuotesReformat
|
|
3244
|
+
* @summary Query Forex rate - All users - available in Microservice
|
|
3245
|
+
* @request GET:/api/quotes/fx
|
|
3246
|
+
* @secure
|
|
3247
|
+
*/
|
|
3248
|
+
getQuotesReformat(query?: {
|
|
3249
|
+
/** base_currency/quote_currecy. Can query multiple, separated with ',' */
|
|
3250
|
+
symbols?: string;
|
|
3251
|
+
/** @default "" */
|
|
3252
|
+
platform?: string;
|
|
3253
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3254
|
+
}
|
|
3255
|
+
export class UmaTest<HandleError extends boolean = boolean> {
|
|
3256
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3257
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3258
|
+
/**
|
|
3259
|
+
* @tags UMATest
|
|
3260
|
+
* @name GetRevokeUmaUser
|
|
3261
|
+
* @summary Test to revoke uma user - internal use only - Super admin - available in Microservice
|
|
3262
|
+
* @request GET:/api/uma-test/revoke-uma-user
|
|
3263
|
+
* @secure
|
|
3264
|
+
*/
|
|
3265
|
+
getRevokeUmaUser(query?: {
|
|
3266
|
+
user_id?: string;
|
|
3267
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3268
|
+
/**
|
|
3269
|
+
* @tags UMATest
|
|
3270
|
+
* @name GetFirmList
|
|
3271
|
+
* @summary Test to get all uma firms - internal use only - Super admin - available in Microservice
|
|
3272
|
+
* @request GET:/api/uma-test/firm-list
|
|
3273
|
+
* @secure
|
|
3274
|
+
*/
|
|
3275
|
+
getFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
|
|
3276
|
+
/**
|
|
3277
|
+
* @tags UMATest
|
|
3278
|
+
* @name GetFirmListToLocal
|
|
3279
|
+
* @summary Import all uma firms to AES - internal use only - Super admin - available in Microservice
|
|
3280
|
+
* @request GET:/api/uma-test/firm-list-to-local
|
|
3281
|
+
* @secure
|
|
3282
|
+
*/
|
|
3283
|
+
getFirmListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3284
|
+
/**
|
|
3285
|
+
* @tags UMATest
|
|
3286
|
+
* @name GetB2BUserById
|
|
3287
|
+
* @summary Test to get uma b2b user by user_id - internal use only - Super admin - available in Microservice
|
|
3288
|
+
* @request GET:/api/uma-test/b2b-user-by-id
|
|
3289
|
+
* @secure
|
|
3290
|
+
*/
|
|
3291
|
+
getB2BUserById(query?: {
|
|
3292
|
+
user_id?: string;
|
|
3293
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
|
|
3294
|
+
/**
|
|
3295
|
+
* @tags UMATest
|
|
3296
|
+
* @name GetB2BUserList
|
|
3297
|
+
* @summary Test to get all uma b2b users - internal use only - Super admin - available in Microservice
|
|
3298
|
+
* @request GET:/api/uma-test/b2b-user-list
|
|
3299
|
+
* @secure
|
|
3300
|
+
*/
|
|
3301
|
+
getB2BUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
|
|
3302
|
+
/**
|
|
3303
|
+
* @tags UMATest
|
|
3304
|
+
* @name GetB2BUserListToLocal
|
|
3305
|
+
* @summary Import all uma b2b users to AES - internal use only - Super admin - available in Microservice
|
|
3306
|
+
* @request GET:/api/uma-test/b2b-user-list-to-local
|
|
3307
|
+
* @secure
|
|
3308
|
+
*/
|
|
3309
|
+
getB2BUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3310
|
+
/**
|
|
3311
|
+
* @tags UMATest
|
|
3312
|
+
* @name GetB2CUserById
|
|
3313
|
+
* @summary Test to get uma b2c user by user_id - internal use only - Super admin - available in Microservice
|
|
3314
|
+
* @request GET:/api/uma-test/b2c-user-by-id
|
|
3315
|
+
* @secure
|
|
3316
|
+
*/
|
|
3317
|
+
getB2CUserById(query?: {
|
|
3318
|
+
user_id?: string;
|
|
3319
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
|
|
3320
|
+
/**
|
|
3321
|
+
* @tags UMATest
|
|
3322
|
+
* @name GetB2CUserList
|
|
3323
|
+
* @summary Test to get all uma b2c users - internal use only - Super admin - available in Microservice
|
|
3324
|
+
* @request GET:/api/uma-test/b2c-user-list
|
|
3325
|
+
* @secure
|
|
3326
|
+
*/
|
|
3327
|
+
getB2CUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
|
|
3328
|
+
/**
|
|
3329
|
+
* @tags UMATest
|
|
3330
|
+
* @name GetB2CUserListToLocal
|
|
3331
|
+
* @summary Import all uma b2c users to AES - internal use only - Super admin - available in Microservice
|
|
3332
|
+
* @request GET:/api/uma-test/b2c-user-list-to-local
|
|
3333
|
+
* @secure
|
|
3334
|
+
*/
|
|
3335
|
+
getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3336
|
+
}
|
|
3337
|
+
export class User<HandleError extends boolean = boolean> {
|
|
3338
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3339
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3340
|
+
/**
|
|
3341
|
+
* @tags User
|
|
3342
|
+
* @name PostRegisterRegular
|
|
3343
|
+
* @summary Create a new regular user - Firm manager, or super admin - Not available in Microservice
|
|
3344
|
+
* @request POST:/api/user/register-regular
|
|
3345
|
+
* @secure
|
|
3346
|
+
*/
|
|
3347
|
+
postRegisterRegular(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3348
|
+
/**
|
|
3349
|
+
* @tags User
|
|
3350
|
+
* @name PostRegisterAdmin
|
|
3351
|
+
* @summary Create a new admin user - Super admin - Not available in Microservice
|
|
3352
|
+
* @request POST:/api/user/register-admin
|
|
3353
|
+
* @secure
|
|
3354
|
+
*/
|
|
3355
|
+
postRegisterAdmin(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3356
|
+
/**
|
|
3357
|
+
* @tags User
|
|
3358
|
+
* @name PostRegisterManager
|
|
3359
|
+
* @summary Create a new firm manager user - Firm manager, or super admin - Not available in Microservice
|
|
3360
|
+
* @request POST:/api/user/register-manager
|
|
3361
|
+
* @secure
|
|
3362
|
+
*/
|
|
3363
|
+
postRegisterManager(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3364
|
+
/**
|
|
3365
|
+
* @tags User
|
|
3366
|
+
* @name PostRegisterUmaB2BUser
|
|
3367
|
+
* @summary Create a new b2b user from UMA - Firm manager, or super admin - available in Microservice
|
|
3368
|
+
* @request POST:/api/user/register-uma-b2b-user
|
|
3369
|
+
* @secure
|
|
3370
|
+
*/
|
|
3371
|
+
postRegisterUmaB2BUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3372
|
+
/**
|
|
3373
|
+
* @tags User
|
|
3374
|
+
* @name PostRegisterUmaB2CUser
|
|
3375
|
+
* @summary Create a new b2c user from UMA - Firm manager, or super admin - available in Microservice
|
|
3376
|
+
* @request POST:/api/user/register-uma-b2c-user
|
|
3377
|
+
* @secure
|
|
3378
|
+
*/
|
|
3379
|
+
postRegisterUmaB2CUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3380
|
+
/**
|
|
3381
|
+
* @tags User
|
|
3382
|
+
* @name GetUmaB2BUserList
|
|
3383
|
+
* @summary Get UMA b2b users - Firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
3384
|
+
* @request GET:/api/user/uma-b2b-user-list
|
|
3385
|
+
* @secure
|
|
3386
|
+
*/
|
|
3387
|
+
getUmaB2BUserList(query?: {
|
|
3388
|
+
/**
|
|
3389
|
+
* fuzzy search on uma user first/last name
|
|
3390
|
+
* @default ""
|
|
3391
|
+
*/
|
|
3392
|
+
name?: string;
|
|
3393
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
|
|
3394
|
+
/**
|
|
3395
|
+
* @tags User
|
|
3396
|
+
* @name GetUmaB2CUserList
|
|
3397
|
+
* @summary Get UMA b2c users - Firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
3398
|
+
* @request GET:/api/user/uma-b2c-user-list
|
|
3399
|
+
* @secure
|
|
3400
|
+
*/
|
|
3401
|
+
getUmaB2CUserList(query?: {
|
|
3402
|
+
/**
|
|
3403
|
+
* fuzzy search on uma user first/last name
|
|
3404
|
+
* @default ""
|
|
3405
|
+
*/
|
|
3406
|
+
name?: string;
|
|
3407
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
|
|
3408
|
+
/**
|
|
3409
|
+
* @tags User
|
|
3410
|
+
* @name PostLogin
|
|
3411
|
+
* @summary all user login - All users - Not available in Microservice
|
|
3412
|
+
* @request POST:/api/user/login
|
|
3413
|
+
* @secure
|
|
3414
|
+
*/
|
|
3415
|
+
postLogin(data: AesMidasLoginModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3416
|
+
/**
|
|
3417
|
+
* @description token will be revoked even not expired
|
|
3418
|
+
* @tags User
|
|
3419
|
+
* @name GetLogout
|
|
3420
|
+
* @summary logout with user id - All users - Not available in Microservice
|
|
3421
|
+
* @request GET:/api/user/logout
|
|
3422
|
+
* @secure
|
|
3423
|
+
*/
|
|
3424
|
+
getLogout(query?: {
|
|
3425
|
+
user_id?: string;
|
|
3426
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3427
|
+
/**
|
|
3428
|
+
* @tags User
|
|
3429
|
+
* @name PutPhoneNumber
|
|
3430
|
+
* @summary update a user registered phone number - All users - Not available in Microservice
|
|
3431
|
+
* @request PUT:/api/user/phone-number
|
|
3432
|
+
* @secure
|
|
3433
|
+
*/
|
|
3434
|
+
putPhoneNumber(data: AesMidasModifyPhoneNumberModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3435
|
+
/**
|
|
3436
|
+
* @tags User
|
|
3437
|
+
* @name PutEmail
|
|
3438
|
+
* @summary update a user registered email - All users - Not available in Microservice
|
|
3439
|
+
* @request PUT:/api/user/email
|
|
3440
|
+
* @secure
|
|
3441
|
+
*/
|
|
3442
|
+
putEmail(data: AesMidasModifyEmailModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3443
|
+
/**
|
|
3444
|
+
* @description It will check old passoword.
|
|
3445
|
+
* @tags User
|
|
3446
|
+
* @name PutChangePassword
|
|
3447
|
+
* @summary User change its own password - All users - Not available in Microservice
|
|
3448
|
+
* @request PUT:/api/user/change-password
|
|
3449
|
+
* @secure
|
|
3450
|
+
*/
|
|
3451
|
+
putChangePassword(data: AesMidasChangePasswordModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3452
|
+
/**
|
|
3453
|
+
* @description For manager/admin user, it does not require old password.
|
|
3454
|
+
* @tags User
|
|
3455
|
+
* @name GetResetUserPassword
|
|
3456
|
+
* @summary Reset a user password - Firm manager, or super admin - Not available in Microservice
|
|
3457
|
+
* @request GET:/api/user/reset-user-password
|
|
3458
|
+
* @secure
|
|
3459
|
+
*/
|
|
3460
|
+
getResetUserPassword(query?: {
|
|
3461
|
+
user_id?: string;
|
|
3462
|
+
new_password?: string;
|
|
3463
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3464
|
+
/**
|
|
3465
|
+
* @tags User
|
|
3466
|
+
* @name GetUserNameById
|
|
3467
|
+
* @summary Get a user Name by a specific user Id - All users - Not available in Microservice
|
|
3468
|
+
* @request GET:/api/user/user-name-by-id
|
|
3469
|
+
* @secure
|
|
3470
|
+
*/
|
|
3471
|
+
getUserNameById(query?: {
|
|
3472
|
+
user_id?: string;
|
|
3473
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3474
|
+
/**
|
|
3475
|
+
* @description User Name is unique in the system.
|
|
3476
|
+
* @tags User
|
|
3477
|
+
* @name GetUserIdByName
|
|
3478
|
+
* @summary Get a user Id by a specific user Name - All users - Not available in Microservice
|
|
3479
|
+
* @request GET:/api/user/user-id-by-name
|
|
3480
|
+
* @secure
|
|
3481
|
+
*/
|
|
3482
|
+
getUserIdByName(query?: {
|
|
3483
|
+
user_name?: string;
|
|
3484
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3485
|
+
/**
|
|
3486
|
+
* @tags User
|
|
3487
|
+
* @name GetUserByName
|
|
3488
|
+
* @summary Search a user by an exactly user name - All users - Not available in Microservice
|
|
3489
|
+
* @request GET:/api/user/user-by-name
|
|
3490
|
+
* @secure
|
|
3491
|
+
*/
|
|
3492
|
+
getUserByName(query?: {
|
|
3493
|
+
user_name?: string;
|
|
3494
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUser, HandleError>>;
|
|
3495
|
+
/**
|
|
3496
|
+
* @tags User
|
|
3497
|
+
* @name GetUsersById
|
|
3498
|
+
* @summary Search users by exactly userids - All users - Not available in Microservice
|
|
3499
|
+
* @request GET:/api/user/users-by-id
|
|
3500
|
+
* @secure
|
|
3501
|
+
*/
|
|
3502
|
+
getUsersById(query?: {
|
|
3503
|
+
user_ids?: string;
|
|
3504
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUser[], HandleError>>;
|
|
3505
|
+
/**
|
|
3506
|
+
* @description It will return all users that user name contains the query string, no matter case.
|
|
3507
|
+
* @tags User
|
|
3508
|
+
* @name PostUsersFuzzy
|
|
3509
|
+
* @summary Search users which include a specific string with Pagination and Sort - All users - Not available in Microservice
|
|
3510
|
+
* @request POST:/api/user/users-fuzzy
|
|
3511
|
+
* @secure
|
|
3512
|
+
*/
|
|
3513
|
+
postUsersFuzzy(data: AesMidasQueryPostBody, query?: {
|
|
3514
|
+
user_name?: string;
|
|
3515
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
|
|
3516
|
+
/**
|
|
3517
|
+
* @tags User
|
|
3518
|
+
* @name GetUsersByFirm
|
|
3519
|
+
* @summary Query all users in a specific firm - Firm manager, or super admin - Not available in Microservice
|
|
3520
|
+
* @request GET:/api/user/users-by-firm
|
|
3521
|
+
* @secure
|
|
3522
|
+
*/
|
|
3523
|
+
getUsersByFirm(query?: {
|
|
3524
|
+
/** @default "" */
|
|
3525
|
+
firm?: string;
|
|
3526
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
3527
|
+
/**
|
|
3528
|
+
* @description All conditions are optional
|
|
3529
|
+
* @tags User
|
|
3530
|
+
* @name PostUsersByMultipleConditions
|
|
3531
|
+
* @summary Search Users by multiple conditions with Pagination and Sort - Firm manager, or super admin - available in Microservice
|
|
3532
|
+
For Microservice API:
|
|
3533
|
+
1. No parameter 'user_name' and 'email'. Instead, it has parameter 'user_search', which will do fuzzy search on both user_name and email.
|
|
3534
|
+
2. Only return 'UMA' source users
|
|
3535
|
+
* @request POST:/api/user/users-by-multiple-conditions
|
|
3536
|
+
* @secure
|
|
3537
|
+
*/
|
|
3538
|
+
postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
|
|
3539
|
+
/**
|
|
3540
|
+
* optional
|
|
3541
|
+
* @default ""
|
|
3542
|
+
*/
|
|
3543
|
+
firm?: string;
|
|
3544
|
+
/**
|
|
3545
|
+
* fuzzy search, optional
|
|
3546
|
+
* @default ""
|
|
3547
|
+
*/
|
|
3548
|
+
user_name?: string;
|
|
3549
|
+
/**
|
|
3550
|
+
* optional
|
|
3551
|
+
* @default ""
|
|
3552
|
+
*/
|
|
3553
|
+
email?: string;
|
|
3554
|
+
/**
|
|
3555
|
+
* Value: Active/Suspended, optional
|
|
3556
|
+
* @default ""
|
|
3557
|
+
*/
|
|
3558
|
+
status?: string;
|
|
3559
|
+
/**
|
|
3560
|
+
* Value: Professional/Non-Professional, optional
|
|
3561
|
+
* @default ""
|
|
3562
|
+
*/
|
|
3563
|
+
professional?: string;
|
|
3564
|
+
/**
|
|
3565
|
+
* Value: Yes/No, optional
|
|
3566
|
+
* @default ""
|
|
3567
|
+
*/
|
|
3568
|
+
has_contract?: string;
|
|
3569
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserMultiConditionResultResponseResponsewithPagination, HandleError>>;
|
|
3570
|
+
/**
|
|
3571
|
+
* @description Super admin is admin users in ViewTrade
|
|
3572
|
+
* @tags User
|
|
3573
|
+
* @name PostSuperAdmins
|
|
3574
|
+
* @summary Query all super admin users - Super admin - Not available in Microservice
|
|
3575
|
+
* @request POST:/api/user/super-admins
|
|
3576
|
+
* @secure
|
|
3577
|
+
*/
|
|
3578
|
+
postSuperAdmins(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
|
|
3579
|
+
/**
|
|
3580
|
+
* @description !Caution! It will delete the relevant user information, data configuration and unsign all UserEntitlements for this user.
|
|
3581
|
+
* @tags User
|
|
3582
|
+
* @name DeleteUser
|
|
3583
|
+
* @summary Delete an existing user - Super admin - Not available in Microservice
|
|
3584
|
+
* @request DELETE:/api/user/user
|
|
3585
|
+
* @secure
|
|
3586
|
+
*/
|
|
3587
|
+
deleteUser(query?: {
|
|
3588
|
+
user_id?: string;
|
|
3589
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* @tags User
|
|
3592
|
+
* @name GetUserRole
|
|
3593
|
+
* @summary Search a user role by user Id - All users - Not available in Microservice
|
|
3594
|
+
* @request GET:/api/user/user-role
|
|
3595
|
+
* @secure
|
|
3596
|
+
*/
|
|
3597
|
+
getUserRole(query?: {
|
|
3598
|
+
user_id?: string;
|
|
3599
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3600
|
+
/**
|
|
3601
|
+
* @description When manager/admin create user information, it will not validate user information. When end user create user information, it will validate user information: - "FirstName is required and length is 1~255" - "LastName is required and length is 1~255" - "Street1 is required" - "City is required" - "State is required" - "ZipCode is required" - "Country is required" - "EmployStatus is required" - "LicenseNumber is required and length is 1~255 for professional user"
|
|
3602
|
+
* @tags User
|
|
3603
|
+
* @name PostUserInformation
|
|
3604
|
+
* @summary Create new user information - All users - available in Microservice
|
|
3605
|
+
* @request POST:/api/user/user-information
|
|
3606
|
+
* @secure
|
|
3607
|
+
*/
|
|
3608
|
+
postUserInformation(data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
|
|
3609
|
+
/**
|
|
3610
|
+
* @description When manager/admin create user information, it will not validate user information. When end user create user information, it will validate user information: - "FirstName is required and length is 1~255" - "LastName is required and length is 1~255" - "Street1 is required" - "City is required" - "State is required" - "ZipCode is required" - "Country is required" - "EmployStatus is required" - "LicenseNumber is required and length is 1~255 for professional user"
|
|
3611
|
+
* @tags User
|
|
3612
|
+
* @name PutUserInformation
|
|
3613
|
+
* @summary Update existing user information - All users - available in Microservice
|
|
3614
|
+
* @request PUT:/api/user/user-information
|
|
3615
|
+
* @secure
|
|
3616
|
+
*/
|
|
3617
|
+
putUserInformation(data: AesMidasUserInformation, query?: {
|
|
3618
|
+
user_id?: string;
|
|
3619
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3620
|
+
/**
|
|
3621
|
+
* @tags User
|
|
3622
|
+
* @name GetUserInformationById
|
|
3623
|
+
* @summary Query a specific user information - All users - available in Microservice
|
|
3624
|
+
* @request GET:/api/user/user-information-by-id
|
|
3625
|
+
* @secure
|
|
3626
|
+
*/
|
|
3627
|
+
getUserInformationById(query?: {
|
|
3628
|
+
user_id?: string;
|
|
3629
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
|
|
3630
|
+
/**
|
|
3631
|
+
* @tags User
|
|
3632
|
+
* @name GetOccupationList
|
|
3633
|
+
* @summary Query occupation list that can be used in user information EmploymentFunction - All users - available in Microservice
|
|
3634
|
+
* @request GET:/api/user/occupation-list
|
|
3635
|
+
* @secure
|
|
3636
|
+
*/
|
|
3637
|
+
getOccupationList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOccupation[], HandleError>>;
|
|
3638
|
+
/**
|
|
3639
|
+
* @description It will check if user firm has relevant data acess.
|
|
3640
|
+
* @tags User
|
|
3641
|
+
* @name PostUserDataConfig
|
|
3642
|
+
* @summary Create new user data configuration - Firm manager, or super admin - available in Microservice
|
|
3643
|
+
* @request POST:/api/user/user-data-config
|
|
3644
|
+
* @secure
|
|
3645
|
+
*/
|
|
3646
|
+
postUserDataConfig(data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
|
|
3647
|
+
/**
|
|
3648
|
+
* @description It will check if user firm has relevant data acess.
|
|
3649
|
+
* @tags User
|
|
3650
|
+
* @name PutUserDataConfig
|
|
3651
|
+
* @summary Update existing user data configuration - Firm manager, or super admin - available in Microservice
|
|
3652
|
+
* @request PUT:/api/user/user-data-config
|
|
3653
|
+
* @secure
|
|
3654
|
+
*/
|
|
3655
|
+
putUserDataConfig(data: AesMidasUserDataConfig, query?: {
|
|
3656
|
+
user_id?: string;
|
|
3657
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3658
|
+
/**
|
|
3659
|
+
* @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
|
|
3660
|
+
* @tags User
|
|
3661
|
+
* @name GetUserDataConfigById
|
|
3662
|
+
* @summary Query a user data configuration by user Id - All users - available in Microservice
|
|
3663
|
+
* @request GET:/api/user/user-data-config-by-id
|
|
3664
|
+
* @secure
|
|
3665
|
+
*/
|
|
3666
|
+
getUserDataConfigById(query?: {
|
|
3667
|
+
user_id?: string;
|
|
3668
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
|
|
3669
|
+
/**
|
|
3670
|
+
* @tags User
|
|
3671
|
+
* @name GetUserDataConfigByIdExtraInfo
|
|
3672
|
+
* @summary Query a user data configuration by user Id - All users - available in Microservice
|
|
3673
|
+
* @request GET:/api/user/user-data-config-by-id-extra-info
|
|
3674
|
+
* @secure
|
|
3675
|
+
*/
|
|
3676
|
+
getUserDataConfigByIdExtraInfo(query?: {
|
|
3677
|
+
user_id?: string;
|
|
3678
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfigExtraInfo, HandleError>>;
|
|
3679
|
+
/**
|
|
3680
|
+
* @tags User
|
|
3681
|
+
* @name GetUserDataConfigs
|
|
3682
|
+
* @summary Query user data configurations by user Ids - Firm manager or super admin - available in Microservice
|
|
3683
|
+
* @request GET:/api/user/user-data-configs
|
|
3684
|
+
* @secure
|
|
3685
|
+
*/
|
|
3686
|
+
getUserDataConfigs(query?: {
|
|
3687
|
+
user_ids?: string;
|
|
3688
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig[], HandleError>>;
|
|
3689
|
+
/**
|
|
3690
|
+
* @tags User
|
|
3691
|
+
* @name GetUserNeedSignAgreements
|
|
3692
|
+
* @summary Query which entitlements(agreements) a user need to sign(but not signed yet) by user name - All users - available in Microservice
|
|
3693
|
+
* @request GET:/api/user/user-need-sign-agreements
|
|
3694
|
+
* @secure
|
|
3695
|
+
*/
|
|
3696
|
+
getUserNeedSignAgreements(query?: {
|
|
3697
|
+
user_name?: string;
|
|
3698
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3699
|
+
/**
|
|
3700
|
+
* @tags User
|
|
3701
|
+
* @name GetSessionAlive
|
|
3702
|
+
* @summary Query if current user session is alive - All users - Not available in Microservice
|
|
3703
|
+
* @request GET:/api/user/session-alive
|
|
3704
|
+
* @secure
|
|
3705
|
+
*/
|
|
3706
|
+
getSessionAlive(config?: RequestConfig<HandleError>): Promise<ClientResponse<boolean, HandleError>>;
|
|
3707
|
+
/**
|
|
3708
|
+
* @tags User
|
|
3709
|
+
* @name GetTest
|
|
3710
|
+
* @summary For system deployment user only - All users - available in Microservice
|
|
3711
|
+
* @request GET:/api/user/Test
|
|
3712
|
+
* @secure
|
|
3713
|
+
*/
|
|
3714
|
+
getTest(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3715
|
+
}
|
|
3716
|
+
export class WebSocket<HandleError extends boolean = boolean> {
|
|
3717
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3718
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3719
|
+
/**
|
|
3720
|
+
* @tags WebSocket
|
|
3721
|
+
* @name GetWebSocket
|
|
3722
|
+
* @summary WebSocket endpoint - All users - available in Microservice
|
|
3723
|
+
* @request GET:/ws
|
|
3724
|
+
* @secure
|
|
3725
|
+
*/
|
|
3726
|
+
getWebSocket(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3727
|
+
}
|
|
3728
|
+
export class WsStream<HandleError extends boolean = boolean> {
|
|
3729
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3730
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3731
|
+
/**
|
|
3732
|
+
* @tags WsStream
|
|
3733
|
+
* @name GetStream
|
|
3734
|
+
* @summary ws stream endpoint - All users - available in Microservice
|
|
3735
|
+
* @request GET:/stream
|
|
3736
|
+
* @secure
|
|
3737
|
+
*/
|
|
3738
|
+
getStream(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3739
|
+
}
|
|
3740
|
+
export class AesMidasApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
3741
|
+
dataSource: DataSource<HandleError>;
|
|
3742
|
+
entitlement: Entitlement<HandleError>;
|
|
3743
|
+
file: File<HandleError>;
|
|
3744
|
+
firm: Firm<HandleError>;
|
|
3745
|
+
fundWebQuote: FundWebQuote<HandleError>;
|
|
3746
|
+
log: Log<HandleError>;
|
|
3747
|
+
permission: Permission<HandleError>;
|
|
3748
|
+
quote: Quote<HandleError>;
|
|
3749
|
+
quotesReformat: QuotesReformat<HandleError>;
|
|
3750
|
+
user: User<HandleError>;
|
|
3751
|
+
webSocket: WebSocket<HandleError>;
|
|
3752
|
+
wsStream: WsStream<HandleError>;
|
|
3753
|
+
constructor(config: JwtClientConfig<HandleError>);
|
|
3754
|
+
}
|
|
3755
|
+
|
|
3756
|
+
//# sourceMappingURL=index.d.ts.map
|