@orbis-systems/orbis-api-clients 0.5.2 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,7 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
7
7
  defaultHeaders?: Record<string, string>;
8
8
  defaultSecure?: boolean;
9
9
  authDataStorageKey?: string;
10
+ withCredentials?: boolean;
10
11
  onAxiosError?: (error: AxiosError) => void;
11
12
  onError?: (error: unknown) => void;
12
13
  }
@@ -270,6 +271,8 @@ export interface AesMidasBondReformat {
270
271
  company_name?: string | null;
271
272
  exchange?: string | null;
272
273
  market_description?: string | null;
274
+ issue_market?: string | null;
275
+ country?: string | null;
273
276
  /** @format double */
274
277
  high52week?: number | null;
275
278
  /** @format double */
@@ -433,7 +436,6 @@ export interface AesMidasBondReformat {
433
436
  last_coupon_date?: string | null;
434
437
  updated_at?: string | null;
435
438
  country_code?: string | null;
436
- country?: string | null;
437
439
  bond_warrant?: boolean | null;
438
440
  /** @format double */
439
441
  close_price?: number | null;
@@ -619,6 +621,7 @@ export interface AesMidasEquiductL1 {
619
621
  quote_time?: string | null;
620
622
  bid_exch?: string | null;
621
623
  ask_exch?: string | null;
624
+ country_code?: string | null;
622
625
  }
623
626
  export interface AesMidasExchanges {
624
627
  exchange?: string | null;
@@ -643,12 +646,70 @@ export interface AesMidasFirm {
643
646
  option?: number;
644
647
  /** @format int32 */
645
648
  indice?: number;
646
- /** @format int32 */
647
- international_market?: number;
648
649
  crypto?: boolean;
649
- futures?: boolean;
650
650
  mutual_funds?: boolean;
651
651
  vender_of_records?: boolean;
652
+ fixed_income?: boolean;
653
+ offshore_mutual_funds?: boolean;
654
+ forex?: boolean;
655
+ /** @format int32 */
656
+ austria?: number;
657
+ /** @format int32 */
658
+ belgium?: number;
659
+ /** @format int32 */
660
+ canada_to?: number;
661
+ /** @format int32 */
662
+ canada_v?: number;
663
+ /** @format int32 */
664
+ canada_ca?: number;
665
+ /** @format int32 */
666
+ denmark?: number;
667
+ /** @format int32 */
668
+ finland?: number;
669
+ /** @format int32 */
670
+ france?: number;
671
+ /** @format int32 */
672
+ germany?: number;
673
+ /** @format int32 */
674
+ uk?: number;
675
+ /** @format int32 */
676
+ hk?: number;
677
+ /** @format int32 */
678
+ indonesia?: number;
679
+ /** @format int32 */
680
+ ireland?: number;
681
+ /** @format int32 */
682
+ israel?: number;
683
+ /** @format int32 */
684
+ italy?: number;
685
+ /** @format int32 */
686
+ japan?: number;
687
+ /** @format int32 */
688
+ korea?: number;
689
+ /** @format int32 */
690
+ malaysia?: number;
691
+ /** @format int32 */
692
+ netherlands?: number;
693
+ /** @format int32 */
694
+ norway?: number;
695
+ /** @format int32 */
696
+ portugal?: number;
697
+ /** @format int32 */
698
+ singapore?: number;
699
+ /** @format int32 */
700
+ spain?: number;
701
+ /** @format int32 */
702
+ sweden?: number;
703
+ /** @format int32 */
704
+ switzerland?: number;
705
+ /** @format int32 */
706
+ taiwan?: number;
707
+ /** @format int32 */
708
+ thailand?: number;
709
+ /** @format int32 */
710
+ us_chart?: number;
711
+ option_chart?: boolean;
712
+ international_chart?: boolean;
652
713
  }
653
714
  export interface AesMidasFirmEntitlement {
654
715
  /** @minLength 1 */
@@ -688,13 +749,75 @@ export interface AesMidasFirmDefaultDataSetting {
688
749
  /** @format int32 */
689
750
  indice?: number;
690
751
  /** @format int32 */
691
- international_market?: number;
692
- /** @format int32 */
693
752
  crypto?: number;
694
753
  /** @format int32 */
695
- futures?: number;
696
- /** @format int32 */
697
754
  mutual_funds?: number;
755
+ /** @format int32 */
756
+ fixed_income?: number;
757
+ /** @format int32 */
758
+ offshore_mutual_funds?: number;
759
+ /** @format int32 */
760
+ forex?: number;
761
+ /** @format int32 */
762
+ austria?: number;
763
+ /** @format int32 */
764
+ belgium?: number;
765
+ /** @format int32 */
766
+ canada_to?: number;
767
+ /** @format int32 */
768
+ canada_v?: number;
769
+ /** @format int32 */
770
+ canada_ca?: number;
771
+ /** @format int32 */
772
+ denmark?: number;
773
+ /** @format int32 */
774
+ finland?: number;
775
+ /** @format int32 */
776
+ france?: number;
777
+ /** @format int32 */
778
+ germany?: number;
779
+ /** @format int32 */
780
+ uk?: number;
781
+ /** @format int32 */
782
+ hk?: number;
783
+ /** @format int32 */
784
+ indonesia?: number;
785
+ /** @format int32 */
786
+ ireland?: number;
787
+ /** @format int32 */
788
+ israel?: number;
789
+ /** @format int32 */
790
+ italy?: number;
791
+ /** @format int32 */
792
+ japan?: number;
793
+ /** @format int32 */
794
+ korea?: number;
795
+ /** @format int32 */
796
+ malaysia?: number;
797
+ /** @format int32 */
798
+ netherlands?: number;
799
+ /** @format int32 */
800
+ norway?: number;
801
+ /** @format int32 */
802
+ portugal?: number;
803
+ /** @format int32 */
804
+ singapore?: number;
805
+ /** @format int32 */
806
+ spain?: number;
807
+ /** @format int32 */
808
+ sweden?: number;
809
+ /** @format int32 */
810
+ switzerland?: number;
811
+ /** @format int32 */
812
+ taiwan?: number;
813
+ /** @format int32 */
814
+ thailand?: number;
815
+ /** @format int32 */
816
+ us_chart?: number;
817
+ /** @format int32 */
818
+ option_chart?: number;
819
+ /** @format int32 */
820
+ international_chart?: number;
698
821
  }
699
822
  export interface AesMidasForexRate {
700
823
  symbol?: string | null;
@@ -774,6 +897,7 @@ export interface AesMidasICEEOD {
774
897
  market_desc?: string | null;
775
898
  /** @format double */
776
899
  yest_close_px?: number | null;
900
+ country_code?: string | null;
777
901
  }
778
902
  export interface AesMidasIsinInfo {
779
903
  isin?: string | null;
@@ -879,6 +1003,7 @@ export interface AesMidasLevel1 {
879
1003
  fund_beta?: number;
880
1004
  market_name?: string | null;
881
1005
  market_desc?: string | null;
1006
+ country_code?: string | null;
882
1007
  data_source?: string | null;
883
1008
  }
884
1009
  export interface AesMidasLevel1Reformat {
@@ -892,6 +1017,8 @@ export interface AesMidasLevel1Reformat {
892
1017
  company_name?: string | null;
893
1018
  exchange?: string | null;
894
1019
  market_description?: string | null;
1020
+ issue_market?: string | null;
1021
+ country?: string | null;
895
1022
  /** @format double */
896
1023
  high52week?: number | null;
897
1024
  /** @format double */
@@ -1207,11 +1334,11 @@ export interface AesMidasPermission {
1207
1334
  /** @format int32 */
1208
1335
  num_query_per_sec: number;
1209
1336
  /** @format int32 */
1210
- size_data_per_sec: number;
1337
+ num_query_per_min: number;
1338
+ /** @format int32 */
1339
+ size_data_per_min: number;
1211
1340
  /** @minLength 1 */
1212
1341
  allow_ip: string;
1213
- level1: boolean;
1214
- level2: boolean;
1215
1342
  }
1216
1343
  export interface AesMidasQueryLog {
1217
1344
  id?: string | null;
@@ -1285,6 +1412,7 @@ export interface AesMidasQuoddDelay {
1285
1412
  change_percent?: number | null;
1286
1413
  status?: string | null;
1287
1414
  market_name?: string | null;
1415
+ country_code?: string | null;
1288
1416
  }
1289
1417
  export interface AesMidasQuoddEOD {
1290
1418
  symbol?: string | null;
@@ -1325,6 +1453,7 @@ export interface AesMidasQuoddEOD {
1325
1453
  /** @format double */
1326
1454
  low52w_px?: number | null;
1327
1455
  market_name?: string | null;
1456
+ country_code?: string | null;
1328
1457
  }
1329
1458
  export interface AesMidasRegion {
1330
1459
  code?: string | null;
@@ -1798,11 +1927,69 @@ export interface AesMidasUserDataConfig {
1798
1927
  option?: number;
1799
1928
  /** @format int32 */
1800
1929
  indice?: number;
1801
- /** @format int32 */
1802
- international_market?: number;
1803
1930
  crypto?: boolean;
1804
- futures?: boolean;
1805
1931
  mutual_funds?: boolean;
1932
+ fixed_income?: boolean;
1933
+ offshore_mutual_funds?: boolean;
1934
+ forex?: boolean;
1935
+ /** @format int32 */
1936
+ austria?: number;
1937
+ /** @format int32 */
1938
+ belgium?: number;
1939
+ /** @format int32 */
1940
+ canada_to?: number;
1941
+ /** @format int32 */
1942
+ canada_v?: number;
1943
+ /** @format int32 */
1944
+ canada_ca?: number;
1945
+ /** @format int32 */
1946
+ denmark?: number;
1947
+ /** @format int32 */
1948
+ finland?: number;
1949
+ /** @format int32 */
1950
+ france?: number;
1951
+ /** @format int32 */
1952
+ germany?: number;
1953
+ /** @format int32 */
1954
+ uk?: number;
1955
+ /** @format int32 */
1956
+ hk?: number;
1957
+ /** @format int32 */
1958
+ indonesia?: number;
1959
+ /** @format int32 */
1960
+ ireland?: number;
1961
+ /** @format int32 */
1962
+ israel?: number;
1963
+ /** @format int32 */
1964
+ italy?: number;
1965
+ /** @format int32 */
1966
+ japan?: number;
1967
+ /** @format int32 */
1968
+ korea?: number;
1969
+ /** @format int32 */
1970
+ malaysia?: number;
1971
+ /** @format int32 */
1972
+ netherlands?: number;
1973
+ /** @format int32 */
1974
+ norway?: number;
1975
+ /** @format int32 */
1976
+ portugal?: number;
1977
+ /** @format int32 */
1978
+ singapore?: number;
1979
+ /** @format int32 */
1980
+ spain?: number;
1981
+ /** @format int32 */
1982
+ sweden?: number;
1983
+ /** @format int32 */
1984
+ switzerland?: number;
1985
+ /** @format int32 */
1986
+ taiwan?: number;
1987
+ /** @format int32 */
1988
+ thailand?: number;
1989
+ /** @format int32 */
1990
+ us_chart?: number;
1991
+ option_chart?: boolean;
1992
+ international_chart?: boolean;
1806
1993
  }
1807
1994
  export interface AesMidasUserDataConfigHistory {
1808
1995
  id?: string | null;
@@ -1960,6 +2147,14 @@ export class DataSource<HandleError extends boolean = boolean> {
1960
2147
  deleteDataSource(query?: {
1961
2148
  name?: string;
1962
2149
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2150
+ /**
2151
+ * @tags DataSource
2152
+ * @name GetDataSourceBitMapping
2153
+ * @summary Get All DataSource Bit Mappings - All users - available in Microservice
2154
+ * @request GET:/api/datasource/data-source-bit-mapping
2155
+ * @secure
2156
+ */
2157
+ getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
1963
2158
  /**
1964
2159
  * @tags DataSource
1965
2160
  * @name GetDataSourceTallyCount
@@ -2874,6 +3069,40 @@ export class Quote<HandleError extends boolean = boolean> {
2874
3069
  /** @default "" */
2875
3070
  platform?: string;
2876
3071
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks[], HandleError>>;
3072
+ /**
3073
+ * @tags Quote
3074
+ * @name GetOptionDayChart
3075
+ * @summary Query Option Day Chart - All users - available in Microservice
3076
+ * @request GET:/api/quote/option-day-chart
3077
+ * @secure
3078
+ */
3079
+ getOptionDayChart(query?: {
3080
+ /** Allow one symbol */
3081
+ symbol?: string;
3082
+ /**
3083
+ * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
3084
+ * @default ""
3085
+ */
3086
+ year?: string;
3087
+ /**
3088
+ * how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
3089
+ * @format int32
3090
+ * @default 0
3091
+ */
3092
+ month?: number;
3093
+ /**
3094
+ * Optional. Default is false. If true, response will be camel case
3095
+ * @default false
3096
+ */
3097
+ response_camel_case?: boolean;
3098
+ /**
3099
+ * Optional. Must input if enterprise user query on behave of their clients
3100
+ * @default ""
3101
+ */
3102
+ user_name?: string;
3103
+ /** @default "" */
3104
+ platform?: string;
3105
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
2877
3106
  /**
2878
3107
  * @tags Quote
2879
3108
  * @name GetEquiductLevel1
@@ -2884,6 +3113,11 @@ export class Quote<HandleError extends boolean = boolean> {
2884
3113
  getEquiductLevel1(query?: {
2885
3114
  /** Allow multiple symbols, separated by ',' */
2886
3115
  symbols?: string;
3116
+ /**
3117
+ * True to query realtime data, False to query delay data
3118
+ * @default false
3119
+ */
3120
+ realtime?: boolean;
2887
3121
  /**
2888
3122
  * Optional. Default is false. If true, response will be camel case
2889
3123
  * @default false
@@ -3136,12 +3370,12 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3136
3370
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3137
3371
  /**
3138
3372
  * @tags QuotesReformat
3139
- * @name GetEquityHistorical
3140
- * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
3141
- * @request GET:/api/quotes/equity/historical
3373
+ * @name GetOptionHistorical
3374
+ * @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
3375
+ * @request GET:/api/quotes/option/historical
3142
3376
  * @secure
3143
3377
  */
3144
- getEquityHistorical(query?: {
3378
+ getOptionHistorical(query?: {
3145
3379
  /** Allow one symbol */
3146
3380
  symbol?: string;
3147
3381
  /** start date (MM/dd/yyyy) */
@@ -3220,6 +3454,28 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
3220
3454
  /** @default "" */
3221
3455
  platform?: string;
3222
3456
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3457
+ /**
3458
+ * @tags QuotesReformat
3459
+ * @name GetEquityHistorical
3460
+ * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users - available in Microservice
3461
+ * @request GET:/api/quotes/equity/historical
3462
+ * @secure
3463
+ */
3464
+ getEquityHistorical(query?: {
3465
+ /** Allow one symbol */
3466
+ symbol?: string;
3467
+ /** start date (MM/dd/yyyy) */
3468
+ start?: string;
3469
+ /** end date (MM/dd/yyyy) */
3470
+ end?: string;
3471
+ /**
3472
+ * 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
3473
+ * @default ""
3474
+ */
3475
+ range?: string;
3476
+ /** @default "" */
3477
+ platform?: string;
3478
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3223
3479
  /**
3224
3480
  * @tags QuotesReformat
3225
3481
  * @name GetBonds