@orbis-systems/orbis-api-clients 0.7.3 → 0.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +440 -144
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +337 -216
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +166 -142
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +127 -127
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +1244 -1236
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +301 -301
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +222 -222
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -604,6 +604,39 @@ export enum BridgeWiseCompositionTypeEnum {
604
604
  Stocks = "stocks",
605
605
  Others = "others"
606
606
  }
607
+ /** ConsensusRatingsList */
608
+ export type BridgeWiseConsensusRatingsList = BridgeWiseConsensusRatingsResponse[];
609
+ /** ConsensusRatingsResponse */
610
+ export interface BridgeWiseConsensusRatingsResponse {
611
+ /**
612
+ * Language
613
+ * @default "en-US"
614
+ */
615
+ language?: string;
616
+ /** Date */
617
+ date: string;
618
+ /**
619
+ * Updated At
620
+ * @format date-time
621
+ */
622
+ updated_at: string;
623
+ /** Trading Item Id */
624
+ trading_item_id: number;
625
+ /** Security Id */
626
+ security_id: number;
627
+ /** Company Id */
628
+ company_id: number;
629
+ /** Analysts Consensus Name */
630
+ analysts_consensus_name: string;
631
+ /** Analysts Consensus Score Type */
632
+ analysts_consensus_score_type: string;
633
+ /** Analysts Consensus Rating Analyst Count */
634
+ analysts_consensus_rating_analyst_count: number;
635
+ /** Analysts Consensus Rating Score Group */
636
+ analysts_consensus_rating_score_group: number;
637
+ /** Analysts Consensus Rating Score Group Text */
638
+ analysts_consensus_rating_score_group_text: string;
639
+ }
607
640
  /** FundHoldingsList */
608
641
  export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
609
642
  /** FundsCompositionItem */
@@ -702,12 +735,6 @@ export interface BridgeWiseHoldingsStatisticsItem {
702
735
  /** Fund Analysis Score Group Text */
703
736
  fund_analysis_score_group_text: string | null;
704
737
  }
705
- /** IdentifierTypeEnum */
706
- export enum BridgeWiseIdentifierTypeEnum {
707
- TickerExchange = "ticker_exchange",
708
- Isin = "isin",
709
- Custom = "custom"
710
- }
711
738
  /** ImageExtensionEnum */
712
739
  export enum BridgeWiseImageExtensionEnum {
713
740
  Png = "png",
@@ -1443,6 +1470,42 @@ export enum BridgeWiseAnalysisTypeEnum {
1443
1470
  }
1444
1471
  /** CompanyTechAnalysisResponse */
1445
1472
  export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
1473
+ /** EsgFundsAnalysis */
1474
+ export interface BridgeWiseEsgFundsAnalysis {
1475
+ /**
1476
+ * Language
1477
+ * @default "en-US"
1478
+ */
1479
+ language?: string;
1480
+ /** Updated At */
1481
+ updated_at: string;
1482
+ /** Analysis Score */
1483
+ analysis_score: number;
1484
+ /** Year */
1485
+ year: number;
1486
+ /** Month */
1487
+ month: number;
1488
+ /** Analysis Rank In Sector */
1489
+ analysis_rank_in_sector: number;
1490
+ /** Analysis Score Group Text */
1491
+ analysis_score_group_text: string | number;
1492
+ /** Analysis Score Group */
1493
+ analysis_score_group: string | number;
1494
+ /** Pct From Aum */
1495
+ pct_from_aum?: number | null;
1496
+ /** Analysis Percentile In Sector */
1497
+ analysis_percentile_in_sector: number;
1498
+ /** Analysis Rank Global */
1499
+ analysis_rank_global: number;
1500
+ /** Analysis Percentile Global */
1501
+ analysis_percentile_global: number;
1502
+ /** Total Funds In Sector */
1503
+ total_funds_in_sector: number;
1504
+ /** Analysis Score Sector Median */
1505
+ analysis_score_sector_median: number;
1506
+ /** Analysis Score Sector Avg */
1507
+ analysis_score_sector_avg: number;
1508
+ }
1446
1509
  /** FundamentalAnalysisResponse */
1447
1510
  export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
1448
1511
  /** FundamentalAnalysisResponseItem */
@@ -2051,6 +2114,51 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
2051
2114
  Gt = "gt",
2052
2115
  Lt = "lt"
2053
2116
  }
2117
+ export class Logos<HandleError extends boolean = boolean> {
2118
+ protected readonly apiClient: JwtClient<HandleError>;
2119
+ constructor(apiClient: JwtClient<HandleError>);
2120
+ /**
2121
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
2122
+ * @tags Logos
2123
+ * @name FetchLogos
2124
+ * @summary Fetch Logos
2125
+ * @request GET:/companies/logos
2126
+ * @secure
2127
+ */
2128
+ fetchLogos(query?: {
2129
+ /**
2130
+ * Company Id In
2131
+ * Specify a list of BW identifiers for bulk queries.
2132
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2133
+ * @example "74822,83343211"
2134
+ */
2135
+ company_id__in?: string;
2136
+ /**
2137
+ * Size
2138
+ * Page size
2139
+ * @min 1
2140
+ * @max 100
2141
+ * @default 50
2142
+ */
2143
+ size?: number;
2144
+ /**
2145
+ * Page
2146
+ * Page number
2147
+ * @min 1
2148
+ * @default 1
2149
+ */
2150
+ page?: number;
2151
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
2152
+ /**
2153
+ * @description Retrieves the logo for a specified company using the provided company_id.
2154
+ * @tags Logos
2155
+ * @name FetchLogo
2156
+ * @summary Fetch Logo
2157
+ * @request GET:/companies/{company_id}/logos
2158
+ * @secure
2159
+ */
2160
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
2161
+ }
2054
2162
  export class CompanyMetadata<HandleError extends boolean = boolean> {
2055
2163
  protected readonly apiClient: JwtClient<HandleError>;
2056
2164
  constructor(apiClient: JwtClient<HandleError>);
@@ -2662,7 +2770,7 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2662
2770
  language?: BridgeWiseLanguageEnum;
2663
2771
  /**
2664
2772
  * Include
2665
- * Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
2773
+ * Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`, `technical_analysis`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
2666
2774
  * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
2667
2775
  */
2668
2776
  include?: string;
@@ -2689,11 +2797,151 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2689
2797
  /**
2690
2798
  * Identifier Type
2691
2799
  * Define the type of the external identifier provided.
2692
- * e.g., ISIN, ticker-exchange.
2800
+ * e.g., ISIN, ticker-exchange. The field accepts either a single value or multiple comma-separated values. <br>Example: ticker_exchange, isin, custom, tase</br>
2801
+ * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
2693
2802
  */
2694
- identifier_type: BridgeWiseIdentifierTypeEnum;
2803
+ identifier_type: string;
2695
2804
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2696
2805
  }
2806
+ export class Activities<HandleError extends boolean = boolean> {
2807
+ protected readonly apiClient: JwtClient<HandleError>;
2808
+ constructor(apiClient: JwtClient<HandleError>);
2809
+ /**
2810
+ * @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
2811
+ * @tags Activities
2812
+ * @name GetCompanyAlerts
2813
+ * @summary Get Company Alerts
2814
+ * @request GET:/companies/{company_id}/alerts
2815
+ * @secure
2816
+ */
2817
+ getCompanyAlerts(companyId: number, query?: {
2818
+ /**
2819
+ * Language
2820
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2821
+ * @default "en-US"
2822
+ */
2823
+ language?: BridgeWiseLanguageEnum;
2824
+ /**
2825
+ * Alert Type
2826
+ * Specify the group of the alert type that will be presented (fundamental or market).
2827
+ */
2828
+ alert_type?: BridgeWiseCompanyAlertType;
2829
+ /**
2830
+ * Sentiment
2831
+ * Filter alerts by their sentiment.
2832
+ */
2833
+ sentiment?: BridgeWiseCompanyAlertSentiment;
2834
+ /**
2835
+ * Importance
2836
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
2837
+ */
2838
+ importance?: string | null;
2839
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
2840
+ /**
2841
+ * @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
2842
+ * @tags Activities
2843
+ * @name GetCompanyForecastsKeyDevelopment
2844
+ * @summary Get Company Forecasts Key Development
2845
+ * @request GET:/companies/{company_id}/key-developments
2846
+ * @secure
2847
+ */
2848
+ getCompanyForecastsKeyDevelopment(companyId: number, query?: {
2849
+ /**
2850
+ * Language
2851
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2852
+ * @default "en-US"
2853
+ */
2854
+ language?: BridgeWiseLanguageEnum;
2855
+ /**
2856
+ * Importance
2857
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
2858
+ * @default "0,1"
2859
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2860
+ */
2861
+ importance?: string;
2862
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
2863
+ }
2864
+ export class ConsensusAnalysts<HandleError extends boolean = boolean> {
2865
+ protected readonly apiClient: JwtClient<HandleError>;
2866
+ constructor(apiClient: JwtClient<HandleError>);
2867
+ /**
2868
+ * @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
2869
+ * @tags Consensus Analysts
2870
+ * @name GetConsensusRatings
2871
+ * @summary Get Consensus Ratings
2872
+ * @request GET:/companies/{company_id}/consensus-ratings
2873
+ * @secure
2874
+ */
2875
+ getConsensusRatings(companyId: number, query?: {
2876
+ /**
2877
+ * Trading Item Id
2878
+ * Specify a BW trading asset identifier for a targeted query.
2879
+ */
2880
+ trading_item_id?: number;
2881
+ /**
2882
+ * Language
2883
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2884
+ * @default "en-US"
2885
+ */
2886
+ language?: BridgeWiseLanguageEnum;
2887
+ /**
2888
+ * Date Gte
2889
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
2890
+ */
2891
+ date__gte?: string | null;
2892
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
2893
+ }
2894
+ export class EarningCalls<HandleError extends boolean = boolean> {
2895
+ protected readonly apiClient: JwtClient<HandleError>;
2896
+ constructor(apiClient: JwtClient<HandleError>);
2897
+ /**
2898
+ * @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
2899
+ * @tags Earning Calls
2900
+ * @name GetCompanyEarningsCalls
2901
+ * @summary Get Company Earnings Calls
2902
+ * @request GET:/companies/{company_id}/earnings-call
2903
+ * @secure
2904
+ */
2905
+ getCompanyEarningsCalls(companyId: number, query?: {
2906
+ /**
2907
+ * Language
2908
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2909
+ * @default "en-US"
2910
+ */
2911
+ language?: BridgeWiseLanguageEnum;
2912
+ /**
2913
+ * Year
2914
+ * Specify the year for which the analysis is requested.
2915
+ */
2916
+ year?: number | null;
2917
+ /**
2918
+ * Quarter
2919
+ * Specify the quarter for which the analysis is requested.
2920
+ */
2921
+ quarter?: number | null;
2922
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
2923
+ /**
2924
+ * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
2925
+ * @tags Earning Calls
2926
+ * @name GetEarningsCallsRecaps
2927
+ * @summary Get Earnings Calls Recaps
2928
+ * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
2929
+ * @secure
2930
+ */
2931
+ getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
2932
+ /**
2933
+ * Language
2934
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2935
+ * @default "en-US"
2936
+ */
2937
+ language?: BridgeWiseLanguageEnum;
2938
+ /**
2939
+ * Type
2940
+ * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
2941
+ */
2942
+ type?: BridgeWiseEarningsCallRecapEnum;
2943
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
2944
+ }
2697
2945
  export class EsgAnalysis<HandleError extends boolean = boolean> {
2698
2946
  protected readonly apiClient: JwtClient<HandleError>;
2699
2947
  constructor(apiClient: JwtClient<HandleError>);
@@ -3005,160 +3253,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3005
3253
  date__lte?: string;
3006
3254
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
3007
3255
  }
3008
- export class Activities<HandleError extends boolean = boolean> {
3009
- protected readonly apiClient: JwtClient<HandleError>;
3010
- constructor(apiClient: JwtClient<HandleError>);
3011
- /**
3012
- * @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
3013
- * @tags Activities
3014
- * @name GetCompanyAlerts
3015
- * @summary Get Company Alerts
3016
- * @request GET:/companies/{company_id}/alerts
3017
- * @secure
3018
- */
3019
- getCompanyAlerts(companyId: number, query?: {
3020
- /**
3021
- * Language
3022
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3023
- * @default "en-US"
3024
- */
3025
- language?: BridgeWiseLanguageEnum;
3026
- /**
3027
- * Alert Type
3028
- * Specify the group of the alert type that will be presented (fundamental or market).
3029
- */
3030
- alert_type?: BridgeWiseCompanyAlertType;
3031
- /**
3032
- * Sentiment
3033
- * Filter alerts by their sentiment.
3034
- */
3035
- sentiment?: BridgeWiseCompanyAlertSentiment;
3036
- /**
3037
- * Importance
3038
- * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
3039
- */
3040
- importance?: string | null;
3041
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
3042
- /**
3043
- * @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
3044
- * @tags Activities
3045
- * @name GetCompanyForecastsKeyDevelopment
3046
- * @summary Get Company Forecasts Key Development
3047
- * @request GET:/companies/{company_id}/key-developments
3048
- * @secure
3049
- */
3050
- getCompanyForecastsKeyDevelopment(companyId: number, query?: {
3051
- /**
3052
- * Language
3053
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3054
- * @default "en-US"
3055
- */
3056
- language?: BridgeWiseLanguageEnum;
3057
- /**
3058
- * Importance
3059
- * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
3060
- * @default "0,1"
3061
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3062
- */
3063
- importance?: string;
3064
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
3065
- }
3066
- export class Logos<HandleError extends boolean = boolean> {
3067
- protected readonly apiClient: JwtClient<HandleError>;
3068
- constructor(apiClient: JwtClient<HandleError>);
3069
- /**
3070
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
3071
- * @tags Logos
3072
- * @name FetchLogos
3073
- * @summary Fetch Logos
3074
- * @request GET:/companies/logos
3075
- * @secure
3076
- */
3077
- fetchLogos(query?: {
3078
- /**
3079
- * Company Id In
3080
- * Specify a list of BW identifiers for bulk queries.
3081
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3082
- * @example "74822,83343211"
3083
- */
3084
- company_id__in?: string;
3085
- /**
3086
- * Size
3087
- * Page size
3088
- * @min 1
3089
- * @max 100
3090
- * @default 50
3091
- */
3092
- size?: number;
3093
- /**
3094
- * Page
3095
- * Page number
3096
- * @min 1
3097
- * @default 1
3098
- */
3099
- page?: number;
3100
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
3101
- /**
3102
- * @description Retrieves the logo for a specified company using the provided company_id.
3103
- * @tags Logos
3104
- * @name FetchLogo
3105
- * @summary Fetch Logo
3106
- * @request GET:/companies/{company_id}/logos
3107
- * @secure
3108
- */
3109
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
3110
- }
3111
- export class EarningCalls<HandleError extends boolean = boolean> {
3112
- protected readonly apiClient: JwtClient<HandleError>;
3113
- constructor(apiClient: JwtClient<HandleError>);
3114
- /**
3115
- * @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
3116
- * @tags Earning Calls
3117
- * @name GetCompanyEarningsCalls
3118
- * @summary Get Company Earnings Calls
3119
- * @request GET:/companies/{company_id}/earnings-call
3120
- * @secure
3121
- */
3122
- getCompanyEarningsCalls(companyId: number, query?: {
3123
- /**
3124
- * Language
3125
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3126
- * @default "en-US"
3127
- */
3128
- language?: BridgeWiseLanguageEnum;
3129
- /**
3130
- * Year
3131
- * Specify the year for which the analysis is requested.
3132
- */
3133
- year?: number | null;
3134
- /**
3135
- * Quarter
3136
- * Specify the quarter for which the analysis is requested.
3137
- */
3138
- quarter?: number | null;
3139
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
3140
- /**
3141
- * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
3142
- * @tags Earning Calls
3143
- * @name GetEarningsCallsRecaps
3144
- * @summary Get Earnings Calls Recaps
3145
- * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
3146
- * @secure
3147
- */
3148
- getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
3149
- /**
3150
- * Language
3151
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3152
- * @default "en-US"
3153
- */
3154
- language?: BridgeWiseLanguageEnum;
3155
- /**
3156
- * Type
3157
- * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
3158
- */
3159
- type?: BridgeWiseEarningsCallRecapEnum;
3160
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
3161
- }
3162
3256
  export class CompanyMarketData<HandleError extends boolean = boolean> {
3163
3257
  protected readonly apiClient: JwtClient<HandleError>;
3164
3258
  constructor(apiClient: JwtClient<HandleError>);
@@ -4001,54 +4095,30 @@ export class Holdings<HandleError extends boolean = boolean> {
4001
4095
  page_size?: number;
4002
4096
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
4003
4097
  }
4004
- export class FundMarketData<HandleError extends boolean = boolean> {
4098
+ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
4005
4099
  protected readonly apiClient: JwtClient<HandleError>;
4006
4100
  constructor(apiClient: JwtClient<HandleError>);
4007
4101
  /**
4008
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
4009
- * @tags Fund Market Data
4010
- * @name GetFundsMarketData
4011
- * @summary Get Funds Market Data
4012
- * @request GET:/funds/{fund_id}/market
4102
+ * @description Provide the user all the minimum required data for the fund ESG score.
4103
+ * @tags Fund ESG Analysis
4104
+ * @name GetFundEsgAnalysis
4105
+ * @summary Get Fund Esg Analysis
4106
+ * @request GET:/funds/{fund_id}/esg-analysis
4013
4107
  * @secure
4014
4108
  */
4015
- getFundsMarketData(fundId: number, query?: {
4016
- /**
4017
- * Trading Item Id
4018
- * Specify a BW trading asset identifier for a targeted query.
4019
- */
4020
- trading_item_id?: number | null;
4021
- /**
4022
- * Date Ge
4023
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4024
- */
4025
- date__ge?: string | null;
4026
- /**
4027
- * Date Le
4028
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4029
- */
4030
- date__le?: string | null;
4031
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
4032
- /**
4033
- * @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
4034
- * @tags Fund Market Data
4035
- * @name GetFundsMarketStatistics
4036
- * @summary Get Funds Market Statistics
4037
- * @request GET:/funds/{fund_id}/market-statistics
4038
- * @secure
4039
- */
4040
- getFundsMarketStatistics(fundId: number, query?: {
4109
+ getFundEsgAnalysis(fundId: number, query?: {
4041
4110
  /**
4042
- * Trading Item Id
4043
- * Specify a BW trading asset identifier for a targeted query.
4111
+ * Limit
4112
+ * Number of historical periods to be returned (default is 1).
4044
4113
  */
4045
- trading_item_id?: number | null;
4114
+ limit?: number;
4046
4115
  /**
4047
- * Identifier In
4048
- * Specify a list of external identifiers.
4116
+ * Language
4117
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4118
+ * @default "en-US"
4049
4119
  */
4050
- identifier__in?: string | null;
4051
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
4120
+ language?: BridgeWiseLanguageEnum;
4121
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
4052
4122
  }
4053
4123
  export class Segmentations<HandleError extends boolean = boolean> {
4054
4124
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4106,6 +4176,29 @@ export class Segmentations<HandleError extends boolean = boolean> {
4106
4176
  segment?: string;
4107
4177
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
4108
4178
  }
4179
+ export class Users<HandleError extends boolean = boolean> {
4180
+ protected readonly apiClient: JwtClient<HandleError>;
4181
+ constructor(apiClient: JwtClient<HandleError>);
4182
+ /**
4183
+ * @tags Users
4184
+ * @name Authenticate
4185
+ * @summary Authenticate
4186
+ * @request POST:/users/authenticate
4187
+ * @secure
4188
+ */
4189
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
4190
+ /**
4191
+ * @tags Users
4192
+ * @name FetchClientDetails
4193
+ * @summary Fetch Client Details
4194
+ * @request GET:/users/machine
4195
+ * @secure
4196
+ */
4197
+ fetchClientDetails(headers: {
4198
+ /** Authorization */
4199
+ authorization: string;
4200
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
4201
+ }
4109
4202
  export class Tenants<HandleError extends boolean = boolean> {
4110
4203
  protected readonly apiClient: JwtClient<HandleError>;
4111
4204
  constructor(apiClient: JwtClient<HandleError>);
@@ -4282,28 +4375,54 @@ export class Tenants<HandleError extends boolean = boolean> {
4282
4375
  */
4283
4376
  deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
4284
4377
  }
4285
- export class Users<HandleError extends boolean = boolean> {
4378
+ export class FundMarketData<HandleError extends boolean = boolean> {
4286
4379
  protected readonly apiClient: JwtClient<HandleError>;
4287
4380
  constructor(apiClient: JwtClient<HandleError>);
4288
4381
  /**
4289
- * @tags Users
4290
- * @name Authenticate
4291
- * @summary Authenticate
4292
- * @request POST:/users/authenticate
4382
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
4383
+ * @tags Fund Market Data
4384
+ * @name GetFundsMarketData
4385
+ * @summary Get Funds Market Data
4386
+ * @request GET:/funds/{fund_id}/market
4293
4387
  * @secure
4294
4388
  */
4295
- authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
4389
+ getFundsMarketData(fundId: number, query?: {
4390
+ /**
4391
+ * Trading Item Id
4392
+ * Specify a BW trading asset identifier for a targeted query.
4393
+ */
4394
+ trading_item_id?: number | null;
4395
+ /**
4396
+ * Date Ge
4397
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4398
+ */
4399
+ date__ge?: string | null;
4400
+ /**
4401
+ * Date Le
4402
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4403
+ */
4404
+ date__le?: string | null;
4405
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
4296
4406
  /**
4297
- * @tags Users
4298
- * @name FetchClientDetails
4299
- * @summary Fetch Client Details
4300
- * @request GET:/users/machine
4407
+ * @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
4408
+ * @tags Fund Market Data
4409
+ * @name GetFundsMarketStatistics
4410
+ * @summary Get Funds Market Statistics
4411
+ * @request GET:/funds/{fund_id}/market-statistics
4301
4412
  * @secure
4302
4413
  */
4303
- fetchClientDetails(headers: {
4304
- /** Authorization */
4305
- authorization: string;
4306
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
4414
+ getFundsMarketStatistics(fundId: number, query?: {
4415
+ /**
4416
+ * Trading Item Id
4417
+ * Specify a BW trading asset identifier for a targeted query.
4418
+ */
4419
+ trading_item_id?: number | null;
4420
+ /**
4421
+ * Identifier In
4422
+ * Specify a list of external identifiers.
4423
+ */
4424
+ identifier__in?: string | null;
4425
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
4307
4426
  }
4308
4427
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4309
4428
  readonly config: JwtClientConfig<HandleError>;
@@ -4311,10 +4430,12 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
4311
4430
  companyMarketData: CompanyMarketData<HandleError>;
4312
4431
  companyMetadata: CompanyMetadata<HandleError>;
4313
4432
  companyNews: CompanyNews<HandleError>;
4433
+ consensusAnalysts: ConsensusAnalysts<HandleError>;
4314
4434
  earningCalls: EarningCalls<HandleError>;
4315
4435
  esgAnalysis: EsgAnalysis<HandleError>;
4316
4436
  fundamentalAnalysis: FundamentalAnalysis<HandleError>;
4317
4437
  fundAnalysis: FundAnalysis<HandleError>;
4438
+ fundEsgAnalysis: FundEsgAnalysis<HandleError>;
4318
4439
  fundMarketData: FundMarketData<HandleError>;
4319
4440
  fundMetadata: FundMetadata<HandleError>;
4320
4441
  holdings: Holdings<HandleError>;