@orbis-systems/orbis-api-clients 0.6.7 → 0.6.8

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