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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +642 -721
  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 +543 -381
  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 +1043 -1026
  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 +95 -95
  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 +4123 -4103
  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 +640 -598
  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/dist/zerohash/index.d.ts +15480 -0
  38. package/dist/zerohash/index.d.ts.map +1 -0
  39. package/dist/zerohash/index.esm.js +2 -0
  40. package/dist/zerohash/index.esm.js.map +1 -0
  41. package/dist/zerohash/index.js +2 -0
  42. package/dist/zerohash/index.js.map +1 -0
  43. package/package.json +5 -3
@@ -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
+ statuses?: string[] | null;
255
+ sectors?: string[] | null;
256
+ types?: string[] | null;
257
+ coupon_frequencies?: string[] | null;
258
+ municipal_states?: string[] | null;
259
+ sp_ratings?: string[] | null;
260
+ municipal_types?: string[] | null;
261
+ purposes?: 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;
@@ -710,6 +757,11 @@ export interface AesMidasFirm {
710
757
  /** @format int32 */
711
758
  thailand?: number;
712
759
  /** @format int32 */
760
+ australia?: number;
761
+ /** @format int32 */
762
+ new_zealand?: number;
763
+ company_profile?: boolean;
764
+ /** @format int32 */
713
765
  us_chart?: number;
714
766
  option_chart?: boolean;
715
767
  international_chart?: boolean;
@@ -747,6 +799,39 @@ export interface AesMidasFirmEntitlementHistory {
747
799
  action_time?: string;
748
800
  version?: string | null;
749
801
  }
802
+ export interface AesMidasFirmEntitlementHistoryResponsewithPagination {
803
+ /** @format int32 */
804
+ total_items?: number;
805
+ /** @format int32 */
806
+ total_pages?: number;
807
+ /** @format int32 */
808
+ current_pages?: number;
809
+ /** @format int32 */
810
+ page_size?: number;
811
+ data?: AesMidasFirmEntitlementHistory[] | null;
812
+ }
813
+ export interface AesMidasFirmEntitlementResponsewithPagination {
814
+ /** @format int32 */
815
+ total_items?: number;
816
+ /** @format int32 */
817
+ total_pages?: number;
818
+ /** @format int32 */
819
+ current_pages?: number;
820
+ /** @format int32 */
821
+ page_size?: number;
822
+ data?: AesMidasFirmEntitlement[] | null;
823
+ }
824
+ export interface AesMidasFirmResponsewithPagination {
825
+ /** @format int32 */
826
+ total_items?: number;
827
+ /** @format int32 */
828
+ total_pages?: number;
829
+ /** @format int32 */
830
+ current_pages?: number;
831
+ /** @format int32 */
832
+ page_size?: number;
833
+ data?: AesMidasFirm[] | null;
834
+ }
750
835
  export interface AesMidasFirmDefaultDataSetting {
751
836
  firm_id?: string | null;
752
837
  /** @format int32 */
@@ -826,6 +911,12 @@ export interface AesMidasFirmDefaultDataSetting {
826
911
  /** @format int32 */
827
912
  thailand?: number;
828
913
  /** @format int32 */
914
+ australia?: number;
915
+ /** @format int32 */
916
+ new_zealand?: number;
917
+ /** @format int32 */
918
+ company_profile?: number;
919
+ /** @format int32 */
829
920
  us_chart?: number;
830
921
  /** @format int32 */
831
922
  option_chart?: number;
@@ -894,14 +985,6 @@ export interface AesMidasFundWebQuote {
894
985
  one_year_change_percent?: number;
895
986
  cusip?: string | null;
896
987
  }
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
988
  export interface AesMidasICEEOD {
906
989
  symbol?: string | null;
907
990
  /** @format double */
@@ -1052,7 +1135,6 @@ export interface AesMidasLevel1Reformat {
1052
1135
  company_name?: string | null;
1053
1136
  exchange?: string | null;
1054
1137
  market_description?: string | null;
1055
- issue_market?: string | null;
1056
1138
  country?: string | null;
1057
1139
  time_zone?: string | null;
1058
1140
  /** @format double */
@@ -1177,12 +1259,6 @@ export interface AesMidasLevel1Reformat {
1177
1259
  base_currency?: string | null;
1178
1260
  fx?: boolean;
1179
1261
  }
1180
- export interface AesMidasLoginModel {
1181
- /** @minLength 1 */
1182
- user_name: string;
1183
- /** @minLength 1 */
1184
- password: string;
1185
- }
1186
1262
  export interface AesMidasMinuteChart {
1187
1263
  symbol?: string | null;
1188
1264
  /** @format date-time */
@@ -1216,18 +1292,6 @@ export interface AesMidasMinuteChartReformat {
1216
1292
  sma?: AesMidasRsiSpan[] | null;
1217
1293
  ema?: AesMidasRsiSpan[] | null;
1218
1294
  }
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
1295
  export interface AesMidasMutualFund {
1232
1296
  symbol?: string | null;
1233
1297
  company_name?: string | null;
@@ -1371,11 +1435,11 @@ export interface AesMidasPermission {
1371
1435
  /** @format int32 */
1372
1436
  num_query_per_sec: number;
1373
1437
  /** @format int32 */
1374
- num_query_per_min: number;
1375
- /** @format int32 */
1376
- size_data_per_min: number;
1438
+ size_data_per_sec: number;
1377
1439
  /** @minLength 1 */
1378
1440
  allow_ip: string;
1441
+ level1: boolean;
1442
+ level2: boolean;
1379
1443
  }
1380
1444
  export interface AesMidasQueryLog {
1381
1445
  id?: string | null;
@@ -1399,6 +1463,28 @@ export interface AesMidasQueryLogReport {
1399
1463
  platform?: string | null;
1400
1464
  action?: string | null;
1401
1465
  }
1466
+ export interface AesMidasQueryLogReportResponsewithPagination {
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?: AesMidasQueryLogReport[] | null;
1476
+ }
1477
+ export interface AesMidasQueryLogResponsewithPagination {
1478
+ /** @format int32 */
1479
+ total_items?: number;
1480
+ /** @format int32 */
1481
+ total_pages?: number;
1482
+ /** @format int32 */
1483
+ current_pages?: number;
1484
+ /** @format int32 */
1485
+ page_size?: number;
1486
+ data?: AesMidasQueryLog[] | null;
1487
+ }
1402
1488
  export interface AesMidasQueryPostBody {
1403
1489
  pagination?: AesMidasPagination;
1404
1490
  sorts?: AesMidasSort[] | null;
@@ -1513,17 +1599,6 @@ export interface AesMidasRegionQuote {
1513
1599
  ask_time?: string | null;
1514
1600
  data_source?: string | null;
1515
1601
  }
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
1602
  export interface AesMidasRsiSpan {
1528
1603
  /** @format int32 */
1529
1604
  span?: number;
@@ -1791,6 +1866,18 @@ export interface AesMidasUMAB2BUser {
1791
1866
  roles?: AesMidasUMARole[] | null;
1792
1867
  small_avatar_url?: string | null;
1793
1868
  theme?: string | null;
1869
+ status?: string | null;
1870
+ }
1871
+ export interface AesMidasUMAB2BUserResponsewithPagination {
1872
+ /** @format int32 */
1873
+ total_items?: number;
1874
+ /** @format int32 */
1875
+ total_pages?: number;
1876
+ /** @format int32 */
1877
+ current_pages?: number;
1878
+ /** @format int32 */
1879
+ page_size?: number;
1880
+ data?: AesMidasUMAB2BUser[] | null;
1794
1881
  }
1795
1882
  export interface AesMidasUMAB2CUser {
1796
1883
  allow_feedback?: boolean;
@@ -1819,6 +1906,18 @@ export interface AesMidasUMAB2CUser {
1819
1906
  microservices?: AesMidasUMAUserMicroservice[] | null;
1820
1907
  permissions?: AesMidasUMAPermission[] | null;
1821
1908
  roles?: AesMidasUMARole[] | null;
1909
+ status?: string | null;
1910
+ }
1911
+ export interface AesMidasUMAB2CUserResponsewithPagination {
1912
+ /** @format int32 */
1913
+ total_items?: number;
1914
+ /** @format int32 */
1915
+ total_pages?: number;
1916
+ /** @format int32 */
1917
+ current_pages?: number;
1918
+ /** @format int32 */
1919
+ page_size?: number;
1920
+ data?: AesMidasUMAB2CUser[] | null;
1822
1921
  }
1823
1922
  export interface AesMidasUMABranch {
1824
1923
  code?: string | null;
@@ -1851,6 +1950,17 @@ export interface AesMidasUMAFirm {
1851
1950
  updated_at?: string | null;
1852
1951
  twilio_creds?: AesMidasUMATwilioCreds;
1853
1952
  }
1953
+ export interface AesMidasUMAFirmResponsewithPagination {
1954
+ /** @format int32 */
1955
+ total_items?: number;
1956
+ /** @format int32 */
1957
+ total_pages?: number;
1958
+ /** @format int32 */
1959
+ current_pages?: number;
1960
+ /** @format int32 */
1961
+ page_size?: number;
1962
+ data?: AesMidasUMAFirm[] | null;
1963
+ }
1854
1964
  export interface AesMidasUMAFirmBasic {
1855
1965
  /** @format int32 */
1856
1966
  admins_count?: number;
@@ -2026,6 +2136,11 @@ export interface AesMidasUserDataConfig {
2026
2136
  /** @format int32 */
2027
2137
  thailand?: number;
2028
2138
  /** @format int32 */
2139
+ australia?: number;
2140
+ /** @format int32 */
2141
+ new_zealand?: number;
2142
+ company_profile?: boolean;
2143
+ /** @format int32 */
2029
2144
  us_chart?: number;
2030
2145
  option_chart?: boolean;
2031
2146
  international_chart?: boolean;
@@ -2085,6 +2200,28 @@ export interface AesMidasUserEntitlementHistory {
2085
2200
  status?: number;
2086
2201
  file_id?: string | null;
2087
2202
  }
2203
+ export interface AesMidasUserEntitlementHistoryResponsewithPagination {
2204
+ /** @format int32 */
2205
+ total_items?: number;
2206
+ /** @format int32 */
2207
+ total_pages?: number;
2208
+ /** @format int32 */
2209
+ current_pages?: number;
2210
+ /** @format int32 */
2211
+ page_size?: number;
2212
+ data?: AesMidasUserEntitlementHistory[] | null;
2213
+ }
2214
+ export interface AesMidasUserEntitlementResponsewithPagination {
2215
+ /** @format int32 */
2216
+ total_items?: number;
2217
+ /** @format int32 */
2218
+ total_pages?: number;
2219
+ /** @format int32 */
2220
+ current_pages?: number;
2221
+ /** @format int32 */
2222
+ page_size?: number;
2223
+ data?: AesMidasUserEntitlement[] | null;
2224
+ }
2088
2225
  export interface AesMidasUserInformation {
2089
2226
  /** @minLength 1 */
2090
2227
  id: string;
@@ -2137,12 +2274,12 @@ export class DataSource<HandleError extends boolean = boolean> {
2137
2274
  /**
2138
2275
  * @description All parameters are optional
2139
2276
  * @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
2277
+ * @name PostDataSourceList
2278
+ * @summary Query all DataSources in the whole system with optional filters - All users
2279
+ * @request POST:/api/datasource/data-source-list
2143
2280
  * @secure
2144
2281
  */
2145
- getDataSourceList(query?: {
2282
+ postDataSourceList(data: AesMidasQueryPostBody, query?: {
2146
2283
  /** Datasource name */
2147
2284
  name?: string;
2148
2285
  /** entitlement name */
@@ -2154,22 +2291,22 @@ export class DataSource<HandleError extends boolean = boolean> {
2154
2291
  inuse?: number;
2155
2292
  /** category */
2156
2293
  category?: string;
2157
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource[], HandleError>>;
2294
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
2158
2295
  /**
2159
2296
  * @tags DataSource
2160
2297
  * @name GetDataSource
2161
- * @summary Query a specific DataSource by unique DataSource Name - All users - available in Microservice
2298
+ * @summary Query a specific DataSource by unique DataSource Name
2162
2299
  * @request GET:/api/datasource/data-source
2163
2300
  * @secure
2164
2301
  */
2165
- getDataSource(query?: {
2166
- name?: string;
2302
+ getDataSource(query: {
2303
+ name: string;
2167
2304
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
2168
2305
  /**
2169
2306
  * @description Create a new DataSource with/without an existing Entitlement
2170
2307
  * @tags DataSource
2171
2308
  * @name PostDataSource
2172
- * @summary Create a new DataSource - Super admin - available in Microservice
2309
+ * @summary Create a new DataSource
2173
2310
  * @request POST:/api/datasource/data-source
2174
2311
  * @secure
2175
2312
  */
@@ -2178,36 +2315,43 @@ export class DataSource<HandleError extends boolean = boolean> {
2178
2315
  * @description If modification is Entitlement related, server will unsign old entitlement in firms and users
2179
2316
  * @tags DataSource
2180
2317
  * @name PutDataSource
2181
- * @summary Update an existing DataSource - Super admin - available in Microservice
2318
+ * @summary Update an existing DataSource
2182
2319
  * @request PUT:/api/datasource/data-source
2183
2320
  * @secure
2184
2321
  */
2185
- putDataSource(data: AesMidasDataSource, query?: {
2186
- name?: string;
2187
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2322
+ putDataSource(query: {
2323
+ name: string;
2324
+ }, data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2188
2325
  /**
2189
2326
  * @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
2190
2327
  * @tags DataSource
2191
2328
  * @name DeleteDataSource
2192
- * @summary Delete an existing DataSource - Super admin - available in Microservice
2329
+ * @summary Delete an existing DataSource
2193
2330
  * @request DELETE:/api/datasource/data-source
2194
2331
  * @secure
2195
2332
  */
2196
- deleteDataSource(query?: {
2197
- name?: string;
2333
+ deleteDataSource(query: {
2334
+ name: string;
2198
2335
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2199
2336
  /**
2200
2337
  * @tags DataSource
2201
2338
  * @name GetDataSourceBitMapping
2202
- * @summary Get All DataSource Bit Mappings - All users - available in Microservice
2203
2339
  * @request GET:/api/datasource/data-source-bit-mapping
2204
2340
  * @secure
2205
2341
  */
2206
2342
  getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2343
+ /**
2344
+ * @tags DataSource
2345
+ * @name GetDataSourceToConfigBitMapping
2346
+ * @summary Get All DataSource name to entitlement field Bit Mappings - All users - available in Microservice
2347
+ * @request GET:/api/datasource/data-source-to-config-bit-mapping
2348
+ * @secure
2349
+ */
2350
+ getDataSourceToConfigBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2207
2351
  /**
2208
2352
  * @tags DataSource
2209
2353
  * @name GetDataSourceTallyCount
2210
- * @summary For ViewTrade admin to generate data source tally report - Super admin - available in Microservice
2354
+ * @summary For ViewTrade admin to generate data source tally report - Super admin
2211
2355
  * @request GET:/api/datasource/data-source-tally-count
2212
2356
  * @secure
2213
2357
  */
@@ -2215,48 +2359,46 @@ export class DataSource<HandleError extends boolean = boolean> {
2215
2359
  /**
2216
2360
  * @tags DataSource
2217
2361
  * @name PostDataSourceTallyReport
2218
- * @summary For ViewTrade admin to generate data source tally report with Pagination and Sort - Super admin - available in Microservice
2362
+ * @summary For ViewTrade admin to generate data source tally report
2219
2363
  * @request POST:/api/datasource/data-source-tally-report
2220
2364
  * @secure
2221
2365
  */
2222
- postDataSourceTallyReport(data: AesMidasQueryPostBody, query?: {
2223
- data_source?: string;
2224
- firm_id?: string;
2225
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2366
+ postDataSourceTallyReport(query: {
2367
+ data_source: string;
2368
+ firm_id: string;
2369
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2226
2370
  }
2227
2371
  export class Entitlement<HandleError extends boolean = boolean> {
2228
2372
  protected readonly apiClient: JwtClient<HandleError>;
2229
2373
  constructor(apiClient: JwtClient<HandleError>);
2230
2374
  /**
2231
- * @description bitwise in Datasource: 1 UTP, 2 CTA, 3 CBOE1, 4 OPRA, 5 DJI, 6 SP500, 7 CAN, 8 SNAPSHOT
2232
2375
  * @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
2376
+ * @name PostEntitlementList
2377
+ * @summary Query all available Entitlements(agreements) in the system
2378
+ * @request POST:/api/entitlement/entitlement-list
2236
2379
  * @secure
2237
2380
  */
2238
- getEntitlementList(query?: {
2381
+ postEntitlementList(data: AesMidasQueryPostBody, query?: {
2239
2382
  /**
2240
2383
  * entielement name, for example 'UTP'. Optional
2241
2384
  * @default ""
2242
2385
  */
2243
2386
  name?: string;
2244
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement[], HandleError>>;
2387
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementResponsewithPagination, HandleError>>;
2245
2388
  /**
2246
2389
  * @tags Entitlement
2247
2390
  * @name GetEntitlement
2248
- * @summary Query a specific Entitlement by unique EntitlementName - All users - available in Microservice
2391
+ * @summary Query a specific Entitlement by unique EntitlementName
2249
2392
  * @request GET:/api/entitlement/entitlement
2250
2393
  * @secure
2251
2394
  */
2252
- getEntitlement(query?: {
2253
- name?: string;
2395
+ getEntitlement(query: {
2396
+ name: string;
2254
2397
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlement, HandleError>>;
2255
2398
  /**
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
2399
  * @tags Entitlement
2258
2400
  * @name PostEntitlement
2259
- * @summary Create a new Entitlement(Agreement) - Super admin - available in Microservice
2401
+ * @summary Create a new Entitlement(Agreement)
2260
2402
  * @request POST:/api/entitlement/entitlement
2261
2403
  * @secure
2262
2404
  */
@@ -2264,74 +2406,74 @@ export class Entitlement<HandleError extends boolean = boolean> {
2264
2406
  /**
2265
2407
  * @tags Entitlement
2266
2408
  * @name PutEntitlement
2267
- * @summary Update an existing Entitlement - Super admin - available in Microservice
2409
+ * @summary Update an existing Entitlement
2268
2410
  * @request PUT:/api/entitlement/entitlement
2269
2411
  * @secure
2270
2412
  */
2271
- putEntitlement(data: AesMidasEntitlementBody, query?: {
2272
- name?: string;
2273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2413
+ putEntitlement(query: {
2414
+ name: string;
2415
+ }, data: AesMidasEntitlementBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2274
2416
  /**
2275
2417
  * @description If an entitlement is being used in a datasource, it cannot be deleted.
2276
2418
  * @tags Entitlement
2277
2419
  * @name DeleteEntitlement
2278
- * @summary Delete an existing Entitlement - Super admin - available in Microservice
2420
+ * @summary Delete an existing Entitlement
2279
2421
  * @request DELETE:/api/entitlement/entitlement
2280
2422
  * @secure
2281
2423
  */
2282
- deleteEntitlement(query?: {
2283
- name?: string;
2424
+ deleteEntitlement(query: {
2425
+ name: string;
2284
2426
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2285
2427
  /**
2286
2428
  * @tags Entitlement
2287
2429
  * @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
2430
+ * @summary Query a specific UserEntitlement by userid and eneitlement name
2289
2431
  * @request GET:/api/entitlement/user-entitlement
2290
2432
  * @secure
2291
2433
  */
2292
- getUserEntitlement(query?: {
2293
- user_id?: string;
2294
- entitlement?: string;
2434
+ getUserEntitlement(query: {
2435
+ user_id: string;
2436
+ entitlement: string;
2295
2437
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement, HandleError>>;
2296
2438
  /**
2297
2439
  * @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
2440
+ * @name PostUserEntitlementList
2441
+ * @summary Query all UserEntitlements for a specific user
2442
+ * @request POST:/api/entitlement/user-entitlement-list
2301
2443
  * @secure
2302
2444
  */
2303
- getUserEntitlementList(query?: {
2445
+ postUserEntitlementList(query: {
2304
2446
  /** user_id, must fill out */
2305
- user_id?: string;
2447
+ user_id: string;
2306
2448
  /** entitlement name, optional */
2307
2449
  entitlement?: string;
2308
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
2450
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementResponsewithPagination, HandleError>>;
2309
2451
  /**
2310
2452
  * @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
2453
+ * @name PostEntitlementUserList
2454
+ * @summary Query all UserEntitlements for a specific Entitlement
2455
+ * @request POST:/api/entitlement/entitlement-user-list
2314
2456
  * @secure
2315
2457
  */
2316
- getEntitlementUserList(query?: {
2317
- entitlement?: string;
2318
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlement[], HandleError>>;
2458
+ postEntitlementUserList(query: {
2459
+ entitlement: string;
2460
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementResponsewithPagination, HandleError>>;
2319
2461
  /**
2320
2462
  * @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
2463
+ * @name PostUserEntitlementHistory
2464
+ * @summary Query history for a UserEntitlement
2465
+ * @request POST:/api/entitlement/user-entitlement-history
2324
2466
  * @secure
2325
2467
  */
2326
- getUserEntitlementHistory(query?: {
2327
- user_id?: string;
2328
- entitlement?: string;
2329
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementHistory[], HandleError>>;
2468
+ postUserEntitlementHistory(query: {
2469
+ user_id: string;
2470
+ entitlement: string;
2471
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserEntitlementHistoryResponsewithPagination, HandleError>>;
2330
2472
  /**
2331
2473
  * @description Create a new UserEntitlement if not existing previously. Update UserEntitlement if already exists.
2332
2474
  * @tags Entitlement
2333
2475
  * @name PutSignEntitlement
2334
- * @summary Sign a UserEntitlement - All users - available in Microservice
2476
+ * @summary Sign a UserEntitlement
2335
2477
  * @request PUT:/api/entitlement/sign-entitlement
2336
2478
  * @secure
2337
2479
  */
@@ -2339,30 +2481,30 @@ export class Entitlement<HandleError extends boolean = boolean> {
2339
2481
  /**
2340
2482
  * @tags Entitlement
2341
2483
  * @name PutUnsignEntitlement
2342
- * @summary Unsign a UserEntitlement - End user itself, or firm manager, or super admin - available in Microservice
2484
+ * @summary Unsign a UserEntitlement
2343
2485
  * @request PUT:/api/entitlement/unsign-entitlement
2344
2486
  * @secure
2345
2487
  */
2346
- putUnsignEntitlement(query?: {
2347
- user_id?: string;
2348
- entitlement?: string;
2488
+ putUnsignEntitlement(query: {
2489
+ user_id: string;
2490
+ entitlement: string;
2349
2491
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2350
2492
  /**
2351
2493
  * @tags Entitlement
2352
2494
  * @name GetContractsCount
2353
- * @summary For ViewTrade admin to Get contract counts for a specific firm and entitlement - Super admin - available in Microservice
2495
+ * @summary For ViewTrade admin to Get contract counts for a specific firm and entitlement - Super admin
2354
2496
  * @request GET:/api/entitlement/contracts-count
2355
2497
  * @secure
2356
2498
  */
2357
- getContractsCount(query?: {
2499
+ getContractsCount(query: {
2358
2500
  /** Three letter month name, for example 'Jan' */
2359
- from_month?: string;
2501
+ from_month: string;
2360
2502
  /** for example '2024' */
2361
- from_year?: string;
2503
+ from_year: string;
2362
2504
  /** Three letter month name, for example 'Jan' */
2363
- to_month?: string;
2505
+ to_month: string;
2364
2506
  /** for example '2024' */
2365
- to_year?: string;
2507
+ to_year: string;
2366
2508
  /** true/false, optional */
2367
2509
  professional?: boolean;
2368
2510
  /** true/false, optional */
@@ -2373,41 +2515,41 @@ export class Entitlement<HandleError extends boolean = boolean> {
2373
2515
  /**
2374
2516
  * @tags Entitlement
2375
2517
  * @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
2518
+ * @summary For ViewTrade admin to generate contract counts report
2377
2519
  * @request POST:/api/entitlement/contracts-report
2378
2520
  * @secure
2379
2521
  */
2380
- postContractsReport(data: AesMidasQueryPostBody, query?: {
2381
- firm_id?: string;
2382
- entitlement_name?: string;
2522
+ postContractsReport(query: {
2523
+ firm_id: string;
2524
+ entitlement_name: string;
2383
2525
  /** Three letter month name, for example 'Jan' */
2384
- from_month?: string;
2385
- from_year?: string;
2526
+ from_month: string;
2527
+ from_year: string;
2386
2528
  /** Three letter month name, for example 'Jan' */
2387
- to_month?: string;
2388
- to_year?: string;
2529
+ to_month: string;
2530
+ to_year: string;
2389
2531
  /** true/false, optional */
2390
2532
  professional?: boolean;
2391
2533
  /** true/false, optional */
2392
2534
  admin_or_manager?: boolean;
2393
2535
  /** true/false, optional */
2394
2536
  vendor_of_record?: boolean;
2395
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractRecordsResponsewithPagination, HandleError>>;
2537
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasContractRecordsResponsewithPagination, HandleError>>;
2396
2538
  /**
2397
2539
  * @tags Entitlement
2398
2540
  * @name GetFirmEntitlement
2399
- * @summary Query a specific FirmEntitlement - Firm manager, or super admin - available in Microservice
2541
+ * @summary Query a specific FirmEntitlement
2400
2542
  * @request GET:/api/entitlement/firm-entitlement
2401
2543
  * @secure
2402
2544
  */
2403
- getFirmEntitlement(query?: {
2404
- firm_id?: string;
2405
- entitlement?: string;
2545
+ getFirmEntitlement(query: {
2546
+ firm_id: string;
2547
+ entitlement: string;
2406
2548
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement, HandleError>>;
2407
2549
  /**
2408
2550
  * @tags Entitlement
2409
2551
  * @name PostFirmEntitlement
2410
- * @summary Create a new FirmEntitlement - Super admin - available in Microservice
2552
+ * @summary Create a new FirmEntitlement
2411
2553
  * @request POST:/api/entitlement/firm-entitlement
2412
2554
  * @secure
2413
2555
  */
@@ -2416,60 +2558,58 @@ export class Entitlement<HandleError extends boolean = boolean> {
2416
2558
  * @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
2559
  * @tags Entitlement
2418
2560
  * @name PutFirmEntitlement
2419
- * @summary Upadte an existing FirmEntitlement - Super admin - available in Microservice
2561
+ * @summary Upadte an existing FirmEntitlement
2420
2562
  * @request PUT:/api/entitlement/firm-entitlement
2421
2563
  * @secure
2422
2564
  */
2423
- putFirmEntitlement(data: AesMidasFirmEntitlement, query?: {
2424
- firm_id?: string;
2425
- entitlement?: string;
2426
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2565
+ putFirmEntitlement(query: {
2566
+ firm_id: string;
2567
+ entitlement: string;
2568
+ }, data: AesMidasFirmEntitlement, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2427
2569
  /**
2428
2570
  * @description !Caution! This action will unsign all UserEntitlements in this firm for the relevant entitlement.
2429
2571
  * @tags Entitlement
2430
2572
  * @name DeleteFirmEntitlement
2431
- * @summary Delete an existing FirmEntitlement - Super admin - available in Microservice
2573
+ * @summary Delete an existing FirmEntitlement
2432
2574
  * @request DELETE:/api/entitlement/firm-entitlement
2433
2575
  * @secure
2434
2576
  */
2435
- deleteFirmEntitlement(query?: {
2436
- firm_id?: string;
2437
- entitlement?: string;
2577
+ deleteFirmEntitlement(query: {
2578
+ firm_id: string;
2579
+ entitlement: string;
2438
2580
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2439
2581
  /**
2440
2582
  * @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
2583
+ * @name PostFirmEntitlementList
2584
+ * @summary Query all FirmEntitlements for a specific firm
2585
+ * @request POST:/api/entitlement/firm-entitlement-list
2444
2586
  * @secure
2445
2587
  */
2446
- getFirmEntitlementList(query?: {
2447
- /** firm id, must fill this parameter */
2448
- firm_id?: string;
2449
- /** entitlement name, option filter parameter */
2588
+ postFirmEntitlementList(query: {
2589
+ firm_id: string;
2450
2590
  entitlement_name?: string;
2451
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
2591
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementResponsewithPagination, HandleError>>;
2452
2592
  /**
2453
2593
  * @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
2594
+ * @name PostEntitlementFirmList
2595
+ * @summary Query all FirmEntitlements for a specific Entitlement
2596
+ * @request POST:/api/entitlement/entitlement-firm-list
2457
2597
  * @secure
2458
2598
  */
2459
- getEntitlementFirmList(query?: {
2460
- entitlement?: string;
2461
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlement[], HandleError>>;
2599
+ postEntitlementFirmList(query: {
2600
+ entitlement: string;
2601
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementResponsewithPagination, HandleError>>;
2462
2602
  /**
2463
2603
  * @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
2604
+ * @name PostFirmEntitlementHistory
2605
+ * @summary Query history of a specific FirmEntitlement
2606
+ * @request POST:/api/entitlement/firm-entitlement-history
2467
2607
  * @secure
2468
2608
  */
2469
- getFirmEntitlementHistory(query?: {
2470
- firm_id?: string;
2471
- entitlement?: string;
2472
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistory[], HandleError>>;
2609
+ postFirmEntitlementHistory(query: {
2610
+ firm_id: string;
2611
+ entitlement: string;
2612
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
2473
2613
  }
2474
2614
  export class File<HandleError extends boolean = boolean> {
2475
2615
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2477,7 +2617,7 @@ export class File<HandleError extends boolean = boolean> {
2477
2617
  /**
2478
2618
  * @tags File
2479
2619
  * @name PostUpload
2480
- * @summary upload file - All users - available in Microservice
2620
+ * @summary upload file
2481
2621
  * @request POST:/api/file/upload
2482
2622
  * @secure
2483
2623
  */
@@ -2485,46 +2625,44 @@ export class File<HandleError extends boolean = boolean> {
2485
2625
  /**
2486
2626
  * @tags File
2487
2627
  * @name GetDownload
2488
- * @summary download file by file id - All users - available in Microservice
2628
+ * @summary download file by file id
2489
2629
  * @request GET:/api/file/download
2490
2630
  * @secure
2491
2631
  */
2492
- getDownload(query?: {
2493
- file_id?: string;
2632
+ getDownload(query: {
2633
+ file_id: string;
2494
2634
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
2495
2635
  }
2496
2636
  export class Firm<HandleError extends boolean = boolean> {
2497
2637
  protected readonly apiClient: JwtClient<HandleError>;
2498
2638
  constructor(apiClient: JwtClient<HandleError>);
2499
2639
  /**
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?: {
2640
+ * @tags Firm
2641
+ * @name PostFirmList
2642
+ * @summary Query all Firms in the system
2643
+ * @request POST:/api/firm/firm-list
2644
+ * @secure
2645
+ */
2646
+ postFirmList(data: AesMidasQueryPostBody, query?: {
2509
2647
  /** firm_id, optional */
2510
2648
  firm_id?: string;
2511
2649
  /** firm name, fuzzy search, optional */
2512
2650
  name?: string;
2513
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm[], HandleError>>;
2651
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
2514
2652
  /**
2515
2653
  * @tags Firm
2516
2654
  * @name GetFirm
2517
- * @summary Query a specific Firm by firmid(short name) - All users - available in Microservice
2655
+ * @summary Query a specific Firm by firmid(short name)
2518
2656
  * @request GET:/api/firm/firm
2519
2657
  * @secure
2520
2658
  */
2521
- getFirm(query?: {
2522
- firm_id?: string;
2659
+ getFirm(query: {
2660
+ firm_id: string;
2523
2661
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
2524
2662
  /**
2525
2663
  * @tags Firm
2526
2664
  * @name PostFirm
2527
- * @summary Create a new Firm - Super admin - available in Microservice
2665
+ * @summary Create a new Firm
2528
2666
  * @request POST:/api/firm/firm
2529
2667
  * @secure
2530
2668
  */
@@ -2533,36 +2671,36 @@ For Microservice: only return 'UMA' source firms
2533
2671
  * @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
2534
2672
  * @tags Firm
2535
2673
  * @name PutFirm
2536
- * @summary Update an existing Firm setting - Super admin - available in Microservice
2674
+ * @summary Update an existing Firm setting
2537
2675
  * @request PUT:/api/firm/firm
2538
2676
  * @secure
2539
2677
  */
2540
- putFirm(data: AesMidasFirm, query?: {
2541
- firm_id?: string;
2542
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2678
+ putFirm(query: {
2679
+ firm_id: string;
2680
+ }, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2543
2681
  /**
2544
2682
  * @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
2545
2683
  * @tags Firm
2546
2684
  * @name GetFirmDataAccess
2547
- * @summary Get which data sources that a firm can access - All users - available in Microservice
2685
+ * @summary Get which data sources that a firm can access
2548
2686
  * @request GET:/api/firm/firm-data-access
2549
2687
  * @secure
2550
2688
  */
2551
- getFirmDataAccess(query?: {
2552
- firm_id?: string;
2689
+ getFirmDataAccess(query: {
2690
+ firm_id: string;
2553
2691
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
2554
2692
  /**
2555
2693
  * @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
2694
+ * @name PostUmaFirmList
2695
+ * @summary Get all firms from UMA - Super admin
2696
+ * @request POST:/api/firm/uma-firm-list
2559
2697
  * @secure
2560
2698
  */
2561
- getUmaFirmList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirm[], HandleError>>;
2699
+ postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
2562
2700
  /**
2563
2701
  * @tags Firm
2564
2702
  * @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
2703
+ * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
2566
2704
  * @request GET:/api/firm/system-firm-default-data
2567
2705
  * @secure
2568
2706
  */
@@ -2570,7 +2708,7 @@ For Microservice: only return 'UMA' source firms
2570
2708
  /**
2571
2709
  * @tags Firm
2572
2710
  * @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
2711
+ * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
2574
2712
  * @request PUT:/api/firm/system-firm-default-data
2575
2713
  * @secure
2576
2714
  */
@@ -2578,35 +2716,35 @@ For Microservice: only return 'UMA' source firms
2578
2716
  /**
2579
2717
  * @tags Firm
2580
2718
  * @name GetFirmDefaultData
2581
- * @summary Query a specific Firm Default Data Setting by firmid(short name) - All users - available in Microservice
2719
+ * @summary Query a specific Firm Default Data Setting by firmid(short name)
2582
2720
  * @request GET:/api/firm/firm-default-data
2583
2721
  * @secure
2584
2722
  */
2585
- getFirmDefaultData(query?: {
2586
- firm_id?: string;
2723
+ getFirmDefaultData(query: {
2724
+ firm_id: string;
2587
2725
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
2588
2726
  /**
2589
2727
  * @description New default data must within firm data access availability
2590
2728
  * @tags Firm
2591
2729
  * @name PostFirmDefaultData
2592
- * @summary Create Firm Default Data setting for a specific firm - Firm manager, or super admin - available in Microservice
2730
+ * @summary Create Firm Default Data setting for a specific firm
2593
2731
  * @request POST:/api/firm/firm-default-data
2594
2732
  * @secure
2595
2733
  */
2596
- postFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
2597
- firm_id?: string;
2598
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2734
+ postFirmDefaultData(query: {
2735
+ firm_id: string;
2736
+ }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2599
2737
  /**
2600
2738
  * @description New default data must within firm data access availability
2601
2739
  * @tags Firm
2602
2740
  * @name PutFirmDefaultData
2603
- * @summary Update an existing Firm Default Data setting - Firm manager, or super admin - available in Microservice
2741
+ * @summary Update an existing Firm Default Data setting
2604
2742
  * @request PUT:/api/firm/firm-default-data
2605
2743
  * @secure
2606
2744
  */
2607
- putFirmDefaultData(data: AesMidasFirmDefaultDataSetting, query?: {
2608
- firm_id?: string;
2609
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2745
+ putFirmDefaultData(query: {
2746
+ firm_id: string;
2747
+ }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2610
2748
  }
2611
2749
  export class FundWebQuote<HandleError extends boolean = boolean> {
2612
2750
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2614,17 +2752,15 @@ export class FundWebQuote<HandleError extends boolean = boolean> {
2614
2752
  /**
2615
2753
  * @tags FundWebQuote
2616
2754
  * @name GetFund
2617
- * @summary Get a specific fund data - Internal use only - available in Microservice
2618
2755
  * @request GET:/api/fund/fund
2619
2756
  * @secure
2620
2757
  */
2621
- getFund(query?: {
2622
- symbol?: string;
2758
+ getFund(query: {
2759
+ symbol: string;
2623
2760
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
2624
2761
  /**
2625
2762
  * @tags FundWebQuote
2626
2763
  * @name GetFundList
2627
- * @summary Get all availabe fund data - Internal use only - available in Microservice
2628
2764
  * @request GET:/api/fund/fund-list
2629
2765
  * @secure
2630
2766
  */
@@ -2636,95 +2772,87 @@ export class Log<HandleError extends boolean = boolean> {
2636
2772
  /**
2637
2773
  * @tags Log
2638
2774
  * @name GetDataQueryActionList
2639
- * @summary Query all data query action list in the system - Super admin - available in Microservice
2775
+ * @summary Query all data query action list in the system
2640
2776
  * @request GET:/api/log/data-query-action-list
2641
2777
  * @secure
2642
2778
  */
2643
2779
  getDataQueryActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
2644
2780
  /**
2645
2781
  * @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
2782
+ * @name PostDataQueryLogByAction
2783
+ * @summary Query data query logs by a specific query and date range
2784
+ * @request POST:/api/log/data-query-log-by-action
2649
2785
  * @secure
2650
2786
  */
2651
- getDataQueryLogByAction(query?: {
2652
- action?: string;
2653
- 'start_date(UTC)'?: string;
2654
- 'end_date(UTC)'?: string;
2655
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLog[], HandleError>>;
2787
+ postDataQueryLogByAction(query: {
2788
+ action: string;
2789
+ 'start_date(UTC)': string;
2790
+ 'end_date(UTC)': string;
2791
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
2656
2792
  /**
2657
2793
  * @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
2794
+ * @name PostDataQueryLogByDataSource
2795
+ * @summary Query data query logs by a specific data source and date range and return for report
2796
+ * @request POST:/api/log/data-query-log-by-data-source
2661
2797
  * @secure
2662
2798
  */
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>>;
2799
+ postDataQueryLogByDataSource(query: {
2800
+ data_source: string;
2801
+ 'start_date(UTC)': string;
2802
+ 'end_date(UTC)': string;
2803
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
2668
2804
  /**
2669
2805
  * @tags Log
2670
2806
  * @name GetSnapshotCount
2671
- * @summary Query snapshot report counts - Super admin - available in Microservice
2807
+ * @summary Query snapshot report counts - Super admin
2672
2808
  * @request GET:/api/log/snapshot-count
2673
2809
  * @secure
2674
2810
  */
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 */
2811
+ getSnapshotCount(query: {
2812
+ 'start_date(UTC)': string;
2813
+ 'end_date(UTC)': string;
2681
2814
  market_hour_only?: boolean;
2682
2815
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
2683
2816
  /**
2684
2817
  * @tags Log
2685
2818
  * @name PostSnapshotReport
2686
- * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin - available in Microservice
2819
+ * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin
2687
2820
  * @request POST:/api/log/snapshot-report
2688
2821
  * @secure
2689
2822
  */
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 */
2823
+ postSnapshotReport(query: {
2824
+ 'start_date(UTC)': string;
2825
+ 'end_date(UTC)': string;
2826
+ firm_id: string;
2827
+ exchange: string;
2700
2828
  market_hour_only?: boolean;
2701
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
2829
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
2702
2830
  /**
2703
2831
  * @tags Log
2704
2832
  * @name GetModificationActionList
2705
- * @summary Query all modification actions list in the system - Super admin - available in Microservice
2833
+ * @summary Query all modification actions list in the system
2706
2834
  * @request GET:/api/log/modification-action-list
2707
2835
  * @secure
2708
2836
  */
2709
2837
  getModificationActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
2710
2838
  /**
2711
2839
  * @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
2840
+ * @name PostModificationLogByAction
2841
+ * @summary Query login/out and modification actions logs by a specific action and date range
2842
+ * @request POST:/api/log/modification-log-by-action
2715
2843
  * @secure
2716
2844
  */
2717
- getModificationLogByAction(query?: {
2845
+ postModificationLogByAction(query: {
2718
2846
  /** 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;
2847
+ action: string;
2848
+ 'start_date(UTC)': string;
2849
+ 'end_date(UTC)': string;
2722
2850
  /**
2723
2851
  * optional
2724
2852
  * @default ""
2725
2853
  */
2726
2854
  target_user?: string;
2727
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLog[], HandleError>>;
2855
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
2728
2856
  }
2729
2857
  export class Permission<HandleError extends boolean = boolean> {
2730
2858
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2732,7 +2860,6 @@ export class Permission<HandleError extends boolean = boolean> {
2732
2860
  /**
2733
2861
  * @tags Permission
2734
2862
  * @name PostPermission
2735
- * @summary Create permission for a user - Internal use only - Super admin - available in Microservice
2736
2863
  * @request POST:/api/permission/permission
2737
2864
  * @secure
2738
2865
  */
@@ -2740,22 +2867,20 @@ export class Permission<HandleError extends boolean = boolean> {
2740
2867
  /**
2741
2868
  * @tags Permission
2742
2869
  * @name GetPermission
2743
- * @summary Get permission for a user - Internal use only - Super admin - available in Microservice
2744
2870
  * @request GET:/api/permission/permission
2745
2871
  * @secure
2746
2872
  */
2747
- getPermission(query?: {
2748
- user_name?: string;
2873
+ getPermission(query: {
2874
+ user_name: string;
2749
2875
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
2750
2876
  /**
2751
2877
  * @tags Permission
2752
2878
  * @name DeletePermission
2753
- * @summary Delete permission for a user - Internal use only - Super admin - available in Microservice
2754
2879
  * @request DELETE:/api/permission/permission
2755
2880
  * @secure
2756
2881
  */
2757
- deletePermission(query?: {
2758
- user_name?: string;
2882
+ deletePermission(query: {
2883
+ user_name: string;
2759
2884
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2760
2885
  }
2761
2886
  export class Quote<HandleError extends boolean = boolean> {
@@ -2764,7 +2889,7 @@ export class Quote<HandleError extends boolean = boolean> {
2764
2889
  /**
2765
2890
  * @tags Quote
2766
2891
  * @name PostSymbolSearch
2767
- * @summary Symbol screener - All users - available in Microservice version
2892
+ * @summary Symbol screener - All users
2768
2893
  * @request POST:/api/quote/symbol-search
2769
2894
  * @secure
2770
2895
  */
@@ -2782,13 +2907,13 @@ export class Quote<HandleError extends boolean = boolean> {
2782
2907
  /**
2783
2908
  * @tags Quote
2784
2909
  * @name GetBestQuote
2785
- * @summary Query Best Quote(Level 1 data) - All users - available in Microservice
2910
+ * @summary Query Best Quote(Level 1 data) - All users
2786
2911
  * @request GET:/api/quote/best-quote
2787
2912
  * @secure
2788
2913
  */
2789
- getBestQuote(query?: {
2914
+ getBestQuote(query: {
2790
2915
  /** Allow multiple symbols query, seperated by ',' */
2791
- symbols?: string;
2916
+ symbols: string;
2792
2917
  /**
2793
2918
  * Optional. Default is false. If true, response will be camel case
2794
2919
  * @default false
@@ -2805,13 +2930,13 @@ export class Quote<HandleError extends boolean = boolean> {
2805
2930
  /**
2806
2931
  * @tags Quote
2807
2932
  * @name GetNbboSnapshot
2808
- * @summary Query NBBO Snapshot - All users - available in Microservice
2933
+ * @summary Query NBBO Snapshot - All users
2809
2934
  * @request GET:/api/quote/nbbo-snapshot
2810
2935
  * @secure
2811
2936
  */
2812
- getNbboSnapshot(query?: {
2937
+ getNbboSnapshot(query: {
2813
2938
  /** Allow multiple symbols query, seperated by ',' */
2814
- symbols?: string;
2939
+ symbols: string;
2815
2940
  /**
2816
2941
  * Optional. Default is false. If true, response will be camel case
2817
2942
  * @default false
@@ -2828,13 +2953,13 @@ export class Quote<HandleError extends boolean = boolean> {
2828
2953
  /**
2829
2954
  * @tags Quote
2830
2955
  * @name GetLevel1
2831
- * @summary Query full Level 1 data - All users - available in Microservice
2956
+ * @summary Query full Level 1 data - All users
2832
2957
  * @request GET:/api/quote/level1
2833
2958
  * @secure
2834
2959
  */
2835
- getLevel1(query?: {
2960
+ getLevel1(query: {
2836
2961
  /** Allow multiple symbols, separated by ',' */
2837
- symbols?: string;
2962
+ symbols: string;
2838
2963
  /**
2839
2964
  * Optional. Default is false. If true, response will be camel case
2840
2965
  * @default false
@@ -2851,13 +2976,13 @@ export class Quote<HandleError extends boolean = boolean> {
2851
2976
  /**
2852
2977
  * @tags Quote
2853
2978
  * @name GetRegionQuotes
2854
- * @summary Query Region Quotes from Tick data - All users - available in Microservice
2979
+ * @summary Query Region Quotes from Tick data - All users
2855
2980
  * @request GET:/api/quote/region-quotes
2856
2981
  * @secure
2857
2982
  */
2858
- getRegionQuotes(query?: {
2983
+ getRegionQuotes(query: {
2859
2984
  /** Allow one symbol */
2860
- symbol?: string;
2985
+ symbol: string;
2861
2986
  /**
2862
2987
  * Optional. Default is false. If true, response will be camel case
2863
2988
  * @default false
@@ -2874,13 +2999,13 @@ export class Quote<HandleError extends boolean = boolean> {
2874
2999
  /**
2875
3000
  * @tags Quote
2876
3001
  * @name GetTimeSale
2877
- * @summary Query TimeSale from Tick data - All users - available in Microservice
3002
+ * @summary Query TimeSale from Tick data - All users
2878
3003
  * @request GET:/api/quote/time-sale
2879
3004
  * @secure
2880
3005
  */
2881
- getTimeSale(query?: {
3006
+ getTimeSale(query: {
2882
3007
  /** Allow one symbol */
2883
- symbol?: string;
3008
+ symbol: string;
2884
3009
  /**
2885
3010
  * Optional. Default is false. If true, response will be camel case
2886
3011
  * @default false
@@ -2897,13 +3022,13 @@ export class Quote<HandleError extends boolean = boolean> {
2897
3022
  /**
2898
3023
  * @tags Quote
2899
3024
  * @name GetLastTrade
2900
- * @summary Query Last Trade(Level 2 data) - All users - available in Microservice
3025
+ * @summary Query Last Trade(Level 2 data) - All users
2901
3026
  * @request GET:/api/quote/last-trade
2902
3027
  * @secure
2903
3028
  */
2904
- getLastTrade(query?: {
3029
+ getLastTrade(query: {
2905
3030
  /** Allow multiple symbols query, seperated by ',' */
2906
- symbols?: string;
3031
+ symbols: string;
2907
3032
  /**
2908
3033
  * Optional. Default is false. If true, response will be camel case
2909
3034
  * @default false
@@ -2920,14 +3045,17 @@ export class Quote<HandleError extends boolean = boolean> {
2920
3045
  /**
2921
3046
  * @tags Quote
2922
3047
  * @name GetIntradayChart
2923
- * @summary Query intra-day Day Chart and Minute Chart - All users - available in Microservice
3048
+ * @summary Query intra-day Day Chart and Minute Chart - All users
2924
3049
  * @request GET:/api/quote/intraday-chart
2925
3050
  * @secure
2926
3051
  */
2927
- getIntradayChart(query?: {
3052
+ getIntradayChart(query: {
2928
3053
  /** Allow one symbol */
2929
- symbol?: string;
2930
- /** 'D' for day chart, 'M' for minute chart */
3054
+ symbol: string;
3055
+ /**
3056
+ * 'D' for day chart, 'M' for minute chart
3057
+ * @default "D"
3058
+ */
2931
3059
  day_minute?: string;
2932
3060
  /**
2933
3061
  * Optional. Default is false. If true, response will be camel case
@@ -2945,13 +3073,13 @@ export class Quote<HandleError extends boolean = boolean> {
2945
3073
  /**
2946
3074
  * @tags Quote
2947
3075
  * @name GetHistoricalDayChart
2948
- * @summary Query Historical Day Chart - All users - available in Microservice
3076
+ * @summary Query Historical Day Chart - All users
2949
3077
  * @request GET:/api/quote/historical-day-chart
2950
3078
  * @secure
2951
3079
  */
2952
- getHistoricalDayChart(query?: {
3080
+ getHistoricalDayChart(query: {
2953
3081
  /** Allow one symbol */
2954
- symbol?: string;
3082
+ symbol: string;
2955
3083
  /**
2956
3084
  * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
2957
3085
  * @default ""
@@ -2979,13 +3107,13 @@ export class Quote<HandleError extends boolean = boolean> {
2979
3107
  /**
2980
3108
  * @tags Quote
2981
3109
  * @name GetHistoricalMinuteChart
2982
- * @summary Query Historical Minute Chart - All users - available in Microservice
3110
+ * @summary Query Historical Minute Chart - All users
2983
3111
  * @request GET:/api/quote/historical-minute-chart
2984
3112
  * @secure
2985
3113
  */
2986
- getHistoricalMinuteChart(query?: {
3114
+ getHistoricalMinuteChart(query: {
2987
3115
  /** Allow one symbol */
2988
- symbol?: string;
3116
+ symbol: string;
2989
3117
  /** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
2990
3118
  date?: string;
2991
3119
  /**
@@ -3004,7 +3132,7 @@ export class Quote<HandleError extends boolean = boolean> {
3004
3132
  /**
3005
3133
  * @tags Quote
3006
3134
  * @name GetTop20
3007
- * @summary Query Top20 data - All users - available in Microservice
3135
+ * @summary Query Top20 data - All users
3008
3136
  * @request GET:/api/quote/top-20
3009
3137
  * @secure
3010
3138
  */
@@ -3022,13 +3150,13 @@ export class Quote<HandleError extends boolean = boolean> {
3022
3150
  /**
3023
3151
  * @tags Quote
3024
3152
  * @name GetOptionChainDates
3025
- * @summary Query Option Chain dates - All users - available in Microservice
3153
+ * @summary Query Option Chain dates - All users
3026
3154
  * @request GET:/api/quote/option-chain-dates
3027
3155
  * @secure
3028
3156
  */
3029
- getOptionChainDates(query?: {
3157
+ getOptionChainDates(query: {
3030
3158
  /** Allow one underlying symbol */
3031
- symbol?: string;
3159
+ symbol: string;
3032
3160
  /**
3033
3161
  * Optional. Default is false. If true, response will be camel case
3034
3162
  * @default false
@@ -3045,15 +3173,15 @@ export class Quote<HandleError extends boolean = boolean> {
3045
3173
  /**
3046
3174
  * @tags Quote
3047
3175
  * @name GetOptionChain
3048
- * @summary Query Option Chain data - All users - available in Microservice
3176
+ * @summary Query Option Chain data - All users
3049
3177
  * @request GET:/api/quote/option-chain
3050
3178
  * @secure
3051
3179
  */
3052
- getOptionChain(query?: {
3180
+ getOptionChain(query: {
3053
3181
  /** Allow one underlying symbol */
3054
- underlying?: string;
3182
+ underlying: string;
3055
3183
  /** allow one date, format YYYY-MM-DD */
3056
- date?: string;
3184
+ date: string;
3057
3185
  /**
3058
3186
  * Optional. Default is false. If true, response will be camel case
3059
3187
  * @default false
@@ -3070,13 +3198,13 @@ export class Quote<HandleError extends boolean = boolean> {
3070
3198
  /**
3071
3199
  * @tags Quote
3072
3200
  * @name GetOptionLevel1
3073
- * @summary Query Option Level 1 data - All users - available in Microservice
3201
+ * @summary Query Option Level 1 data - All users
3074
3202
  * @request GET:/api/quote/option-level1
3075
3203
  * @secure
3076
3204
  */
3077
- getOptionLevel1(query?: {
3205
+ getOptionLevel1(query: {
3078
3206
  /** Allow multiple option symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3079
- option_names?: string;
3207
+ option_names: string;
3080
3208
  /**
3081
3209
  * Optional. Default is false. If true, response will be camel case
3082
3210
  * @default false
@@ -3093,13 +3221,13 @@ export class Quote<HandleError extends boolean = boolean> {
3093
3221
  /**
3094
3222
  * @tags Quote
3095
3223
  * @name GetOptionLevel1WithGreek
3096
- * @summary Query Option Level 1 data - All users - available in Microservice
3224
+ * @summary Query Option Level 1 data - All users
3097
3225
  * @request GET:/api/quote/option-level1-with-greek
3098
3226
  * @secure
3099
3227
  */
3100
- getOptionLevel1WithGreek(query?: {
3228
+ getOptionLevel1WithGreek(query: {
3101
3229
  /** Allow multiple symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3102
- option_names?: string;
3230
+ option_names: string;
3103
3231
  /**
3104
3232
  * Optional. Default is false. If true, response will be camel case
3105
3233
  * @default false
@@ -3121,13 +3249,13 @@ export class Quote<HandleError extends boolean = boolean> {
3121
3249
  /**
3122
3250
  * @tags Quote
3123
3251
  * @name GetOptionDayChart
3124
- * @summary Query Option Day Chart - All users - available in Microservice
3252
+ * @summary Query Option Day Chart - All users
3125
3253
  * @request GET:/api/quote/option-day-chart
3126
3254
  * @secure
3127
3255
  */
3128
- getOptionDayChart(query?: {
3256
+ getOptionDayChart(query: {
3129
3257
  /** Allow one symbol */
3130
- symbol?: string;
3258
+ symbol: string;
3131
3259
  /**
3132
3260
  * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
3133
3261
  * @default ""
@@ -3155,15 +3283,15 @@ export class Quote<HandleError extends boolean = boolean> {
3155
3283
  /**
3156
3284
  * @tags Quote
3157
3285
  * @name GetEquiductLevel1
3158
- * @summary Query Equiduct Level 1 data - All users - available in Microservice
3286
+ * @summary Query Equiduct Level 1 data - All users
3159
3287
  * @request GET:/api/quote/equiduct-level1
3160
3288
  * @secure
3161
3289
  */
3162
- getEquiductLevel1(query?: {
3290
+ getEquiductLevel1(query: {
3163
3291
  /** Allow multiple symbols, separated by ',' */
3164
- symbols?: string;
3292
+ symbols: string;
3165
3293
  /**
3166
- * True to query realtime data, False to query delay data
3294
+ * True to query realtime data, False to query delay data. Default is false.
3167
3295
  * @default false
3168
3296
  */
3169
3297
  realtime?: boolean;
@@ -3183,13 +3311,13 @@ export class Quote<HandleError extends boolean = boolean> {
3183
3311
  /**
3184
3312
  * @tags Quote
3185
3313
  * @name GetBonds
3186
- * @summary Query Bonds data - All users - available in Microservice
3314
+ * @summary Query Bonds data - All users
3187
3315
  * @request GET:/api/quote/bonds
3188
3316
  * @secure
3189
3317
  */
3190
- getBonds(query?: {
3318
+ getBonds(query: {
3191
3319
  /** ISIN, allow multiple query separated by ',' */
3192
- isins?: string;
3320
+ isins: string;
3193
3321
  /**
3194
3322
  * Price type, default is Percentage. ('Percentage'|'Decimal')
3195
3323
  * @default "Percentage"
@@ -3206,18 +3334,20 @@ export class Quote<HandleError extends boolean = boolean> {
3206
3334
  */
3207
3335
  response_camel_case?: boolean;
3208
3336
  /** @default "" */
3337
+ user_name?: string;
3338
+ /** @default "" */
3209
3339
  platform?: string;
3210
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondWholeApex[], HandleError>>;
3340
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBond[], HandleError>>;
3211
3341
  /**
3212
3342
  * @tags Quote
3213
3343
  * @name GetBondsSearch
3214
- * @summary Search bonds - All users - available in Microservice
3344
+ * @summary Search bonds - All users
3215
3345
  * @request GET:/api/quote/bonds-search
3216
3346
  * @secure
3217
3347
  */
3218
- getBondsSearch(query?: {
3348
+ getBondsSearch(query: {
3219
3349
  /** search string */
3220
- criteria?: string;
3350
+ criteria: string;
3221
3351
  /**
3222
3352
  * how many records that need to return, 20 is maximum
3223
3353
  * @format int32
@@ -3249,20 +3379,21 @@ export class Quote<HandleError extends boolean = boolean> {
3249
3379
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3250
3380
  /**
3251
3381
  * @tags Quote
3252
- * @name GetBondsChart
3253
- * @summary Query Bonds historical chart data - All users - available in Microservice
3254
- * @request GET:/api/quote/bonds-chart
3382
+ * @name GetBondScreenerFieldValues
3383
+ * @summary bond screener field possible values - All users
3384
+ * @request GET:/api/quote/bond-screener-field-values
3255
3385
  * @secure
3256
3386
  */
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;
3387
+ getBondScreenerFieldValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondFieldValues, HandleError>>;
3388
+ /**
3389
+ * @description For fields possible value, please query in endpoint 'bonds-screener-field-values"
3390
+ * @tags Quote
3391
+ * @name PostBondsScreener
3392
+ * @summary Bond screener - All users
3393
+ * @request POST:/api/quote/bonds-screener
3394
+ * @secure
3395
+ */
3396
+ postBondsScreener(data: AesMidasBondSearchBody, query?: {
3266
3397
  /**
3267
3398
  * if response with camel case
3268
3399
  * @default false
@@ -3270,17 +3401,17 @@ export class Quote<HandleError extends boolean = boolean> {
3270
3401
  response_camel_case?: boolean;
3271
3402
  /** @default "" */
3272
3403
  platform?: string;
3273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasHistoricalBondChartApex[], HandleError>>;
3404
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondPagedResult, HandleError>>;
3274
3405
  /**
3275
3406
  * @tags Quote
3276
3407
  * @name GetMutualFunds
3277
- * @summary Query Mutual Funds data - All users - available in Microservice
3408
+ * @summary Query Mutual Funds data - All users
3278
3409
  * @request GET:/api/quote/mutual-funds
3279
3410
  * @secure
3280
3411
  */
3281
- getMutualFunds(query?: {
3412
+ getMutualFunds(query: {
3282
3413
  /** symbol, allow multiple query separated by ',' */
3283
- symbols?: string;
3414
+ symbols: string;
3284
3415
  /**
3285
3416
  * if response with camel case
3286
3417
  * @default false
@@ -3292,13 +3423,13 @@ export class Quote<HandleError extends boolean = boolean> {
3292
3423
  /**
3293
3424
  * @tags Quote
3294
3425
  * @name GetQuoddEod
3295
- * @summary Query QUODD EOD data - All users - available in Microservice
3426
+ * @summary Query QUODD EOD data(mostly are Asian exchanges data)- All users
3296
3427
  * @request GET:/api/quote/quodd-eod
3297
3428
  * @secure
3298
3429
  */
3299
- getQuoddEod(query?: {
3430
+ getQuoddEod(query: {
3300
3431
  /** Allow multiple symbols, separated by ',' */
3301
- symbols?: string;
3432
+ symbols: string;
3302
3433
  /**
3303
3434
  * Optional. Default is false. If true, response will be camel case
3304
3435
  * @default false
@@ -3315,13 +3446,13 @@ export class Quote<HandleError extends boolean = boolean> {
3315
3446
  /**
3316
3447
  * @tags Quote
3317
3448
  * @name GetQuoddDelay
3318
- * @summary Query QUODD Delay data - All users - available in Microservice
3449
+ * @summary Query QUODD Delay data - All users
3319
3450
  * @request GET:/api/quote/quodd-delay
3320
3451
  * @secure
3321
3452
  */
3322
- getQuoddDelay(query?: {
3453
+ getQuoddDelay(query: {
3323
3454
  /** Allow multiple symbols, separated by ',' */
3324
- symbols?: string;
3455
+ symbols: string;
3325
3456
  /**
3326
3457
  * Optional. Default is false. If true, response will be camel case
3327
3458
  * @default false
@@ -3338,13 +3469,13 @@ export class Quote<HandleError extends boolean = boolean> {
3338
3469
  /**
3339
3470
  * @tags Quote
3340
3471
  * @name GetIceIsin
3341
- * @summary Query ICE ISIN data - All users - available in Microservice
3472
+ * @summary Query ICE ISIN data - All users
3342
3473
  * @request GET:/api/quote/ice-isin
3343
3474
  * @secure
3344
3475
  */
3345
- getIceIsin(query?: {
3476
+ getIceIsin(query: {
3346
3477
  /** Allow multiple isins, separated by ',' */
3347
- isins?: string;
3478
+ isins: string;
3348
3479
  /**
3349
3480
  * Optional. Default is false. If true, response will be camel case
3350
3481
  * @default false
@@ -3361,13 +3492,13 @@ export class Quote<HandleError extends boolean = boolean> {
3361
3492
  /**
3362
3493
  * @tags Quote
3363
3494
  * @name GetIceEod
3364
- * @summary Query ICE EOD data - All users - available in Microservice
3495
+ * @summary Query ICE EOD data - All users
3365
3496
  * @request GET:/api/quote/ice-eod
3366
3497
  * @secure
3367
3498
  */
3368
- getIceEod(query?: {
3499
+ getIceEod(query: {
3369
3500
  /** Allow multiple symbols, separated by ',' */
3370
- symbols?: string;
3501
+ symbols: string;
3371
3502
  /**
3372
3503
  * Optional. Default is false. If true, response will be camel case
3373
3504
  * @default false
@@ -3384,13 +3515,13 @@ export class Quote<HandleError extends boolean = boolean> {
3384
3515
  /**
3385
3516
  * @tags Quote
3386
3517
  * @name GetFxRate
3387
- * @summary Query Forex data with symbols - All users - available in Microservice
3518
+ * @summary Query Forex data with symbols - All users
3388
3519
  * @request GET:/api/quote/fx-rate
3389
3520
  * @secure
3390
3521
  */
3391
- getFxRate(query?: {
3522
+ getFxRate(query: {
3392
3523
  /** Allow multiple symbols, separated by ',' */
3393
- symbols?: string;
3524
+ symbols: string;
3394
3525
  /**
3395
3526
  * Optional. Default is false. If true, response will be camel case
3396
3527
  * @default false
@@ -3407,13 +3538,13 @@ export class Quote<HandleError extends boolean = boolean> {
3407
3538
  /**
3408
3539
  * @tags Quote
3409
3540
  * @name GetFxTable
3410
- * @summary Query Forex table for one currency - All users - available in Microservice
3541
+ * @summary Query Forex table for one currency - All users
3411
3542
  * @request GET:/api/quote/fx-table
3412
3543
  * @secure
3413
3544
  */
3414
- getFxTable(query?: {
3545
+ getFxTable(query: {
3415
3546
  /** Allow multiple symbols, separated by ',' */
3416
- symbols?: string;
3547
+ symbols: string;
3417
3548
  /**
3418
3549
  * Optional. Default is false. If true, response will be camel case
3419
3550
  * @default false
@@ -3434,26 +3565,26 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3434
3565
  /**
3435
3566
  * @tags QuotesReformat
3436
3567
  * @name GetEquity
3437
- * @summary Query full Level 1 data - All users - available in Microservice
3568
+ * @summary Query full Level 1 data - All users
3438
3569
  * @request GET:/api/quotes/equity
3439
3570
  * @secure
3440
3571
  */
3441
- getEquity(query?: {
3572
+ getEquity(query: {
3442
3573
  /** Allow multiple symbols, separated by ',' */
3443
- symbols?: string;
3574
+ symbols: string;
3444
3575
  /** @default "" */
3445
3576
  platform?: string;
3446
3577
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3447
3578
  /**
3448
3579
  * @tags QuotesReformat
3449
3580
  * @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
3581
+ * @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
3582
  * @request GET:/api/quotes/equity/intraday
3452
3583
  * @secure
3453
3584
  */
3454
- getEquityIntraday(query?: {
3585
+ getEquityIntraday(query: {
3455
3586
  /** Allow one symbol */
3456
- symbol?: string;
3587
+ symbol: string;
3457
3588
  /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
3458
3589
  from?: string;
3459
3590
  /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
@@ -3463,20 +3594,20 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3463
3594
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3464
3595
  /**
3465
3596
  * @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
3597
+ * @name GetEquityHistorical
3598
+ * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3599
+ * @request GET:/api/quotes/equity/historical
3469
3600
  * @secure
3470
3601
  */
3471
- getOptionHistorical(query?: {
3602
+ getEquityHistorical(query: {
3472
3603
  /** Allow one symbol */
3473
- symbol?: string;
3604
+ symbol: string;
3474
3605
  /** start date (MM/dd/yyyy) */
3475
3606
  start?: string;
3476
3607
  /** end date (MM/dd/yyyy) */
3477
3608
  end?: string;
3478
3609
  /**
3479
- * If start and end are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). num specifies number of (y/m) back from current date
3610
+ * If start and end are not specified, then range needs to be given. Format: [num][y/m/w] (y – year, m – months, w - weeks). num specifies number of (y/m) back from current date
3480
3611
  * @default ""
3481
3612
  */
3482
3613
  range?: string;
@@ -3486,13 +3617,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3486
3617
  /**
3487
3618
  * @tags QuotesReformat
3488
3619
  * @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
3620
+ * @summary To search for a company and the exact ticker symbol is not known, use this endpoint for a string search. - All users
3490
3621
  * @request GET:/api/quotes/search
3491
3622
  * @secure
3492
3623
  */
3493
- getSearch(query?: {
3624
+ getSearch(query: {
3494
3625
  /** String to search for */
3495
- criteria?: string;
3626
+ criteria: string;
3496
3627
  /**
3497
3628
  * Maximum number of results to return (default is 20)
3498
3629
  * @format int32
@@ -3510,13 +3641,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3510
3641
  /**
3511
3642
  * @tags QuotesReformat
3512
3643
  * @name GetOption
3513
- * @summary Query Option Level 1 data - All users - available in Microservice
3644
+ * @summary Query Option Level 1 data - All users
3514
3645
  * @request GET:/api/quotes/option
3515
3646
  * @secure
3516
3647
  */
3517
- getOption(query?: {
3648
+ getOption(query: {
3518
3649
  /** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3519
- symbols?: string;
3650
+ symbols: string;
3520
3651
  /**
3521
3652
  * if include greek letter value in response
3522
3653
  * @default false
@@ -3528,7 +3659,7 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3528
3659
  /**
3529
3660
  * @tags QuotesReformat
3530
3661
  * @name GetOptionChainDates
3531
- * @summary Query Option Chain dates - All users - available in Microservice
3662
+ * @summary Query Option Chain dates - All users
3532
3663
  * @request GET:/api/quotes/option/chain/dates/{symbol}
3533
3664
  * @secure
3534
3665
  */
@@ -3539,7 +3670,7 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3539
3670
  /**
3540
3671
  * @tags QuotesReformat
3541
3672
  * @name GetOptionChain
3542
- * @summary Query Option Chain data - All users - available in Microservice
3673
+ * @summary Query Option Chain data - All users
3543
3674
  * @request GET:/api/quotes/option/chain/{symbol}/{date}
3544
3675
  * @secure
3545
3676
  */
@@ -3549,14 +3680,14 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3549
3680
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3550
3681
  /**
3551
3682
  * @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
3683
+ * @name GetOptionHistorical
3684
+ * @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3685
+ * @request GET:/api/quotes/option/historical
3555
3686
  * @secure
3556
3687
  */
3557
- getEquityHistorical(query?: {
3688
+ getOptionHistorical(query: {
3558
3689
  /** Allow one symbol */
3559
- symbol?: string;
3690
+ symbol: string;
3560
3691
  /** start date (MM/dd/yyyy) */
3561
3692
  start?: string;
3562
3693
  /** end date (MM/dd/yyyy) */
@@ -3572,13 +3703,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3572
3703
  /**
3573
3704
  * @tags QuotesReformat
3574
3705
  * @name GetBonds
3575
- * @summary Query Bonds data - All users - available in Microservice
3706
+ * @summary Query Bonds data - All users
3576
3707
  * @request GET:/api/quotes/bonds
3577
3708
  * @secure
3578
3709
  */
3579
- getBonds(query?: {
3710
+ getBonds(query: {
3580
3711
  /** ISIN, allow multiple query separated by ',' */
3581
- identifiers?: string;
3712
+ identifiers: string;
3582
3713
  /**
3583
3714
  * Price type, default is Percentage. ('Percentage'|'Decimal')
3584
3715
  * @default "Percentage"
@@ -3595,13 +3726,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3595
3726
  /**
3596
3727
  * @tags QuotesReformat
3597
3728
  * @name GetBondsSearch
3598
- * @summary Search bonds - All users - available in Microservice
3729
+ * @summary Search bonds - All users
3599
3730
  * @request GET:/api/quotes/bonds/search
3600
3731
  * @secure
3601
3732
  */
3602
- getBondsSearch(query?: {
3733
+ getBondsSearch(query: {
3603
3734
  /** search string */
3604
- criteria?: string;
3735
+ criteria: string;
3605
3736
  /**
3606
3737
  * how many records that need to return, 20 is maximum
3607
3738
  * @format int32
@@ -3629,13 +3760,13 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3629
3760
  /**
3630
3761
  * @tags QuotesReformat
3631
3762
  * @name GetQuotesReformat
3632
- * @summary Query Forex rate - All users - available in Microservice
3763
+ * @summary Query Forex rate - All users
3633
3764
  * @request GET:/api/quotes/fx
3634
3765
  * @secure
3635
3766
  */
3636
- getQuotesReformat(query?: {
3767
+ getQuotesReformat(query: {
3637
3768
  /** base_currency/quote_currecy. Can query multiple, separated with ',' */
3638
- symbols?: string;
3769
+ symbols: string;
3639
3770
  /** @default "" */
3640
3771
  platform?: string;
3641
3772
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
@@ -3646,17 +3777,18 @@ export class UmaTest<HandleError extends boolean = boolean> {
3646
3777
  /**
3647
3778
  * @tags UMATest
3648
3779
  * @name GetRevokeUmaUser
3649
- * @summary Test to revoke uma user - internal use only - Super admin - available in Microservice
3780
+ * @summary Revoke uma user
3650
3781
  * @request GET:/api/uma-test/revoke-uma-user
3651
3782
  * @secure
3652
3783
  */
3653
3784
  getRevokeUmaUser(query?: {
3785
+ /** please use UMA user id */
3654
3786
  user_id?: string;
3655
3787
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3656
3788
  /**
3657
3789
  * @tags UMATest
3658
3790
  * @name GetFirmList
3659
- * @summary Test to get all uma firms - internal use only - Super admin - available in Microservice
3791
+ * @summary Test to get all uma firms - internal use only - Super admin
3660
3792
  * @request GET:/api/uma-test/firm-list
3661
3793
  * @secure
3662
3794
  */
@@ -3664,25 +3796,15 @@ export class UmaTest<HandleError extends boolean = boolean> {
3664
3796
  /**
3665
3797
  * @tags UMATest
3666
3798
  * @name GetFirmListToLocal
3667
- * @summary Import all uma firms to AES - internal use only - Super admin - available in Microservice
3799
+ * @summary Import all uma firms to AES - internal use only - Super admin
3668
3800
  * @request GET:/api/uma-test/firm-list-to-local
3669
3801
  * @secure
3670
3802
  */
3671
3803
  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
3804
  /**
3683
3805
  * @tags UMATest
3684
3806
  * @name GetB2BUserList
3685
- * @summary Test to get all uma b2b users - internal use only - Super admin - available in Microservice
3807
+ * @summary Test to get all uma b2b users - internal use only - Super admin
3686
3808
  * @request GET:/api/uma-test/b2b-user-list
3687
3809
  * @secure
3688
3810
  */
@@ -3690,25 +3812,15 @@ export class UmaTest<HandleError extends boolean = boolean> {
3690
3812
  /**
3691
3813
  * @tags UMATest
3692
3814
  * @name GetB2BUserListToLocal
3693
- * @summary Import all uma b2b users to AES - internal use only - Super admin - available in Microservice
3815
+ * @summary Import all uma b2b users to AES - internal use only - Super admin
3694
3816
  * @request GET:/api/uma-test/b2b-user-list-to-local
3695
3817
  * @secure
3696
3818
  */
3697
3819
  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
3820
  /**
3709
3821
  * @tags UMATest
3710
3822
  * @name GetB2CUserList
3711
- * @summary Test to get all uma b2c users - internal use only - Super admin - available in Microservice
3823
+ * @summary Test to get all uma b2c users - internal use only - Super admin
3712
3824
  * @request GET:/api/uma-test/b2c-user-list
3713
3825
  * @secure
3714
3826
  */
@@ -3716,7 +3828,7 @@ export class UmaTest<HandleError extends boolean = boolean> {
3716
3828
  /**
3717
3829
  * @tags UMATest
3718
3830
  * @name GetB2CUserListToLocal
3719
- * @summary Import all uma b2c users to AES - internal use only - Super admin - available in Microservice
3831
+ * @summary Import all uma b2c users to aes - internal use only - Super admin
3720
3832
  * @request GET:/api/uma-test/b2c-user-list-to-local
3721
3833
  * @secure
3722
3834
  */
@@ -3725,34 +3837,10 @@ export class UmaTest<HandleError extends boolean = boolean> {
3725
3837
  export class User<HandleError extends boolean = boolean> {
3726
3838
  protected readonly apiClient: JwtClient<HandleError>;
3727
3839
  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
3840
  /**
3753
3841
  * @tags User
3754
3842
  * @name PostRegisterUmaB2BUser
3755
- * @summary Create a new b2b user from UMA - Firm manager, or super admin - available in Microservice
3843
+ * @summary Create a new b2b user from UMA - Firm manager, or super admin
3756
3844
  * @request POST:/api/user/register-uma-b2b-user
3757
3845
  * @secure
3758
3846
  */
@@ -3760,265 +3848,100 @@ export class User<HandleError extends boolean = boolean> {
3760
3848
  /**
3761
3849
  * @tags User
3762
3850
  * @name PostRegisterUmaB2CUser
3763
- * @summary Create a new b2c user from UMA - Firm manager, or super admin - available in Microservice
3851
+ * @summary Create a new b2c user from UMA - Firm manager, or super admin
3764
3852
  * @request POST:/api/user/register-uma-b2c-user
3765
3853
  * @secure
3766
3854
  */
3767
3855
  postRegisterUmaB2CUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3768
3856
  /**
3769
3857
  * @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
3858
+ * @name PostUmaB2BUserList
3859
+ * @summary Get UMA b2b users - Firm manager, or super admin
3860
+ * @request POST:/api/user/uma-b2b-user-list
3773
3861
  * @secure
3774
3862
  */
3775
- getUmaB2BUserList(query?: {
3776
- /**
3777
- * fuzzy search on uma user first/last name
3778
- * @default ""
3779
- */
3863
+ postUmaB2BUserList(data: AesMidasQueryPostBody, query?: {
3864
+ /** @default "" */
3780
3865
  name?: string;
3781
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUser[], HandleError>>;
3866
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2BUserResponsewithPagination, HandleError>>;
3782
3867
  /**
3783
3868
  * @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
3869
+ * @name PostUmaB2CUserList
3870
+ * @summary Get UMA b2c users - Firm manager, or super admin
3871
+ * @request POST:/api/user/uma-b2c-user-list
3787
3872
  * @secure
3788
3873
  */
3789
- getUmaB2CUserList(query?: {
3790
- /**
3791
- * fuzzy search on uma user first/last name
3792
- * @default ""
3793
- */
3874
+ postUmaB2CUserList(data: AesMidasQueryPostBody, query?: {
3875
+ /** @default "" */
3794
3876
  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>>;
3877
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAB2CUserResponsewithPagination, HandleError>>;
3904
3878
  /**
3879
+ * @description All conditions are optional
3905
3880
  * @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
3881
+ * @name PostUsersByMultipleConditions
3882
+ * @summary Search Users by multiple conditions
3883
+ * @request POST:/api/user/users-by-multiple-conditions
3909
3884
  * @secure
3910
3885
  */
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
3886
  postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
3927
3887
  /**
3928
- * optional
3888
+ * firm id
3929
3889
  * @default ""
3930
3890
  */
3931
3891
  firm?: string;
3932
3892
  /**
3933
- * fuzzy search, optional
3934
- * @default ""
3935
- */
3936
- user_name?: string;
3937
- /**
3938
- * optional
3893
+ * fuzzy search on both user_name and email
3939
3894
  * @default ""
3940
3895
  */
3941
- email?: string;
3896
+ user_search?: string;
3942
3897
  /**
3943
- * Value: Active/Suspended, optional
3898
+ * Value: Active/Suspended
3944
3899
  * @default ""
3945
3900
  */
3946
3901
  status?: string;
3947
3902
  /**
3948
- * Value: Professional/Non-Professional, optional
3903
+ * Value: Professional/Non-Professional
3949
3904
  * @default ""
3950
3905
  */
3951
3906
  professional?: string;
3952
3907
  /**
3953
- * Value: Yes/No, optional
3908
+ * Value: Yes/No
3954
3909
  * @default ""
3955
3910
  */
3956
3911
  has_contract?: string;
3957
3912
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserMultiConditionResultResponseResponsewithPagination, HandleError>>;
3958
3913
  /**
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
3914
  * @tags User
3991
3915
  * @name PostUserInformation
3992
- * @summary Create new user information - All users - available in Microservice
3916
+ * @summary Create new user information
3993
3917
  * @request POST:/api/user/user-information
3994
3918
  * @secure
3995
3919
  */
3996
3920
  postUserInformation(data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
3997
3921
  /**
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
3922
  * @tags User
4000
3923
  * @name PutUserInformation
4001
- * @summary Update existing user information - All users - available in Microservice
3924
+ * @summary Update existing user information
4002
3925
  * @request PUT:/api/user/user-information
4003
3926
  * @secure
4004
3927
  */
4005
- putUserInformation(data: AesMidasUserInformation, query?: {
4006
- user_id?: string;
4007
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3928
+ putUserInformation(query: {
3929
+ user_id: string;
3930
+ }, data: AesMidasUserInformation, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4008
3931
  /**
4009
3932
  * @tags User
4010
3933
  * @name GetUserInformationById
4011
- * @summary Query a specific user information - All users - available in Microservice
3934
+ * @summary Query a specific user information
4012
3935
  * @request GET:/api/user/user-information-by-id
4013
3936
  * @secure
4014
3937
  */
4015
- getUserInformationById(query?: {
4016
- user_id?: string;
3938
+ getUserInformationById(query: {
3939
+ user_id: string;
4017
3940
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserInformation, HandleError>>;
4018
3941
  /**
4019
3942
  * @tags User
4020
3943
  * @name GetOccupationList
4021
- * @summary Query occupation list that can be used in user information EmploymentFunction - All users - available in Microservice
3944
+ * @summary Query occupation list that can be used in user information EmploymentFunction - All users
4022
3945
  * @request GET:/api/user/occupation-list
4023
3946
  * @secure
4024
3947
  */
@@ -4027,7 +3950,7 @@ For Microservice API:
4027
3950
  * @description It will check if user firm has relevant data acess.
4028
3951
  * @tags User
4029
3952
  * @name PostUserDataConfig
4030
- * @summary Create new user data configuration - Firm manager, or super admin - available in Microservice
3953
+ * @summary Create new user data configuration
4031
3954
  * @request POST:/api/user/user-data-config
4032
3955
  * @secure
4033
3956
  */
@@ -4036,67 +3959,66 @@ For Microservice API:
4036
3959
  * @description It will check if user firm has relevant data acess.
4037
3960
  * @tags User
4038
3961
  * @name PutUserDataConfig
4039
- * @summary Update existing user data configuration - Firm manager, or super admin - available in Microservice
3962
+ * @summary Update existing user data configuration
4040
3963
  * @request PUT:/api/user/user-data-config
4041
3964
  * @secure
4042
3965
  */
4043
- putUserDataConfig(data: AesMidasUserDataConfig, query?: {
4044
- user_id?: string;
4045
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3966
+ putUserDataConfig(query: {
3967
+ user_id: string;
3968
+ }, data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4046
3969
  /**
4047
- * @description USEquity bitwise: 1 UTP(Nasdaq), 2 CBOE1, 3 BATS, 4 NYBQT, 5 UTP OTC, 6 CTA-A, 7 CTA-B
4048
3970
  * @tags User
4049
3971
  * @name GetUserDataConfigById
4050
- * @summary Query a user data configuration by user Id - All users - available in Microservice
3972
+ * @summary Query a user data configuration by user Id
4051
3973
  * @request GET:/api/user/user-data-config-by-id
4052
3974
  * @secure
4053
3975
  */
4054
- getUserDataConfigById(query?: {
4055
- user_id?: string;
3976
+ getUserDataConfigById(query: {
3977
+ user_id: string;
4056
3978
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig, HandleError>>;
4057
3979
  /**
4058
3980
  * @tags User
4059
3981
  * @name GetUserDataConfigByIdExtraInfo
4060
- * @summary Query a user data configuration by user Id - All users - available in Microservice
3982
+ * @summary Query a user data configuration by user Id
4061
3983
  * @request GET:/api/user/user-data-config-by-id-extra-info
4062
3984
  * @secure
4063
3985
  */
4064
- getUserDataConfigByIdExtraInfo(query?: {
4065
- user_id?: string;
3986
+ getUserDataConfigByIdExtraInfo(query: {
3987
+ user_id: string;
4066
3988
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfigExtraInfo, HandleError>>;
4067
3989
  /**
4068
3990
  * @tags User
4069
3991
  * @name GetUserDataConfigs
4070
- * @summary Query user data configurations by user Ids - Firm manager or super admin - available in Microservice
3992
+ * @summary Query user data configurations by user Ids
4071
3993
  * @request GET:/api/user/user-data-configs
4072
3994
  * @secure
4073
3995
  */
4074
- getUserDataConfigs(query?: {
4075
- user_ids?: string;
3996
+ getUserDataConfigs(query: {
3997
+ user_ids: string;
4076
3998
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUserDataConfig[], HandleError>>;
4077
3999
  /**
4078
4000
  * @tags User
4079
4001
  * @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
4002
+ * @summary Query which entitlements(agreements) a user need to sign(but not signed yet) by user name
4081
4003
  * @request GET:/api/user/user-need-sign-agreements
4082
4004
  * @secure
4083
4005
  */
4084
- getUserNeedSignAgreements(query?: {
4085
- user_name?: string;
4006
+ getUserNeedSignAgreements(query: {
4007
+ user_name: string;
4086
4008
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4087
4009
  /**
4088
4010
  * @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
4011
+ * @name GetTestAuthorize
4012
+ * @summary For authorize test only
4013
+ * @request GET:/api/user/test-authorize
4092
4014
  * @secure
4093
4015
  */
4094
- getSessionAlive(config?: RequestConfig<HandleError>): Promise<ClientResponse<boolean, HandleError>>;
4016
+ getTestAuthorize(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4095
4017
  /**
4096
4018
  * @tags User
4097
4019
  * @name GetTest
4098
- * @summary For system deployment user only - All users - available in Microservice
4099
- * @request GET:/api/user/Test
4020
+ * @summary For system deployment user only
4021
+ * @request GET:/api/user/test
4100
4022
  * @secure
4101
4023
  */
4102
4024
  getTest(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
@@ -4107,7 +4029,7 @@ export class WebSocket<HandleError extends boolean = boolean> {
4107
4029
  /**
4108
4030
  * @tags WebSocket
4109
4031
  * @name GetWebSocket
4110
- * @summary WebSocket endpoint - All users - available in Microservice
4032
+ * @summary WebSocket endpoint in polling mode - All users
4111
4033
  * @request GET:/ws
4112
4034
  * @secure
4113
4035
  */
@@ -4115,7 +4037,7 @@ export class WebSocket<HandleError extends boolean = boolean> {
4115
4037
  /**
4116
4038
  * @tags WebSocket
4117
4039
  * @name GetWssub
4118
- * @summary WebSocket endpoint - All users - available in Microservice
4040
+ * @summary WebSocket endpoint in subscription mode - All users
4119
4041
  * @request GET:/wssub
4120
4042
  * @secure
4121
4043
  */
@@ -4127,7 +4049,6 @@ export class WsStream<HandleError extends boolean = boolean> {
4127
4049
  /**
4128
4050
  * @tags WsStream
4129
4051
  * @name GetStream
4130
- * @summary ws stream endpoint - All users - available in Microservice
4131
4052
  * @request GET:/stream
4132
4053
  * @secure
4133
4054
  */