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

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