@orbis-systems/orbis-api-clients 0.6.10 → 0.6.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +672 -775
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +238 -77
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +315 -298
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +34 -34
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +383 -363
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +364 -328
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -77,6 +77,34 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
77
77
  setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
78
78
  protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
79
79
  }
80
+ export class BackgroundService<HandleError extends boolean = boolean> {
81
+ protected readonly apiClient: JwtClient<HandleError>;
82
+ constructor(apiClient: JwtClient<HandleError>);
83
+ /**
84
+ * @tags BackgroundService
85
+ * @name PostStart
86
+ * @summary Start the background service to sync UMA firms/users
87
+ * @request POST:/api/background-service/start
88
+ * @secure
89
+ */
90
+ postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
91
+ /**
92
+ * @tags BackgroundService
93
+ * @name PostStop
94
+ * @summary Stop the background service to sync UMA firms/users
95
+ * @request POST:/api/background-service/stop
96
+ * @secure
97
+ */
98
+ postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
99
+ /**
100
+ * @tags BackgroundService
101
+ * @name GetStatus
102
+ * @summary Check the status of the background service
103
+ * @request GET:/api/background-service/status
104
+ * @secure
105
+ */
106
+ getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
107
+ }
80
108
  export interface AesMidasActionLog {
81
109
  id?: string | null;
82
110
  /** @format date-time */
@@ -89,6 +117,17 @@ export interface AesMidasActionLog {
89
117
  post_body?: string | null;
90
118
  message?: string | null;
91
119
  }
120
+ export interface AesMidasActionLogResponsewithPagination {
121
+ /** @format int32 */
122
+ total_items?: number;
123
+ /** @format int32 */
124
+ total_pages?: number;
125
+ /** @format int32 */
126
+ current_pages?: number;
127
+ /** @format int32 */
128
+ page_size?: number;
129
+ data?: AesMidasActionLog[] | null;
130
+ }
92
131
  export interface AesMidasApplicationUser {
93
132
  user_name?: string | null;
94
133
  normalized_user_name?: string | null;
@@ -111,17 +150,6 @@ export interface AesMidasApplicationUser {
111
150
  source?: string | null;
112
151
  user_type?: string | null;
113
152
  }
114
- export interface AesMidasApplicationUserResponsewithPagination {
115
- /** @format int32 */
116
- total_items?: number;
117
- /** @format int32 */
118
- total_pages?: number;
119
- /** @format int32 */
120
- current_pages?: number;
121
- /** @format int32 */
122
- page_size?: number;
123
- data?: AesMidasApplicationUser[] | null;
124
- }
125
153
  export interface AesMidasBestQuote {
126
154
  symbol?: string | null;
127
155
  issue_market?: string | null;
@@ -222,42 +250,56 @@ export interface AesMidasBond {
222
250
  source?: string | null;
223
251
  settlement_convention?: string | null;
224
252
  }
225
- export interface AesMidasBondMarksApex {
226
- isin?: string | null;
227
- cusip?: string | null;
228
- timestamp?: string | null;
229
- /** @format double */
230
- price?: number | null;
231
- /** @format double */
232
- dirty_price?: number | null;
233
- /** @format double */
234
- accrued_interest?: number | null;
235
- /** @format double */
236
- yield_to_worst?: number | null;
237
- error?: string | null;
253
+ export interface AesMidasBondFieldValues {
254
+ status?: string[] | null;
255
+ sector?: string[] | null;
256
+ type?: string[] | null;
257
+ coupon_frequency?: string[] | null;
258
+ municipal_state?: string[] | null;
259
+ sp_rating?: string[] | null;
260
+ municipal_type?: string[] | null;
261
+ purpose?: string[] | null;
262
+ }
263
+ export interface AesMidasBondPagedResult {
264
+ /** @format int64 */
265
+ total_count?: number;
266
+ results?: AesMidasBond[] | null;
238
267
  }
239
- export interface AesMidasBondQuotesApex {
240
- timestamp?: string | null;
241
- /** @format double */
242
- bid_price?: number | null;
243
- /** @format double */
244
- bid_yield_to_worst?: number | null;
245
- /** @format double */
246
- bid_size?: number | null;
247
- /** @format double */
248
- bid_min_size?: number | null;
249
- /** @format double */
250
- ask_price?: number | null;
251
- /** @format double */
252
- ask_yield_to_worst?: number | null;
253
- /** @format double */
254
- ask_size?: number | null;
255
- /** @format double */
256
- ask_min_size?: number | null;
268
+ export interface AesMidasBondSearchBody {
269
+ issuer?: string | null;
270
+ description?: string | null;
271
+ statuses?: string[] | null;
272
+ bank_qualified?: boolean | null;
273
+ callable?: boolean | null;
274
+ convertible?: boolean | null;
275
+ has_ticker?: boolean | null;
257
276
  /** @format double */
258
- bid_yield_to_maturity?: number | null;
277
+ coupon_low?: number | null;
259
278
  /** @format double */
260
- ask_yield_to_maturity?: number | null;
279
+ coupon_high?: number | null;
280
+ coupon_frequencies?: string[] | null;
281
+ insured?: boolean | null;
282
+ /** @format date */
283
+ issue_date_start?: string | null;
284
+ /** @format date */
285
+ issue_date_end?: string | null;
286
+ /** @format date */
287
+ maturity_start?: string | null;
288
+ /** @format date */
289
+ maturity_end?: string | null;
290
+ municipal_states?: string[] | null;
291
+ municial_tax?: boolean | null;
292
+ municial_types?: string[] | null;
293
+ purposes?: string[] | null;
294
+ sectors?: string[] | null;
295
+ sp_ratings?: string[] | null;
296
+ tickers?: string[] | null;
297
+ country_codes?: string[] | null;
298
+ types?: string[] | null;
299
+ isins?: string[] | null;
300
+ cusips?: string[] | null;
301
+ sorts?: AesMidasSort[] | null;
302
+ pagination?: AesMidasPagination;
261
303
  }
262
304
  export interface AesMidasBondReformat {
263
305
  symbol?: string | null;
@@ -270,7 +312,6 @@ export interface AesMidasBondReformat {
270
312
  company_name?: string | null;
271
313
  exchange?: string | null;
272
314
  market_description?: string | null;
273
- issue_market?: string | null;
274
315
  country?: string | null;
275
316
  time_zone?: string | null;
276
317
  /** @format double */
@@ -445,11 +486,6 @@ export interface AesMidasBondReformat {
445
486
  issue_minimum_denomination?: number | null;
446
487
  puttable?: boolean | null;
447
488
  }
448
- export interface AesMidasBondWholeApex {
449
- basic?: AesMidasBond;
450
- mark?: AesMidasBondMarksApex;
451
- quote?: AesMidasBondQuotesApex;
452
- }
453
489
  export interface AesMidasCandelstick {
454
490
  /** @format double */
455
491
  open?: number;
@@ -460,14 +496,6 @@ export interface AesMidasCandelstick {
460
496
  /** @format double */
461
497
  close?: number;
462
498
  }
463
- export interface AesMidasChangePasswordModel {
464
- /** @minLength 1 */
465
- user_id: string;
466
- /** @minLength 1 */
467
- old_password: string;
468
- /** @minLength 1 */
469
- new_password: string;
470
- }
471
499
  export interface AesMidasChartBar {
472
500
  time?: string | null;
473
501
  /** @format double */
@@ -519,6 +547,17 @@ export interface AesMidasDataSource {
519
547
  position_bit?: number;
520
548
  description?: string | null;
521
549
  }
550
+ export interface AesMidasDataSourceResponsewithPagination {
551
+ /** @format int32 */
552
+ total_items?: number;
553
+ /** @format int32 */
554
+ total_pages?: number;
555
+ /** @format int32 */
556
+ current_pages?: number;
557
+ /** @format int32 */
558
+ page_size?: number;
559
+ data?: AesMidasDataSource[] | null;
560
+ }
522
561
  export interface AesMidasDataSourceTally {
523
562
  id?: string | null;
524
563
  user?: AesMidasApplicationUser;
@@ -588,14 +627,22 @@ export interface AesMidasEntitlementFile {
588
627
  file_name?: string | null;
589
628
  /** @minLength 1 */
590
629
  mime_type: string;
591
- /**
592
- * @format byte
593
- * @maxLength 16777215
594
- */
630
+ /** @format byte */
595
631
  content: string;
596
632
  /** @format date-time */
597
633
  create_date_time?: string;
598
634
  }
635
+ export interface AesMidasEntitlementResponsewithPagination {
636
+ /** @format int32 */
637
+ total_items?: number;
638
+ /** @format int32 */
639
+ total_pages?: number;
640
+ /** @format int32 */
641
+ current_pages?: number;
642
+ /** @format int32 */
643
+ page_size?: number;
644
+ data?: AesMidasEntitlement[] | null;
645
+ }
599
646
  export interface AesMidasEntitlementBody {
600
647
  entitlement: AesMidasEntitlement;
601
648
  use_same_file?: boolean;
@@ -747,6 +794,39 @@ export interface AesMidasFirmEntitlementHistory {
747
794
  action_time?: string;
748
795
  version?: string | null;
749
796
  }
797
+ export interface AesMidasFirmEntitlementHistoryResponsewithPagination {
798
+ /** @format int32 */
799
+ total_items?: number;
800
+ /** @format int32 */
801
+ total_pages?: number;
802
+ /** @format int32 */
803
+ current_pages?: number;
804
+ /** @format int32 */
805
+ page_size?: number;
806
+ data?: AesMidasFirmEntitlementHistory[] | null;
807
+ }
808
+ export interface AesMidasFirmEntitlementResponsewithPagination {
809
+ /** @format int32 */
810
+ total_items?: number;
811
+ /** @format int32 */
812
+ total_pages?: number;
813
+ /** @format int32 */
814
+ current_pages?: number;
815
+ /** @format int32 */
816
+ page_size?: number;
817
+ data?: AesMidasFirmEntitlement[] | null;
818
+ }
819
+ export interface AesMidasFirmResponsewithPagination {
820
+ /** @format int32 */
821
+ total_items?: number;
822
+ /** @format int32 */
823
+ total_pages?: number;
824
+ /** @format int32 */
825
+ current_pages?: number;
826
+ /** @format int32 */
827
+ page_size?: number;
828
+ data?: AesMidasFirm[] | null;
829
+ }
750
830
  export interface AesMidasFirmDefaultDataSetting {
751
831
  firm_id?: string | null;
752
832
  /** @format int32 */
@@ -894,14 +974,6 @@ export interface AesMidasFundWebQuote {
894
974
  one_year_change_percent?: number;
895
975
  cusip?: string | null;
896
976
  }
897
- export interface AesMidasHistoricalBondChartApex {
898
- /** @format date-time */
899
- timestamp?: string;
900
- /** @format double */
901
- price?: number;
902
- /** @format double */
903
- yield_to_worst?: number;
904
- }
905
977
  export interface AesMidasICEEOD {
906
978
  symbol?: string | null;
907
979
  /** @format double */
@@ -1052,7 +1124,6 @@ export interface AesMidasLevel1Reformat {
1052
1124
  company_name?: string | null;
1053
1125
  exchange?: string | null;
1054
1126
  market_description?: string | null;
1055
- issue_market?: string | null;
1056
1127
  country?: string | null;
1057
1128
  time_zone?: string | null;
1058
1129
  /** @format double */
@@ -1177,12 +1248,6 @@ export interface AesMidasLevel1Reformat {
1177
1248
  base_currency?: string | null;
1178
1249
  fx?: boolean;
1179
1250
  }
1180
- export interface AesMidasLoginModel {
1181
- /** @minLength 1 */
1182
- user_name: string;
1183
- /** @minLength 1 */
1184
- password: string;
1185
- }
1186
1251
  export interface AesMidasMinuteChart {
1187
1252
  symbol?: string | null;
1188
1253
  /** @format date-time */
@@ -1216,18 +1281,6 @@ export interface AesMidasMinuteChartReformat {
1216
1281
  sma?: AesMidasRsiSpan[] | null;
1217
1282
  ema?: AesMidasRsiSpan[] | null;
1218
1283
  }
1219
- export interface AesMidasModifyEmailModel {
1220
- /** @minLength 1 */
1221
- user_id: string;
1222
- /** @minLength 1 */
1223
- email: string;
1224
- }
1225
- export interface AesMidasModifyPhoneNumberModel {
1226
- /** @minLength 1 */
1227
- user_id: string;
1228
- /** @minLength 1 */
1229
- phone_number: string;
1230
- }
1231
1284
  export interface AesMidasMutualFund {
1232
1285
  symbol?: string | null;
1233
1286
  company_name?: string | null;
@@ -1371,11 +1424,11 @@ export interface AesMidasPermission {
1371
1424
  /** @format int32 */
1372
1425
  num_query_per_sec: number;
1373
1426
  /** @format int32 */
1374
- num_query_per_min: number;
1375
- /** @format int32 */
1376
- size_data_per_min: number;
1427
+ size_data_per_sec: number;
1377
1428
  /** @minLength 1 */
1378
1429
  allow_ip: string;
1430
+ level1: boolean;
1431
+ level2: boolean;
1379
1432
  }
1380
1433
  export interface AesMidasQueryLog {
1381
1434
  id?: string | null;
@@ -1399,6 +1452,28 @@ export interface AesMidasQueryLogReport {
1399
1452
  platform?: string | null;
1400
1453
  action?: string | null;
1401
1454
  }
1455
+ export interface AesMidasQueryLogReportResponsewithPagination {
1456
+ /** @format int32 */
1457
+ total_items?: number;
1458
+ /** @format int32 */
1459
+ total_pages?: number;
1460
+ /** @format int32 */
1461
+ current_pages?: number;
1462
+ /** @format int32 */
1463
+ page_size?: number;
1464
+ data?: AesMidasQueryLogReport[] | null;
1465
+ }
1466
+ export interface AesMidasQueryLogResponsewithPagination {
1467
+ /** @format int32 */
1468
+ total_items?: number;
1469
+ /** @format int32 */
1470
+ total_pages?: number;
1471
+ /** @format int32 */
1472
+ current_pages?: number;
1473
+ /** @format int32 */
1474
+ page_size?: number;
1475
+ data?: AesMidasQueryLog[] | null;
1476
+ }
1402
1477
  export interface AesMidasQueryPostBody {
1403
1478
  pagination?: AesMidasPagination;
1404
1479
  sorts?: AesMidasSort[] | null;
@@ -1513,17 +1588,6 @@ export interface AesMidasRegionQuote {
1513
1588
  ask_time?: string | null;
1514
1589
  data_source?: string | null;
1515
1590
  }
1516
- export interface AesMidasRegisterModel {
1517
- /** @minLength 1 */
1518
- user_name: string;
1519
- /** @minLength 1 */
1520
- email: string;
1521
- /** @minLength 1 */
1522
- phone_number: string;
1523
- /** @minLength 1 */
1524
- password: string;
1525
- firm_id?: string | null;
1526
- }
1527
1591
  export interface AesMidasRsiSpan {
1528
1592
  /** @format int32 */
1529
1593
  span?: number;
@@ -1791,6 +1855,18 @@ export interface AesMidasUMAB2BUser {
1791
1855
  roles?: AesMidasUMARole[] | null;
1792
1856
  small_avatar_url?: string | null;
1793
1857
  theme?: string | null;
1858
+ status?: string | null;
1859
+ }
1860
+ export interface AesMidasUMAB2BUserResponsewithPagination {
1861
+ /** @format int32 */
1862
+ total_items?: number;
1863
+ /** @format int32 */
1864
+ total_pages?: number;
1865
+ /** @format int32 */
1866
+ current_pages?: number;
1867
+ /** @format int32 */
1868
+ page_size?: number;
1869
+ data?: AesMidasUMAB2BUser[] | null;
1794
1870
  }
1795
1871
  export interface AesMidasUMAB2CUser {
1796
1872
  allow_feedback?: boolean;
@@ -1819,6 +1895,18 @@ export interface AesMidasUMAB2CUser {
1819
1895
  microservices?: AesMidasUMAUserMicroservice[] | null;
1820
1896
  permissions?: AesMidasUMAPermission[] | null;
1821
1897
  roles?: AesMidasUMARole[] | null;
1898
+ status?: string | null;
1899
+ }
1900
+ export interface AesMidasUMAB2CUserResponsewithPagination {
1901
+ /** @format int32 */
1902
+ total_items?: number;
1903
+ /** @format int32 */
1904
+ total_pages?: number;
1905
+ /** @format int32 */
1906
+ current_pages?: number;
1907
+ /** @format int32 */
1908
+ page_size?: number;
1909
+ data?: AesMidasUMAB2CUser[] | null;
1822
1910
  }
1823
1911
  export interface AesMidasUMABranch {
1824
1912
  code?: string | null;
@@ -1851,6 +1939,17 @@ export interface AesMidasUMAFirm {
1851
1939
  updated_at?: string | null;
1852
1940
  twilio_creds?: AesMidasUMATwilioCreds;
1853
1941
  }
1942
+ export interface AesMidasUMAFirmResponsewithPagination {
1943
+ /** @format int32 */
1944
+ total_items?: number;
1945
+ /** @format int32 */
1946
+ total_pages?: number;
1947
+ /** @format int32 */
1948
+ current_pages?: number;
1949
+ /** @format int32 */
1950
+ page_size?: number;
1951
+ data?: AesMidasUMAFirm[] | null;
1952
+ }
1854
1953
  export interface AesMidasUMAFirmBasic {
1855
1954
  /** @format int32 */
1856
1955
  admins_count?: number;
@@ -2085,6 +2184,28 @@ export interface AesMidasUserEntitlementHistory {
2085
2184
  status?: number;
2086
2185
  file_id?: string | null;
2087
2186
  }
2187
+ export interface AesMidasUserEntitlementHistoryResponsewithPagination {
2188
+ /** @format int32 */
2189
+ total_items?: number;
2190
+ /** @format int32 */
2191
+ total_pages?: number;
2192
+ /** @format int32 */
2193
+ current_pages?: number;
2194
+ /** @format int32 */
2195
+ page_size?: number;
2196
+ data?: AesMidasUserEntitlementHistory[] | null;
2197
+ }
2198
+ export interface AesMidasUserEntitlementResponsewithPagination {
2199
+ /** @format int32 */
2200
+ total_items?: number;
2201
+ /** @format int32 */
2202
+ total_pages?: number;
2203
+ /** @format int32 */
2204
+ current_pages?: number;
2205
+ /** @format int32 */
2206
+ page_size?: number;
2207
+ data?: AesMidasUserEntitlement[] | null;
2208
+ }
2088
2209
  export interface AesMidasUserInformation {
2089
2210
  /** @minLength 1 */
2090
2211
  id: string;
@@ -2137,12 +2258,12 @@ export class DataSource<HandleError extends boolean = boolean> {
2137
2258
  /**
2138
2259
  * @description All parameters are optional
2139
2260
  * @tags DataSource
2140
- * @name GetDataSourceList
2141
- * @summary Query all DataSources in the whole system with optional filters - All users - available in Microservice, POST with pagination and sort
2142
- * @request GET:/api/datasource/data-source-list
2261
+ * @name PostDataSourceList
2262
+ * @summary Query all DataSources in the whole system with optional filters - All users
2263
+ * @request POST:/api/datasource/data-source-list
2143
2264
  * @secure
2144
2265
  */
2145
- getDataSourceList(query?: {
2266
+ postDataSourceList(data: AesMidasQueryPostBody, query?: {
2146
2267
  /** Datasource name */
2147
2268
  name?: string;
2148
2269
  /** entitlement name */
@@ -2154,22 +2275,22 @@ export class DataSource<HandleError extends boolean = boolean> {
2154
2275
  inuse?: number;
2155
2276
  /** category */
2156
2277
  category?: string;
2157
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource[], HandleError>>;
2278
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
2158
2279
  /**
2159
2280
  * @tags DataSource
2160
2281
  * @name GetDataSource
2161
- * @summary Query a specific DataSource by unique DataSource Name - All users - available in Microservice
2282
+ * @summary Query a specific DataSource by unique DataSource Name
2162
2283
  * @request GET:/api/datasource/data-source
2163
2284
  * @secure
2164
2285
  */
2165
- getDataSource(query?: {
2166
- name?: string;
2286
+ getDataSource(query: {
2287
+ name: string;
2167
2288
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
2168
2289
  /**
2169
2290
  * @description Create a new DataSource with/without an existing Entitlement
2170
2291
  * @tags DataSource
2171
2292
  * @name PostDataSource
2172
- * @summary Create a new DataSource - Super admin - available in Microservice
2293
+ * @summary Create a new DataSource
2173
2294
  * @request POST:/api/datasource/data-source
2174
2295
  * @secure
2175
2296
  */
@@ -2178,28 +2299,27 @@ export class DataSource<HandleError extends boolean = boolean> {
2178
2299
  * @description If modification is Entitlement related, server will unsign old entitlement in firms and users
2179
2300
  * @tags DataSource
2180
2301
  * @name PutDataSource
2181
- * @summary Update an existing DataSource - Super admin - available in Microservice
2302
+ * @summary Update an existing DataSource
2182
2303
  * @request PUT:/api/datasource/data-source
2183
2304
  * @secure
2184
2305
  */
2185
- putDataSource(data: AesMidasDataSource, query?: {
2186
- name?: string;
2187
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2306
+ putDataSource(query: {
2307
+ name: string;
2308
+ }, data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2188
2309
  /**
2189
2310
  * @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
2190
2311
  * @tags DataSource
2191
2312
  * @name DeleteDataSource
2192
- * @summary Delete an existing DataSource - Super admin - available in Microservice
2313
+ * @summary Delete an existing DataSource
2193
2314
  * @request DELETE:/api/datasource/data-source
2194
2315
  * @secure
2195
2316
  */
2196
- deleteDataSource(query?: {
2197
- name?: string;
2317
+ deleteDataSource(query: {
2318
+ name: string;
2198
2319
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2199
2320
  /**
2200
2321
  * @tags DataSource
2201
2322
  * @name GetDataSourceBitMapping
2202
- * @summary Get All DataSource Bit Mappings - All users - available in Microservice
2203
2323
  * @request GET:/api/datasource/data-source-bit-mapping
2204
2324
  * @secure
2205
2325
  */
@@ -2207,7 +2327,7 @@ export class DataSource<HandleError extends boolean = boolean> {
2207
2327
  /**
2208
2328
  * @tags DataSource
2209
2329
  * @name GetDataSourceTallyCount
2210
- * @summary For ViewTrade admin to generate data source tally report - Super admin - available in Microservice
2330
+ * @summary For ViewTrade admin to generate data source tally report - Super admin
2211
2331
  * @request GET:/api/datasource/data-source-tally-count
2212
2332
  * @secure
2213
2333
  */
@@ -2215,48 +2335,46 @@ export class DataSource<HandleError extends boolean = boolean> {
2215
2335
  /**
2216
2336
  * @tags DataSource
2217
2337
  * @name PostDataSourceTallyReport
2218
- * @summary For ViewTrade admin to generate data source tally report with Pagination and Sort - Super admin - available in Microservice
2338
+ * @summary For ViewTrade admin to generate data source tally report
2219
2339
  * @request POST:/api/datasource/data-source-tally-report
2220
2340
  * @secure
2221
2341
  */
2222
- postDataSourceTallyReport(data: AesMidasQueryPostBody, query?: {
2223
- data_source?: string;
2224
- firm_id?: string;
2225
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2342
+ postDataSourceTallyReport(query: {
2343
+ data_source: string;
2344
+ firm_id: string;
2345
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2226
2346
  }
2227
2347
  export class Entitlement<HandleError extends boolean = boolean> {
2228
2348
  protected readonly apiClient: JwtClient<HandleError>;
2229
2349
  constructor(apiClient: JwtClient<HandleError>);
2230
2350
  /**
2231
- * @description bitwise in Datasource: 1 UTP, 2 CTA, 3 CBOE1, 4 OPRA, 5 DJI, 6 SP500, 7 CAN, 8 SNAPSHOT
2232
2351
  * @tags Entitlement
2233
- * @name GetEntitlementList
2234
- * @summary Query all available Entitlements(agreements) in the system - All users - available in Microservice, POST with pagination and sort
2235
- * @request GET:/api/entitlement/entitlement-list
2352
+ * @name PostEntitlementList
2353
+ * @summary Query all available Entitlements(agreements) in the system
2354
+ * @request POST:/api/entitlement/entitlement-list
2236
2355
  * @secure
2237
2356
  */
2238
- getEntitlementList(query?: {
2357
+ postEntitlementList(data: AesMidasQueryPostBody, query?: {
2239
2358
  /**
2240
2359
  * entielement name, for example 'UTP'. Optional
2241
2360
  * @default ""
2242
2361
  */
2243
2362
  name?: string;
2244
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement[], HandleError>>;
2363
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementResponsewithPagination, HandleError>>;
2245
2364
  /**
2246
2365
  * @tags Entitlement
2247
2366
  * @name GetEntitlement
2248
- * @summary Query a specific Entitlement by unique EntitlementName - All users - available in Microservice
2367
+ * @summary Query a specific Entitlement by unique EntitlementName
2249
2368
  * @request GET:/api/entitlement/entitlement
2250
2369
  * @secure
2251
2370
  */
2252
- getEntitlement(query?: {
2253
- name?: string;
2371
+ getEntitlement(query: {
2372
+ name: string;
2254
2373
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement, HandleError>>;
2255
2374
  /**
2256
- * @description Files can be uploaded along with entitlement. File ids can be left blank, server will generate and update file ids to the entitlement.
2257
2375
  * @tags Entitlement
2258
2376
  * @name PostEntitlement
2259
- * @summary Create a new Entitlement(Agreement) - Super admin - available in Microservice
2377
+ * @summary Create a new Entitlement(Agreement)
2260
2378
  * @request POST:/api/entitlement/entitlement
2261
2379
  * @secure
2262
2380
  */
@@ -2264,74 +2382,74 @@ export class Entitlement<HandleError extends boolean = boolean> {
2264
2382
  /**
2265
2383
  * @tags Entitlement
2266
2384
  * @name PutEntitlement
2267
- * @summary Update an existing Entitlement - Super admin - available in Microservice
2385
+ * @summary Update an existing Entitlement
2268
2386
  * @request PUT:/api/entitlement/entitlement
2269
2387
  * @secure
2270
2388
  */
2271
- putEntitlement(data: AesMidasEntitlementBody, query?: {
2272
- name?: string;
2273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2389
+ putEntitlement(query: {
2390
+ name: string;
2391
+ }, data: AesMidasEntitlementBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2274
2392
  /**
2275
2393
  * @description If an entitlement is being used in a datasource, it cannot be deleted.
2276
2394
  * @tags Entitlement
2277
2395
  * @name DeleteEntitlement
2278
- * @summary Delete an existing Entitlement - Super admin - available in Microservice
2396
+ * @summary Delete an existing Entitlement
2279
2397
  * @request DELETE:/api/entitlement/entitlement
2280
2398
  * @secure
2281
2399
  */
2282
- deleteEntitlement(query?: {
2283
- name?: string;
2400
+ deleteEntitlement(query: {
2401
+ name: string;
2284
2402
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2285
2403
  /**
2286
2404
  * @tags Entitlement
2287
2405
  * @name GetUserEntitlement
2288
- * @summary Query a specific UserEntitlement by userid and eneitlement name - End user itself, or firm manager, or super admin - available in Microservice
2406
+ * @summary Query a specific UserEntitlement by userid and eneitlement name
2289
2407
  * @request GET:/api/entitlement/user-entitlement
2290
2408
  * @secure
2291
2409
  */
2292
- getUserEntitlement(query?: {
2293
- user_id?: string;
2294
- entitlement?: string;
2410
+ getUserEntitlement(query: {
2411
+ user_id: string;
2412
+ entitlement: string;
2295
2413
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement, HandleError>>;
2296
2414
  /**
2297
2415
  * @tags Entitlement
2298
- * @name GetUserEntitlementList
2299
- * @summary Query all UserEntitlements for a specific user - End user itself, or firm manager, or super admin - available in Microservice, POST with pagination and sort
2300
- * @request GET:/api/entitlement/user-entitlement-list
2416
+ * @name PostUserEntitlementList
2417
+ * @summary Query all UserEntitlements for a specific user
2418
+ * @request POST:/api/entitlement/user-entitlement-list
2301
2419
  * @secure
2302
2420
  */
2303
- getUserEntitlementList(query?: {
2421
+ postUserEntitlementList(query: {
2304
2422
  /** user_id, must fill out */
2305
- user_id?: string;
2423
+ user_id: string;
2306
2424
  /** entitlement name, optional */
2307
2425
  entitlement?: string;
2308
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
2426
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementResponsewithPagination, HandleError>>;
2309
2427
  /**
2310
2428
  * @tags Entitlement
2311
- * @name GetEntitlementUserList
2312
- * @summary Query all UserEntitlements for a specific Entitlement - Super admin - available in Microservice, POST with pagination and sort
2313
- * @request GET:/api/entitlement/entitlement-user-list
2429
+ * @name PostEntitlementUserList
2430
+ * @summary Query all UserEntitlements for a specific Entitlement
2431
+ * @request POST:/api/entitlement/entitlement-user-list
2314
2432
  * @secure
2315
2433
  */
2316
- getEntitlementUserList(query?: {
2317
- entitlement?: string;
2318
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
2434
+ postEntitlementUserList(query: {
2435
+ entitlement: string;
2436
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementResponsewithPagination, HandleError>>;
2319
2437
  /**
2320
2438
  * @tags Entitlement
2321
- * @name GetUserEntitlementHistory
2322
- * @summary Query history for a UserEntitlement - Super admin - available in Microservice, POST with pagination and sort
2323
- * @request GET:/api/entitlement/user-entitlement-history
2439
+ * @name PostUserEntitlementHistory
2440
+ * @summary Query history for a UserEntitlement
2441
+ * @request POST:/api/entitlement/user-entitlement-history
2324
2442
  * @secure
2325
2443
  */
2326
- getUserEntitlementHistory(query?: {
2327
- user_id?: string;
2328
- entitlement?: string;
2329
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementHistory[], HandleError>>;
2444
+ postUserEntitlementHistory(query: {
2445
+ user_id: string;
2446
+ entitlement: string;
2447
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementHistoryResponsewithPagination, HandleError>>;
2330
2448
  /**
2331
2449
  * @description Create a new UserEntitlement if not existing previously. Update UserEntitlement if already exists.
2332
2450
  * @tags Entitlement
2333
2451
  * @name PutSignEntitlement
2334
- * @summary Sign a UserEntitlement - All users - available in Microservice
2452
+ * @summary Sign a UserEntitlement
2335
2453
  * @request PUT:/api/entitlement/sign-entitlement
2336
2454
  * @secure
2337
2455
  */
@@ -2339,30 +2457,30 @@ export class Entitlement<HandleError extends boolean = boolean> {
2339
2457
  /**
2340
2458
  * @tags Entitlement
2341
2459
  * @name PutUnsignEntitlement
2342
- * @summary Unsign a UserEntitlement - End user itself, or firm manager, or super admin - available in Microservice
2460
+ * @summary Unsign a UserEntitlement
2343
2461
  * @request PUT:/api/entitlement/unsign-entitlement
2344
2462
  * @secure
2345
2463
  */
2346
- putUnsignEntitlement(query?: {
2347
- user_id?: string;
2348
- entitlement?: string;
2464
+ putUnsignEntitlement(query: {
2465
+ user_id: string;
2466
+ entitlement: string;
2349
2467
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2350
2468
  /**
2351
2469
  * @tags Entitlement
2352
2470
  * @name GetContractsCount
2353
- * @summary For ViewTrade admin to Get contract counts for a specific firm and entitlement - Super admin - available in Microservice
2471
+ * @summary For ViewTrade admin to Get contract counts for a specific firm and entitlement - Super admin
2354
2472
  * @request GET:/api/entitlement/contracts-count
2355
2473
  * @secure
2356
2474
  */
2357
- getContractsCount(query?: {
2475
+ getContractsCount(query: {
2358
2476
  /** Three letter month name, for example 'Jan' */
2359
- from_month?: string;
2477
+ from_month: string;
2360
2478
  /** for example '2024' */
2361
- from_year?: string;
2479
+ from_year: string;
2362
2480
  /** Three letter month name, for example 'Jan' */
2363
- to_month?: string;
2481
+ to_month: string;
2364
2482
  /** for example '2024' */
2365
- to_year?: string;
2483
+ to_year: string;
2366
2484
  /** true/false, optional */
2367
2485
  professional?: boolean;
2368
2486
  /** true/false, optional */
@@ -2373,41 +2491,41 @@ export class Entitlement<HandleError extends boolean = boolean> {
2373
2491
  /**
2374
2492
  * @tags Entitlement
2375
2493
  * @name PostContractsReport
2376
- * @summary For ViewTrade admin to generate contract counts report for a specific firm and entitlement with paginition and sort - Super admin - available in Microservice
2494
+ * @summary For ViewTrade admin to generate contract counts report
2377
2495
  * @request POST:/api/entitlement/contracts-report
2378
2496
  * @secure
2379
2497
  */
2380
- postContractsReport(data: AesMidasQueryPostBody, query?: {
2381
- firm_id?: string;
2382
- entitlement_name?: string;
2498
+ postContractsReport(query: {
2499
+ firm_id: string;
2500
+ entitlement_name: string;
2383
2501
  /** Three letter month name, for example 'Jan' */
2384
- from_month?: string;
2385
- from_year?: string;
2502
+ from_month: string;
2503
+ from_year: string;
2386
2504
  /** Three letter month name, for example 'Jan' */
2387
- to_month?: string;
2388
- to_year?: string;
2505
+ to_month: string;
2506
+ to_year: string;
2389
2507
  /** true/false, optional */
2390
2508
  professional?: boolean;
2391
2509
  /** true/false, optional */
2392
2510
  admin_or_manager?: boolean;
2393
2511
  /** true/false, optional */
2394
2512
  vendor_of_record?: boolean;
2395
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractRecordsResponsewithPagination, HandleError>>;
2513
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractRecordsResponsewithPagination, HandleError>>;
2396
2514
  /**
2397
2515
  * @tags Entitlement
2398
2516
  * @name GetFirmEntitlement
2399
- * @summary Query a specific FirmEntitlement - Firm manager, or super admin - available in Microservice
2517
+ * @summary Query a specific FirmEntitlement
2400
2518
  * @request GET:/api/entitlement/firm-entitlement
2401
2519
  * @secure
2402
2520
  */
2403
- getFirmEntitlement(query?: {
2404
- firm_id?: string;
2405
- entitlement?: string;
2521
+ getFirmEntitlement(query: {
2522
+ firm_id: string;
2523
+ entitlement: string;
2406
2524
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement, HandleError>>;
2407
2525
  /**
2408
2526
  * @tags Entitlement
2409
2527
  * @name PostFirmEntitlement
2410
- * @summary Create a new FirmEntitlement - Super admin - available in Microservice
2528
+ * @summary Create a new FirmEntitlement
2411
2529
  * @request POST:/api/entitlement/firm-entitlement
2412
2530
  * @secure
2413
2531
  */
@@ -2416,60 +2534,58 @@ export class Entitlement<HandleError extends boolean = boolean> {
2416
2534
  * @description Firm must have relevant data setting if need to active a FirmEntitlement./n!Caution! If de-active a FirmEntitlement, it will unsign all UserEntitlements in this firm for the relevant entitlement.
2417
2535
  * @tags Entitlement
2418
2536
  * @name PutFirmEntitlement
2419
- * @summary Upadte an existing FirmEntitlement - Super admin - available in Microservice
2537
+ * @summary Upadte an existing FirmEntitlement
2420
2538
  * @request PUT:/api/entitlement/firm-entitlement
2421
2539
  * @secure
2422
2540
  */
2423
- putFirmEntitlement(data: AesMidasFirmEntitlement, query?: {
2424
- firm_id?: string;
2425
- entitlement?: string;
2426
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2541
+ putFirmEntitlement(query: {
2542
+ firm_id: string;
2543
+ entitlement: string;
2544
+ }, data: AesMidasFirmEntitlement, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2427
2545
  /**
2428
2546
  * @description !Caution! This action will unsign all UserEntitlements in this firm for the relevant entitlement.
2429
2547
  * @tags Entitlement
2430
2548
  * @name DeleteFirmEntitlement
2431
- * @summary Delete an existing FirmEntitlement - Super admin - available in Microservice
2549
+ * @summary Delete an existing FirmEntitlement
2432
2550
  * @request DELETE:/api/entitlement/firm-entitlement
2433
2551
  * @secure
2434
2552
  */
2435
- deleteFirmEntitlement(query?: {
2436
- firm_id?: string;
2437
- entitlement?: string;
2553
+ deleteFirmEntitlement(query: {
2554
+ firm_id: string;
2555
+ entitlement: string;
2438
2556
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2439
2557
  /**
2440
2558
  * @tags Entitlement
2441
- * @name GetFirmEntitlementList
2442
- * @summary Query all FirmEntitlements for a specific firm - Firm manager, or super admin - available in Microservice, POST with pagination and sort
2443
- * @request GET:/api/entitlement/firm-entitlement-list
2559
+ * @name PostFirmEntitlementList
2560
+ * @summary Query all FirmEntitlements for a specific firm
2561
+ * @request POST:/api/entitlement/firm-entitlement-list
2444
2562
  * @secure
2445
2563
  */
2446
- getFirmEntitlementList(query?: {
2447
- /** firm id, must fill this parameter */
2448
- firm_id?: string;
2449
- /** entitlement name, option filter parameter */
2564
+ postFirmEntitlementList(query: {
2565
+ firm_id: string;
2450
2566
  entitlement_name?: string;
2451
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
2567
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementResponsewithPagination, HandleError>>;
2452
2568
  /**
2453
2569
  * @tags Entitlement
2454
- * @name GetEntitlementFirmList
2455
- * @summary Query all FirmEntitlements for a specific Entitlement - Super admin - available in Microservice, POST with pagination and sort
2456
- * @request GET:/api/entitlement/entitlement-firm-list
2570
+ * @name PostEntitlementFirmList
2571
+ * @summary Query all FirmEntitlements for a specific Entitlement
2572
+ * @request POST:/api/entitlement/entitlement-firm-list
2457
2573
  * @secure
2458
2574
  */
2459
- getEntitlementFirmList(query?: {
2460
- entitlement?: string;
2461
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
2575
+ postEntitlementFirmList(query: {
2576
+ entitlement: string;
2577
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementResponsewithPagination, HandleError>>;
2462
2578
  /**
2463
2579
  * @tags Entitlement
2464
- * @name GetFirmEntitlementHistory
2465
- * @summary Query history of a specific FirmEntitlement - Super admin - available in Microservice, POST with pagination and sort
2466
- * @request GET:/api/entitlement/firm-entitlement-history
2580
+ * @name PostFirmEntitlementHistory
2581
+ * @summary Query history of a specific FirmEntitlement
2582
+ * @request POST:/api/entitlement/firm-entitlement-history
2467
2583
  * @secure
2468
2584
  */
2469
- getFirmEntitlementHistory(query?: {
2470
- firm_id?: string;
2471
- entitlement?: string;
2472
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistory[], HandleError>>;
2585
+ postFirmEntitlementHistory(query: {
2586
+ firm_id: string;
2587
+ entitlement: string;
2588
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
2473
2589
  }
2474
2590
  export class File<HandleError extends boolean = boolean> {
2475
2591
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2477,7 +2593,7 @@ export class File<HandleError extends boolean = boolean> {
2477
2593
  /**
2478
2594
  * @tags File
2479
2595
  * @name PostUpload
2480
- * @summary upload file - All users - available in Microservice
2596
+ * @summary upload file
2481
2597
  * @request POST:/api/file/upload
2482
2598
  * @secure
2483
2599
  */
@@ -2485,46 +2601,44 @@ export class File<HandleError extends boolean = boolean> {
2485
2601
  /**
2486
2602
  * @tags File
2487
2603
  * @name GetDownload
2488
- * @summary download file by file id - All users - available in Microservice
2604
+ * @summary download file by file id
2489
2605
  * @request GET:/api/file/download
2490
2606
  * @secure
2491
2607
  */
2492
- getDownload(query?: {
2493
- file_id?: string;
2608
+ getDownload(query: {
2609
+ file_id: string;
2494
2610
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
2495
2611
  }
2496
2612
  export class Firm<HandleError extends boolean = boolean> {
2497
2613
  protected readonly apiClient: JwtClient<HandleError>;
2498
2614
  constructor(apiClient: JwtClient<HandleError>);
2499
2615
  /**
2500
- * @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
2501
- * @tags Firm
2502
- * @name GetFirmList
2503
- * @summary Query all Firms in the system - All users - available in Microservice, POST with pagination and sort
2504
- For Microservice: only return 'UMA' source firms
2505
- * @request GET:/api/firm/firm-list
2506
- * @secure
2507
- */
2508
- getFirmList(query?: {
2616
+ * @tags Firm
2617
+ * @name PostFirmList
2618
+ * @summary Query all Firms in the system
2619
+ * @request POST:/api/firm/firm-list
2620
+ * @secure
2621
+ */
2622
+ postFirmList(data: AesMidasQueryPostBody, query?: {
2509
2623
  /** firm_id, optional */
2510
2624
  firm_id?: string;
2511
2625
  /** firm name, fuzzy search, optional */
2512
2626
  name?: string;
2513
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm[], HandleError>>;
2627
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
2514
2628
  /**
2515
2629
  * @tags Firm
2516
2630
  * @name GetFirm
2517
- * @summary Query a specific Firm by firmid(short name) - All users - available in Microservice
2631
+ * @summary Query a specific Firm by firmid(short name)
2518
2632
  * @request GET:/api/firm/firm
2519
2633
  * @secure
2520
2634
  */
2521
- getFirm(query?: {
2522
- firm_id?: string;
2635
+ getFirm(query: {
2636
+ firm_id: string;
2523
2637
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
2524
2638
  /**
2525
2639
  * @tags Firm
2526
2640
  * @name PostFirm
2527
- * @summary Create a new Firm - Super admin - available in Microservice
2641
+ * @summary Create a new Firm
2528
2642
  * @request POST:/api/firm/firm
2529
2643
  * @secure
2530
2644
  */
@@ -2533,36 +2647,36 @@ For Microservice: only return 'UMA' source firms
2533
2647
  * @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
2534
2648
  * @tags Firm
2535
2649
  * @name PutFirm
2536
- * @summary Update an existing Firm setting - Super admin - available in Microservice
2650
+ * @summary Update an existing Firm setting
2537
2651
  * @request PUT:/api/firm/firm
2538
2652
  * @secure
2539
2653
  */
2540
- putFirm(data: AesMidasFirm, query?: {
2541
- firm_id?: string;
2542
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2654
+ putFirm(query: {
2655
+ firm_id: string;
2656
+ }, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2543
2657
  /**
2544
2658
  * @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
2545
2659
  * @tags Firm
2546
2660
  * @name GetFirmDataAccess
2547
- * @summary Get which data sources that a firm can access - All users - available in Microservice
2661
+ * @summary Get which data sources that a firm can access
2548
2662
  * @request GET:/api/firm/firm-data-access
2549
2663
  * @secure
2550
2664
  */
2551
- getFirmDataAccess(query?: {
2552
- firm_id?: string;
2665
+ getFirmDataAccess(query: {
2666
+ firm_id: string;
2553
2667
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
2554
2668
  /**
2555
2669
  * @tags Firm
2556
- * @name GetUmaFirmList
2557
- * @summary Get all firms from UMA - Super admin - available in Microservice, POST with pagination and sort
2558
- * @request GET:/api/firm/uma-firm-list
2670
+ * @name PostUmaFirmList
2671
+ * @summary Get all firms from UMA - Super admin
2672
+ * @request POST:/api/firm/uma-firm-list
2559
2673
  * @secure
2560
2674
  */
2561
- getUmaFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
2675
+ postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
2562
2676
  /**
2563
2677
  * @tags Firm
2564
2678
  * @name GetSystemFirmDefaultData
2565
- * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise - All users - available in Microservice
2679
+ * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
2566
2680
  * @request GET:/api/firm/system-firm-default-data
2567
2681
  * @secure
2568
2682
  */
@@ -2570,7 +2684,7 @@ For Microservice: only return 'UMA' source firms
2570
2684
  /**
2571
2685
  * @tags Firm
2572
2686
  * @name PutSystemFirmDefaultData
2573
- * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise - Super admin - available in Microservice
2687
+ * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
2574
2688
  * @request PUT:/api/firm/system-firm-default-data
2575
2689
  * @secure
2576
2690
  */
@@ -2578,35 +2692,35 @@ For Microservice: only return 'UMA' source firms
2578
2692
  /**
2579
2693
  * @tags Firm
2580
2694
  * @name GetFirmDefaultData
2581
- * @summary Query a specific Firm Default Data Setting by firmid(short name) - All users - available in Microservice
2695
+ * @summary Query a specific Firm Default Data Setting by firmid(short name)
2582
2696
  * @request GET:/api/firm/firm-default-data
2583
2697
  * @secure
2584
2698
  */
2585
- getFirmDefaultData(query?: {
2586
- firm_id?: string;
2699
+ getFirmDefaultData(query: {
2700
+ firm_id: string;
2587
2701
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
2588
2702
  /**
2589
2703
  * @description New default data must within firm data access availability
2590
2704
  * @tags Firm
2591
2705
  * @name PostFirmDefaultData
2592
- * @summary Create Firm Default Data setting for a specific firm - Firm manager, or super admin - available in Microservice
2706
+ * @summary Create Firm Default Data setting for a specific firm
2593
2707
  * @request POST:/api/firm/firm-default-data
2594
2708
  * @secure
2595
2709
  */
2596
- postFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
2597
- firm_id?: string;
2598
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2710
+ postFirmDefaultData(query: {
2711
+ firm_id: string;
2712
+ }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2599
2713
  /**
2600
2714
  * @description New default data must within firm data access availability
2601
2715
  * @tags Firm
2602
2716
  * @name PutFirmDefaultData
2603
- * @summary Update an existing Firm Default Data setting - Firm manager, or super admin - available in Microservice
2717
+ * @summary Update an existing Firm Default Data setting
2604
2718
  * @request PUT:/api/firm/firm-default-data
2605
2719
  * @secure
2606
2720
  */
2607
- putFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
2608
- firm_id?: string;
2609
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2721
+ putFirmDefaultData(query: {
2722
+ firm_id: string;
2723
+ }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2610
2724
  }
2611
2725
  export class FundWebQuote<HandleError extends boolean = boolean> {
2612
2726
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2614,17 +2728,15 @@ export class FundWebQuote<HandleError extends boolean = boolean> {
2614
2728
  /**
2615
2729
  * @tags FundWebQuote
2616
2730
  * @name GetFund
2617
- * @summary Get a specific fund data - Internal use only - available in Microservice
2618
2731
  * @request GET:/api/fund/fund
2619
2732
  * @secure
2620
2733
  */
2621
- getFund(query?: {
2622
- symbol?: string;
2734
+ getFund(query: {
2735
+ symbol: string;
2623
2736
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
2624
2737
  /**
2625
2738
  * @tags FundWebQuote
2626
2739
  * @name GetFundList
2627
- * @summary Get all availabe fund data - Internal use only - available in Microservice
2628
2740
  * @request GET:/api/fund/fund-list
2629
2741
  * @secure
2630
2742
  */
@@ -2636,95 +2748,87 @@ export class Log<HandleError extends boolean = boolean> {
2636
2748
  /**
2637
2749
  * @tags Log
2638
2750
  * @name GetDataQueryActionList
2639
- * @summary Query all data query action list in the system - Super admin - available in Microservice
2751
+ * @summary Query all data query action list in the system
2640
2752
  * @request GET:/api/log/data-query-action-list
2641
2753
  * @secure
2642
2754
  */
2643
2755
  getDataQueryActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
2644
2756
  /**
2645
2757
  * @tags Log
2646
- * @name GetDataQueryLogByAction
2647
- * @summary Query data query logs by a specific query and date range - Super admin - available in Microservice, POST with pagination and sort
2648
- * @request GET:/api/log/data-query-log-by-action
2758
+ * @name PostDataQueryLogByAction
2759
+ * @summary Query data query logs by a specific query and date range
2760
+ * @request POST:/api/log/data-query-log-by-action
2649
2761
  * @secure
2650
2762
  */
2651
- getDataQueryLogByAction(query?: {
2652
- action?: string;
2653
- 'start_date(UTC)'?: string;
2654
- 'end_date(UTC)'?: string;
2655
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLog[], HandleError>>;
2763
+ postDataQueryLogByAction(query: {
2764
+ action: string;
2765
+ 'start_date(UTC)': string;
2766
+ 'end_date(UTC)': string;
2767
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
2656
2768
  /**
2657
2769
  * @tags Log
2658
- * @name GetDataQueryLogByDataSource
2659
- * @summary Query data query logs by a specific data source and date range and return for report - Super admin - available in Microservice, POST with pagination and sort
2660
- * @request GET:/api/log/data-query-log-by-data-source
2770
+ * @name PostDataQueryLogByDataSource
2771
+ * @summary Query data query logs by a specific data source and date range and return for report
2772
+ * @request POST:/api/log/data-query-log-by-data-source
2661
2773
  * @secure
2662
2774
  */
2663
- getDataQueryLogByDataSource(query?: {
2664
- data_source?: string;
2665
- 'start_date(UTC)'?: string;
2666
- 'end_date(UTC)'?: string;
2667
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReport[], HandleError>>;
2775
+ postDataQueryLogByDataSource(query: {
2776
+ data_source: string;
2777
+ 'start_date(UTC)': string;
2778
+ 'end_date(UTC)': string;
2779
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
2668
2780
  /**
2669
2781
  * @tags Log
2670
2782
  * @name GetSnapshotCount
2671
- * @summary Query snapshot report counts - Super admin - available in Microservice
2783
+ * @summary Query snapshot report counts - Super admin
2672
2784
  * @request GET:/api/log/snapshot-count
2673
2785
  * @secure
2674
2786
  */
2675
- getSnapshotCount(query?: {
2676
- /** start date, format(yyyy-MM-dd) */
2677
- 'start_date(UTC)'?: string;
2678
- /** end date(will be count in), format(yyyy-MM-dd) */
2679
- 'end_date(UTC)'?: string;
2680
- /** optional, if null, will count all; if true, will only count queries in market hour; if false, will only count queries out of market hour */
2787
+ getSnapshotCount(query: {
2788
+ 'start_date(UTC)': string;
2789
+ 'end_date(UTC)': string;
2681
2790
  market_hour_only?: boolean;
2682
2791
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
2683
2792
  /**
2684
2793
  * @tags Log
2685
2794
  * @name PostSnapshotReport
2686
- * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin - available in Microservice
2795
+ * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin
2687
2796
  * @request POST:/api/log/snapshot-report
2688
2797
  * @secure
2689
2798
  */
2690
- postSnapshotReport(data: AesMidasQueryPostBody, query?: {
2691
- /** start date, format(yyyy-MM-dd) */
2692
- 'start_date(UTC)'?: string;
2693
- /** end date, format(yyyy-MM-dd) */
2694
- 'end_date(UTC)'?: string;
2695
- /** firm id */
2696
- firm_id?: string;
2697
- /** one letter that stands for exchange: A-AMEX,N-NYSE, Q-NSDQ,V-OTC, I-Index. */
2698
- exchange?: string;
2699
- /** optional, if null, will return records in whole day range; if true, will only return records in market hour; if false, will only return records out of market hour */
2799
+ postSnapshotReport(query: {
2800
+ 'start_date(UTC)': string;
2801
+ 'end_date(UTC)': string;
2802
+ firm_id: string;
2803
+ exchange: string;
2700
2804
  market_hour_only?: boolean;
2701
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
2805
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
2702
2806
  /**
2703
2807
  * @tags Log
2704
2808
  * @name GetModificationActionList
2705
- * @summary Query all modification actions list in the system - Super admin - available in Microservice
2809
+ * @summary Query all modification actions list in the system
2706
2810
  * @request GET:/api/log/modification-action-list
2707
2811
  * @secure
2708
2812
  */
2709
2813
  getModificationActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
2710
2814
  /**
2711
2815
  * @tags Log
2712
- * @name GetModificationLogByAction
2713
- * @summary Query login/out and modification actions logs by a specific action and date range - Super admin - available in Microservice, POST with pagination and sort
2714
- * @request GET:/api/log/modification-log-by-action
2816
+ * @name PostModificationLogByAction
2817
+ * @summary Query login/out and modification actions logs by a specific action and date range
2818
+ * @request POST:/api/log/modification-log-by-action
2715
2819
  * @secure
2716
2820
  */
2717
- getModificationLogByAction(query?: {
2821
+ postModificationLogByAction(query: {
2718
2822
  /** To get available actions list, please call api/Log/modification-action-list. */
2719
- action?: string;
2720
- 'start_date(UTC)'?: string;
2721
- 'end_date(UTC)'?: string;
2823
+ action: string;
2824
+ 'start_date(UTC)': string;
2825
+ 'end_date(UTC)': string;
2722
2826
  /**
2723
2827
  * optional
2724
2828
  * @default ""
2725
2829
  */
2726
2830
  target_user?: string;
2727
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLog[], HandleError>>;
2831
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
2728
2832
  }
2729
2833
  export class Permission<HandleError extends boolean = boolean> {
2730
2834
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2732,7 +2836,6 @@ export class Permission<HandleError extends boolean = boolean> {
2732
2836
  /**
2733
2837
  * @tags Permission
2734
2838
  * @name PostPermission
2735
- * @summary Create permission for a user - Internal use only - Super admin - available in Microservice
2736
2839
  * @request POST:/api/permission/permission
2737
2840
  * @secure
2738
2841
  */
@@ -2740,22 +2843,20 @@ export class Permission<HandleError extends boolean = boolean> {
2740
2843
  /**
2741
2844
  * @tags Permission
2742
2845
  * @name GetPermission
2743
- * @summary Get permission for a user - Internal use only - Super admin - available in Microservice
2744
2846
  * @request GET:/api/permission/permission
2745
2847
  * @secure
2746
2848
  */
2747
- getPermission(query?: {
2748
- user_name?: string;
2849
+ getPermission(query: {
2850
+ user_name: string;
2749
2851
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
2750
2852
  /**
2751
2853
  * @tags Permission
2752
2854
  * @name DeletePermission
2753
- * @summary Delete permission for a user - Internal use only - Super admin - available in Microservice
2754
2855
  * @request DELETE:/api/permission/permission
2755
2856
  * @secure
2756
2857
  */
2757
- deletePermission(query?: {
2758
- user_name?: string;
2858
+ deletePermission(query: {
2859
+ user_name: string;
2759
2860
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2760
2861
  }
2761
2862
  export class Quote<HandleError extends boolean = boolean> {
@@ -2764,7 +2865,7 @@ export class Quote<HandleError extends boolean = boolean> {
2764
2865
  /**
2765
2866
  * @tags Quote
2766
2867
  * @name PostSymbolSearch
2767
- * @summary Symbol screener - All users - available in Microservice version
2868
+ * @summary Symbol screener - All users
2768
2869
  * @request POST:/api/quote/symbol-search
2769
2870
  * @secure
2770
2871
  */
@@ -2782,13 +2883,13 @@ export class Quote<HandleError extends boolean = boolean> {
2782
2883
  /**
2783
2884
  * @tags Quote
2784
2885
  * @name GetBestQuote
2785
- * @summary Query Best Quote(Level 1 data) - All users - available in Microservice
2886
+ * @summary Query Best Quote(Level 1 data) - All users
2786
2887
  * @request GET:/api/quote/best-quote
2787
2888
  * @secure
2788
2889
  */
2789
- getBestQuote(query?: {
2890
+ getBestQuote(query: {
2790
2891
  /** Allow multiple symbols query, seperated by ',' */
2791
- symbols?: string;
2892
+ symbols: string;
2792
2893
  /**
2793
2894
  * Optional. Default is false. If true, response will be camel case
2794
2895
  * @default false
@@ -2805,13 +2906,13 @@ export class Quote<HandleError extends boolean = boolean> {
2805
2906
  /**
2806
2907
  * @tags Quote
2807
2908
  * @name GetNbboSnapshot
2808
- * @summary Query NBBO Snapshot - All users - available in Microservice
2909
+ * @summary Query NBBO Snapshot - All users
2809
2910
  * @request GET:/api/quote/nbbo-snapshot
2810
2911
  * @secure
2811
2912
  */
2812
- getNbboSnapshot(query?: {
2913
+ getNbboSnapshot(query: {
2813
2914
  /** Allow multiple symbols query, seperated by ',' */
2814
- symbols?: string;
2915
+ symbols: string;
2815
2916
  /**
2816
2917
  * Optional. Default is false. If true, response will be camel case
2817
2918
  * @default false
@@ -2828,13 +2929,13 @@ export class Quote<HandleError extends boolean = boolean> {
2828
2929
  /**
2829
2930
  * @tags Quote
2830
2931
  * @name GetLevel1
2831
- * @summary Query full Level 1 data - All users - available in Microservice
2932
+ * @summary Query full Level 1 data - All users
2832
2933
  * @request GET:/api/quote/level1
2833
2934
  * @secure
2834
2935
  */
2835
- getLevel1(query?: {
2936
+ getLevel1(query: {
2836
2937
  /** Allow multiple symbols, separated by ',' */
2837
- symbols?: string;
2938
+ symbols: string;
2838
2939
  /**
2839
2940
  * Optional. Default is false. If true, response will be camel case
2840
2941
  * @default false
@@ -2851,13 +2952,13 @@ export class Quote<HandleError extends boolean = boolean> {
2851
2952
  /**
2852
2953
  * @tags Quote
2853
2954
  * @name GetRegionQuotes
2854
- * @summary Query Region Quotes from Tick data - All users - available in Microservice
2955
+ * @summary Query Region Quotes from Tick data - All users
2855
2956
  * @request GET:/api/quote/region-quotes
2856
2957
  * @secure
2857
2958
  */
2858
- getRegionQuotes(query?: {
2959
+ getRegionQuotes(query: {
2859
2960
  /** Allow one symbol */
2860
- symbol?: string;
2961
+ symbol: string;
2861
2962
  /**
2862
2963
  * Optional. Default is false. If true, response will be camel case
2863
2964
  * @default false
@@ -2874,13 +2975,13 @@ export class Quote<HandleError extends boolean = boolean> {
2874
2975
  /**
2875
2976
  * @tags Quote
2876
2977
  * @name GetTimeSale
2877
- * @summary Query TimeSale from Tick data - All users - available in Microservice
2978
+ * @summary Query TimeSale from Tick data - All users
2878
2979
  * @request GET:/api/quote/time-sale
2879
2980
  * @secure
2880
2981
  */
2881
- getTimeSale(query?: {
2982
+ getTimeSale(query: {
2882
2983
  /** Allow one symbol */
2883
- symbol?: string;
2984
+ symbol: string;
2884
2985
  /**
2885
2986
  * Optional. Default is false. If true, response will be camel case
2886
2987
  * @default false
@@ -2897,13 +2998,13 @@ export class Quote<HandleError extends boolean = boolean> {
2897
2998
  /**
2898
2999
  * @tags Quote
2899
3000
  * @name GetLastTrade
2900
- * @summary Query Last Trade(Level 2 data) - All users - available in Microservice
3001
+ * @summary Query Last Trade(Level 2 data) - All users
2901
3002
  * @request GET:/api/quote/last-trade
2902
3003
  * @secure
2903
3004
  */
2904
- getLastTrade(query?: {
3005
+ getLastTrade(query: {
2905
3006
  /** Allow multiple symbols query, seperated by ',' */
2906
- symbols?: string;
3007
+ symbols: string;
2907
3008
  /**
2908
3009
  * Optional. Default is false. If true, response will be camel case
2909
3010
  * @default false
@@ -2920,14 +3021,17 @@ export class Quote<HandleError extends boolean = boolean> {
2920
3021
  /**
2921
3022
  * @tags Quote
2922
3023
  * @name GetIntradayChart
2923
- * @summary Query intra-day Day Chart and Minute Chart - All users - available in Microservice
3024
+ * @summary Query intra-day Day Chart and Minute Chart - All users
2924
3025
  * @request GET:/api/quote/intraday-chart
2925
3026
  * @secure
2926
3027
  */
2927
- getIntradayChart(query?: {
3028
+ getIntradayChart(query: {
2928
3029
  /** Allow one symbol */
2929
- symbol?: string;
2930
- /** 'D' for day chart, 'M' for minute chart */
3030
+ symbol: string;
3031
+ /**
3032
+ * 'D' for day chart, 'M' for minute chart
3033
+ * @default "D"
3034
+ */
2931
3035
  day_minute?: string;
2932
3036
  /**
2933
3037
  * Optional. Default is false. If true, response will be camel case
@@ -2945,13 +3049,13 @@ export class Quote<HandleError extends boolean = boolean> {
2945
3049
  /**
2946
3050
  * @tags Quote
2947
3051
  * @name GetHistoricalDayChart
2948
- * @summary Query Historical Day Chart - All users - available in Microservice
3052
+ * @summary Query Historical Day Chart - All users
2949
3053
  * @request GET:/api/quote/historical-day-chart
2950
3054
  * @secure
2951
3055
  */
2952
- getHistoricalDayChart(query?: {
3056
+ getHistoricalDayChart(query: {
2953
3057
  /** Allow one symbol */
2954
- symbol?: string;
3058
+ symbol: string;
2955
3059
  /**
2956
3060
  * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
2957
3061
  * @default ""
@@ -2979,13 +3083,13 @@ export class Quote<HandleError extends boolean = boolean> {
2979
3083
  /**
2980
3084
  * @tags Quote
2981
3085
  * @name GetHistoricalMinuteChart
2982
- * @summary Query Historical Minute Chart - All users - available in Microservice
3086
+ * @summary Query Historical Minute Chart - All users
2983
3087
  * @request GET:/api/quote/historical-minute-chart
2984
3088
  * @secure
2985
3089
  */
2986
- getHistoricalMinuteChart(query?: {
3090
+ getHistoricalMinuteChart(query: {
2987
3091
  /** Allow one symbol */
2988
- symbol?: string;
3092
+ symbol: string;
2989
3093
  /** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
2990
3094
  date?: string;
2991
3095
  /**
@@ -3004,7 +3108,7 @@ export class Quote<HandleError extends boolean = boolean> {
3004
3108
  /**
3005
3109
  * @tags Quote
3006
3110
  * @name GetTop20
3007
- * @summary Query Top20 data - All users - available in Microservice
3111
+ * @summary Query Top20 data - All users
3008
3112
  * @request GET:/api/quote/top-20
3009
3113
  * @secure
3010
3114
  */
@@ -3022,13 +3126,13 @@ export class Quote<HandleError extends boolean = boolean> {
3022
3126
  /**
3023
3127
  * @tags Quote
3024
3128
  * @name GetOptionChainDates
3025
- * @summary Query Option Chain dates - All users - available in Microservice
3129
+ * @summary Query Option Chain dates - All users
3026
3130
  * @request GET:/api/quote/option-chain-dates
3027
3131
  * @secure
3028
3132
  */
3029
- getOptionChainDates(query?: {
3133
+ getOptionChainDates(query: {
3030
3134
  /** Allow one underlying symbol */
3031
- symbol?: string;
3135
+ symbol: string;
3032
3136
  /**
3033
3137
  * Optional. Default is false. If true, response will be camel case
3034
3138
  * @default false
@@ -3045,15 +3149,15 @@ export class Quote<HandleError extends boolean = boolean> {
3045
3149
  /**
3046
3150
  * @tags Quote
3047
3151
  * @name GetOptionChain
3048
- * @summary Query Option Chain data - All users - available in Microservice
3152
+ * @summary Query Option Chain data - All users
3049
3153
  * @request GET:/api/quote/option-chain
3050
3154
  * @secure
3051
3155
  */
3052
- getOptionChain(query?: {
3156
+ getOptionChain(query: {
3053
3157
  /** Allow one underlying symbol */
3054
- underlying?: string;
3158
+ underlying: string;
3055
3159
  /** allow one date, format YYYY-MM-DD */
3056
- date?: string;
3160
+ date: string;
3057
3161
  /**
3058
3162
  * Optional. Default is false. If true, response will be camel case
3059
3163
  * @default false
@@ -3070,13 +3174,13 @@ export class Quote<HandleError extends boolean = boolean> {
3070
3174
  /**
3071
3175
  * @tags Quote
3072
3176
  * @name GetOptionLevel1
3073
- * @summary Query Option Level 1 data - All users - available in Microservice
3177
+ * @summary Query Option Level 1 data - All users
3074
3178
  * @request GET:/api/quote/option-level1
3075
3179
  * @secure
3076
3180
  */
3077
- getOptionLevel1(query?: {
3181
+ getOptionLevel1(query: {
3078
3182
  /** Allow multiple option symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3079
- option_names?: string;
3183
+ option_names: string;
3080
3184
  /**
3081
3185
  * Optional. Default is false. If true, response will be camel case
3082
3186
  * @default false
@@ -3093,13 +3197,13 @@ export class Quote<HandleError extends boolean = boolean> {
3093
3197
  /**
3094
3198
  * @tags Quote
3095
3199
  * @name GetOptionLevel1WithGreek
3096
- * @summary Query Option Level 1 data - All users - available in Microservice
3200
+ * @summary Query Option Level 1 data - All users
3097
3201
  * @request GET:/api/quote/option-level1-with-greek
3098
3202
  * @secure
3099
3203
  */
3100
- getOptionLevel1WithGreek(query?: {
3204
+ getOptionLevel1WithGreek(query: {
3101
3205
  /** Allow multiple symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3102
- option_names?: string;
3206
+ option_names: string;
3103
3207
  /**
3104
3208
  * Optional. Default is false. If true, response will be camel case
3105
3209
  * @default false
@@ -3121,13 +3225,13 @@ export class Quote<HandleError extends boolean = boolean> {
3121
3225
  /**
3122
3226
  * @tags Quote
3123
3227
  * @name GetOptionDayChart
3124
- * @summary Query Option Day Chart - All users - available in Microservice
3228
+ * @summary Query Option Day Chart - All users
3125
3229
  * @request GET:/api/quote/option-day-chart
3126
3230
  * @secure
3127
3231
  */
3128
- getOptionDayChart(query?: {
3232
+ getOptionDayChart(query: {
3129
3233
  /** Allow one symbol */
3130
- symbol?: string;
3234
+ symbol: string;
3131
3235
  /**
3132
3236
  * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
3133
3237
  * @default ""
@@ -3155,15 +3259,15 @@ export class Quote<HandleError extends boolean = boolean> {
3155
3259
  /**
3156
3260
  * @tags Quote
3157
3261
  * @name GetEquiductLevel1
3158
- * @summary Query Equiduct Level 1 data - All users - available in Microservice
3262
+ * @summary Query Equiduct Level 1 data - All users
3159
3263
  * @request GET:/api/quote/equiduct-level1
3160
3264
  * @secure
3161
3265
  */
3162
- getEquiductLevel1(query?: {
3266
+ getEquiductLevel1(query: {
3163
3267
  /** Allow multiple symbols, separated by ',' */
3164
- symbols?: string;
3268
+ symbols: string;
3165
3269
  /**
3166
- * True to query realtime data, False to query delay data
3270
+ * True to query realtime data, False to query delay data. Default is false.
3167
3271
  * @default false
3168
3272
  */
3169
3273
  realtime?: boolean;
@@ -3183,13 +3287,13 @@ export class Quote<HandleError extends boolean = boolean> {
3183
3287
  /**
3184
3288
  * @tags Quote
3185
3289
  * @name GetBonds
3186
- * @summary Query Bonds data - All users - available in Microservice
3290
+ * @summary Query Bonds data - All users
3187
3291
  * @request GET:/api/quote/bonds
3188
3292
  * @secure
3189
3293
  */
3190
- getBonds(query?: {
3294
+ getBonds(query: {
3191
3295
  /** ISIN, allow multiple query separated by ',' */
3192
- isins?: string;
3296
+ isins: string;
3193
3297
  /**
3194
3298
  * Price type, default is Percentage. ('Percentage'|'Decimal')
3195
3299
  * @default "Percentage"
@@ -3206,18 +3310,20 @@ export class Quote<HandleError extends boolean = boolean> {
3206
3310
  */
3207
3311
  response_camel_case?: boolean;
3208
3312
  /** @default "" */
3313
+ user_name?: string;
3314
+ /** @default "" */
3209
3315
  platform?: string;
3210
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondWholeApex[], HandleError>>;
3316
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBond[], HandleError>>;
3211
3317
  /**
3212
3318
  * @tags Quote
3213
3319
  * @name GetBondsSearch
3214
- * @summary Search bonds - All users - available in Microservice
3320
+ * @summary Search bonds - All users
3215
3321
  * @request GET:/api/quote/bonds-search
3216
3322
  * @secure
3217
3323
  */
3218
- getBondsSearch(query?: {
3324
+ getBondsSearch(query: {
3219
3325
  /** search string */
3220
- criteria?: string;
3326
+ criteria: string;
3221
3327
  /**
3222
3328
  * how many records that need to return, 20 is maximum
3223
3329
  * @format int32
@@ -3249,20 +3355,21 @@ export class Quote<HandleError extends boolean = boolean> {
3249
3355
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3250
3356
  /**
3251
3357
  * @tags Quote
3252
- * @name GetBondsChart
3253
- * @summary Query Bonds historical chart data - All users - available in Microservice
3254
- * @request GET:/api/quote/bonds-chart
3358
+ * @name GetBondScreenerFieldValues
3359
+ * @summary bond screener field possible values - All users
3360
+ * @request GET:/api/quote/bond-screener-field-values
3255
3361
  * @secure
3256
3362
  */
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;
3363
+ getBondScreenerFieldValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondFieldValues, HandleError>>;
3364
+ /**
3365
+ * @description For fields possible value, please query in endpoint 'bonds-screener-field-values"
3366
+ * @tags Quote
3367
+ * @name PostBondsScreener
3368
+ * @summary Bond screener - All users
3369
+ * @request POST:/api/quote/bonds-screener
3370
+ * @secure
3371
+ */
3372
+ postBondsScreener(data: AesMidasBondSearchBody, query?: {
3266
3373
  /**
3267
3374
  * if response with camel case
3268
3375
  * @default false
@@ -3270,17 +3377,17 @@ export class Quote<HandleError extends boolean = boolean> {
3270
3377
  response_camel_case?: boolean;
3271
3378
  /** @default "" */
3272
3379
  platform?: string;
3273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasHistoricalBondChartApex[], HandleError>>;
3380
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondPagedResult, HandleError>>;
3274
3381
  /**
3275
3382
  * @tags Quote
3276
3383
  * @name GetMutualFunds
3277
- * @summary Query Mutual Funds data - All users - available in Microservice
3384
+ * @summary Query Mutual Funds data - All users
3278
3385
  * @request GET:/api/quote/mutual-funds
3279
3386
  * @secure
3280
3387
  */
3281
- getMutualFunds(query?: {
3388
+ getMutualFunds(query: {
3282
3389
  /** symbol, allow multiple query separated by ',' */
3283
- symbols?: string;
3390
+ symbols: string;
3284
3391
  /**
3285
3392
  * if response with camel case
3286
3393
  * @default false
@@ -3292,13 +3399,13 @@ export class Quote<HandleError extends boolean = boolean> {
3292
3399
  /**
3293
3400
  * @tags Quote
3294
3401
  * @name GetQuoddEod
3295
- * @summary Query QUODD EOD data - All users - available in Microservice
3402
+ * @summary Query QUODD EOD data(mostly are Asian exchanges data)- All users
3296
3403
  * @request GET:/api/quote/quodd-eod
3297
3404
  * @secure
3298
3405
  */
3299
- getQuoddEod(query?: {
3406
+ getQuoddEod(query: {
3300
3407
  /** Allow multiple symbols, separated by ',' */
3301
- symbols?: string;
3408
+ symbols: string;
3302
3409
  /**
3303
3410
  * Optional. Default is false. If true, response will be camel case
3304
3411
  * @default false
@@ -3315,13 +3422,13 @@ export class Quote<HandleError extends boolean = boolean> {
3315
3422
  /**
3316
3423
  * @tags Quote
3317
3424
  * @name GetQuoddDelay
3318
- * @summary Query QUODD Delay data - All users - available in Microservice
3425
+ * @summary Query QUODD Delay data - All users
3319
3426
  * @request GET:/api/quote/quodd-delay
3320
3427
  * @secure
3321
3428
  */
3322
- getQuoddDelay(query?: {
3429
+ getQuoddDelay(query: {
3323
3430
  /** Allow multiple symbols, separated by ',' */
3324
- symbols?: string;
3431
+ symbols: string;
3325
3432
  /**
3326
3433
  * Optional. Default is false. If true, response will be camel case
3327
3434
  * @default false
@@ -3338,13 +3445,13 @@ export class Quote<HandleError extends boolean = boolean> {
3338
3445
  /**
3339
3446
  * @tags Quote
3340
3447
  * @name GetIceIsin
3341
- * @summary Query ICE ISIN data - All users - available in Microservice
3448
+ * @summary Query ICE ISIN data - All users
3342
3449
  * @request GET:/api/quote/ice-isin
3343
3450
  * @secure
3344
3451
  */
3345
- getIceIsin(query?: {
3452
+ getIceIsin(query: {
3346
3453
  /** Allow multiple isins, separated by ',' */
3347
- isins?: string;
3454
+ isins: string;
3348
3455
  /**
3349
3456
  * Optional. Default is false. If true, response will be camel case
3350
3457
  * @default false
@@ -3361,13 +3468,13 @@ export class Quote<HandleError extends boolean = boolean> {
3361
3468
  /**
3362
3469
  * @tags Quote
3363
3470
  * @name GetIceEod
3364
- * @summary Query ICE EOD data - All users - available in Microservice
3471
+ * @summary Query ICE EOD data - All users
3365
3472
  * @request GET:/api/quote/ice-eod
3366
3473
  * @secure
3367
3474
  */
3368
- getIceEod(query?: {
3475
+ getIceEod(query: {
3369
3476
  /** Allow multiple symbols, separated by ',' */
3370
- symbols?: string;
3477
+ symbols: string;
3371
3478
  /**
3372
3479
  * Optional. Default is false. If true, response will be camel case
3373
3480
  * @default false
@@ -3384,13 +3491,13 @@ export class Quote<HandleError extends boolean = boolean> {
3384
3491
  /**
3385
3492
  * @tags Quote
3386
3493
  * @name GetFxRate
3387
- * @summary Query Forex data with symbols - All users - available in Microservice
3494
+ * @summary Query Forex data with symbols - All users
3388
3495
  * @request GET:/api/quote/fx-rate
3389
3496
  * @secure
3390
3497
  */
3391
- getFxRate(query?: {
3498
+ getFxRate(query: {
3392
3499
  /** Allow multiple symbols, separated by ',' */
3393
- symbols?: string;
3500
+ symbols: string;
3394
3501
  /**
3395
3502
  * Optional. Default is false. If true, response will be camel case
3396
3503
  * @default false
@@ -3407,13 +3514,13 @@ export class Quote<HandleError extends boolean = boolean> {
3407
3514
  /**
3408
3515
  * @tags Quote
3409
3516
  * @name GetFxTable
3410
- * @summary Query Forex table for one currency - All users - available in Microservice
3517
+ * @summary Query Forex table for one currency - All users
3411
3518
  * @request GET:/api/quote/fx-table
3412
3519
  * @secure
3413
3520
  */
3414
- getFxTable(query?: {
3521
+ getFxTable(query: {
3415
3522
  /** Allow multiple symbols, separated by ',' */
3416
- symbols?: string;
3523
+ symbols: string;
3417
3524
  /**
3418
3525
  * Optional. Default is false. If true, response will be camel case
3419
3526
  * @default false
@@ -3434,26 +3541,26 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3434
3541
  /**
3435
3542
  * @tags QuotesReformat
3436
3543
  * @name GetEquity
3437
- * @summary Query full Level 1 data - All users - available in Microservice
3544
+ * @summary Query full Level 1 data - All users
3438
3545
  * @request GET:/api/quotes/equity
3439
3546
  * @secure
3440
3547
  */
3441
- getEquity(query?: {
3548
+ getEquity(query: {
3442
3549
  /** Allow multiple symbols, separated by ',' */
3443
- symbols?: string;
3550
+ symbols: string;
3444
3551
  /** @default "" */
3445
3552
  platform?: string;
3446
3553
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3447
3554
  /**
3448
3555
  * @tags QuotesReformat
3449
3556
  * @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
3557
+ * @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
3451
3558
  * @request GET:/api/quotes/equity/intraday
3452
3559
  * @secure
3453
3560
  */
3454
- getEquityIntraday(query?: {
3561
+ getEquityIntraday(query: {
3455
3562
  /** Allow one symbol */
3456
- symbol?: string;
3563
+ symbol: string;
3457
3564
  /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
3458
3565
  from?: string;
3459
3566
  /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
@@ -3463,14 +3570,14 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3463
3570
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3464
3571
  /**
3465
3572
  * @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
3573
+ * @name GetEquityHistorical
3574
+ * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3575
+ * @request GET:/api/quotes/equity/historical
3469
3576
  * @secure
3470
3577
  */
3471
- getOptionHistorical(query?: {
3578
+ getEquityHistorical(query: {
3472
3579
  /** Allow one symbol */
3473
- symbol?: string;
3580
+ symbol: string;
3474
3581
  /** start date (MM/dd/yyyy) */
3475
3582
  start?: string;
3476
3583
  /** end date (MM/dd/yyyy) */
@@ -3486,13 +3593,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3486
3593
  /**
3487
3594
  * @tags QuotesReformat
3488
3595
  * @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
3596
+ * @summary To search for a company and the exact ticker symbol is not known, use this endpoint for a string search. - All users
3490
3597
  * @request GET:/api/quotes/search
3491
3598
  * @secure
3492
3599
  */
3493
- getSearch(query?: {
3600
+ getSearch(query: {
3494
3601
  /** String to search for */
3495
- criteria?: string;
3602
+ criteria: string;
3496
3603
  /**
3497
3604
  * Maximum number of results to return (default is 20)
3498
3605
  * @format int32
@@ -3510,13 +3617,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3510
3617
  /**
3511
3618
  * @tags QuotesReformat
3512
3619
  * @name GetOption
3513
- * @summary Query Option Level 1 data - All users - available in Microservice
3620
+ * @summary Query Option Level 1 data - All users
3514
3621
  * @request GET:/api/quotes/option
3515
3622
  * @secure
3516
3623
  */
3517
- getOption(query?: {
3624
+ getOption(query: {
3518
3625
  /** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3519
- symbols?: string;
3626
+ symbols: string;
3520
3627
  /**
3521
3628
  * if include greek letter value in response
3522
3629
  * @default false
@@ -3528,7 +3635,7 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3528
3635
  /**
3529
3636
  * @tags QuotesReformat
3530
3637
  * @name GetOptionChainDates
3531
- * @summary Query Option Chain dates - All users - available in Microservice
3638
+ * @summary Query Option Chain dates - All users
3532
3639
  * @request GET:/api/quotes/option/chain/dates/{symbol}
3533
3640
  * @secure
3534
3641
  */
@@ -3539,7 +3646,7 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3539
3646
  /**
3540
3647
  * @tags QuotesReformat
3541
3648
  * @name GetOptionChain
3542
- * @summary Query Option Chain data - All users - available in Microservice
3649
+ * @summary Query Option Chain data - All users
3543
3650
  * @request GET:/api/quotes/option/chain/{symbol}/{date}
3544
3651
  * @secure
3545
3652
  */
@@ -3549,14 +3656,14 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3549
3656
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3550
3657
  /**
3551
3658
  * @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
3659
+ * @name GetOptionHistorical
3660
+ * @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3661
+ * @request GET:/api/quotes/option/historical
3555
3662
  * @secure
3556
3663
  */
3557
- getEquityHistorical(query?: {
3664
+ getOptionHistorical(query: {
3558
3665
  /** Allow one symbol */
3559
- symbol?: string;
3666
+ symbol: string;
3560
3667
  /** start date (MM/dd/yyyy) */
3561
3668
  start?: string;
3562
3669
  /** end date (MM/dd/yyyy) */
@@ -3572,13 +3679,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3572
3679
  /**
3573
3680
  * @tags QuotesReformat
3574
3681
  * @name GetBonds
3575
- * @summary Query Bonds data - All users - available in Microservice
3682
+ * @summary Query Bonds data - All users
3576
3683
  * @request GET:/api/quotes/bonds
3577
3684
  * @secure
3578
3685
  */
3579
- getBonds(query?: {
3686
+ getBonds(query: {
3580
3687
  /** ISIN, allow multiple query separated by ',' */
3581
- identifiers?: string;
3688
+ identifiers: string;
3582
3689
  /**
3583
3690
  * Price type, default is Percentage. ('Percentage'|'Decimal')
3584
3691
  * @default "Percentage"
@@ -3595,13 +3702,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3595
3702
  /**
3596
3703
  * @tags QuotesReformat
3597
3704
  * @name GetBondsSearch
3598
- * @summary Search bonds - All users - available in Microservice
3705
+ * @summary Search bonds - All users
3599
3706
  * @request GET:/api/quotes/bonds/search
3600
3707
  * @secure
3601
3708
  */
3602
- getBondsSearch(query?: {
3709
+ getBondsSearch(query: {
3603
3710
  /** search string */
3604
- criteria?: string;
3711
+ criteria: string;
3605
3712
  /**
3606
3713
  * how many records that need to return, 20 is maximum
3607
3714
  * @format int32
@@ -3629,130 +3736,24 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3629
3736
  /**
3630
3737
  * @tags QuotesReformat
3631
3738
  * @name GetQuotesReformat
3632
- * @summary Query Forex rate - All users - available in Microservice
3739
+ * @summary Query Forex rate - All users
3633
3740
  * @request GET:/api/quotes/fx
3634
3741
  * @secure
3635
3742
  */
3636
- getQuotesReformat(query?: {
3743
+ getQuotesReformat(query: {
3637
3744
  /** base_currency/quote_currecy. Can query multiple, separated with ',' */
3638
- symbols?: string;
3745
+ symbols: string;
3639
3746
  /** @default "" */
3640
3747
  platform?: string;
3641
3748
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3642
3749
  }
3643
- export class UmaTest<HandleError extends boolean = boolean> {
3644
- protected readonly apiClient: JwtClient<HandleError>;
3645
- constructor(apiClient: JwtClient<HandleError>);
3646
- /**
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
3651
- * @secure
3652
- */
3653
- getRevokeUmaUser(query?: {
3654
- user_id?: string;
3655
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3656
- /**
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
3661
- * @secure
3662
- */
3663
- getFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
3664
- /**
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
3669
- * @secure
3670
- */
3671
- getFirmListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3672
- /**
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
3677
- * @secure
3678
- */
3679
- getB2BUserById(query?: {
3680
- user_id?: string;
3681
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
3682
- /**
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
3687
- * @secure
3688
- */
3689
- getB2BUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
3690
- /**
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
3695
- * @secure
3696
- */
3697
- getB2BUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3698
- /**
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
3703
- * @secure
3704
- */
3705
- getB2CUserById(query?: {
3706
- user_id?: string;
3707
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser, HandleError>>;
3708
- /**
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
3713
- * @secure
3714
- */
3715
- getB2CUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
3716
- /**
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
3721
- * @secure
3722
- */
3723
- getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3724
- }
3725
3750
  export class User<HandleError extends boolean = boolean> {
3726
3751
  protected readonly apiClient: JwtClient<HandleError>;
3727
3752
  constructor(apiClient: JwtClient<HandleError>);
3728
- /**
3729
- * @tags User
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
3733
- * @secure
3734
- */
3735
- postRegisterRegular(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3736
- /**
3737
- * @tags User
3738
- * @name PostRegisterAdmin
3739
- * @summary Create a new admin user - Super admin - Not available in Microservice
3740
- * @request POST:/api/user/register-admin
3741
- * @secure
3742
- */
3743
- postRegisterAdmin(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3744
- /**
3745
- * @tags User
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
3749
- * @secure
3750
- */
3751
- postRegisterManager(data: AesMidasRegisterModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3752
3753
  /**
3753
3754
  * @tags User
3754
3755
  * @name PostRegisterUmaB2BUser
3755
- * @summary Create a new b2b user from UMA - Firm manager, or super admin - available in Microservice
3756
+ * @summary Create a new b2b user from UMA - Firm manager, or super admin
3756
3757
  * @request POST:/api/user/register-uma-b2b-user
3757
3758
  * @secure
3758
3759
  */
@@ -3760,265 +3761,100 @@ export class User<HandleError extends boolean = boolean> {
3760
3761
  /**
3761
3762
  * @tags User
3762
3763
  * @name PostRegisterUmaB2CUser
3763
- * @summary Create a new b2c user from UMA - Firm manager, or super admin - available in Microservice
3764
+ * @summary Create a new b2c user from UMA - Firm manager, or super admin
3764
3765
  * @request POST:/api/user/register-uma-b2c-user
3765
3766
  * @secure
3766
3767
  */
3767
3768
  postRegisterUmaB2CUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3768
3769
  /**
3769
3770
  * @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
3771
+ * @name PostUmaB2BUserList
3772
+ * @summary Get UMA b2b users - Firm manager, or super admin
3773
+ * @request POST:/api/user/uma-b2b-user-list
3773
3774
  * @secure
3774
3775
  */
3775
- getUmaB2BUserList(query?: {
3776
- /**
3777
- * fuzzy search on uma user first/last name
3778
- * @default ""
3779
- */
3776
+ postUmaB2BUserList(data: AesMidasQueryPostBody, query?: {
3777
+ /** @default "" */
3780
3778
  name?: string;
3781
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
3779
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUserResponsewithPagination, HandleError>>;
3782
3780
  /**
3783
3781
  * @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
3782
+ * @name PostUmaB2CUserList
3783
+ * @summary Get UMA b2c users - Firm manager, or super admin
3784
+ * @request POST:/api/user/uma-b2c-user-list
3787
3785
  * @secure
3788
3786
  */
3789
- getUmaB2CUserList(query?: {
3790
- /**
3791
- * fuzzy search on uma user first/last name
3792
- * @default ""
3793
- */
3787
+ postUmaB2CUserList(data: AesMidasQueryPostBody, query?: {
3788
+ /** @default "" */
3794
3789
  name?: string;
3795
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
3796
- /**
3797
- * @tags User
3798
- * @name PostLogin
3799
- * @summary all user login - All users - Not available in Microservice
3800
- * @request POST:/api/user/login
3801
- * @secure
3802
- */
3803
- postLogin(data: AesMidasLoginModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3804
- /**
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
3810
- * @secure
3811
- */
3812
- getLogout(query?: {
3813
- user_id?: string;
3814
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3815
- /**
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
3820
- * @secure
3821
- */
3822
- putPhoneNumber(data: AesMidasModifyPhoneNumberModel, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3823
- /**
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
3828
- * @secure
3829
- */
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?: {
3871
- user_name?: string;
3872
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
3873
- /**
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
3878
- * @secure
3879
- */
3880
- getUserByName(query?: {
3881
- user_name?: string;
3882
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUser, HandleError>>;
3883
- /**
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
3888
- * @secure
3889
- */
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?: {
3902
- user_name?: string;
3903
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
3790
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUserResponsewithPagination, HandleError>>;
3904
3791
  /**
3792
+ * @description All conditions are optional
3905
3793
  * @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
3794
+ * @name PostUsersByMultipleConditions
3795
+ * @summary Search Users by multiple conditions
3796
+ * @request POST:/api/user/users-by-multiple-conditions
3909
3797
  * @secure
3910
3798
  */
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
3799
  postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
3927
3800
  /**
3928
- * optional
3801
+ * firm id
3929
3802
  * @default ""
3930
3803
  */
3931
3804
  firm?: string;
3932
3805
  /**
3933
- * fuzzy search, optional
3934
- * @default ""
3935
- */
3936
- user_name?: string;
3937
- /**
3938
- * optional
3806
+ * fuzzy search on both user_name and email
3939
3807
  * @default ""
3940
3808
  */
3941
- email?: string;
3809
+ user_search?: string;
3942
3810
  /**
3943
- * Value: Active/Suspended, optional
3811
+ * Value: Active/Suspended
3944
3812
  * @default ""
3945
3813
  */
3946
3814
  status?: string;
3947
3815
  /**
3948
- * Value: Professional/Non-Professional, optional
3816
+ * Value: Professional/Non-Professional
3949
3817
  * @default ""
3950
3818
  */
3951
3819
  professional?: string;
3952
3820
  /**
3953
- * Value: Yes/No, optional
3821
+ * Value: Yes/No
3954
3822
  * @default ""
3955
3823
  */
3956
3824
  has_contract?: string;
3957
3825
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserMultiConditionResultResponseResponsewithPagination, HandleError>>;
3958
3826
  /**
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
3964
- * @secure
3965
- */
3966
- postSuperAdmins(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasApplicationUserResponsewithPagination, HandleError>>;
3967
- /**
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
3973
- * @secure
3974
- */
3975
- deleteUser(query?: {
3976
- user_id?: string;
3977
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3978
- /**
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
3983
- * @secure
3984
- */
3985
- getUserRole(query?: {
3986
- user_id?: string;
3987
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3988
- /**
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
3827
  * @tags User
3991
3828
  * @name PostUserInformation
3992
- * @summary Create new user information - All users - available in Microservice
3829
+ * @summary Create new user information
3993
3830
  * @request POST:/api/user/user-information
3994
3831
  * @secure
3995
3832
  */
3996
3833
  postUserInformation(data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
3997
3834
  /**
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
3835
  * @tags User
4000
3836
  * @name PutUserInformation
4001
- * @summary Update existing user information - All users - available in Microservice
3837
+ * @summary Update existing user information
4002
3838
  * @request PUT:/api/user/user-information
4003
3839
  * @secure
4004
3840
  */
4005
- putUserInformation(data: AesMidasUserInformation, query?: {
4006
- user_id?: string;
4007
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3841
+ putUserInformation(query: {
3842
+ user_id: string;
3843
+ }, data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4008
3844
  /**
4009
3845
  * @tags User
4010
3846
  * @name GetUserInformationById
4011
- * @summary Query a specific user information - All users - available in Microservice
3847
+ * @summary Query a specific user information
4012
3848
  * @request GET:/api/user/user-information-by-id
4013
3849
  * @secure
4014
3850
  */
4015
- getUserInformationById(query?: {
4016
- user_id?: string;
3851
+ getUserInformationById(query: {
3852
+ user_id: string;
4017
3853
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
4018
3854
  /**
4019
3855
  * @tags User
4020
3856
  * @name GetOccupationList
4021
- * @summary Query occupation list that can be used in user information EmploymentFunction - All users - available in Microservice
3857
+ * @summary Query occupation list that can be used in user information EmploymentFunction - All users
4022
3858
  * @request GET:/api/user/occupation-list
4023
3859
  * @secure
4024
3860
  */
@@ -4027,7 +3863,7 @@ For Microservice API:
4027
3863
  * @description It will check if user firm has relevant data acess.
4028
3864
  * @tags User
4029
3865
  * @name PostUserDataConfig
4030
- * @summary Create new user data configuration - Firm manager, or super admin - available in Microservice
3866
+ * @summary Create new user data configuration
4031
3867
  * @request POST:/api/user/user-data-config
4032
3868
  * @secure
4033
3869
  */
@@ -4036,78 +3872,140 @@ For Microservice API:
4036
3872
  * @description It will check if user firm has relevant data acess.
4037
3873
  * @tags User
4038
3874
  * @name PutUserDataConfig
4039
- * @summary Update existing user data configuration - Firm manager, or super admin - available in Microservice
3875
+ * @summary Update existing user data configuration
4040
3876
  * @request PUT:/api/user/user-data-config
4041
3877
  * @secure
4042
3878
  */
4043
- putUserDataConfig(data: AesMidasUserDataConfig, query?: {
4044
- user_id?: string;
4045
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3879
+ putUserDataConfig(query: {
3880
+ user_id: string;
3881
+ }, data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4046
3882
  /**
4047
- * @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
4048
3883
  * @tags User
4049
3884
  * @name GetUserDataConfigById
4050
- * @summary Query a user data configuration by user Id - All users - available in Microservice
3885
+ * @summary Query a user data configuration by user Id
4051
3886
  * @request GET:/api/user/user-data-config-by-id
4052
3887
  * @secure
4053
3888
  */
4054
- getUserDataConfigById(query?: {
4055
- user_id?: string;
3889
+ getUserDataConfigById(query: {
3890
+ user_id: string;
4056
3891
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
4057
3892
  /**
4058
3893
  * @tags User
4059
3894
  * @name GetUserDataConfigByIdExtraInfo
4060
- * @summary Query a user data configuration by user Id - All users - available in Microservice
3895
+ * @summary Query a user data configuration by user Id
4061
3896
  * @request GET:/api/user/user-data-config-by-id-extra-info
4062
3897
  * @secure
4063
3898
  */
4064
- getUserDataConfigByIdExtraInfo(query?: {
4065
- user_id?: string;
3899
+ getUserDataConfigByIdExtraInfo(query: {
3900
+ user_id: string;
4066
3901
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfigExtraInfo, HandleError>>;
4067
3902
  /**
4068
3903
  * @tags User
4069
3904
  * @name GetUserDataConfigs
4070
- * @summary Query user data configurations by user Ids - Firm manager or super admin - available in Microservice
3905
+ * @summary Query user data configurations by user Ids
4071
3906
  * @request GET:/api/user/user-data-configs
4072
3907
  * @secure
4073
3908
  */
4074
- getUserDataConfigs(query?: {
4075
- user_ids?: string;
3909
+ getUserDataConfigs(query: {
3910
+ user_ids: string;
4076
3911
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig[], HandleError>>;
4077
3912
  /**
4078
3913
  * @tags User
4079
3914
  * @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
3915
+ * @summary Query which entitlements(agreements) a user need to sign(but not signed yet) by user name
4081
3916
  * @request GET:/api/user/user-need-sign-agreements
4082
3917
  * @secure
4083
3918
  */
4084
- getUserNeedSignAgreements(query?: {
4085
- user_name?: string;
3919
+ getUserNeedSignAgreements(query: {
3920
+ user_name: string;
4086
3921
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4087
3922
  /**
4088
3923
  * @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
3924
+ * @name GetTestAuthorize
3925
+ * @summary For authorize test only
3926
+ * @request GET:/api/user/test-authorize
4092
3927
  * @secure
4093
3928
  */
4094
- getSessionAlive(config?: RequestConfig<HandleError>): Promise<ClientResponse<boolean, HandleError>>;
3929
+ getTestAuthorize(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4095
3930
  /**
4096
3931
  * @tags User
4097
3932
  * @name GetTest
4098
- * @summary For system deployment user only - All users - available in Microservice
4099
- * @request GET:/api/user/Test
3933
+ * @summary For system deployment user only
3934
+ * @request GET:/api/user/test
4100
3935
  * @secure
4101
3936
  */
4102
3937
  getTest(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4103
3938
  }
3939
+ export class UmaTest<HandleError extends boolean = boolean> {
3940
+ protected readonly apiClient: JwtClient<HandleError>;
3941
+ constructor(apiClient: JwtClient<HandleError>);
3942
+ /**
3943
+ * @tags UMATest
3944
+ * @name GetRevokeUmaUser
3945
+ * @summary Revoke uma user
3946
+ * @request GET:/api/uma-test/revoke-uma-user
3947
+ * @secure
3948
+ */
3949
+ getRevokeUmaUser(query?: {
3950
+ /** please use UMA user id */
3951
+ user_id?: string;
3952
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3953
+ /**
3954
+ * @tags UMATest
3955
+ * @name GetFirmList
3956
+ * @summary Test to get all uma firms - internal use only - Super admin
3957
+ * @request GET:/api/uma-test/firm-list
3958
+ * @secure
3959
+ */
3960
+ getFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
3961
+ /**
3962
+ * @tags UMATest
3963
+ * @name GetFirmListToLocal
3964
+ * @summary Import all uma firms to AES - internal use only - Super admin
3965
+ * @request GET:/api/uma-test/firm-list-to-local
3966
+ * @secure
3967
+ */
3968
+ getFirmListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3969
+ /**
3970
+ * @tags UMATest
3971
+ * @name GetB2BUserList
3972
+ * @summary Test to get all uma b2b users - internal use only - Super admin
3973
+ * @request GET:/api/uma-test/b2b-user-list
3974
+ * @secure
3975
+ */
3976
+ getB2BUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
3977
+ /**
3978
+ * @tags UMATest
3979
+ * @name GetB2BUserListToLocal
3980
+ * @summary Import all uma b2b users to AES - internal use only - Super admin
3981
+ * @request GET:/api/uma-test/b2b-user-list-to-local
3982
+ * @secure
3983
+ */
3984
+ getB2BUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3985
+ /**
3986
+ * @tags UMATest
3987
+ * @name GetB2CUserList
3988
+ * @summary Test to get all uma b2c users - internal use only - Super admin
3989
+ * @request GET:/api/uma-test/b2c-user-list
3990
+ * @secure
3991
+ */
3992
+ getB2CUserList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUser[], HandleError>>;
3993
+ /**
3994
+ * @tags UMATest
3995
+ * @name GetB2CUserListToLocal
3996
+ * @summary Import all uma b2c users to aes - internal use only - Super admin
3997
+ * @request GET:/api/uma-test/b2c-user-list-to-local
3998
+ * @secure
3999
+ */
4000
+ getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4001
+ }
4104
4002
  export class WebSocket<HandleError extends boolean = boolean> {
4105
4003
  protected readonly apiClient: JwtClient<HandleError>;
4106
4004
  constructor(apiClient: JwtClient<HandleError>);
4107
4005
  /**
4108
4006
  * @tags WebSocket
4109
4007
  * @name GetWebSocket
4110
- * @summary WebSocket endpoint - All users - available in Microservice
4008
+ * @summary WebSocket endpoint in polling mode - All users
4111
4009
  * @request GET:/ws
4112
4010
  * @secure
4113
4011
  */
@@ -4115,7 +4013,7 @@ export class WebSocket<HandleError extends boolean = boolean> {
4115
4013
  /**
4116
4014
  * @tags WebSocket
4117
4015
  * @name GetWssub
4118
- * @summary WebSocket endpoint - All users - available in Microservice
4016
+ * @summary WebSocket endpoint in subscription mode - All users
4119
4017
  * @request GET:/wssub
4120
4018
  * @secure
4121
4019
  */
@@ -4127,7 +4025,6 @@ export class WsStream<HandleError extends boolean = boolean> {
4127
4025
  /**
4128
4026
  * @tags WsStream
4129
4027
  * @name GetStream
4130
- * @summary ws stream endpoint - All users - available in Microservice
4131
4028
  * @request GET:/stream
4132
4029
  * @secure
4133
4030
  */