@orbis-systems/orbis-api-clients 0.6.7 → 0.6.9
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 +1114 -1105
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -2806
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -2811
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +94 -93
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1888
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1893
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/index.esm.js +1 -257
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -280
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +326 -325
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -3753
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -3758
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +34 -34
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1066
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1071
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1236 -1236
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -7009
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -7014
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +290 -290
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -3993
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -3998
- package/dist/uma/index.js.map +1 -1
- package/package.json +9 -1
package/dist/aesmidas/index.d.ts
CHANGED
|
@@ -273,6 +273,7 @@ export interface AesMidasBondReformat {
|
|
|
273
273
|
market_description?: string | null;
|
|
274
274
|
issue_market?: string | null;
|
|
275
275
|
country?: string | null;
|
|
276
|
+
time_zone?: string | null;
|
|
276
277
|
/** @format double */
|
|
277
278
|
high52week?: number | null;
|
|
278
279
|
/** @format double */
|
|
@@ -579,6 +580,8 @@ export interface AesMidasEntitlement {
|
|
|
579
580
|
version: string;
|
|
580
581
|
pro_file_id?: string | null;
|
|
581
582
|
non_pro_file_id?: string | null;
|
|
583
|
+
pro_pdf_template_link?: string | null;
|
|
584
|
+
non_pro_pdf_template_link?: string | null;
|
|
582
585
|
description?: string | null;
|
|
583
586
|
}
|
|
584
587
|
export interface AesMidasEntitlementFile {
|
|
@@ -622,6 +625,7 @@ export interface AesMidasEquiductL1 {
|
|
|
622
625
|
bid_exch?: string | null;
|
|
623
626
|
ask_exch?: string | null;
|
|
624
627
|
country_code?: string | null;
|
|
628
|
+
time_zone?: string | null;
|
|
625
629
|
}
|
|
626
630
|
export interface AesMidasExchanges {
|
|
627
631
|
exchange?: string | null;
|
|
@@ -928,6 +932,7 @@ export interface AesMidasICEEOD {
|
|
|
928
932
|
/** @format double */
|
|
929
933
|
yest_close_px?: number | null;
|
|
930
934
|
country_code?: string | null;
|
|
935
|
+
time_zone?: string | null;
|
|
931
936
|
}
|
|
932
937
|
export interface AesMidasIsinInfo {
|
|
933
938
|
isin?: string | null;
|
|
@@ -1034,6 +1039,7 @@ export interface AesMidasLevel1 {
|
|
|
1034
1039
|
market_name?: string | null;
|
|
1035
1040
|
market_desc?: string | null;
|
|
1036
1041
|
country_code?: string | null;
|
|
1042
|
+
time_zone?: string | null;
|
|
1037
1043
|
data_source?: string | null;
|
|
1038
1044
|
}
|
|
1039
1045
|
export interface AesMidasLevel1Reformat {
|
|
@@ -1049,6 +1055,7 @@ export interface AesMidasLevel1Reformat {
|
|
|
1049
1055
|
market_description?: string | null;
|
|
1050
1056
|
issue_market?: string | null;
|
|
1051
1057
|
country?: string | null;
|
|
1058
|
+
time_zone?: string | null;
|
|
1052
1059
|
/** @format double */
|
|
1053
1060
|
high52week?: number | null;
|
|
1054
1061
|
/** @format double */
|
|
@@ -1443,6 +1450,7 @@ export interface AesMidasQuoddDelay {
|
|
|
1443
1450
|
status?: string | null;
|
|
1444
1451
|
market_name?: string | null;
|
|
1445
1452
|
country_code?: string | null;
|
|
1453
|
+
time_zone?: string | null;
|
|
1446
1454
|
}
|
|
1447
1455
|
export interface AesMidasQuoddEOD {
|
|
1448
1456
|
symbol?: string | null;
|
|
@@ -1484,6 +1492,7 @@ export interface AesMidasQuoddEOD {
|
|
|
1484
1492
|
low52w_px?: number | null;
|
|
1485
1493
|
market_name?: string | null;
|
|
1486
1494
|
country_code?: string | null;
|
|
1495
|
+
time_zone?: string | null;
|
|
1487
1496
|
}
|
|
1488
1497
|
export interface AesMidasRegion {
|
|
1489
1498
|
code?: string | null;
|
|
@@ -2122,99 +2131,6 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
|
|
|
2122
2131
|
page_size?: number;
|
|
2123
2132
|
data?: AesMidasUserMultiConditionResultResponse[] | null;
|
|
2124
2133
|
}
|
|
2125
|
-
export class DataSource<HandleError extends boolean = boolean> {
|
|
2126
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2127
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2128
|
-
/**
|
|
2129
|
-
* @description All parameters are optional
|
|
2130
|
-
* @tags DataSource
|
|
2131
|
-
* @name GetDataSourceList
|
|
2132
|
-
* @summary Query all DataSources in the whole system with optional filters - All users - available in Microservice, POST with pagination and sort
|
|
2133
|
-
* @request GET:/api/datasource/data-source-list
|
|
2134
|
-
* @secure
|
|
2135
|
-
*/
|
|
2136
|
-
getDataSourceList(query?: {
|
|
2137
|
-
/** Datasource name */
|
|
2138
|
-
name?: string;
|
|
2139
|
-
/** entitlement name */
|
|
2140
|
-
entitlement?: string;
|
|
2141
|
-
/**
|
|
2142
|
-
* 0 or 1
|
|
2143
|
-
* @format int32
|
|
2144
|
-
*/
|
|
2145
|
-
inuse?: number;
|
|
2146
|
-
/** category */
|
|
2147
|
-
category?: string;
|
|
2148
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource[], HandleError>>;
|
|
2149
|
-
/**
|
|
2150
|
-
* @tags DataSource
|
|
2151
|
-
* @name GetDataSource
|
|
2152
|
-
* @summary Query a specific DataSource by unique DataSource Name - All users - available in Microservice
|
|
2153
|
-
* @request GET:/api/datasource/data-source
|
|
2154
|
-
* @secure
|
|
2155
|
-
*/
|
|
2156
|
-
getDataSource(query?: {
|
|
2157
|
-
name?: string;
|
|
2158
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2159
|
-
/**
|
|
2160
|
-
* @description Create a new DataSource with/without an existing Entitlement
|
|
2161
|
-
* @tags DataSource
|
|
2162
|
-
* @name PostDataSource
|
|
2163
|
-
* @summary Create a new DataSource - Super admin - available in Microservice
|
|
2164
|
-
* @request POST:/api/datasource/data-source
|
|
2165
|
-
* @secure
|
|
2166
|
-
*/
|
|
2167
|
-
postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2168
|
-
/**
|
|
2169
|
-
* @description If modification is Entitlement related, server will unsign old entitlement in firms and users
|
|
2170
|
-
* @tags DataSource
|
|
2171
|
-
* @name PutDataSource
|
|
2172
|
-
* @summary Update an existing DataSource - Super admin - available in Microservice
|
|
2173
|
-
* @request PUT:/api/datasource/data-source
|
|
2174
|
-
* @secure
|
|
2175
|
-
*/
|
|
2176
|
-
putDataSource(data: AesMidasDataSource, query?: {
|
|
2177
|
-
name?: string;
|
|
2178
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2179
|
-
/**
|
|
2180
|
-
* @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
|
|
2181
|
-
* @tags DataSource
|
|
2182
|
-
* @name DeleteDataSource
|
|
2183
|
-
* @summary Delete an existing DataSource - Super admin - available in Microservice
|
|
2184
|
-
* @request DELETE:/api/datasource/data-source
|
|
2185
|
-
* @secure
|
|
2186
|
-
*/
|
|
2187
|
-
deleteDataSource(query?: {
|
|
2188
|
-
name?: string;
|
|
2189
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2190
|
-
/**
|
|
2191
|
-
* @tags DataSource
|
|
2192
|
-
* @name GetDataSourceBitMapping
|
|
2193
|
-
* @summary Get All DataSource Bit Mappings - All users - available in Microservice
|
|
2194
|
-
* @request GET:/api/datasource/data-source-bit-mapping
|
|
2195
|
-
* @secure
|
|
2196
|
-
*/
|
|
2197
|
-
getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2198
|
-
/**
|
|
2199
|
-
* @tags DataSource
|
|
2200
|
-
* @name GetDataSourceTallyCount
|
|
2201
|
-
* @summary For ViewTrade admin to generate data source tally report - Super admin - available in Microservice
|
|
2202
|
-
* @request GET:/api/datasource/data-source-tally-count
|
|
2203
|
-
* @secure
|
|
2204
|
-
*/
|
|
2205
|
-
getDataSourceTallyCount(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
|
|
2206
|
-
/**
|
|
2207
|
-
* @tags DataSource
|
|
2208
|
-
* @name PostDataSourceTallyReport
|
|
2209
|
-
* @summary For ViewTrade admin to generate data source tally report with Pagination and Sort - Super admin - available in Microservice
|
|
2210
|
-
* @request POST:/api/datasource/data-source-tally-report
|
|
2211
|
-
* @secure
|
|
2212
|
-
*/
|
|
2213
|
-
postDataSourceTallyReport(data: AesMidasQueryPostBody, query?: {
|
|
2214
|
-
data_source?: string;
|
|
2215
|
-
firm_id?: string;
|
|
2216
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
|
|
2217
|
-
}
|
|
2218
2134
|
export class Entitlement<HandleError extends boolean = boolean> {
|
|
2219
2135
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2220
2136
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2462,6 +2378,99 @@ export class Entitlement<HandleError extends boolean = boolean> {
|
|
|
2462
2378
|
entitlement?: string;
|
|
2463
2379
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistory[], HandleError>>;
|
|
2464
2380
|
}
|
|
2381
|
+
export class DataSource<HandleError extends boolean = boolean> {
|
|
2382
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2383
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2384
|
+
/**
|
|
2385
|
+
* @description All parameters are optional
|
|
2386
|
+
* @tags DataSource
|
|
2387
|
+
* @name GetDataSourceList
|
|
2388
|
+
* @summary Query all DataSources in the whole system with optional filters - All users - available in Microservice, POST with pagination and sort
|
|
2389
|
+
* @request GET:/api/datasource/data-source-list
|
|
2390
|
+
* @secure
|
|
2391
|
+
*/
|
|
2392
|
+
getDataSourceList(query?: {
|
|
2393
|
+
/** Datasource name */
|
|
2394
|
+
name?: string;
|
|
2395
|
+
/** entitlement name */
|
|
2396
|
+
entitlement?: string;
|
|
2397
|
+
/**
|
|
2398
|
+
* 0 or 1
|
|
2399
|
+
* @format int32
|
|
2400
|
+
*/
|
|
2401
|
+
inuse?: number;
|
|
2402
|
+
/** category */
|
|
2403
|
+
category?: string;
|
|
2404
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource[], HandleError>>;
|
|
2405
|
+
/**
|
|
2406
|
+
* @tags DataSource
|
|
2407
|
+
* @name GetDataSource
|
|
2408
|
+
* @summary Query a specific DataSource by unique DataSource Name - All users - available in Microservice
|
|
2409
|
+
* @request GET:/api/datasource/data-source
|
|
2410
|
+
* @secure
|
|
2411
|
+
*/
|
|
2412
|
+
getDataSource(query?: {
|
|
2413
|
+
name?: string;
|
|
2414
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2415
|
+
/**
|
|
2416
|
+
* @description Create a new DataSource with/without an existing Entitlement
|
|
2417
|
+
* @tags DataSource
|
|
2418
|
+
* @name PostDataSource
|
|
2419
|
+
* @summary Create a new DataSource - Super admin - available in Microservice
|
|
2420
|
+
* @request POST:/api/datasource/data-source
|
|
2421
|
+
* @secure
|
|
2422
|
+
*/
|
|
2423
|
+
postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2424
|
+
/**
|
|
2425
|
+
* @description If modification is Entitlement related, server will unsign old entitlement in firms and users
|
|
2426
|
+
* @tags DataSource
|
|
2427
|
+
* @name PutDataSource
|
|
2428
|
+
* @summary Update an existing DataSource - Super admin - available in Microservice
|
|
2429
|
+
* @request PUT:/api/datasource/data-source
|
|
2430
|
+
* @secure
|
|
2431
|
+
*/
|
|
2432
|
+
putDataSource(data: AesMidasDataSource, query?: {
|
|
2433
|
+
name?: string;
|
|
2434
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
|
|
2437
|
+
* @tags DataSource
|
|
2438
|
+
* @name DeleteDataSource
|
|
2439
|
+
* @summary Delete an existing DataSource - Super admin - available in Microservice
|
|
2440
|
+
* @request DELETE:/api/datasource/data-source
|
|
2441
|
+
* @secure
|
|
2442
|
+
*/
|
|
2443
|
+
deleteDataSource(query?: {
|
|
2444
|
+
name?: string;
|
|
2445
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2446
|
+
/**
|
|
2447
|
+
* @tags DataSource
|
|
2448
|
+
* @name GetDataSourceBitMapping
|
|
2449
|
+
* @summary Get All DataSource Bit Mappings - All users - available in Microservice
|
|
2450
|
+
* @request GET:/api/datasource/data-source-bit-mapping
|
|
2451
|
+
* @secure
|
|
2452
|
+
*/
|
|
2453
|
+
getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2454
|
+
/**
|
|
2455
|
+
* @tags DataSource
|
|
2456
|
+
* @name GetDataSourceTallyCount
|
|
2457
|
+
* @summary For ViewTrade admin to generate data source tally report - Super admin - available in Microservice
|
|
2458
|
+
* @request GET:/api/datasource/data-source-tally-count
|
|
2459
|
+
* @secure
|
|
2460
|
+
*/
|
|
2461
|
+
getDataSourceTallyCount(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
|
|
2462
|
+
/**
|
|
2463
|
+
* @tags DataSource
|
|
2464
|
+
* @name PostDataSourceTallyReport
|
|
2465
|
+
* @summary For ViewTrade admin to generate data source tally report with Pagination and Sort - Super admin - available in Microservice
|
|
2466
|
+
* @request POST:/api/datasource/data-source-tally-report
|
|
2467
|
+
* @secure
|
|
2468
|
+
*/
|
|
2469
|
+
postDataSourceTallyReport(data: AesMidasQueryPostBody, query?: {
|
|
2470
|
+
data_source?: string;
|
|
2471
|
+
firm_id?: string;
|
|
2472
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
|
|
2473
|
+
}
|
|
2465
2474
|
export class File<HandleError extends boolean = boolean> {
|
|
2466
2475
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2467
2476
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2749,239 +2758,438 @@ export class Permission<HandleError extends boolean = boolean> {
|
|
|
2749
2758
|
user_name?: string;
|
|
2750
2759
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2751
2760
|
}
|
|
2752
|
-
export class
|
|
2761
|
+
export class Quote<HandleError extends boolean = boolean> {
|
|
2753
2762
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2754
2763
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2755
2764
|
/**
|
|
2756
|
-
* @tags
|
|
2757
|
-
* @name
|
|
2758
|
-
* @summary
|
|
2759
|
-
* @request
|
|
2760
|
-
* @secure
|
|
2761
|
-
*/
|
|
2762
|
-
getRevokeUmaUser(query?: {
|
|
2763
|
-
user_id?: string;
|
|
2764
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2765
|
-
/**
|
|
2766
|
-
* @tags UMATest
|
|
2767
|
-
* @name GetFirmList
|
|
2768
|
-
* @summary Test to get all uma firms - internal use only - Super admin - available in Microservice
|
|
2769
|
-
* @request GET:/api/uma-test/firm-list
|
|
2765
|
+
* @tags Quote
|
|
2766
|
+
* @name PostSymbolSearch
|
|
2767
|
+
* @summary Symbol screener - All users - available in Microservice version
|
|
2768
|
+
* @request POST:/api/quote/symbol-search
|
|
2770
2769
|
* @secure
|
|
2771
2770
|
*/
|
|
2772
|
-
|
|
2771
|
+
postSymbolSearch(data: AesMidasSymbolSearchBody, query?: {
|
|
2772
|
+
/**
|
|
2773
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2774
|
+
* @default false
|
|
2775
|
+
*/
|
|
2776
|
+
response_camel_case?: boolean;
|
|
2777
|
+
/** @default "" */
|
|
2778
|
+
user_name?: string;
|
|
2779
|
+
/** @default "" */
|
|
2780
|
+
platform?: string;
|
|
2781
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError>>;
|
|
2773
2782
|
/**
|
|
2774
|
-
* @tags
|
|
2775
|
-
* @name
|
|
2776
|
-
* @summary
|
|
2777
|
-
* @request GET:/api/
|
|
2783
|
+
* @tags Quote
|
|
2784
|
+
* @name GetBestQuote
|
|
2785
|
+
* @summary Query Best Quote(Level 1 data) - All users - available in Microservice
|
|
2786
|
+
* @request GET:/api/quote/best-quote
|
|
2778
2787
|
* @secure
|
|
2779
2788
|
*/
|
|
2780
|
-
|
|
2789
|
+
getBestQuote(query?: {
|
|
2790
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2791
|
+
symbols?: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2794
|
+
* @default false
|
|
2795
|
+
*/
|
|
2796
|
+
response_camel_case?: boolean;
|
|
2797
|
+
/**
|
|
2798
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2799
|
+
* @default ""
|
|
2800
|
+
*/
|
|
2801
|
+
user_name?: string;
|
|
2802
|
+
/** @default "" */
|
|
2803
|
+
platform?: string;
|
|
2804
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBestQuote[], HandleError>>;
|
|
2781
2805
|
/**
|
|
2782
|
-
* @tags
|
|
2783
|
-
* @name
|
|
2784
|
-
* @summary
|
|
2785
|
-
* @request GET:/api/
|
|
2806
|
+
* @tags Quote
|
|
2807
|
+
* @name GetNbboSnapshot
|
|
2808
|
+
* @summary Query NBBO Snapshot - All users - available in Microservice
|
|
2809
|
+
* @request GET:/api/quote/nbbo-snapshot
|
|
2786
2810
|
* @secure
|
|
2787
2811
|
*/
|
|
2788
|
-
|
|
2789
|
-
|
|
2790
|
-
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
* @secure
|
|
2805
|
-
*/
|
|
2806
|
-
getB2BUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2807
|
-
/**
|
|
2808
|
-
* @tags UMATest
|
|
2809
|
-
* @name GetB2CUserById
|
|
2810
|
-
* @summary Test to get uma b2c user by user_id - internal use only - Super admin - available in Microservice
|
|
2811
|
-
* @request GET:/api/uma-test/b2c-user-by-id
|
|
2812
|
-
* @secure
|
|
2813
|
-
*/
|
|
2814
|
-
getB2CUserById(query?: {
|
|
2815
|
-
user_id?: string;
|
|
2816
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
|
|
2817
|
-
/**
|
|
2818
|
-
* @tags UMATest
|
|
2819
|
-
* @name GetB2CUserList
|
|
2820
|
-
* @summary Test to get all uma b2c users - internal use only - Super admin - available in Microservice
|
|
2821
|
-
* @request GET:/api/uma-test/b2c-user-list
|
|
2822
|
-
* @secure
|
|
2823
|
-
*/
|
|
2824
|
-
getB2CUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
|
|
2825
|
-
/**
|
|
2826
|
-
* @tags UMATest
|
|
2827
|
-
* @name GetB2CUserListToLocal
|
|
2828
|
-
* @summary Import all uma b2c users to AES - internal use only - Super admin - available in Microservice
|
|
2829
|
-
* @request GET:/api/uma-test/b2c-user-list-to-local
|
|
2830
|
-
* @secure
|
|
2831
|
-
*/
|
|
2832
|
-
getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2833
|
-
}
|
|
2834
|
-
export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
2835
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2836
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2812
|
+
getNbboSnapshot(query?: {
|
|
2813
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2814
|
+
symbols?: string;
|
|
2815
|
+
/**
|
|
2816
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2817
|
+
* @default false
|
|
2818
|
+
*/
|
|
2819
|
+
response_camel_case?: boolean;
|
|
2820
|
+
/**
|
|
2821
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2822
|
+
* @default ""
|
|
2823
|
+
*/
|
|
2824
|
+
user_name?: string;
|
|
2825
|
+
/** @default "" */
|
|
2826
|
+
platform?: string;
|
|
2827
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
|
|
2837
2828
|
/**
|
|
2838
|
-
* @tags
|
|
2839
|
-
* @name
|
|
2829
|
+
* @tags Quote
|
|
2830
|
+
* @name GetLevel1
|
|
2840
2831
|
* @summary Query full Level 1 data - All users - available in Microservice
|
|
2841
|
-
* @request GET:/api/
|
|
2832
|
+
* @request GET:/api/quote/level1
|
|
2842
2833
|
* @secure
|
|
2843
2834
|
*/
|
|
2844
|
-
|
|
2835
|
+
getLevel1(query?: {
|
|
2845
2836
|
/** Allow multiple symbols, separated by ',' */
|
|
2846
2837
|
symbols?: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2840
|
+
* @default false
|
|
2841
|
+
*/
|
|
2842
|
+
response_camel_case?: boolean;
|
|
2843
|
+
/**
|
|
2844
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2845
|
+
* @default ""
|
|
2846
|
+
*/
|
|
2847
|
+
user_name?: string;
|
|
2847
2848
|
/** @default "" */
|
|
2848
2849
|
platform?: string;
|
|
2849
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2850
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1[], HandleError>>;
|
|
2850
2851
|
/**
|
|
2851
|
-
* @tags
|
|
2852
|
-
* @name
|
|
2853
|
-
* @summary Query
|
|
2854
|
-
* @request GET:/api/quotes
|
|
2852
|
+
* @tags Quote
|
|
2853
|
+
* @name GetRegionQuotes
|
|
2854
|
+
* @summary Query Region Quotes from Tick data - All users - available in Microservice
|
|
2855
|
+
* @request GET:/api/quote/region-quotes
|
|
2855
2856
|
* @secure
|
|
2856
2857
|
*/
|
|
2857
|
-
|
|
2858
|
+
getRegionQuotes(query?: {
|
|
2858
2859
|
/** Allow one symbol */
|
|
2859
2860
|
symbol?: string;
|
|
2860
|
-
/**
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2861
|
+
/**
|
|
2862
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2863
|
+
* @default false
|
|
2864
|
+
*/
|
|
2865
|
+
response_camel_case?: boolean;
|
|
2866
|
+
/**
|
|
2867
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2868
|
+
* @default ""
|
|
2869
|
+
*/
|
|
2870
|
+
user_name?: string;
|
|
2864
2871
|
/** @default "" */
|
|
2865
2872
|
platform?: string;
|
|
2866
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2873
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
|
|
2867
2874
|
/**
|
|
2868
|
-
* @tags
|
|
2869
|
-
* @name
|
|
2870
|
-
* @summary Query
|
|
2871
|
-
* @request GET:/api/
|
|
2875
|
+
* @tags Quote
|
|
2876
|
+
* @name GetTimeSale
|
|
2877
|
+
* @summary Query TimeSale from Tick data - All users - available in Microservice
|
|
2878
|
+
* @request GET:/api/quote/time-sale
|
|
2872
2879
|
* @secure
|
|
2873
2880
|
*/
|
|
2874
|
-
|
|
2881
|
+
getTimeSale(query?: {
|
|
2875
2882
|
/** Allow one symbol */
|
|
2876
2883
|
symbol?: string;
|
|
2877
|
-
/** start date (MM/dd/yyyy) */
|
|
2878
|
-
start?: string;
|
|
2879
|
-
/** end date (MM/dd/yyyy) */
|
|
2880
|
-
end?: string;
|
|
2881
2884
|
/**
|
|
2882
|
-
*
|
|
2885
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2886
|
+
* @default false
|
|
2887
|
+
*/
|
|
2888
|
+
response_camel_case?: boolean;
|
|
2889
|
+
/**
|
|
2890
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2883
2891
|
* @default ""
|
|
2884
2892
|
*/
|
|
2885
|
-
|
|
2893
|
+
user_name?: string;
|
|
2886
2894
|
/** @default "" */
|
|
2887
2895
|
platform?: string;
|
|
2888
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2896
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
2889
2897
|
/**
|
|
2890
|
-
* @tags
|
|
2891
|
-
* @name
|
|
2892
|
-
* @summary
|
|
2893
|
-
* @request GET:/api/
|
|
2898
|
+
* @tags Quote
|
|
2899
|
+
* @name GetLastTrade
|
|
2900
|
+
* @summary Query Last Trade(Level 2 data) - All users - available in Microservice
|
|
2901
|
+
* @request GET:/api/quote/last-trade
|
|
2894
2902
|
* @secure
|
|
2895
2903
|
*/
|
|
2896
|
-
|
|
2897
|
-
/**
|
|
2898
|
-
|
|
2904
|
+
getLastTrade(query?: {
|
|
2905
|
+
/** Allow multiple symbols query, seperated by ',' */
|
|
2906
|
+
symbols?: string;
|
|
2899
2907
|
/**
|
|
2900
|
-
*
|
|
2901
|
-
* @
|
|
2902
|
-
* @default 20
|
|
2908
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2909
|
+
* @default false
|
|
2903
2910
|
*/
|
|
2904
|
-
|
|
2911
|
+
response_camel_case?: boolean;
|
|
2905
2912
|
/**
|
|
2906
|
-
*
|
|
2907
|
-
* @default
|
|
2913
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2914
|
+
* @default ""
|
|
2908
2915
|
*/
|
|
2909
|
-
|
|
2916
|
+
user_name?: string;
|
|
2910
2917
|
/** @default "" */
|
|
2911
2918
|
platform?: string;
|
|
2912
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2919
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
2913
2920
|
/**
|
|
2914
|
-
* @tags
|
|
2915
|
-
* @name
|
|
2916
|
-
* @summary Query
|
|
2917
|
-
* @request GET:/api/
|
|
2921
|
+
* @tags Quote
|
|
2922
|
+
* @name GetIntradayChart
|
|
2923
|
+
* @summary Query intra-day Day Chart and Minute Chart - All users - available in Microservice
|
|
2924
|
+
* @request GET:/api/quote/intraday-chart
|
|
2918
2925
|
* @secure
|
|
2919
2926
|
*/
|
|
2920
|
-
|
|
2921
|
-
/**
|
|
2922
|
-
|
|
2927
|
+
getIntradayChart(query?: {
|
|
2928
|
+
/** Allow one symbol */
|
|
2929
|
+
symbol?: string;
|
|
2930
|
+
/** 'D' for day chart, 'M' for minute chart */
|
|
2931
|
+
day_minute?: string;
|
|
2923
2932
|
/**
|
|
2924
|
-
*
|
|
2933
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2925
2934
|
* @default false
|
|
2926
2935
|
*/
|
|
2927
|
-
|
|
2928
|
-
/**
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
* @name GetOptionChainDates
|
|
2934
|
-
* @summary Query Option Chain dates - All users - available in Microservice
|
|
2935
|
-
* @request GET:/api/quotes/option/chain/dates/{symbol}
|
|
2936
|
-
* @secure
|
|
2937
|
-
*/
|
|
2938
|
-
getOptionChainDates(symbol: string, query?: {
|
|
2939
|
-
/** @default "" */
|
|
2940
|
-
platform?: string;
|
|
2941
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2942
|
-
/**
|
|
2943
|
-
* @tags QuotesReformat
|
|
2944
|
-
* @name GetOptionChain
|
|
2945
|
-
* @summary Query Option Chain data - All users - available in Microservice
|
|
2946
|
-
* @request GET:/api/quotes/option/chain/{symbol}/{date}
|
|
2947
|
-
* @secure
|
|
2948
|
-
*/
|
|
2949
|
-
getOptionChain(symbol: string, date: string, query?: {
|
|
2936
|
+
response_camel_case?: boolean;
|
|
2937
|
+
/**
|
|
2938
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2939
|
+
* @default ""
|
|
2940
|
+
*/
|
|
2941
|
+
user_name?: string;
|
|
2950
2942
|
/** @default "" */
|
|
2951
2943
|
platform?: string;
|
|
2952
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2944
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasChartBar[], HandleError>>;
|
|
2953
2945
|
/**
|
|
2954
|
-
* @tags
|
|
2955
|
-
* @name
|
|
2956
|
-
* @summary Query Historical Day Chart
|
|
2957
|
-
* @request GET:/api/
|
|
2946
|
+
* @tags Quote
|
|
2947
|
+
* @name GetHistoricalDayChart
|
|
2948
|
+
* @summary Query Historical Day Chart - All users - available in Microservice
|
|
2949
|
+
* @request GET:/api/quote/historical-day-chart
|
|
2958
2950
|
* @secure
|
|
2959
2951
|
*/
|
|
2960
|
-
|
|
2952
|
+
getHistoricalDayChart(query?: {
|
|
2961
2953
|
/** Allow one symbol */
|
|
2962
2954
|
symbol?: string;
|
|
2963
|
-
/** start date (MM/dd/yyyy) */
|
|
2964
|
-
start?: string;
|
|
2965
|
-
/** end date (MM/dd/yyyy) */
|
|
2966
|
-
end?: string;
|
|
2967
2955
|
/**
|
|
2968
|
-
*
|
|
2956
|
+
* Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
|
|
2969
2957
|
* @default ""
|
|
2970
2958
|
*/
|
|
2971
|
-
|
|
2959
|
+
year?: string;
|
|
2960
|
+
/**
|
|
2961
|
+
* how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
|
|
2962
|
+
* @format int32
|
|
2963
|
+
* @default 0
|
|
2964
|
+
*/
|
|
2965
|
+
month?: number;
|
|
2966
|
+
/**
|
|
2967
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2968
|
+
* @default false
|
|
2969
|
+
*/
|
|
2970
|
+
response_camel_case?: boolean;
|
|
2971
|
+
/**
|
|
2972
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2973
|
+
* @default ""
|
|
2974
|
+
*/
|
|
2975
|
+
user_name?: string;
|
|
2972
2976
|
/** @default "" */
|
|
2973
2977
|
platform?: string;
|
|
2974
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2978
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
|
|
2975
2979
|
/**
|
|
2976
|
-
* @tags
|
|
2977
|
-
* @name
|
|
2978
|
-
* @summary Query
|
|
2979
|
-
* @request GET:/api/
|
|
2980
|
+
* @tags Quote
|
|
2981
|
+
* @name GetHistoricalMinuteChart
|
|
2982
|
+
* @summary Query Historical Minute Chart - All users - available in Microservice
|
|
2983
|
+
* @request GET:/api/quote/historical-minute-chart
|
|
2980
2984
|
* @secure
|
|
2981
2985
|
*/
|
|
2982
|
-
|
|
2983
|
-
/**
|
|
2984
|
-
|
|
2986
|
+
getHistoricalMinuteChart(query?: {
|
|
2987
|
+
/** Allow one symbol */
|
|
2988
|
+
symbol?: string;
|
|
2989
|
+
/** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
|
|
2990
|
+
date?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* Optional. Default is false. If true, response will be camel case
|
|
2993
|
+
* @default false
|
|
2994
|
+
*/
|
|
2995
|
+
response_camel_case?: boolean;
|
|
2996
|
+
/**
|
|
2997
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
2998
|
+
* @default ""
|
|
2999
|
+
*/
|
|
3000
|
+
user_name?: string;
|
|
3001
|
+
/** @default "" */
|
|
3002
|
+
platform?: string;
|
|
3003
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMinuteChart[], HandleError>>;
|
|
3004
|
+
/**
|
|
3005
|
+
* @tags Quote
|
|
3006
|
+
* @name GetTop20
|
|
3007
|
+
* @summary Query Top20 data - All users - available in Microservice
|
|
3008
|
+
* @request GET:/api/quote/top-20
|
|
3009
|
+
* @secure
|
|
3010
|
+
*/
|
|
3011
|
+
getTop20(query?: {
|
|
3012
|
+
/**
|
|
3013
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3014
|
+
* @default false
|
|
3015
|
+
*/
|
|
3016
|
+
response_camel_case?: boolean;
|
|
3017
|
+
/** @default "" */
|
|
3018
|
+
user_name?: string;
|
|
3019
|
+
/** @default "" */
|
|
3020
|
+
platform?: string;
|
|
3021
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTop20[], HandleError>>;
|
|
3022
|
+
/**
|
|
3023
|
+
* @tags Quote
|
|
3024
|
+
* @name GetOptionChainDates
|
|
3025
|
+
* @summary Query Option Chain dates - All users - available in Microservice
|
|
3026
|
+
* @request GET:/api/quote/option-chain-dates
|
|
3027
|
+
* @secure
|
|
3028
|
+
*/
|
|
3029
|
+
getOptionChainDates(query?: {
|
|
3030
|
+
/** Allow one underlying symbol */
|
|
3031
|
+
symbol?: string;
|
|
3032
|
+
/**
|
|
3033
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3034
|
+
* @default false
|
|
3035
|
+
*/
|
|
3036
|
+
response_camel_case?: boolean;
|
|
3037
|
+
/**
|
|
3038
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3039
|
+
* @default ""
|
|
3040
|
+
*/
|
|
3041
|
+
user_name?: string;
|
|
3042
|
+
/** @default "" */
|
|
3043
|
+
platform?: string;
|
|
3044
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChainDates[], HandleError>>;
|
|
3045
|
+
/**
|
|
3046
|
+
* @tags Quote
|
|
3047
|
+
* @name GetOptionChain
|
|
3048
|
+
* @summary Query Option Chain data - All users - available in Microservice
|
|
3049
|
+
* @request GET:/api/quote/option-chain
|
|
3050
|
+
* @secure
|
|
3051
|
+
*/
|
|
3052
|
+
getOptionChain(query?: {
|
|
3053
|
+
/** Allow one underlying symbol */
|
|
3054
|
+
underlying?: string;
|
|
3055
|
+
/** allow one date, format YYYY-MM-DD */
|
|
3056
|
+
date?: string;
|
|
3057
|
+
/**
|
|
3058
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3059
|
+
* @default false
|
|
3060
|
+
*/
|
|
3061
|
+
response_camel_case?: boolean;
|
|
3062
|
+
/**
|
|
3063
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3064
|
+
* @default ""
|
|
3065
|
+
*/
|
|
3066
|
+
user_name?: string;
|
|
3067
|
+
/** @default "" */
|
|
3068
|
+
platform?: string;
|
|
3069
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChain[], HandleError>>;
|
|
3070
|
+
/**
|
|
3071
|
+
* @tags Quote
|
|
3072
|
+
* @name GetOptionLevel1
|
|
3073
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
3074
|
+
* @request GET:/api/quote/option-level1
|
|
3075
|
+
* @secure
|
|
3076
|
+
*/
|
|
3077
|
+
getOptionLevel1(query?: {
|
|
3078
|
+
/** Allow multiple option symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
3079
|
+
option_names?: string;
|
|
3080
|
+
/**
|
|
3081
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3082
|
+
* @default false
|
|
3083
|
+
*/
|
|
3084
|
+
response_camel_case?: boolean;
|
|
3085
|
+
/**
|
|
3086
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3087
|
+
* @default ""
|
|
3088
|
+
*/
|
|
3089
|
+
user_name?: string;
|
|
3090
|
+
/** @default "" */
|
|
3091
|
+
platform?: string;
|
|
3092
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1[], HandleError>>;
|
|
3093
|
+
/**
|
|
3094
|
+
* @tags Quote
|
|
3095
|
+
* @name GetOptionLevel1WithGreek
|
|
3096
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
3097
|
+
* @request GET:/api/quote/option-level1-with-greek
|
|
3098
|
+
* @secure
|
|
3099
|
+
*/
|
|
3100
|
+
getOptionLevel1WithGreek(query?: {
|
|
3101
|
+
/** Allow multiple symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
3102
|
+
option_names?: string;
|
|
3103
|
+
/**
|
|
3104
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3105
|
+
* @default false
|
|
3106
|
+
*/
|
|
3107
|
+
response_camel_case?: boolean;
|
|
3108
|
+
/**
|
|
3109
|
+
* if include greek letter value in response
|
|
3110
|
+
* @default false
|
|
3111
|
+
*/
|
|
3112
|
+
include_greek?: boolean;
|
|
3113
|
+
/**
|
|
3114
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3115
|
+
* @default ""
|
|
3116
|
+
*/
|
|
3117
|
+
user_name?: string;
|
|
3118
|
+
/** @default "" */
|
|
3119
|
+
platform?: string;
|
|
3120
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks[], HandleError>>;
|
|
3121
|
+
/**
|
|
3122
|
+
* @tags Quote
|
|
3123
|
+
* @name GetOptionDayChart
|
|
3124
|
+
* @summary Query Option Day Chart - All users - available in Microservice
|
|
3125
|
+
* @request GET:/api/quote/option-day-chart
|
|
3126
|
+
* @secure
|
|
3127
|
+
*/
|
|
3128
|
+
getOptionDayChart(query?: {
|
|
3129
|
+
/** Allow one symbol */
|
|
3130
|
+
symbol?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
|
|
3133
|
+
* @default ""
|
|
3134
|
+
*/
|
|
3135
|
+
year?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
|
|
3138
|
+
* @format int32
|
|
3139
|
+
* @default 0
|
|
3140
|
+
*/
|
|
3141
|
+
month?: number;
|
|
3142
|
+
/**
|
|
3143
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3144
|
+
* @default false
|
|
3145
|
+
*/
|
|
3146
|
+
response_camel_case?: boolean;
|
|
3147
|
+
/**
|
|
3148
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3149
|
+
* @default ""
|
|
3150
|
+
*/
|
|
3151
|
+
user_name?: string;
|
|
3152
|
+
/** @default "" */
|
|
3153
|
+
platform?: string;
|
|
3154
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
|
|
3155
|
+
/**
|
|
3156
|
+
* @tags Quote
|
|
3157
|
+
* @name GetEquiductLevel1
|
|
3158
|
+
* @summary Query Equiduct Level 1 data - All users - available in Microservice
|
|
3159
|
+
* @request GET:/api/quote/equiduct-level1
|
|
3160
|
+
* @secure
|
|
3161
|
+
*/
|
|
3162
|
+
getEquiductLevel1(query?: {
|
|
3163
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3164
|
+
symbols?: string;
|
|
3165
|
+
/**
|
|
3166
|
+
* True to query realtime data, False to query delay data
|
|
3167
|
+
* @default false
|
|
3168
|
+
*/
|
|
3169
|
+
realtime?: boolean;
|
|
3170
|
+
/**
|
|
3171
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3172
|
+
* @default false
|
|
3173
|
+
*/
|
|
3174
|
+
response_camel_case?: boolean;
|
|
3175
|
+
/**
|
|
3176
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3177
|
+
* @default ""
|
|
3178
|
+
*/
|
|
3179
|
+
user_name?: string;
|
|
3180
|
+
/** @default "" */
|
|
3181
|
+
platform?: string;
|
|
3182
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEquiductL1[], HandleError>>;
|
|
3183
|
+
/**
|
|
3184
|
+
* @tags Quote
|
|
3185
|
+
* @name GetBonds
|
|
3186
|
+
* @summary Query Bonds data - All users - available in Microservice
|
|
3187
|
+
* @request GET:/api/quote/bonds
|
|
3188
|
+
* @secure
|
|
3189
|
+
*/
|
|
3190
|
+
getBonds(query?: {
|
|
3191
|
+
/** ISIN, allow multiple query separated by ',' */
|
|
3192
|
+
isins?: string;
|
|
2985
3193
|
/**
|
|
2986
3194
|
* Price type, default is Percentage. ('Percentage'|'Decimal')
|
|
2987
3195
|
* @default "Percentage"
|
|
@@ -2992,14 +3200,19 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
|
2992
3200
|
* @default "Par"
|
|
2993
3201
|
*/
|
|
2994
3202
|
bondQuantityType?: string;
|
|
3203
|
+
/**
|
|
3204
|
+
* if response with camel case
|
|
3205
|
+
* @default false
|
|
3206
|
+
*/
|
|
3207
|
+
response_camel_case?: boolean;
|
|
2995
3208
|
/** @default "" */
|
|
2996
3209
|
platform?: string;
|
|
2997
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3210
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondWholeApex[], HandleError>>;
|
|
2998
3211
|
/**
|
|
2999
|
-
* @tags
|
|
3212
|
+
* @tags Quote
|
|
3000
3213
|
* @name GetBondsSearch
|
|
3001
3214
|
* @summary Search bonds - All users - available in Microservice
|
|
3002
|
-
* @request GET:/api/
|
|
3215
|
+
* @request GET:/api/quote/bonds-search
|
|
3003
3216
|
* @secure
|
|
3004
3217
|
*/
|
|
3005
3218
|
getBondsSearch(query?: {
|
|
@@ -3026,1071 +3239,867 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
|
3026
3239
|
* @default "Par"
|
|
3027
3240
|
*/
|
|
3028
3241
|
bondQuantityType?: string;
|
|
3242
|
+
/**
|
|
3243
|
+
* if response with camel case
|
|
3244
|
+
* @default false
|
|
3245
|
+
*/
|
|
3246
|
+
response_camel_case?: boolean;
|
|
3029
3247
|
/** @default "" */
|
|
3030
3248
|
platform?: string;
|
|
3031
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3249
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3032
3250
|
/**
|
|
3033
|
-
* @tags
|
|
3034
|
-
* @name
|
|
3035
|
-
* @summary Query
|
|
3036
|
-
* @request GET:/api/
|
|
3251
|
+
* @tags Quote
|
|
3252
|
+
* @name GetBondsChart
|
|
3253
|
+
* @summary Query Bonds historical chart data - All users - available in Microservice
|
|
3254
|
+
* @request GET:/api/quote/bonds-chart
|
|
3037
3255
|
* @secure
|
|
3038
3256
|
*/
|
|
3039
|
-
|
|
3040
|
-
/**
|
|
3041
|
-
|
|
3257
|
+
getBondsChart(query?: {
|
|
3258
|
+
/** ISIN, only allow one symbol at a time */
|
|
3259
|
+
isin?: string;
|
|
3260
|
+
/** Frequency of price observations. Supported frequencies and ranges are: 1day: EOD close prices - Maximum supported time range: 365 days. 15min: 15 minute interval prices - Maximum supported time range: 15 days. 1min: 1 minute tick prices.The number of price updates per day will differ based on the liquidity profile of the underlying bond(some bonds will only have a few updates throughout the day). The maximum update frequency is 2 updates per minute.In this case, we will aggregate by taking the later timestamp - Maximum supported time range: 1 day. */
|
|
3261
|
+
frequency?: string;
|
|
3262
|
+
/** Filter data equal to or after this time in YYYY-MM-DD format. */
|
|
3263
|
+
start?: string;
|
|
3264
|
+
/** Filter data equal to or before this time in YYYY-MM-DD format. */
|
|
3265
|
+
end?: string;
|
|
3266
|
+
/**
|
|
3267
|
+
* if response with camel case
|
|
3268
|
+
* @default false
|
|
3269
|
+
*/
|
|
3270
|
+
response_camel_case?: boolean;
|
|
3042
3271
|
/** @default "" */
|
|
3043
3272
|
platform?: string;
|
|
3044
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3045
|
-
}
|
|
3046
|
-
export class User<HandleError extends boolean = boolean> {
|
|
3047
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3048
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3273
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasHistoricalBondChartApex[], HandleError>>;
|
|
3049
3274
|
/**
|
|
3050
|
-
* @tags
|
|
3051
|
-
* @name
|
|
3052
|
-
* @summary
|
|
3053
|
-
* @request
|
|
3054
|
-
* @secure
|
|
3055
|
-
*/
|
|
3056
|
-
postRegisterRegular(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3057
|
-
/**
|
|
3058
|
-
* @tags User
|
|
3059
|
-
* @name PostRegisterAdmin
|
|
3060
|
-
* @summary Create a new admin user - Super admin - Not available in Microservice
|
|
3061
|
-
* @request POST:/api/user/register-admin
|
|
3275
|
+
* @tags Quote
|
|
3276
|
+
* @name GetMutualFunds
|
|
3277
|
+
* @summary Query Mutual Funds data - All users - available in Microservice
|
|
3278
|
+
* @request GET:/api/quote/mutual-funds
|
|
3062
3279
|
* @secure
|
|
3063
3280
|
*/
|
|
3064
|
-
|
|
3281
|
+
getMutualFunds(query?: {
|
|
3282
|
+
/** symbol, allow multiple query separated by ',' */
|
|
3283
|
+
symbols?: string;
|
|
3284
|
+
/**
|
|
3285
|
+
* if response with camel case
|
|
3286
|
+
* @default false
|
|
3287
|
+
*/
|
|
3288
|
+
response_camel_case?: boolean;
|
|
3289
|
+
/** @default "" */
|
|
3290
|
+
platform?: string;
|
|
3291
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMutualFund[], HandleError>>;
|
|
3065
3292
|
/**
|
|
3066
|
-
* @tags
|
|
3067
|
-
* @name
|
|
3068
|
-
* @summary
|
|
3069
|
-
* @request
|
|
3293
|
+
* @tags Quote
|
|
3294
|
+
* @name GetQuoddEod
|
|
3295
|
+
* @summary Query QUODD EOD data - All users - available in Microservice
|
|
3296
|
+
* @request GET:/api/quote/quodd-eod
|
|
3070
3297
|
* @secure
|
|
3071
3298
|
*/
|
|
3072
|
-
|
|
3299
|
+
getQuoddEod(query?: {
|
|
3300
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3301
|
+
symbols?: string;
|
|
3302
|
+
/**
|
|
3303
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3304
|
+
* @default false
|
|
3305
|
+
*/
|
|
3306
|
+
response_camel_case?: boolean;
|
|
3307
|
+
/**
|
|
3308
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3309
|
+
* @default ""
|
|
3310
|
+
*/
|
|
3311
|
+
user_name?: string;
|
|
3312
|
+
/** @default "" */
|
|
3313
|
+
platform?: string;
|
|
3314
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddEOD[], HandleError>>;
|
|
3073
3315
|
/**
|
|
3074
|
-
* @tags
|
|
3075
|
-
* @name
|
|
3076
|
-
* @summary
|
|
3077
|
-
* @request
|
|
3316
|
+
* @tags Quote
|
|
3317
|
+
* @name GetQuoddDelay
|
|
3318
|
+
* @summary Query QUODD Delay data - All users - available in Microservice
|
|
3319
|
+
* @request GET:/api/quote/quodd-delay
|
|
3078
3320
|
* @secure
|
|
3079
3321
|
*/
|
|
3080
|
-
|
|
3322
|
+
getQuoddDelay(query?: {
|
|
3323
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3324
|
+
symbols?: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3327
|
+
* @default false
|
|
3328
|
+
*/
|
|
3329
|
+
response_camel_case?: boolean;
|
|
3330
|
+
/**
|
|
3331
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3332
|
+
* @default ""
|
|
3333
|
+
*/
|
|
3334
|
+
user_name?: string;
|
|
3335
|
+
/** @default "" */
|
|
3336
|
+
platform?: string;
|
|
3337
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddDelay[], HandleError>>;
|
|
3081
3338
|
/**
|
|
3082
|
-
* @tags
|
|
3083
|
-
* @name
|
|
3084
|
-
* @summary
|
|
3085
|
-
* @request
|
|
3339
|
+
* @tags Quote
|
|
3340
|
+
* @name GetIceIsin
|
|
3341
|
+
* @summary Query ICE ISIN data - All users - available in Microservice
|
|
3342
|
+
* @request GET:/api/quote/ice-isin
|
|
3086
3343
|
* @secure
|
|
3087
3344
|
*/
|
|
3088
|
-
|
|
3345
|
+
getIceIsin(query?: {
|
|
3346
|
+
/** Allow multiple isins, separated by ',' */
|
|
3347
|
+
isins?: string;
|
|
3348
|
+
/**
|
|
3349
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3350
|
+
* @default false
|
|
3351
|
+
*/
|
|
3352
|
+
response_camel_case?: boolean;
|
|
3353
|
+
/**
|
|
3354
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3355
|
+
* @default ""
|
|
3356
|
+
*/
|
|
3357
|
+
user_name?: string;
|
|
3358
|
+
/** @default "" */
|
|
3359
|
+
platform?: string;
|
|
3360
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasIsinInfo[], HandleError>>;
|
|
3089
3361
|
/**
|
|
3090
|
-
* @tags
|
|
3091
|
-
* @name
|
|
3092
|
-
* @summary
|
|
3093
|
-
* @request GET:/api/
|
|
3362
|
+
* @tags Quote
|
|
3363
|
+
* @name GetIceEod
|
|
3364
|
+
* @summary Query ICE EOD data - All users - available in Microservice
|
|
3365
|
+
* @request GET:/api/quote/ice-eod
|
|
3094
3366
|
* @secure
|
|
3095
3367
|
*/
|
|
3096
|
-
|
|
3368
|
+
getIceEod(query?: {
|
|
3369
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3370
|
+
symbols?: string;
|
|
3097
3371
|
/**
|
|
3098
|
-
*
|
|
3372
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3373
|
+
* @default false
|
|
3374
|
+
*/
|
|
3375
|
+
response_camel_case?: boolean;
|
|
3376
|
+
/**
|
|
3377
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3099
3378
|
* @default ""
|
|
3100
3379
|
*/
|
|
3101
|
-
|
|
3102
|
-
|
|
3380
|
+
user_name?: string;
|
|
3381
|
+
/** @default "" */
|
|
3382
|
+
platform?: string;
|
|
3383
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasICEEOD[], HandleError>>;
|
|
3103
3384
|
/**
|
|
3104
|
-
* @tags
|
|
3105
|
-
* @name
|
|
3106
|
-
* @summary
|
|
3107
|
-
* @request GET:/api/
|
|
3385
|
+
* @tags Quote
|
|
3386
|
+
* @name GetFxRate
|
|
3387
|
+
* @summary Query Forex data with symbols - All users - available in Microservice
|
|
3388
|
+
* @request GET:/api/quote/fx-rate
|
|
3108
3389
|
* @secure
|
|
3109
3390
|
*/
|
|
3110
|
-
|
|
3391
|
+
getFxRate(query?: {
|
|
3392
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3393
|
+
symbols?: string;
|
|
3111
3394
|
/**
|
|
3112
|
-
*
|
|
3395
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3396
|
+
* @default false
|
|
3397
|
+
*/
|
|
3398
|
+
response_camel_case?: boolean;
|
|
3399
|
+
/**
|
|
3400
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3113
3401
|
* @default ""
|
|
3114
3402
|
*/
|
|
3115
|
-
|
|
3116
|
-
|
|
3403
|
+
user_name?: string;
|
|
3404
|
+
/** @default "" */
|
|
3405
|
+
platform?: string;
|
|
3406
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexRate[], HandleError>>;
|
|
3117
3407
|
/**
|
|
3118
|
-
* @tags
|
|
3119
|
-
* @name
|
|
3120
|
-
* @summary
|
|
3121
|
-
* @request
|
|
3408
|
+
* @tags Quote
|
|
3409
|
+
* @name GetFxTable
|
|
3410
|
+
* @summary Query Forex table for one currency - All users - available in Microservice
|
|
3411
|
+
* @request GET:/api/quote/fx-table
|
|
3122
3412
|
* @secure
|
|
3123
3413
|
*/
|
|
3124
|
-
|
|
3414
|
+
getFxTable(query?: {
|
|
3415
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3416
|
+
symbols?: string;
|
|
3417
|
+
/**
|
|
3418
|
+
* Optional. Default is false. If true, response will be camel case
|
|
3419
|
+
* @default false
|
|
3420
|
+
*/
|
|
3421
|
+
response_camel_case?: boolean;
|
|
3422
|
+
/**
|
|
3423
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
3424
|
+
* @default ""
|
|
3425
|
+
*/
|
|
3426
|
+
user_name?: string;
|
|
3427
|
+
/** @default "" */
|
|
3428
|
+
platform?: string;
|
|
3429
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexTable[], HandleError>>;
|
|
3430
|
+
}
|
|
3431
|
+
export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
3432
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3433
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3125
3434
|
/**
|
|
3126
|
-
* @
|
|
3127
|
-
* @
|
|
3128
|
-
* @
|
|
3129
|
-
* @
|
|
3130
|
-
* @request GET:/api/user/logout
|
|
3435
|
+
* @tags QuotesReformat
|
|
3436
|
+
* @name GetEquity
|
|
3437
|
+
* @summary Query full Level 1 data - All users - available in Microservice
|
|
3438
|
+
* @request GET:/api/quotes/equity
|
|
3131
3439
|
* @secure
|
|
3132
3440
|
*/
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3441
|
+
getEquity(query?: {
|
|
3442
|
+
/** Allow multiple symbols, separated by ',' */
|
|
3443
|
+
symbols?: string;
|
|
3444
|
+
/** @default "" */
|
|
3445
|
+
platform?: string;
|
|
3446
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3136
3447
|
/**
|
|
3137
|
-
* @tags
|
|
3138
|
-
* @name
|
|
3139
|
-
* @summary
|
|
3140
|
-
* @request
|
|
3448
|
+
* @tags QuotesReformat
|
|
3449
|
+
* @name GetEquityIntraday
|
|
3450
|
+
* @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
|
|
3451
|
+
* @request GET:/api/quotes/equity/intraday
|
|
3141
3452
|
* @secure
|
|
3142
3453
|
*/
|
|
3143
|
-
|
|
3454
|
+
getEquityIntraday(query?: {
|
|
3455
|
+
/** Allow one symbol */
|
|
3456
|
+
symbol?: string;
|
|
3457
|
+
/** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
|
|
3458
|
+
from?: string;
|
|
3459
|
+
/** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
|
|
3460
|
+
to?: string;
|
|
3461
|
+
/** @default "" */
|
|
3462
|
+
platform?: string;
|
|
3463
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3144
3464
|
/**
|
|
3145
|
-
* @tags
|
|
3146
|
-
* @name
|
|
3147
|
-
* @summary
|
|
3148
|
-
* @request
|
|
3465
|
+
* @tags QuotesReformat
|
|
3466
|
+
* @name GetOptionHistorical
|
|
3467
|
+
* @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
|
|
3468
|
+
* @request GET:/api/quotes/option/historical
|
|
3149
3469
|
* @secure
|
|
3150
3470
|
*/
|
|
3151
|
-
|
|
3471
|
+
getOptionHistorical(query?: {
|
|
3472
|
+
/** Allow one symbol */
|
|
3473
|
+
symbol?: string;
|
|
3474
|
+
/** start date (MM/dd/yyyy) */
|
|
3475
|
+
start?: string;
|
|
3476
|
+
/** end date (MM/dd/yyyy) */
|
|
3477
|
+
end?: string;
|
|
3478
|
+
/**
|
|
3479
|
+
* 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
|
|
3480
|
+
* @default ""
|
|
3481
|
+
*/
|
|
3482
|
+
range?: string;
|
|
3483
|
+
/** @default "" */
|
|
3484
|
+
platform?: string;
|
|
3485
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3152
3486
|
/**
|
|
3153
|
-
* @
|
|
3154
|
-
* @
|
|
3155
|
-
* @
|
|
3156
|
-
* @
|
|
3157
|
-
* @request PUT:/api/user/change-password
|
|
3487
|
+
* @tags QuotesReformat
|
|
3488
|
+
* @name GetSearch
|
|
3489
|
+
* @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
|
|
3490
|
+
* @request GET:/api/quotes/search
|
|
3158
3491
|
* @secure
|
|
3159
3492
|
*/
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
* @request GET:/api/user/user-name-by-id
|
|
3178
|
-
* @secure
|
|
3179
|
-
*/
|
|
3180
|
-
getUserNameById(query?: {
|
|
3181
|
-
user_id?: string;
|
|
3182
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3493
|
+
getSearch(query?: {
|
|
3494
|
+
/** String to search for */
|
|
3495
|
+
criteria?: string;
|
|
3496
|
+
/**
|
|
3497
|
+
* Maximum number of results to return (default is 20)
|
|
3498
|
+
* @format int32
|
|
3499
|
+
* @default 20
|
|
3500
|
+
*/
|
|
3501
|
+
limit?: number;
|
|
3502
|
+
/**
|
|
3503
|
+
* Whether to load quotes for the results or not
|
|
3504
|
+
* @default false
|
|
3505
|
+
*/
|
|
3506
|
+
loadQuotes?: boolean;
|
|
3507
|
+
/** @default "" */
|
|
3508
|
+
platform?: string;
|
|
3509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3183
3510
|
/**
|
|
3184
|
-
* @
|
|
3185
|
-
* @
|
|
3186
|
-
* @
|
|
3187
|
-
* @
|
|
3188
|
-
* @request GET:/api/user/user-id-by-name
|
|
3511
|
+
* @tags QuotesReformat
|
|
3512
|
+
* @name GetOption
|
|
3513
|
+
* @summary Query Option Level 1 data - All users - available in Microservice
|
|
3514
|
+
* @request GET:/api/quotes/option
|
|
3189
3515
|
* @secure
|
|
3190
3516
|
*/
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3517
|
+
getOption(query?: {
|
|
3518
|
+
/** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
3519
|
+
symbols?: string;
|
|
3520
|
+
/**
|
|
3521
|
+
* if include greek letter value in response
|
|
3522
|
+
* @default false
|
|
3523
|
+
*/
|
|
3524
|
+
greeks?: boolean;
|
|
3525
|
+
/** @default "" */
|
|
3526
|
+
platform?: string;
|
|
3527
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3194
3528
|
/**
|
|
3195
|
-
* @tags
|
|
3196
|
-
* @name
|
|
3197
|
-
* @summary
|
|
3198
|
-
* @request GET:/api/
|
|
3529
|
+
* @tags QuotesReformat
|
|
3530
|
+
* @name GetOptionChainDates
|
|
3531
|
+
* @summary Query Option Chain dates - All users - available in Microservice
|
|
3532
|
+
* @request GET:/api/quotes/option/chain/dates/{symbol}
|
|
3199
3533
|
* @secure
|
|
3200
3534
|
*/
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
|
|
3535
|
+
getOptionChainDates(symbol: string, query?: {
|
|
3536
|
+
/** @default "" */
|
|
3537
|
+
platform?: string;
|
|
3538
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3204
3539
|
/**
|
|
3205
|
-
* @tags
|
|
3206
|
-
* @name
|
|
3207
|
-
* @summary
|
|
3208
|
-
* @request GET:/api/
|
|
3540
|
+
* @tags QuotesReformat
|
|
3541
|
+
* @name GetOptionChain
|
|
3542
|
+
* @summary Query Option Chain data - All users - available in Microservice
|
|
3543
|
+
* @request GET:/api/quotes/option/chain/{symbol}/{date}
|
|
3209
3544
|
* @secure
|
|
3210
3545
|
*/
|
|
3211
|
-
|
|
3212
|
-
|
|
3213
|
-
|
|
3546
|
+
getOptionChain(symbol: string, date: string, query?: {
|
|
3547
|
+
/** @default "" */
|
|
3548
|
+
platform?: string;
|
|
3549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3214
3550
|
/**
|
|
3215
|
-
* @
|
|
3216
|
-
* @
|
|
3217
|
-
* @
|
|
3218
|
-
* @
|
|
3219
|
-
* @request POST:/api/user/users-fuzzy
|
|
3551
|
+
* @tags QuotesReformat
|
|
3552
|
+
* @name GetEquityHistorical
|
|
3553
|
+
* @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
|
|
3554
|
+
* @request GET:/api/quotes/equity/historical
|
|
3220
3555
|
* @secure
|
|
3221
3556
|
*/
|
|
3222
|
-
|
|
3223
|
-
|
|
3224
|
-
|
|
3557
|
+
getEquityHistorical(query?: {
|
|
3558
|
+
/** Allow one symbol */
|
|
3559
|
+
symbol?: string;
|
|
3560
|
+
/** start date (MM/dd/yyyy) */
|
|
3561
|
+
start?: string;
|
|
3562
|
+
/** end date (MM/dd/yyyy) */
|
|
3563
|
+
end?: string;
|
|
3564
|
+
/**
|
|
3565
|
+
* 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
|
|
3566
|
+
* @default ""
|
|
3567
|
+
*/
|
|
3568
|
+
range?: string;
|
|
3569
|
+
/** @default "" */
|
|
3570
|
+
platform?: string;
|
|
3571
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3225
3572
|
/**
|
|
3226
|
-
* @tags
|
|
3227
|
-
* @name
|
|
3228
|
-
* @summary Query
|
|
3229
|
-
* @request GET:/api/
|
|
3573
|
+
* @tags QuotesReformat
|
|
3574
|
+
* @name GetBonds
|
|
3575
|
+
* @summary Query Bonds data - All users - available in Microservice
|
|
3576
|
+
* @request GET:/api/quotes/bonds
|
|
3230
3577
|
* @secure
|
|
3231
3578
|
*/
|
|
3232
|
-
|
|
3233
|
-
/**
|
|
3234
|
-
|
|
3235
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
3236
|
-
/**
|
|
3237
|
-
* @description All conditions are optional
|
|
3238
|
-
* @tags User
|
|
3239
|
-
* @name PostUsersByMultipleConditions
|
|
3240
|
-
* @summary Search Users by multiple conditions with Pagination and Sort - Firm manager, or super admin - available in Microservice
|
|
3241
|
-
For Microservice API:
|
|
3242
|
-
1. No parameter 'user_name' and 'email'. Instead, it has parameter 'user_search', which will do fuzzy search on both user_name and email.
|
|
3243
|
-
2. Only return 'UMA' source users
|
|
3244
|
-
* @request POST:/api/user/users-by-multiple-conditions
|
|
3245
|
-
* @secure
|
|
3246
|
-
*/
|
|
3247
|
-
postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
|
|
3579
|
+
getBonds(query?: {
|
|
3580
|
+
/** ISIN, allow multiple query separated by ',' */
|
|
3581
|
+
identifiers?: string;
|
|
3248
3582
|
/**
|
|
3249
|
-
*
|
|
3250
|
-
* @default ""
|
|
3583
|
+
* Price type, default is Percentage. ('Percentage'|'Decimal')
|
|
3584
|
+
* @default "Percentage"
|
|
3251
3585
|
*/
|
|
3252
|
-
|
|
3586
|
+
bondPriceType?: string;
|
|
3253
3587
|
/**
|
|
3254
|
-
*
|
|
3255
|
-
* @default ""
|
|
3588
|
+
* Quantity type, default is Par. ('Par'|'Unit')
|
|
3589
|
+
* @default "Par"
|
|
3256
3590
|
*/
|
|
3257
|
-
|
|
3591
|
+
bondQuantityType?: string;
|
|
3592
|
+
/** @default "" */
|
|
3593
|
+
platform?: string;
|
|
3594
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3595
|
+
/**
|
|
3596
|
+
* @tags QuotesReformat
|
|
3597
|
+
* @name GetBondsSearch
|
|
3598
|
+
* @summary Search bonds - All users - available in Microservice
|
|
3599
|
+
* @request GET:/api/quotes/bonds/search
|
|
3600
|
+
* @secure
|
|
3601
|
+
*/
|
|
3602
|
+
getBondsSearch(query?: {
|
|
3603
|
+
/** search string */
|
|
3604
|
+
criteria?: string;
|
|
3258
3605
|
/**
|
|
3259
|
-
*
|
|
3260
|
-
* @
|
|
3606
|
+
* how many records that need to return, 20 is maximum
|
|
3607
|
+
* @format int32
|
|
3608
|
+
* @default 20
|
|
3261
3609
|
*/
|
|
3262
|
-
|
|
3610
|
+
limit?: number;
|
|
3263
3611
|
/**
|
|
3264
|
-
*
|
|
3265
|
-
* @default
|
|
3612
|
+
* if return bonds quote. If false, will only return ISIN list
|
|
3613
|
+
* @default false
|
|
3266
3614
|
*/
|
|
3267
|
-
|
|
3615
|
+
loadQuotes?: boolean;
|
|
3268
3616
|
/**
|
|
3269
|
-
*
|
|
3270
|
-
* @default ""
|
|
3617
|
+
* Price type, default is Percentage. ('Percentage'|'Decimal')
|
|
3618
|
+
* @default "Percentage"
|
|
3271
3619
|
*/
|
|
3272
|
-
|
|
3620
|
+
bondPriceType?: string;
|
|
3273
3621
|
/**
|
|
3274
|
-
*
|
|
3275
|
-
* @default ""
|
|
3622
|
+
* Quantity type, default is Par. ('Par'|'Unit')
|
|
3623
|
+
* @default "Par"
|
|
3276
3624
|
*/
|
|
3277
|
-
|
|
3278
|
-
|
|
3625
|
+
bondQuantityType?: string;
|
|
3626
|
+
/** @default "" */
|
|
3627
|
+
platform?: string;
|
|
3628
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3279
3629
|
/**
|
|
3280
|
-
* @
|
|
3281
|
-
* @
|
|
3282
|
-
* @
|
|
3283
|
-
* @
|
|
3284
|
-
* @request POST:/api/user/super-admins
|
|
3630
|
+
* @tags QuotesReformat
|
|
3631
|
+
* @name GetQuotesReformat
|
|
3632
|
+
* @summary Query Forex rate - All users - available in Microservice
|
|
3633
|
+
* @request GET:/api/quotes/fx
|
|
3285
3634
|
* @secure
|
|
3286
3635
|
*/
|
|
3287
|
-
|
|
3636
|
+
getQuotesReformat(query?: {
|
|
3637
|
+
/** base_currency/quote_currecy. Can query multiple, separated with ',' */
|
|
3638
|
+
symbols?: string;
|
|
3639
|
+
/** @default "" */
|
|
3640
|
+
platform?: string;
|
|
3641
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3642
|
+
}
|
|
3643
|
+
export class UmaTest<HandleError extends boolean = boolean> {
|
|
3644
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3645
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3288
3646
|
/**
|
|
3289
|
-
* @
|
|
3290
|
-
* @
|
|
3291
|
-
* @
|
|
3292
|
-
* @
|
|
3293
|
-
* @request DELETE:/api/user/user
|
|
3647
|
+
* @tags UMATest
|
|
3648
|
+
* @name GetRevokeUmaUser
|
|
3649
|
+
* @summary Test to revoke uma user - internal use only - Super admin - available in Microservice
|
|
3650
|
+
* @request GET:/api/uma-test/revoke-uma-user
|
|
3294
3651
|
* @secure
|
|
3295
3652
|
*/
|
|
3296
|
-
|
|
3653
|
+
getRevokeUmaUser(query?: {
|
|
3297
3654
|
user_id?: string;
|
|
3298
3655
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3299
3656
|
/**
|
|
3300
|
-
* @tags
|
|
3301
|
-
* @name
|
|
3302
|
-
* @summary
|
|
3303
|
-
* @request GET:/api/
|
|
3657
|
+
* @tags UMATest
|
|
3658
|
+
* @name GetFirmList
|
|
3659
|
+
* @summary Test to get all uma firms - internal use only - Super admin - available in Microservice
|
|
3660
|
+
* @request GET:/api/uma-test/firm-list
|
|
3304
3661
|
* @secure
|
|
3305
3662
|
*/
|
|
3306
|
-
|
|
3307
|
-
user_id?: string;
|
|
3308
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3663
|
+
getFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
|
|
3309
3664
|
/**
|
|
3310
|
-
* @
|
|
3311
|
-
* @
|
|
3312
|
-
* @
|
|
3313
|
-
* @
|
|
3314
|
-
* @request POST:/api/user/user-information
|
|
3665
|
+
* @tags UMATest
|
|
3666
|
+
* @name GetFirmListToLocal
|
|
3667
|
+
* @summary Import all uma firms to AES - internal use only - Super admin - available in Microservice
|
|
3668
|
+
* @request GET:/api/uma-test/firm-list-to-local
|
|
3315
3669
|
* @secure
|
|
3316
3670
|
*/
|
|
3317
|
-
|
|
3671
|
+
getFirmListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3318
3672
|
/**
|
|
3319
|
-
* @
|
|
3320
|
-
* @
|
|
3321
|
-
* @
|
|
3322
|
-
* @
|
|
3323
|
-
* @request PUT:/api/user/user-information
|
|
3673
|
+
* @tags UMATest
|
|
3674
|
+
* @name GetB2BUserById
|
|
3675
|
+
* @summary Test to get uma b2b user by user_id - internal use only - Super admin - available in Microservice
|
|
3676
|
+
* @request GET:/api/uma-test/b2b-user-by-id
|
|
3324
3677
|
* @secure
|
|
3325
3678
|
*/
|
|
3326
|
-
|
|
3679
|
+
getB2BUserById(query?: {
|
|
3327
3680
|
user_id?: string;
|
|
3328
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3681
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
|
|
3329
3682
|
/**
|
|
3330
|
-
* @tags
|
|
3331
|
-
* @name
|
|
3332
|
-
* @summary
|
|
3333
|
-
* @request GET:/api/
|
|
3683
|
+
* @tags UMATest
|
|
3684
|
+
* @name GetB2BUserList
|
|
3685
|
+
* @summary Test to get all uma b2b users - internal use only - Super admin - available in Microservice
|
|
3686
|
+
* @request GET:/api/uma-test/b2b-user-list
|
|
3334
3687
|
* @secure
|
|
3335
3688
|
*/
|
|
3336
|
-
|
|
3337
|
-
user_id?: string;
|
|
3338
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
|
|
3689
|
+
getB2BUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
|
|
3339
3690
|
/**
|
|
3340
|
-
* @tags
|
|
3341
|
-
* @name
|
|
3342
|
-
* @summary
|
|
3343
|
-
* @request GET:/api/
|
|
3691
|
+
* @tags UMATest
|
|
3692
|
+
* @name GetB2BUserListToLocal
|
|
3693
|
+
* @summary Import all uma b2b users to AES - internal use only - Super admin - available in Microservice
|
|
3694
|
+
* @request GET:/api/uma-test/b2b-user-list-to-local
|
|
3344
3695
|
* @secure
|
|
3345
3696
|
*/
|
|
3346
|
-
|
|
3697
|
+
getB2BUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3347
3698
|
/**
|
|
3348
|
-
* @
|
|
3349
|
-
* @
|
|
3350
|
-
* @
|
|
3351
|
-
* @
|
|
3352
|
-
* @request POST:/api/user/user-data-config
|
|
3699
|
+
* @tags UMATest
|
|
3700
|
+
* @name GetB2CUserById
|
|
3701
|
+
* @summary Test to get uma b2c user by user_id - internal use only - Super admin - available in Microservice
|
|
3702
|
+
* @request GET:/api/uma-test/b2c-user-by-id
|
|
3353
3703
|
* @secure
|
|
3354
3704
|
*/
|
|
3355
|
-
|
|
3705
|
+
getB2CUserById(query?: {
|
|
3706
|
+
user_id?: string;
|
|
3707
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
|
|
3356
3708
|
/**
|
|
3357
|
-
* @
|
|
3358
|
-
* @
|
|
3359
|
-
* @
|
|
3360
|
-
* @
|
|
3361
|
-
* @request PUT:/api/user/user-data-config
|
|
3709
|
+
* @tags UMATest
|
|
3710
|
+
* @name GetB2CUserList
|
|
3711
|
+
* @summary Test to get all uma b2c users - internal use only - Super admin - available in Microservice
|
|
3712
|
+
* @request GET:/api/uma-test/b2c-user-list
|
|
3362
3713
|
* @secure
|
|
3363
3714
|
*/
|
|
3364
|
-
|
|
3365
|
-
user_id?: string;
|
|
3366
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3715
|
+
getB2CUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
|
|
3367
3716
|
/**
|
|
3368
|
-
* @
|
|
3369
|
-
* @
|
|
3370
|
-
* @
|
|
3371
|
-
* @
|
|
3372
|
-
* @request GET:/api/user/user-data-config-by-id
|
|
3717
|
+
* @tags UMATest
|
|
3718
|
+
* @name GetB2CUserListToLocal
|
|
3719
|
+
* @summary Import all uma b2c users to AES - internal use only - Super admin - available in Microservice
|
|
3720
|
+
* @request GET:/api/uma-test/b2c-user-list-to-local
|
|
3373
3721
|
* @secure
|
|
3374
3722
|
*/
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
|
|
3723
|
+
getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3724
|
+
}
|
|
3725
|
+
export class User<HandleError extends boolean = boolean> {
|
|
3726
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3727
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3378
3728
|
/**
|
|
3379
3729
|
* @tags User
|
|
3380
|
-
* @name
|
|
3381
|
-
* @summary
|
|
3382
|
-
* @request
|
|
3730
|
+
* @name PostRegisterRegular
|
|
3731
|
+
* @summary Create a new regular user - Firm manager, or super admin - Not available in Microservice
|
|
3732
|
+
* @request POST:/api/user/register-regular
|
|
3383
3733
|
* @secure
|
|
3384
3734
|
*/
|
|
3385
|
-
|
|
3386
|
-
user_id?: string;
|
|
3387
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfigExtraInfo, HandleError>>;
|
|
3735
|
+
postRegisterRegular(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3388
3736
|
/**
|
|
3389
3737
|
* @tags User
|
|
3390
|
-
* @name
|
|
3391
|
-
* @summary
|
|
3392
|
-
* @request
|
|
3738
|
+
* @name PostRegisterAdmin
|
|
3739
|
+
* @summary Create a new admin user - Super admin - Not available in Microservice
|
|
3740
|
+
* @request POST:/api/user/register-admin
|
|
3393
3741
|
* @secure
|
|
3394
3742
|
*/
|
|
3395
|
-
|
|
3396
|
-
user_ids?: string;
|
|
3397
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig[], HandleError>>;
|
|
3743
|
+
postRegisterAdmin(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3398
3744
|
/**
|
|
3399
3745
|
* @tags User
|
|
3400
|
-
* @name
|
|
3401
|
-
* @summary
|
|
3402
|
-
* @request
|
|
3746
|
+
* @name PostRegisterManager
|
|
3747
|
+
* @summary Create a new firm manager user - Firm manager, or super admin - Not available in Microservice
|
|
3748
|
+
* @request POST:/api/user/register-manager
|
|
3403
3749
|
* @secure
|
|
3404
3750
|
*/
|
|
3405
|
-
|
|
3406
|
-
user_name?: string;
|
|
3407
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3751
|
+
postRegisterManager(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3408
3752
|
/**
|
|
3409
3753
|
* @tags User
|
|
3410
|
-
* @name
|
|
3411
|
-
* @summary
|
|
3412
|
-
* @request
|
|
3754
|
+
* @name PostRegisterUmaB2BUser
|
|
3755
|
+
* @summary Create a new b2b user from UMA - Firm manager, or super admin - available in Microservice
|
|
3756
|
+
* @request POST:/api/user/register-uma-b2b-user
|
|
3413
3757
|
* @secure
|
|
3414
3758
|
*/
|
|
3415
|
-
|
|
3759
|
+
postRegisterUmaB2BUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3416
3760
|
/**
|
|
3417
3761
|
* @tags User
|
|
3418
|
-
* @name
|
|
3419
|
-
* @summary
|
|
3420
|
-
* @request
|
|
3762
|
+
* @name PostRegisterUmaB2CUser
|
|
3763
|
+
* @summary Create a new b2c user from UMA - Firm manager, or super admin - available in Microservice
|
|
3764
|
+
* @request POST:/api/user/register-uma-b2c-user
|
|
3421
3765
|
* @secure
|
|
3422
3766
|
*/
|
|
3423
|
-
|
|
3424
|
-
}
|
|
3425
|
-
export class Quote<HandleError extends boolean = boolean> {
|
|
3426
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3427
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3767
|
+
postRegisterUmaB2CUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3428
3768
|
/**
|
|
3429
|
-
* @tags
|
|
3430
|
-
* @name
|
|
3431
|
-
* @summary
|
|
3432
|
-
* @request
|
|
3769
|
+
* @tags User
|
|
3770
|
+
* @name GetUmaB2BUserList
|
|
3771
|
+
* @summary Get UMA b2b users - Firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
3772
|
+
* @request GET:/api/user/uma-b2b-user-list
|
|
3433
3773
|
* @secure
|
|
3434
3774
|
*/
|
|
3435
|
-
|
|
3775
|
+
getUmaB2BUserList(query?: {
|
|
3436
3776
|
/**
|
|
3437
|
-
*
|
|
3438
|
-
* @default
|
|
3777
|
+
* fuzzy search on uma user first/last name
|
|
3778
|
+
* @default ""
|
|
3439
3779
|
*/
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
user_name?: string;
|
|
3443
|
-
/** @default "" */
|
|
3444
|
-
platform?: string;
|
|
3445
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError>>;
|
|
3780
|
+
name?: string;
|
|
3781
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
|
|
3446
3782
|
/**
|
|
3447
|
-
* @tags
|
|
3448
|
-
* @name
|
|
3449
|
-
* @summary
|
|
3450
|
-
* @request GET:/api/
|
|
3783
|
+
* @tags User
|
|
3784
|
+
* @name GetUmaB2CUserList
|
|
3785
|
+
* @summary Get UMA b2c users - Firm manager, or super admin - available in Microservice, POST with pagination and sort
|
|
3786
|
+
* @request GET:/api/user/uma-b2c-user-list
|
|
3451
3787
|
* @secure
|
|
3452
3788
|
*/
|
|
3453
|
-
|
|
3454
|
-
/** Allow multiple symbols query, seperated by ',' */
|
|
3455
|
-
symbols?: string;
|
|
3456
|
-
/**
|
|
3457
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3458
|
-
* @default false
|
|
3459
|
-
*/
|
|
3460
|
-
response_camel_case?: boolean;
|
|
3789
|
+
getUmaB2CUserList(query?: {
|
|
3461
3790
|
/**
|
|
3462
|
-
*
|
|
3791
|
+
* fuzzy search on uma user first/last name
|
|
3463
3792
|
* @default ""
|
|
3464
3793
|
*/
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
platform?: string;
|
|
3468
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBestQuote[], HandleError>>;
|
|
3794
|
+
name?: string;
|
|
3795
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
|
|
3469
3796
|
/**
|
|
3470
|
-
* @tags
|
|
3471
|
-
* @name
|
|
3472
|
-
* @summary
|
|
3473
|
-
* @request
|
|
3797
|
+
* @tags User
|
|
3798
|
+
* @name PostLogin
|
|
3799
|
+
* @summary all user login - All users - Not available in Microservice
|
|
3800
|
+
* @request POST:/api/user/login
|
|
3474
3801
|
* @secure
|
|
3475
3802
|
*/
|
|
3476
|
-
|
|
3477
|
-
/** Allow multiple symbols query, seperated by ',' */
|
|
3478
|
-
symbols?: string;
|
|
3479
|
-
/**
|
|
3480
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3481
|
-
* @default false
|
|
3482
|
-
*/
|
|
3483
|
-
response_camel_case?: boolean;
|
|
3484
|
-
/**
|
|
3485
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3486
|
-
* @default ""
|
|
3487
|
-
*/
|
|
3488
|
-
user_name?: string;
|
|
3489
|
-
/** @default "" */
|
|
3490
|
-
platform?: string;
|
|
3491
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
|
|
3803
|
+
postLogin(data: AesMidasLoginModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3492
3804
|
/**
|
|
3493
|
-
* @
|
|
3494
|
-
* @
|
|
3495
|
-
* @
|
|
3496
|
-
* @
|
|
3805
|
+
* @description token will be revoked even not expired
|
|
3806
|
+
* @tags User
|
|
3807
|
+
* @name GetLogout
|
|
3808
|
+
* @summary logout with user id - All users - Not available in Microservice
|
|
3809
|
+
* @request GET:/api/user/logout
|
|
3497
3810
|
* @secure
|
|
3498
3811
|
*/
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
/**
|
|
3503
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3504
|
-
* @default false
|
|
3505
|
-
*/
|
|
3506
|
-
response_camel_case?: boolean;
|
|
3507
|
-
/**
|
|
3508
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3509
|
-
* @default ""
|
|
3510
|
-
*/
|
|
3511
|
-
user_name?: string;
|
|
3512
|
-
/** @default "" */
|
|
3513
|
-
platform?: string;
|
|
3514
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1[], HandleError>>;
|
|
3812
|
+
getLogout(query?: {
|
|
3813
|
+
user_id?: string;
|
|
3814
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3515
3815
|
/**
|
|
3516
|
-
* @tags
|
|
3517
|
-
* @name
|
|
3518
|
-
* @summary
|
|
3519
|
-
* @request
|
|
3816
|
+
* @tags User
|
|
3817
|
+
* @name PutPhoneNumber
|
|
3818
|
+
* @summary update a user registered phone number - All users - Not available in Microservice
|
|
3819
|
+
* @request PUT:/api/user/phone-number
|
|
3520
3820
|
* @secure
|
|
3521
3821
|
*/
|
|
3522
|
-
|
|
3523
|
-
/** Allow one symbol */
|
|
3524
|
-
symbol?: string;
|
|
3525
|
-
/**
|
|
3526
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3527
|
-
* @default false
|
|
3528
|
-
*/
|
|
3529
|
-
response_camel_case?: boolean;
|
|
3530
|
-
/**
|
|
3531
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3532
|
-
* @default ""
|
|
3533
|
-
*/
|
|
3534
|
-
user_name?: string;
|
|
3535
|
-
/** @default "" */
|
|
3536
|
-
platform?: string;
|
|
3537
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
|
|
3822
|
+
putPhoneNumber(data: AesMidasModifyPhoneNumberModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3538
3823
|
/**
|
|
3539
|
-
* @tags
|
|
3540
|
-
* @name
|
|
3541
|
-
* @summary
|
|
3542
|
-
* @request
|
|
3824
|
+
* @tags User
|
|
3825
|
+
* @name PutEmail
|
|
3826
|
+
* @summary update a user registered email - All users - Not available in Microservice
|
|
3827
|
+
* @request PUT:/api/user/email
|
|
3543
3828
|
* @secure
|
|
3544
3829
|
*/
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3830
|
+
putEmail(data: AesMidasModifyEmailModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3831
|
+
/**
|
|
3832
|
+
* @description It will check old passoword.
|
|
3833
|
+
* @tags User
|
|
3834
|
+
* @name PutChangePassword
|
|
3835
|
+
* @summary User change its own password - All users - Not available in Microservice
|
|
3836
|
+
* @request PUT:/api/user/change-password
|
|
3837
|
+
* @secure
|
|
3838
|
+
*/
|
|
3839
|
+
putChangePassword(data: AesMidasChangePasswordModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3840
|
+
/**
|
|
3841
|
+
* @description For manager/admin user, it does not require old password.
|
|
3842
|
+
* @tags User
|
|
3843
|
+
* @name GetResetUserPassword
|
|
3844
|
+
* @summary Reset a user password - Firm manager, or super admin - Not available in Microservice
|
|
3845
|
+
* @request GET:/api/user/reset-user-password
|
|
3846
|
+
* @secure
|
|
3847
|
+
*/
|
|
3848
|
+
getResetUserPassword(query?: {
|
|
3849
|
+
user_id?: string;
|
|
3850
|
+
new_password?: string;
|
|
3851
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3852
|
+
/**
|
|
3853
|
+
* @tags User
|
|
3854
|
+
* @name GetUserNameById
|
|
3855
|
+
* @summary Get a user Name by a specific user Id - All users - Not available in Microservice
|
|
3856
|
+
* @request GET:/api/user/user-name-by-id
|
|
3857
|
+
* @secure
|
|
3858
|
+
*/
|
|
3859
|
+
getUserNameById(query?: {
|
|
3860
|
+
user_id?: string;
|
|
3861
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3862
|
+
/**
|
|
3863
|
+
* @description User Name is unique in the system.
|
|
3864
|
+
* @tags User
|
|
3865
|
+
* @name GetUserIdByName
|
|
3866
|
+
* @summary Get a user Id by a specific user Name - All users - Not available in Microservice
|
|
3867
|
+
* @request GET:/api/user/user-id-by-name
|
|
3868
|
+
* @secure
|
|
3869
|
+
*/
|
|
3870
|
+
getUserIdByName(query?: {
|
|
3557
3871
|
user_name?: string;
|
|
3558
|
-
|
|
3559
|
-
platform?: string;
|
|
3560
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
3872
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3561
3873
|
/**
|
|
3562
|
-
* @tags
|
|
3563
|
-
* @name
|
|
3564
|
-
* @summary
|
|
3565
|
-
* @request GET:/api/
|
|
3874
|
+
* @tags User
|
|
3875
|
+
* @name GetUserByName
|
|
3876
|
+
* @summary Search a user by an exactly user name - All users - Not available in Microservice
|
|
3877
|
+
* @request GET:/api/user/user-by-name
|
|
3566
3878
|
* @secure
|
|
3567
3879
|
*/
|
|
3568
|
-
|
|
3569
|
-
/** Allow multiple symbols query, seperated by ',' */
|
|
3570
|
-
symbols?: string;
|
|
3571
|
-
/**
|
|
3572
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3573
|
-
* @default false
|
|
3574
|
-
*/
|
|
3575
|
-
response_camel_case?: boolean;
|
|
3576
|
-
/**
|
|
3577
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3578
|
-
* @default ""
|
|
3579
|
-
*/
|
|
3880
|
+
getUserByName(query?: {
|
|
3580
3881
|
user_name?: string;
|
|
3581
|
-
|
|
3582
|
-
platform?: string;
|
|
3583
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
|
|
3882
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUser, HandleError>>;
|
|
3584
3883
|
/**
|
|
3585
|
-
* @tags
|
|
3586
|
-
* @name
|
|
3587
|
-
* @summary
|
|
3588
|
-
* @request GET:/api/
|
|
3884
|
+
* @tags User
|
|
3885
|
+
* @name GetUsersById
|
|
3886
|
+
* @summary Search users by exactly userids - All users - Not available in Microservice
|
|
3887
|
+
* @request GET:/api/user/users-by-id
|
|
3589
3888
|
* @secure
|
|
3590
3889
|
*/
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
* @default ""
|
|
3604
|
-
*/
|
|
3890
|
+
getUsersById(query?: {
|
|
3891
|
+
user_ids?: string;
|
|
3892
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUser[], HandleError>>;
|
|
3893
|
+
/**
|
|
3894
|
+
* @description It will return all users that user name contains the query string, no matter case.
|
|
3895
|
+
* @tags User
|
|
3896
|
+
* @name PostUsersFuzzy
|
|
3897
|
+
* @summary Search users which include a specific string with Pagination and Sort - All users - Not available in Microservice
|
|
3898
|
+
* @request POST:/api/user/users-fuzzy
|
|
3899
|
+
* @secure
|
|
3900
|
+
*/
|
|
3901
|
+
postUsersFuzzy(data: AesMidasQueryPostBody, query?: {
|
|
3605
3902
|
user_name?: string;
|
|
3606
|
-
|
|
3607
|
-
platform?: string;
|
|
3608
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasChartBar[], HandleError>>;
|
|
3903
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
|
|
3609
3904
|
/**
|
|
3610
|
-
* @tags
|
|
3611
|
-
* @name
|
|
3612
|
-
* @summary Query
|
|
3613
|
-
* @request GET:/api/
|
|
3905
|
+
* @tags User
|
|
3906
|
+
* @name GetUsersByFirm
|
|
3907
|
+
* @summary Query all users in a specific firm - Firm manager, or super admin - Not available in Microservice
|
|
3908
|
+
* @request GET:/api/user/users-by-firm
|
|
3614
3909
|
* @secure
|
|
3615
3910
|
*/
|
|
3616
|
-
|
|
3617
|
-
/**
|
|
3618
|
-
|
|
3911
|
+
getUsersByFirm(query?: {
|
|
3912
|
+
/** @default "" */
|
|
3913
|
+
firm?: string;
|
|
3914
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
3915
|
+
/**
|
|
3916
|
+
* @description All conditions are optional
|
|
3917
|
+
* @tags User
|
|
3918
|
+
* @name PostUsersByMultipleConditions
|
|
3919
|
+
* @summary Search Users by multiple conditions with Pagination and Sort - Firm manager, or super admin - available in Microservice
|
|
3920
|
+
For Microservice API:
|
|
3921
|
+
1. No parameter 'user_name' and 'email'. Instead, it has parameter 'user_search', which will do fuzzy search on both user_name and email.
|
|
3922
|
+
2. Only return 'UMA' source users
|
|
3923
|
+
* @request POST:/api/user/users-by-multiple-conditions
|
|
3924
|
+
* @secure
|
|
3925
|
+
*/
|
|
3926
|
+
postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
|
|
3619
3927
|
/**
|
|
3620
|
-
*
|
|
3928
|
+
* optional
|
|
3621
3929
|
* @default ""
|
|
3622
3930
|
*/
|
|
3623
|
-
|
|
3931
|
+
firm?: string;
|
|
3624
3932
|
/**
|
|
3625
|
-
*
|
|
3626
|
-
* @
|
|
3627
|
-
* @default 0
|
|
3933
|
+
* fuzzy search, optional
|
|
3934
|
+
* @default ""
|
|
3628
3935
|
*/
|
|
3629
|
-
|
|
3936
|
+
user_name?: string;
|
|
3630
3937
|
/**
|
|
3631
|
-
*
|
|
3632
|
-
* @default
|
|
3938
|
+
* optional
|
|
3939
|
+
* @default ""
|
|
3633
3940
|
*/
|
|
3634
|
-
|
|
3941
|
+
email?: string;
|
|
3635
3942
|
/**
|
|
3636
|
-
*
|
|
3943
|
+
* Value: Active/Suspended, optional
|
|
3637
3944
|
* @default ""
|
|
3638
3945
|
*/
|
|
3639
|
-
|
|
3640
|
-
/** @default "" */
|
|
3641
|
-
platform?: string;
|
|
3642
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
|
|
3643
|
-
/**
|
|
3644
|
-
* @tags Quote
|
|
3645
|
-
* @name GetHistoricalMinuteChart
|
|
3646
|
-
* @summary Query Historical Minute Chart - All users - available in Microservice
|
|
3647
|
-
* @request GET:/api/quote/historical-minute-chart
|
|
3648
|
-
* @secure
|
|
3649
|
-
*/
|
|
3650
|
-
getHistoricalMinuteChart(query?: {
|
|
3651
|
-
/** Allow one symbol */
|
|
3652
|
-
symbol?: string;
|
|
3653
|
-
/** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
|
|
3654
|
-
date?: string;
|
|
3946
|
+
status?: string;
|
|
3655
3947
|
/**
|
|
3656
|
-
*
|
|
3657
|
-
* @default
|
|
3948
|
+
* Value: Professional/Non-Professional, optional
|
|
3949
|
+
* @default ""
|
|
3658
3950
|
*/
|
|
3659
|
-
|
|
3951
|
+
professional?: string;
|
|
3660
3952
|
/**
|
|
3661
|
-
*
|
|
3953
|
+
* Value: Yes/No, optional
|
|
3662
3954
|
* @default ""
|
|
3663
3955
|
*/
|
|
3664
|
-
|
|
3665
|
-
|
|
3666
|
-
platform?: string;
|
|
3667
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMinuteChart[], HandleError>>;
|
|
3956
|
+
has_contract?: string;
|
|
3957
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserMultiConditionResultResponseResponsewithPagination, HandleError>>;
|
|
3668
3958
|
/**
|
|
3669
|
-
* @
|
|
3670
|
-
* @
|
|
3671
|
-
* @
|
|
3672
|
-
* @
|
|
3959
|
+
* @description Super admin is admin users in ViewTrade
|
|
3960
|
+
* @tags User
|
|
3961
|
+
* @name PostSuperAdmins
|
|
3962
|
+
* @summary Query all super admin users - Super admin - Not available in Microservice
|
|
3963
|
+
* @request POST:/api/user/super-admins
|
|
3673
3964
|
* @secure
|
|
3674
3965
|
*/
|
|
3675
|
-
|
|
3676
|
-
/**
|
|
3677
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3678
|
-
* @default false
|
|
3679
|
-
*/
|
|
3680
|
-
response_camel_case?: boolean;
|
|
3681
|
-
/** @default "" */
|
|
3682
|
-
user_name?: string;
|
|
3683
|
-
/** @default "" */
|
|
3684
|
-
platform?: string;
|
|
3685
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTop20[], HandleError>>;
|
|
3966
|
+
postSuperAdmins(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
|
|
3686
3967
|
/**
|
|
3687
|
-
* @
|
|
3688
|
-
* @
|
|
3689
|
-
* @
|
|
3690
|
-
* @
|
|
3968
|
+
* @description !Caution! It will delete the relevant user information, data configuration and unsign all UserEntitlements for this user.
|
|
3969
|
+
* @tags User
|
|
3970
|
+
* @name DeleteUser
|
|
3971
|
+
* @summary Delete an existing user - Super admin - Not available in Microservice
|
|
3972
|
+
* @request DELETE:/api/user/user
|
|
3691
3973
|
* @secure
|
|
3692
3974
|
*/
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
/**
|
|
3697
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3698
|
-
* @default false
|
|
3699
|
-
*/
|
|
3700
|
-
response_camel_case?: boolean;
|
|
3701
|
-
/**
|
|
3702
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3703
|
-
* @default ""
|
|
3704
|
-
*/
|
|
3705
|
-
user_name?: string;
|
|
3706
|
-
/** @default "" */
|
|
3707
|
-
platform?: string;
|
|
3708
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChainDates[], HandleError>>;
|
|
3975
|
+
deleteUser(query?: {
|
|
3976
|
+
user_id?: string;
|
|
3977
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3709
3978
|
/**
|
|
3710
|
-
* @tags
|
|
3711
|
-
* @name
|
|
3712
|
-
* @summary
|
|
3713
|
-
* @request GET:/api/
|
|
3979
|
+
* @tags User
|
|
3980
|
+
* @name GetUserRole
|
|
3981
|
+
* @summary Search a user role by user Id - All users - Not available in Microservice
|
|
3982
|
+
* @request GET:/api/user/user-role
|
|
3714
3983
|
* @secure
|
|
3715
3984
|
*/
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
|
|
3719
|
-
/** allow one date, format YYYY-MM-DD */
|
|
3720
|
-
date?: string;
|
|
3721
|
-
/**
|
|
3722
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3723
|
-
* @default false
|
|
3724
|
-
*/
|
|
3725
|
-
response_camel_case?: boolean;
|
|
3726
|
-
/**
|
|
3727
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3728
|
-
* @default ""
|
|
3729
|
-
*/
|
|
3730
|
-
user_name?: string;
|
|
3731
|
-
/** @default "" */
|
|
3732
|
-
platform?: string;
|
|
3733
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChain[], HandleError>>;
|
|
3985
|
+
getUserRole(query?: {
|
|
3986
|
+
user_id?: string;
|
|
3987
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3734
3988
|
/**
|
|
3735
|
-
* @
|
|
3736
|
-
* @
|
|
3737
|
-
* @
|
|
3738
|
-
* @
|
|
3989
|
+
* @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"
|
|
3990
|
+
* @tags User
|
|
3991
|
+
* @name PostUserInformation
|
|
3992
|
+
* @summary Create new user information - All users - available in Microservice
|
|
3993
|
+
* @request POST:/api/user/user-information
|
|
3739
3994
|
* @secure
|
|
3740
3995
|
*/
|
|
3741
|
-
|
|
3742
|
-
/** Allow multiple option symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
|
|
3743
|
-
option_names?: string;
|
|
3744
|
-
/**
|
|
3745
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3746
|
-
* @default false
|
|
3747
|
-
*/
|
|
3748
|
-
response_camel_case?: boolean;
|
|
3749
|
-
/**
|
|
3750
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3751
|
-
* @default ""
|
|
3752
|
-
*/
|
|
3753
|
-
user_name?: string;
|
|
3754
|
-
/** @default "" */
|
|
3755
|
-
platform?: string;
|
|
3756
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1[], HandleError>>;
|
|
3996
|
+
postUserInformation(data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
|
|
3757
3997
|
/**
|
|
3758
|
-
* @
|
|
3759
|
-
* @
|
|
3760
|
-
* @
|
|
3761
|
-
* @
|
|
3998
|
+
* @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"
|
|
3999
|
+
* @tags User
|
|
4000
|
+
* @name PutUserInformation
|
|
4001
|
+
* @summary Update existing user information - All users - available in Microservice
|
|
4002
|
+
* @request PUT:/api/user/user-information
|
|
3762
4003
|
* @secure
|
|
3763
4004
|
*/
|
|
3764
|
-
|
|
3765
|
-
|
|
3766
|
-
|
|
3767
|
-
/**
|
|
3768
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3769
|
-
* @default false
|
|
3770
|
-
*/
|
|
3771
|
-
response_camel_case?: boolean;
|
|
3772
|
-
/**
|
|
3773
|
-
* if include greek letter value in response
|
|
3774
|
-
* @default false
|
|
3775
|
-
*/
|
|
3776
|
-
include_greek?: boolean;
|
|
3777
|
-
/**
|
|
3778
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3779
|
-
* @default ""
|
|
3780
|
-
*/
|
|
3781
|
-
user_name?: string;
|
|
3782
|
-
/** @default "" */
|
|
3783
|
-
platform?: string;
|
|
3784
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks[], HandleError>>;
|
|
4005
|
+
putUserInformation(data: AesMidasUserInformation, query?: {
|
|
4006
|
+
user_id?: string;
|
|
4007
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3785
4008
|
/**
|
|
3786
|
-
* @tags
|
|
3787
|
-
* @name
|
|
3788
|
-
* @summary Query
|
|
3789
|
-
* @request GET:/api/
|
|
4009
|
+
* @tags User
|
|
4010
|
+
* @name GetUserInformationById
|
|
4011
|
+
* @summary Query a specific user information - All users - available in Microservice
|
|
4012
|
+
* @request GET:/api/user/user-information-by-id
|
|
3790
4013
|
* @secure
|
|
3791
4014
|
*/
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
/**
|
|
3796
|
-
* Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
|
|
3797
|
-
* @default ""
|
|
3798
|
-
*/
|
|
3799
|
-
year?: string;
|
|
3800
|
-
/**
|
|
3801
|
-
* how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
|
|
3802
|
-
* @format int32
|
|
3803
|
-
* @default 0
|
|
3804
|
-
*/
|
|
3805
|
-
month?: number;
|
|
3806
|
-
/**
|
|
3807
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3808
|
-
* @default false
|
|
3809
|
-
*/
|
|
3810
|
-
response_camel_case?: boolean;
|
|
3811
|
-
/**
|
|
3812
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3813
|
-
* @default ""
|
|
3814
|
-
*/
|
|
3815
|
-
user_name?: string;
|
|
3816
|
-
/** @default "" */
|
|
3817
|
-
platform?: string;
|
|
3818
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
|
|
4015
|
+
getUserInformationById(query?: {
|
|
4016
|
+
user_id?: string;
|
|
4017
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
|
|
3819
4018
|
/**
|
|
3820
|
-
* @tags
|
|
3821
|
-
* @name
|
|
3822
|
-
* @summary Query
|
|
3823
|
-
* @request GET:/api/
|
|
4019
|
+
* @tags User
|
|
4020
|
+
* @name GetOccupationList
|
|
4021
|
+
* @summary Query occupation list that can be used in user information EmploymentFunction - All users - available in Microservice
|
|
4022
|
+
* @request GET:/api/user/occupation-list
|
|
3824
4023
|
* @secure
|
|
3825
4024
|
*/
|
|
3826
|
-
|
|
3827
|
-
/** Allow multiple symbols, separated by ',' */
|
|
3828
|
-
symbols?: string;
|
|
3829
|
-
/**
|
|
3830
|
-
* True to query realtime data, False to query delay data
|
|
3831
|
-
* @default false
|
|
3832
|
-
*/
|
|
3833
|
-
realtime?: boolean;
|
|
3834
|
-
/**
|
|
3835
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3836
|
-
* @default false
|
|
3837
|
-
*/
|
|
3838
|
-
response_camel_case?: boolean;
|
|
3839
|
-
/**
|
|
3840
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3841
|
-
* @default ""
|
|
3842
|
-
*/
|
|
3843
|
-
user_name?: string;
|
|
3844
|
-
/** @default "" */
|
|
3845
|
-
platform?: string;
|
|
3846
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEquiductL1[], HandleError>>;
|
|
4025
|
+
getOccupationList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOccupation[], HandleError>>;
|
|
3847
4026
|
/**
|
|
3848
|
-
* @
|
|
3849
|
-
* @
|
|
3850
|
-
* @
|
|
3851
|
-
* @
|
|
4027
|
+
* @description It will check if user firm has relevant data acess.
|
|
4028
|
+
* @tags User
|
|
4029
|
+
* @name PostUserDataConfig
|
|
4030
|
+
* @summary Create new user data configuration - Firm manager, or super admin - available in Microservice
|
|
4031
|
+
* @request POST:/api/user/user-data-config
|
|
3852
4032
|
* @secure
|
|
3853
4033
|
*/
|
|
3854
|
-
|
|
3855
|
-
/** ISIN, allow multiple query separated by ',' */
|
|
3856
|
-
isins?: string;
|
|
3857
|
-
/**
|
|
3858
|
-
* Price type, default is Percentage. ('Percentage'|'Decimal')
|
|
3859
|
-
* @default "Percentage"
|
|
3860
|
-
*/
|
|
3861
|
-
bondPriceType?: string;
|
|
3862
|
-
/**
|
|
3863
|
-
* Quantity type, default is Par. ('Par'|'Unit')
|
|
3864
|
-
* @default "Par"
|
|
3865
|
-
*/
|
|
3866
|
-
bondQuantityType?: string;
|
|
3867
|
-
/**
|
|
3868
|
-
* if response with camel case
|
|
3869
|
-
* @default false
|
|
3870
|
-
*/
|
|
3871
|
-
response_camel_case?: boolean;
|
|
3872
|
-
/** @default "" */
|
|
3873
|
-
platform?: string;
|
|
3874
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondWholeApex[], HandleError>>;
|
|
4034
|
+
postUserDataConfig(data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
|
|
3875
4035
|
/**
|
|
3876
|
-
* @
|
|
3877
|
-
* @
|
|
3878
|
-
* @
|
|
3879
|
-
* @
|
|
4036
|
+
* @description It will check if user firm has relevant data acess.
|
|
4037
|
+
* @tags User
|
|
4038
|
+
* @name PutUserDataConfig
|
|
4039
|
+
* @summary Update existing user data configuration - Firm manager, or super admin - available in Microservice
|
|
4040
|
+
* @request PUT:/api/user/user-data-config
|
|
3880
4041
|
* @secure
|
|
3881
4042
|
*/
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
criteria?: string;
|
|
3885
|
-
/**
|
|
3886
|
-
* how many records that need to return, 20 is maximum
|
|
3887
|
-
* @format int32
|
|
3888
|
-
* @default 20
|
|
3889
|
-
*/
|
|
3890
|
-
limit?: number;
|
|
3891
|
-
/**
|
|
3892
|
-
* if return bonds quote. If false, will only return ISIN list
|
|
3893
|
-
* @default false
|
|
3894
|
-
*/
|
|
3895
|
-
loadQuotes?: boolean;
|
|
3896
|
-
/**
|
|
3897
|
-
* Price type, default is Percentage. ('Percentage'|'Decimal')
|
|
3898
|
-
* @default "Percentage"
|
|
3899
|
-
*/
|
|
3900
|
-
bondPriceType?: string;
|
|
3901
|
-
/**
|
|
3902
|
-
* Quantity type, default is Par. ('Par'|'Unit')
|
|
3903
|
-
* @default "Par"
|
|
3904
|
-
*/
|
|
3905
|
-
bondQuantityType?: string;
|
|
3906
|
-
/**
|
|
3907
|
-
* if response with camel case
|
|
3908
|
-
* @default false
|
|
3909
|
-
*/
|
|
3910
|
-
response_camel_case?: boolean;
|
|
3911
|
-
/** @default "" */
|
|
3912
|
-
platform?: string;
|
|
4043
|
+
putUserDataConfig(data: AesMidasUserDataConfig, query?: {
|
|
4044
|
+
user_id?: string;
|
|
3913
4045
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3914
4046
|
/**
|
|
3915
|
-
* @
|
|
3916
|
-
* @
|
|
3917
|
-
* @
|
|
3918
|
-
* @
|
|
3919
|
-
* @
|
|
3920
|
-
*/
|
|
3921
|
-
getBondsChart(query?: {
|
|
3922
|
-
/** ISIN, only allow one symbol at a time */
|
|
3923
|
-
isin?: string;
|
|
3924
|
-
/** Frequency of price observations. Supported frequencies and ranges are: 1day: EOD close prices - Maximum supported time range: 365 days. 15min: 15 minute interval prices - Maximum supported time range: 15 days. 1min: 1 minute tick prices.The number of price updates per day will differ based on the liquidity profile of the underlying bond(some bonds will only have a few updates throughout the day). The maximum update frequency is 2 updates per minute.In this case, we will aggregate by taking the later timestamp - Maximum supported time range: 1 day. */
|
|
3925
|
-
frequency?: string;
|
|
3926
|
-
/** Filter data equal to or after this time in YYYY-MM-DD format. */
|
|
3927
|
-
start?: string;
|
|
3928
|
-
/** Filter data equal to or before this time in YYYY-MM-DD format. */
|
|
3929
|
-
end?: string;
|
|
3930
|
-
/**
|
|
3931
|
-
* if response with camel case
|
|
3932
|
-
* @default false
|
|
3933
|
-
*/
|
|
3934
|
-
response_camel_case?: boolean;
|
|
3935
|
-
/** @default "" */
|
|
3936
|
-
platform?: string;
|
|
3937
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasHistoricalBondChartApex[], HandleError>>;
|
|
3938
|
-
/**
|
|
3939
|
-
* @tags Quote
|
|
3940
|
-
* @name GetMutualFunds
|
|
3941
|
-
* @summary Query Mutual Funds data - All users - available in Microservice
|
|
3942
|
-
* @request GET:/api/quote/mutual-funds
|
|
3943
|
-
* @secure
|
|
3944
|
-
*/
|
|
3945
|
-
getMutualFunds(query?: {
|
|
3946
|
-
/** symbol, allow multiple query separated by ',' */
|
|
3947
|
-
symbols?: string;
|
|
3948
|
-
/**
|
|
3949
|
-
* if response with camel case
|
|
3950
|
-
* @default false
|
|
3951
|
-
*/
|
|
3952
|
-
response_camel_case?: boolean;
|
|
3953
|
-
/** @default "" */
|
|
3954
|
-
platform?: string;
|
|
3955
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMutualFund[], HandleError>>;
|
|
3956
|
-
/**
|
|
3957
|
-
* @tags Quote
|
|
3958
|
-
* @name GetQuoddEod
|
|
3959
|
-
* @summary Query QUODD EOD data - All users - available in Microservice
|
|
3960
|
-
* @request GET:/api/quote/quodd-eod
|
|
4047
|
+
* @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
|
|
4048
|
+
* @tags User
|
|
4049
|
+
* @name GetUserDataConfigById
|
|
4050
|
+
* @summary Query a user data configuration by user Id - All users - available in Microservice
|
|
4051
|
+
* @request GET:/api/user/user-data-config-by-id
|
|
3961
4052
|
* @secure
|
|
3962
4053
|
*/
|
|
3963
|
-
|
|
3964
|
-
|
|
3965
|
-
|
|
3966
|
-
/**
|
|
3967
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3968
|
-
* @default false
|
|
3969
|
-
*/
|
|
3970
|
-
response_camel_case?: boolean;
|
|
3971
|
-
/**
|
|
3972
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3973
|
-
* @default ""
|
|
3974
|
-
*/
|
|
3975
|
-
user_name?: string;
|
|
3976
|
-
/** @default "" */
|
|
3977
|
-
platform?: string;
|
|
3978
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddEOD[], HandleError>>;
|
|
4054
|
+
getUserDataConfigById(query?: {
|
|
4055
|
+
user_id?: string;
|
|
4056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
|
|
3979
4057
|
/**
|
|
3980
|
-
* @tags
|
|
3981
|
-
* @name
|
|
3982
|
-
* @summary Query
|
|
3983
|
-
* @request GET:/api/
|
|
4058
|
+
* @tags User
|
|
4059
|
+
* @name GetUserDataConfigByIdExtraInfo
|
|
4060
|
+
* @summary Query a user data configuration by user Id - All users - available in Microservice
|
|
4061
|
+
* @request GET:/api/user/user-data-config-by-id-extra-info
|
|
3984
4062
|
* @secure
|
|
3985
4063
|
*/
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
/**
|
|
3990
|
-
* Optional. Default is false. If true, response will be camel case
|
|
3991
|
-
* @default false
|
|
3992
|
-
*/
|
|
3993
|
-
response_camel_case?: boolean;
|
|
3994
|
-
/**
|
|
3995
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
3996
|
-
* @default ""
|
|
3997
|
-
*/
|
|
3998
|
-
user_name?: string;
|
|
3999
|
-
/** @default "" */
|
|
4000
|
-
platform?: string;
|
|
4001
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQuoddDelay[], HandleError>>;
|
|
4064
|
+
getUserDataConfigByIdExtraInfo(query?: {
|
|
4065
|
+
user_id?: string;
|
|
4066
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfigExtraInfo, HandleError>>;
|
|
4002
4067
|
/**
|
|
4003
|
-
* @tags
|
|
4004
|
-
* @name
|
|
4005
|
-
* @summary Query
|
|
4006
|
-
* @request GET:/api/
|
|
4068
|
+
* @tags User
|
|
4069
|
+
* @name GetUserDataConfigs
|
|
4070
|
+
* @summary Query user data configurations by user Ids - Firm manager or super admin - available in Microservice
|
|
4071
|
+
* @request GET:/api/user/user-data-configs
|
|
4007
4072
|
* @secure
|
|
4008
4073
|
*/
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
/**
|
|
4013
|
-
* Optional. Default is false. If true, response will be camel case
|
|
4014
|
-
* @default false
|
|
4015
|
-
*/
|
|
4016
|
-
response_camel_case?: boolean;
|
|
4017
|
-
/**
|
|
4018
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
4019
|
-
* @default ""
|
|
4020
|
-
*/
|
|
4021
|
-
user_name?: string;
|
|
4022
|
-
/** @default "" */
|
|
4023
|
-
platform?: string;
|
|
4024
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasIsinInfo[], HandleError>>;
|
|
4074
|
+
getUserDataConfigs(query?: {
|
|
4075
|
+
user_ids?: string;
|
|
4076
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig[], HandleError>>;
|
|
4025
4077
|
/**
|
|
4026
|
-
* @tags
|
|
4027
|
-
* @name
|
|
4028
|
-
* @summary Query
|
|
4029
|
-
* @request GET:/api/
|
|
4078
|
+
* @tags User
|
|
4079
|
+
* @name GetUserNeedSignAgreements
|
|
4080
|
+
* @summary Query which entitlements(agreements) a user need to sign(but not signed yet) by user name - All users - available in Microservice
|
|
4081
|
+
* @request GET:/api/user/user-need-sign-agreements
|
|
4030
4082
|
* @secure
|
|
4031
4083
|
*/
|
|
4032
|
-
|
|
4033
|
-
/** Allow multiple symbols, separated by ',' */
|
|
4034
|
-
symbols?: string;
|
|
4035
|
-
/**
|
|
4036
|
-
* Optional. Default is false. If true, response will be camel case
|
|
4037
|
-
* @default false
|
|
4038
|
-
*/
|
|
4039
|
-
response_camel_case?: boolean;
|
|
4040
|
-
/**
|
|
4041
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
4042
|
-
* @default ""
|
|
4043
|
-
*/
|
|
4084
|
+
getUserNeedSignAgreements(query?: {
|
|
4044
4085
|
user_name?: string;
|
|
4045
|
-
|
|
4046
|
-
platform?: string;
|
|
4047
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasICEEOD[], HandleError>>;
|
|
4086
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
4048
4087
|
/**
|
|
4049
|
-
* @tags
|
|
4050
|
-
* @name
|
|
4051
|
-
* @summary Query
|
|
4052
|
-
* @request GET:/api/
|
|
4088
|
+
* @tags User
|
|
4089
|
+
* @name GetSessionAlive
|
|
4090
|
+
* @summary Query if current user session is alive - All users - Not available in Microservice
|
|
4091
|
+
* @request GET:/api/user/session-alive
|
|
4053
4092
|
* @secure
|
|
4054
4093
|
*/
|
|
4055
|
-
|
|
4056
|
-
/** Allow multiple symbols, separated by ',' */
|
|
4057
|
-
symbols?: string;
|
|
4058
|
-
/**
|
|
4059
|
-
* Optional. Default is false. If true, response will be camel case
|
|
4060
|
-
* @default false
|
|
4061
|
-
*/
|
|
4062
|
-
response_camel_case?: boolean;
|
|
4063
|
-
/**
|
|
4064
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
4065
|
-
* @default ""
|
|
4066
|
-
*/
|
|
4067
|
-
user_name?: string;
|
|
4068
|
-
/** @default "" */
|
|
4069
|
-
platform?: string;
|
|
4070
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexRate[], HandleError>>;
|
|
4094
|
+
getSessionAlive(config?: RequestConfig<HandleError>): Promise<ClientResponse<boolean, HandleError>>;
|
|
4071
4095
|
/**
|
|
4072
|
-
* @tags
|
|
4073
|
-
* @name
|
|
4074
|
-
* @summary
|
|
4075
|
-
* @request GET:/api/
|
|
4096
|
+
* @tags User
|
|
4097
|
+
* @name GetTest
|
|
4098
|
+
* @summary For system deployment user only - All users - available in Microservice
|
|
4099
|
+
* @request GET:/api/user/Test
|
|
4076
4100
|
* @secure
|
|
4077
4101
|
*/
|
|
4078
|
-
|
|
4079
|
-
/** Allow multiple symbols, separated by ',' */
|
|
4080
|
-
symbols?: string;
|
|
4081
|
-
/**
|
|
4082
|
-
* Optional. Default is false. If true, response will be camel case
|
|
4083
|
-
* @default false
|
|
4084
|
-
*/
|
|
4085
|
-
response_camel_case?: boolean;
|
|
4086
|
-
/**
|
|
4087
|
-
* Optional. Must input if enterprise user query on behave of their clients
|
|
4088
|
-
* @default ""
|
|
4089
|
-
*/
|
|
4090
|
-
user_name?: string;
|
|
4091
|
-
/** @default "" */
|
|
4092
|
-
platform?: string;
|
|
4093
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasForexTable[], HandleError>>;
|
|
4102
|
+
getTest(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
4094
4103
|
}
|
|
4095
4104
|
export class WebSocket<HandleError extends boolean = boolean> {
|
|
4096
4105
|
protected readonly apiClient: JwtClient<HandleError>;
|