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

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 +132 -132
  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 +553 -553
  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 +1156 -1156
  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 +101 -101
  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 +4299 -4264
  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 +660 -660
  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 +713 -713
  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
@@ -2051,133 +2051,6 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
2051
2051
  Gt = "gt",
2052
2052
  Lt = "lt"
2053
2053
  }
2054
- export class Activities<HandleError extends boolean = boolean> {
2055
- protected readonly apiClient: JwtClient<HandleError>;
2056
- constructor(apiClient: JwtClient<HandleError>);
2057
- /**
2058
- * @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.
2059
- * @tags Activities
2060
- * @name GetCompanyAlerts
2061
- * @summary Get Company Alerts
2062
- * @request GET:/companies/{company_id}/alerts
2063
- * @secure
2064
- */
2065
- getCompanyAlerts(companyId: number, query?: {
2066
- /**
2067
- * Language
2068
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2069
- * @default "en-US"
2070
- */
2071
- language?: BridgeWiseLanguageEnum;
2072
- /**
2073
- * Alert Type
2074
- * Specify the group of the alert type that will be presented (fundamental or market).
2075
- */
2076
- alert_type?: BridgeWiseCompanyAlertType;
2077
- /**
2078
- * Sentiment
2079
- * Filter alerts by their sentiment.
2080
- */
2081
- sentiment?: BridgeWiseCompanyAlertSentiment;
2082
- /**
2083
- * Importance
2084
- * 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
2085
- */
2086
- importance?: string | null;
2087
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
2088
- /**
2089
- * @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.
2090
- * @tags Activities
2091
- * @name GetCompanyForecastsKeyDevelopment
2092
- * @summary Get Company Forecasts Key Development
2093
- * @request GET:/companies/{company_id}/key-developments
2094
- * @secure
2095
- */
2096
- getCompanyForecastsKeyDevelopment(companyId: number, query?: {
2097
- /**
2098
- * Language
2099
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2100
- * @default "en-US"
2101
- */
2102
- language?: BridgeWiseLanguageEnum;
2103
- /**
2104
- * Importance
2105
- * 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
2106
- * @default "0,1"
2107
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2108
- */
2109
- importance?: string;
2110
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
2111
- }
2112
- export class CompanyMarketData<HandleError extends boolean = boolean> {
2113
- protected readonly apiClient: JwtClient<HandleError>;
2114
- constructor(apiClient: JwtClient<HandleError>);
2115
- /**
2116
- * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
2117
- * @tags Company Market Data
2118
- * @name GetCompanyMarketData
2119
- * @summary Get Company Market Data
2120
- * @request GET:/companies/{company_id}/market
2121
- * @secure
2122
- */
2123
- getCompanyMarketData(companyId: number, query?: {
2124
- /**
2125
- * Trading Item Id
2126
- * Specify a BW trading asset identifier for a targeted query.
2127
- */
2128
- trading_item_id?: number | null;
2129
- /**
2130
- * Date Ge
2131
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
2132
- */
2133
- date__ge?: string | null;
2134
- /**
2135
- * Date Le
2136
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
2137
- */
2138
- date__le?: string | null;
2139
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
2140
- /**
2141
- * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
2142
- * @tags Company Market Data
2143
- * @name GetCompanyMarketStatistics
2144
- * @summary Get Company Market Statistics
2145
- * @request GET:/companies/{company_id}/market-statistics
2146
- * @secure
2147
- */
2148
- getCompanyMarketStatistics(companyId: number, query?: {
2149
- /**
2150
- * Trading Item Id
2151
- * Specify a BW trading asset identifier for a targeted query.
2152
- */
2153
- trading_item_id?: number | null;
2154
- /**
2155
- * Identifier In
2156
- * Specify a list of external identifiers.
2157
- */
2158
- identifier__in?: string | null;
2159
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
2160
- /**
2161
- * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
2162
- * @tags Company Market Data
2163
- * @name GetTradingItems
2164
- * @summary Get Trading Items
2165
- * @request GET:/companies/{company_id}/trading-items
2166
- * @secure
2167
- */
2168
- getTradingItems(companyId: number, query?: {
2169
- /**
2170
- * Primary Flag
2171
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
2172
- */
2173
- primary_flag?: BridgeWiseStringBooleanEnum;
2174
- /**
2175
- * Security Primary Flag
2176
- * Boolean flag. Indicate if only primary asset data is required (true/false).
2177
- */
2178
- security_primary_flag?: BridgeWiseStringBooleanEnum;
2179
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2180
- }
2181
2054
  export class CompanyMetadata<HandleError extends boolean = boolean> {
2182
2055
  protected readonly apiClient: JwtClient<HandleError>;
2183
2056
  constructor(apiClient: JwtClient<HandleError>);
@@ -2821,97 +2694,91 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2821
2694
  identifier_type: BridgeWiseIdentifierTypeEnum;
2822
2695
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2823
2696
  }
2824
- export class CompanyNews<HandleError extends boolean = boolean> {
2697
+ export class EsgAnalysis<HandleError extends boolean = boolean> {
2825
2698
  protected readonly apiClient: JwtClient<HandleError>;
2826
2699
  constructor(apiClient: JwtClient<HandleError>);
2827
2700
  /**
2828
- * @description This endpoint provides news articles related to the specified company.
2829
- * @tags Company News
2830
- * @name GetCompanyNews
2831
- * @summary Get Company News
2832
- * @request GET:/companies/{company_id}/news
2701
+ * @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
2702
+ * @tags ESG Analysis
2703
+ * @name GetCompanyEsgAnalysis
2704
+ * @summary Get Company Esg Analysis
2705
+ * @request GET:/companies/{company_id}/esg-analysis
2833
2706
  * @secure
2834
2707
  */
2835
- getCompanyNews(companyId: number, query?: {
2708
+ getCompanyEsgAnalysis(companyId: number, query?: {
2836
2709
  /**
2837
- * Languages
2710
+ * Language
2838
2711
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2839
2712
  * @default "en-US"
2840
- * @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
2841
2713
  */
2842
- languages?: string;
2714
+ language?: BridgeWiseLanguageEnum;
2843
2715
  /**
2844
- * Published Date Gte
2845
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2846
- * @format date
2847
- * @default "2025-04-09"
2716
+ * Show All
2717
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
2848
2718
  */
2849
- published_date__gte?: string;
2719
+ show_all?: boolean;
2720
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
2721
+ /**
2722
+ * @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
2723
+ * @tags ESG Analysis
2724
+ * @name GetCompanyEsgParagraphs
2725
+ * @summary Get Company Esg Paragraphs
2726
+ * @request GET:/companies/{company_id}/esg-paragraphs
2727
+ * @secure
2728
+ */
2729
+ getCompanyEsgParagraphs(companyId: number, query?: {
2850
2730
  /**
2851
- * Published Date Lte
2852
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2853
- * @format date
2854
- * @default "2025-04-09"
2731
+ * Language
2732
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2733
+ * @default "en-US"
2855
2734
  */
2856
- published_date__lte?: string;
2735
+ language?: BridgeWiseLanguageEnum;
2857
2736
  /**
2858
- * Sort By
2859
- * Specify the field by which to sort the results.
2860
- * @default "publication_date"
2737
+ * Section Type
2738
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
2861
2739
  */
2862
- sort_by?: BridgeWiseCompanyNewsSortingEnum;
2740
+ section_type?: BridgeWiseESGSectionTypeEnum;
2741
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
2742
+ /**
2743
+ * @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
2744
+ * @tags ESG Analysis
2745
+ * @name GetCompanyEsgParameters
2746
+ * @summary Get Company Esg Parameters
2747
+ * @request GET:/companies/{company_id}/esg-parameters
2748
+ * @secure
2749
+ */
2750
+ getCompanyEsgParameters(companyId: number, query?: {
2863
2751
  /**
2864
- * Size
2865
- * Define the number of records per page for pagination purposes.
2866
- * @default 10
2867
- * @example 10
2752
+ * Language
2753
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2754
+ * @default "en-US"
2868
2755
  */
2869
- size?: number;
2756
+ language?: BridgeWiseLanguageEnum;
2870
2757
  /**
2871
- * Page
2872
- * Define the page number for pagination.
2873
- * @default 1
2874
- * @example 1
2758
+ * Parameter Id
2759
+ * Get desired parameter by ID.
2875
2760
  */
2876
- page?: number;
2877
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
2878
- /**
2879
- * @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
2880
- * @tags Company News
2881
- * @name GetAverageCompanyNewsSentiment
2882
- * @summary Get Average Company News Sentiment
2883
- * @request GET:/companies/{company_id}/news-sentiment
2884
- * @secure
2885
- */
2886
- getAverageCompanyNewsSentiment(companyId: number, query?: {
2761
+ parameter_id?: number;
2887
2762
  /**
2888
- * Published Date Gte
2889
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2890
- * @format date
2891
- * @default "2025-04-09"
2763
+ * Section Type
2764
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
2892
2765
  */
2893
- published_date__gte?: string;
2766
+ section_type?: BridgeWiseSectionTypeEnum;
2894
2767
  /**
2895
- * Published Date Lte
2896
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2897
- * @format date
2898
- * @default "2025-04-09"
2768
+ * Show All
2769
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
2899
2770
  */
2900
- published_date__lte?: string;
2901
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
2902
- }
2903
- export class EarningCalls<HandleError extends boolean = boolean> {
2904
- protected readonly apiClient: JwtClient<HandleError>;
2905
- constructor(apiClient: JwtClient<HandleError>);
2771
+ show_all?: boolean;
2772
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
2906
2773
  /**
2907
- * @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.
2908
- * @tags Earning Calls
2909
- * @name GetCompanyEarningsCalls
2910
- * @summary Get Company Earnings Calls
2911
- * @request GET:/companies/{company_id}/earnings-call
2774
+ * @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
2775
+ * @tags ESG Analysis
2776
+ * @name GetCompanyEsgSections
2777
+ * @summary Get Company Esg Sections
2778
+ * @request GET:/companies/{company_id}/esg-sections
2912
2779
  * @secure
2913
2780
  */
2914
- getCompanyEarningsCalls(companyId: number, query?: {
2781
+ getCompanyEsgSections(companyId: number, query?: {
2915
2782
  /**
2916
2783
  * Language
2917
2784
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
@@ -2919,132 +2786,8 @@ export class EarningCalls<HandleError extends boolean = boolean> {
2919
2786
  */
2920
2787
  language?: BridgeWiseLanguageEnum;
2921
2788
  /**
2922
- * Year
2923
- * Specify the year for which the analysis is requested.
2924
- */
2925
- year?: number | null;
2926
- /**
2927
- * Quarter
2928
- * Specify the quarter for which the analysis is requested.
2929
- */
2930
- quarter?: number | null;
2931
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
2932
- /**
2933
- * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
2934
- * @tags Earning Calls
2935
- * @name GetEarningsCallsRecaps
2936
- * @summary Get Earnings Calls Recaps
2937
- * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
2938
- * @secure
2939
- */
2940
- getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
2941
- /**
2942
- * Language
2943
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2944
- * @default "en-US"
2945
- */
2946
- language?: BridgeWiseLanguageEnum;
2947
- /**
2948
- * Type
2949
- * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
2950
- */
2951
- type?: BridgeWiseEarningsCallRecapEnum;
2952
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
2953
- }
2954
- export class EsgAnalysis<HandleError extends boolean = boolean> {
2955
- protected readonly apiClient: JwtClient<HandleError>;
2956
- constructor(apiClient: JwtClient<HandleError>);
2957
- /**
2958
- * @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
2959
- * @tags ESG Analysis
2960
- * @name GetCompanyEsgAnalysis
2961
- * @summary Get Company Esg Analysis
2962
- * @request GET:/companies/{company_id}/esg-analysis
2963
- * @secure
2964
- */
2965
- getCompanyEsgAnalysis(companyId: number, query?: {
2966
- /**
2967
- * Language
2968
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2969
- * @default "en-US"
2970
- */
2971
- language?: BridgeWiseLanguageEnum;
2972
- /**
2973
- * Show All
2974
- * Boolean flag. Indicate whether to return historical data (`true/false`).
2975
- */
2976
- show_all?: boolean;
2977
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
2978
- /**
2979
- * @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
2980
- * @tags ESG Analysis
2981
- * @name GetCompanyEsgParagraphs
2982
- * @summary Get Company Esg Paragraphs
2983
- * @request GET:/companies/{company_id}/esg-paragraphs
2984
- * @secure
2985
- */
2986
- getCompanyEsgParagraphs(companyId: number, query?: {
2987
- /**
2988
- * Language
2989
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2990
- * @default "en-US"
2991
- */
2992
- language?: BridgeWiseLanguageEnum;
2993
- /**
2994
- * Section Type
2995
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
2996
- */
2997
- section_type?: BridgeWiseESGSectionTypeEnum;
2998
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
2999
- /**
3000
- * @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
3001
- * @tags ESG Analysis
3002
- * @name GetCompanyEsgParameters
3003
- * @summary Get Company Esg Parameters
3004
- * @request GET:/companies/{company_id}/esg-parameters
3005
- * @secure
3006
- */
3007
- getCompanyEsgParameters(companyId: number, query?: {
3008
- /**
3009
- * Language
3010
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3011
- * @default "en-US"
3012
- */
3013
- language?: BridgeWiseLanguageEnum;
3014
- /**
3015
- * Parameter Id
3016
- * Get desired parameter by ID.
3017
- */
3018
- parameter_id?: number;
3019
- /**
3020
- * Section Type
3021
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
3022
- */
3023
- section_type?: BridgeWiseSectionTypeEnum;
3024
- /**
3025
- * Show All
3026
- * Boolean flag. Indicate whether to return historical data (`true/false`).
3027
- */
3028
- show_all?: boolean;
3029
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
3030
- /**
3031
- * @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
3032
- * @tags ESG Analysis
3033
- * @name GetCompanyEsgSections
3034
- * @summary Get Company Esg Sections
3035
- * @request GET:/companies/{company_id}/esg-sections
3036
- * @secure
3037
- */
3038
- getCompanyEsgSections(companyId: number, query?: {
3039
- /**
3040
- * Language
3041
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3042
- * @default "en-US"
3043
- */
3044
- language?: BridgeWiseLanguageEnum;
3045
- /**
3046
- * Section Type
3047
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
2789
+ * Section Type
2790
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
3048
2791
  */
3049
2792
  section_type?: BridgeWiseESGSectionTypeEnum;
3050
2793
  /**
@@ -3262,18 +3005,18 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3262
3005
  date__lte?: string;
3263
3006
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
3264
3007
  }
3265
- export class FundAnalysis<HandleError extends boolean = boolean> {
3008
+ export class Activities<HandleError extends boolean = boolean> {
3266
3009
  protected readonly apiClient: JwtClient<HandleError>;
3267
3010
  constructor(apiClient: JwtClient<HandleError>);
3268
3011
  /**
3269
- * @description Returns Bridgewise final analysis for a specified fund.
3270
- * @tags Fund Analysis
3271
- * @name GetFundAnalysis
3272
- * @summary Get Fund Analysis
3273
- * @request GET:/funds/{fund_id}/analysis
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
3274
3017
  * @secure
3275
3018
  */
3276
- getFundAnalysis(fundId: number, query?: {
3019
+ getCompanyAlerts(companyId: number, query?: {
3277
3020
  /**
3278
3021
  * Language
3279
3022
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
@@ -3281,30 +3024,102 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3281
3024
  */
3282
3025
  language?: BridgeWiseLanguageEnum;
3283
3026
  /**
3284
- * Year
3285
- * Specify the year for which the analysis is requested.
3027
+ * Alert Type
3028
+ * Specify the group of the alert type that will be presented (fundamental or market).
3286
3029
  */
3287
- year?: number;
3030
+ alert_type?: BridgeWiseCompanyAlertType;
3288
3031
  /**
3289
- * Quarter
3290
- * Specify the quarter for which the analysis is requested.
3032
+ * Sentiment
3033
+ * Filter alerts by their sentiment.
3291
3034
  */
3292
- quarter?: number;
3035
+ sentiment?: BridgeWiseCompanyAlertSentiment;
3293
3036
  /**
3294
- * Show All
3295
- * Boolean flag. Indicate whether to return historical data (`true/false`).
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
3296
3039
  */
3297
- show_all?: boolean;
3298
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
3040
+ importance?: string | null;
3041
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
3299
3042
  /**
3300
- * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
3301
- * @tags Fund Analysis
3302
- * @name GetFundsParagraphs
3303
- * @summary Get Funds Paragraphs
3304
- * @request GET:/funds/{fund_id}/paragraphs
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
3305
3048
  * @secure
3306
3049
  */
3307
- getFundsParagraphs(fundId: number, query?: {
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?: {
3308
3123
  /**
3309
3124
  * Language
3310
3125
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
@@ -3321,16 +3136,16 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3321
3136
  * Specify the quarter for which the analysis is requested.
3322
3137
  */
3323
3138
  quarter?: number | null;
3324
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
3139
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
3325
3140
  /**
3326
- * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
3327
- * @tags Fund Analysis
3328
- * @name GetFundParameters
3329
- * @summary Get Fund Parameters
3330
- * @request GET:/funds/{fund_id}/parameters
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
3331
3146
  * @secure
3332
3147
  */
3333
- getFundParameters(fundId: number, query?: {
3148
+ getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
3334
3149
  /**
3335
3150
  * Language
3336
3151
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
@@ -3338,91 +3153,256 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3338
3153
  */
3339
3154
  language?: BridgeWiseLanguageEnum;
3340
3155
  /**
3341
- * Parameter Id
3342
- * ID of the parameter for analysis.
3156
+ * Type
3157
+ * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
3343
3158
  */
3344
- parameter_id?: number;
3345
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
3159
+ type?: BridgeWiseEarningsCallRecapEnum;
3160
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
3161
+ }
3162
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
3163
+ protected readonly apiClient: JwtClient<HandleError>;
3164
+ constructor(apiClient: JwtClient<HandleError>);
3346
3165
  /**
3347
- * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
3348
- * @tags Fund Analysis
3349
- * @name GetFundSections
3350
- * @summary Get Fund Sections
3351
- * @request GET:/funds/{fund_id}/sections
3166
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
3167
+ * @tags Company Market Data
3168
+ * @name GetCompanyMarketData
3169
+ * @summary Get Company Market Data
3170
+ * @request GET:/companies/{company_id}/market
3352
3171
  * @secure
3353
3172
  */
3354
- getFundSections(fundId: number, query?: {
3173
+ getCompanyMarketData(companyId: number, query?: {
3355
3174
  /**
3356
- * Year
3357
- * Specify the year for which the analysis is requested.
3175
+ * Trading Item Id
3176
+ * Specify a BW trading asset identifier for a targeted query.
3358
3177
  */
3359
- year?: number;
3178
+ trading_item_id?: number | null;
3360
3179
  /**
3361
- * Quarter
3362
- * Specify the quarter for which the analysis is requested.
3180
+ * Date Ge
3181
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3363
3182
  */
3364
- quarter?: number;
3183
+ date__ge?: string | null;
3365
3184
  /**
3366
- * Language
3185
+ * Date Le
3186
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3187
+ */
3188
+ date__le?: string | null;
3189
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
3190
+ /**
3191
+ * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
3192
+ * @tags Company Market Data
3193
+ * @name GetCompanyMarketStatistics
3194
+ * @summary Get Company Market Statistics
3195
+ * @request GET:/companies/{company_id}/market-statistics
3196
+ * @secure
3197
+ */
3198
+ getCompanyMarketStatistics(companyId: number, query?: {
3199
+ /**
3200
+ * Trading Item Id
3201
+ * Specify a BW trading asset identifier for a targeted query.
3202
+ */
3203
+ trading_item_id?: number | null;
3204
+ /**
3205
+ * Identifier In
3206
+ * Specify a list of external identifiers.
3207
+ */
3208
+ identifier__in?: string | null;
3209
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
3210
+ /**
3211
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
3212
+ * @tags Company Market Data
3213
+ * @name GetTradingItems
3214
+ * @summary Get Trading Items
3215
+ * @request GET:/companies/{company_id}/trading-items
3216
+ * @secure
3217
+ */
3218
+ getTradingItems(companyId: number, query?: {
3219
+ /**
3220
+ * Primary Flag
3221
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
3222
+ */
3223
+ primary_flag?: BridgeWiseStringBooleanEnum;
3224
+ /**
3225
+ * Security Primary Flag
3226
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
3227
+ */
3228
+ security_primary_flag?: BridgeWiseStringBooleanEnum;
3229
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
3230
+ }
3231
+ export class CompanyNews<HandleError extends boolean = boolean> {
3232
+ protected readonly apiClient: JwtClient<HandleError>;
3233
+ constructor(apiClient: JwtClient<HandleError>);
3234
+ /**
3235
+ * @description This endpoint provides news articles related to the specified company.
3236
+ * @tags Company News
3237
+ * @name GetCompanyNews
3238
+ * @summary Get Company News
3239
+ * @request GET:/companies/{company_id}/news
3240
+ * @secure
3241
+ */
3242
+ getCompanyNews(companyId: number, query?: {
3243
+ /**
3244
+ * Languages
3367
3245
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3368
3246
  * @default "en-US"
3247
+ * @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
3369
3248
  */
3370
- language?: BridgeWiseLanguageEnum;
3249
+ languages?: string;
3371
3250
  /**
3372
- * Show All
3373
- * Boolean flag. Indicate whether to return historical data (`true/false`).
3251
+ * Published Date Gte
3252
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3253
+ * @format date
3254
+ * @default "2025-04-09"
3374
3255
  */
3375
- show_all?: boolean;
3376
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
3256
+ published_date__gte?: string;
3257
+ /**
3258
+ * Published Date Lte
3259
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3260
+ * @format date
3261
+ * @default "2025-04-09"
3262
+ */
3263
+ published_date__lte?: string;
3264
+ /**
3265
+ * Sort By
3266
+ * Specify the field by which to sort the results.
3267
+ * @default "publication_date"
3268
+ */
3269
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
3270
+ /**
3271
+ * Size
3272
+ * Define the number of records per page for pagination purposes.
3273
+ * @default 10
3274
+ * @example 10
3275
+ */
3276
+ size?: number;
3277
+ /**
3278
+ * Page
3279
+ * Define the page number for pagination.
3280
+ * @default 1
3281
+ * @example 1
3282
+ */
3283
+ page?: number;
3284
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
3285
+ /**
3286
+ * @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
3287
+ * @tags Company News
3288
+ * @name GetAverageCompanyNewsSentiment
3289
+ * @summary Get Average Company News Sentiment
3290
+ * @request GET:/companies/{company_id}/news-sentiment
3291
+ * @secure
3292
+ */
3293
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
3294
+ /**
3295
+ * Published Date Gte
3296
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3297
+ * @format date
3298
+ * @default "2025-04-09"
3299
+ */
3300
+ published_date__gte?: string;
3301
+ /**
3302
+ * Published Date Lte
3303
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3304
+ * @format date
3305
+ * @default "2025-04-09"
3306
+ */
3307
+ published_date__lte?: string;
3308
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
3377
3309
  }
3378
- export class FundMarketData<HandleError extends boolean = boolean> {
3310
+ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3379
3311
  protected readonly apiClient: JwtClient<HandleError>;
3380
3312
  constructor(apiClient: JwtClient<HandleError>);
3381
3313
  /**
3382
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
3383
- * @tags Fund Market Data
3384
- * @name GetFundsMarketData
3385
- * @summary Get Funds Market Data
3386
- * @request GET:/funds/{fund_id}/market
3314
+ * @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
3315
+ * @tags Technical Analysis
3316
+ * @name GetCompanyTechnicalAnalysis
3317
+ * @summary Get Company Technical Analysis
3318
+ * @request GET:/companies/{company_id}/technical-analysis
3387
3319
  * @secure
3388
3320
  */
3389
- getFundsMarketData(fundId: number, query?: {
3321
+ getCompanyTechnicalAnalysis(companyId: number, query?: {
3322
+ /**
3323
+ * Language
3324
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3325
+ * @default "en-US"
3326
+ */
3327
+ language?: BridgeWiseLanguageEnum;
3390
3328
  /**
3391
3329
  * Trading Item Id
3392
3330
  * Specify a BW trading asset identifier for a targeted query.
3393
3331
  */
3394
- trading_item_id?: number | null;
3332
+ trading_item_id?: number;
3333
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
3334
+ /**
3335
+ * @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
3336
+ * @tags Technical Analysis
3337
+ * @name GetCompanyTechnicalParagraphs
3338
+ * @summary Get Company Technical Paragraphs
3339
+ * @request GET:/companies/{company_id}/technical-paragraphs
3340
+ * @secure
3341
+ */
3342
+ getCompanyTechnicalParagraphs(companyId: number, query?: {
3395
3343
  /**
3396
- * Date Ge
3397
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3344
+ * Language
3345
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3346
+ * @default "en-US"
3398
3347
  */
3399
- date__ge?: string | null;
3348
+ language?: BridgeWiseLanguageEnum;
3400
3349
  /**
3401
- * Date Le
3402
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3350
+ * Trading Item Id
3351
+ * Specify a BW trading asset identifier for a targeted query.
3403
3352
  */
3404
- date__le?: string | null;
3405
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
3353
+ trading_item_id?: number;
3354
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
3406
3355
  /**
3407
- * @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.
3408
- * @tags Fund Market Data
3409
- * @name GetFundsMarketStatistics
3410
- * @summary Get Funds Market Statistics
3411
- * @request GET:/funds/{fund_id}/market-statistics
3356
+ * @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
3357
+ * @tags Technical Analysis
3358
+ * @name GetCompanyTechnicalParameters
3359
+ * @summary Get Company Technical Parameters
3360
+ * @request GET:/companies/{company_id}/technical-parameters
3412
3361
  * @secure
3413
3362
  */
3414
- getFundsMarketStatistics(fundId: number, query?: {
3363
+ getCompanyTechnicalParameters(companyId: number, query?: {
3364
+ /**
3365
+ * Language
3366
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3367
+ * @default "en-US"
3368
+ */
3369
+ language?: BridgeWiseLanguageEnum;
3415
3370
  /**
3416
3371
  * Trading Item Id
3417
3372
  * Specify a BW trading asset identifier for a targeted query.
3418
3373
  */
3419
- trading_item_id?: number | null;
3374
+ trading_item_id?: number;
3420
3375
  /**
3421
- * Identifier In
3422
- * Specify a list of external identifiers.
3376
+ * Parameter Id
3377
+ * Get desired parameter by ID.
3423
3378
  */
3424
- identifier__in?: string | null;
3425
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
3379
+ parameter_id?: number;
3380
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
3381
+ }
3382
+ export class Metadata<HandleError extends boolean = boolean> {
3383
+ protected readonly apiClient: JwtClient<HandleError>;
3384
+ constructor(apiClient: JwtClient<HandleError>);
3385
+ /**
3386
+ * @description This endpoint provides filters
3387
+ * @tags Metadata
3388
+ * @name GetCompanyFilters
3389
+ * @summary Get Company Filters
3390
+ * @request GET:/filters
3391
+ * @secure
3392
+ */
3393
+ getCompanyFilters(query: {
3394
+ /**
3395
+ * Type
3396
+ * Desired filter type.
3397
+ */
3398
+ type: BridgeWiseCompanyFilterType;
3399
+ /**
3400
+ * Language
3401
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3402
+ * @default "en-US"
3403
+ */
3404
+ language?: BridgeWiseLanguageEnum;
3405
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
3426
3406
  }
3427
3407
  export class FundMetadata<HandleError extends boolean = boolean> {
3428
3408
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3757,63 +3737,176 @@ export class FundMetadata<HandleError extends boolean = boolean> {
3757
3737
  * Section Performance Score Gte
3758
3738
  * Section performance score greater than or equal to.
3759
3739
  */
3760
- section_performance_score__gte?: number;
3740
+ section_performance_score__gte?: number;
3741
+ /**
3742
+ * Section Performance Score Lte
3743
+ * Section performance score less than or equal to.
3744
+ */
3745
+ section_performance_score__lte?: number;
3746
+ /**
3747
+ * Return Range Gte
3748
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3749
+ */
3750
+ return_range__gte?: string;
3751
+ /**
3752
+ * Return Value Gte
3753
+ * Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
3754
+ */
3755
+ return_value__gte?: string;
3756
+ /**
3757
+ * Return Range Lte
3758
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3759
+ */
3760
+ return_range__lte?: string;
3761
+ /**
3762
+ * Return Value Lte
3763
+ * Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
3764
+ */
3765
+ return_value__lte?: string;
3766
+ /**
3767
+ * Page
3768
+ * Define the page number for pagination.
3769
+ * @exclusiveMin 0
3770
+ * @default 1
3771
+ */
3772
+ page?: number;
3773
+ /**
3774
+ * Page Size
3775
+ * Define the number of records per page for pagination purposes.
3776
+ * @exclusiveMin 0
3777
+ * @default 100
3778
+ */
3779
+ page_size?: number;
3780
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
3781
+ /**
3782
+ * @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
3783
+ * @tags Fund Metadata
3784
+ * @name GetFund
3785
+ * @summary Get Fund
3786
+ * @request GET:/funds/{fund_id}
3787
+ * @secure
3788
+ */
3789
+ getFund(fundId: number, query?: {
3790
+ /**
3791
+ * Language
3792
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3793
+ * @default "en-US"
3794
+ */
3795
+ language?: BridgeWiseLanguageEnum;
3796
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
3797
+ }
3798
+ export class FundAnalysis<HandleError extends boolean = boolean> {
3799
+ protected readonly apiClient: JwtClient<HandleError>;
3800
+ constructor(apiClient: JwtClient<HandleError>);
3801
+ /**
3802
+ * @description Returns Bridgewise final analysis for a specified fund.
3803
+ * @tags Fund Analysis
3804
+ * @name GetFundAnalysis
3805
+ * @summary Get Fund Analysis
3806
+ * @request GET:/funds/{fund_id}/analysis
3807
+ * @secure
3808
+ */
3809
+ getFundAnalysis(fundId: number, query?: {
3810
+ /**
3811
+ * Language
3812
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3813
+ * @default "en-US"
3814
+ */
3815
+ language?: BridgeWiseLanguageEnum;
3816
+ /**
3817
+ * Year
3818
+ * Specify the year for which the analysis is requested.
3819
+ */
3820
+ year?: number;
3761
3821
  /**
3762
- * Section Performance Score Lte
3763
- * Section performance score less than or equal to.
3822
+ * Quarter
3823
+ * Specify the quarter for which the analysis is requested.
3764
3824
  */
3765
- section_performance_score__lte?: number;
3825
+ quarter?: number;
3766
3826
  /**
3767
- * Return Range Gte
3768
- * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3827
+ * Show All
3828
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3769
3829
  */
3770
- return_range__gte?: string;
3830
+ show_all?: boolean;
3831
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
3832
+ /**
3833
+ * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
3834
+ * @tags Fund Analysis
3835
+ * @name GetFundsParagraphs
3836
+ * @summary Get Funds Paragraphs
3837
+ * @request GET:/funds/{fund_id}/paragraphs
3838
+ * @secure
3839
+ */
3840
+ getFundsParagraphs(fundId: number, query?: {
3771
3841
  /**
3772
- * Return Value Gte
3773
- * Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
3842
+ * Language
3843
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3844
+ * @default "en-US"
3774
3845
  */
3775
- return_value__gte?: string;
3846
+ language?: BridgeWiseLanguageEnum;
3776
3847
  /**
3777
- * Return Range Lte
3778
- * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3848
+ * Year
3849
+ * Specify the year for which the analysis is requested.
3779
3850
  */
3780
- return_range__lte?: string;
3851
+ year?: number | null;
3781
3852
  /**
3782
- * Return Value Lte
3783
- * Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
3853
+ * Quarter
3854
+ * Specify the quarter for which the analysis is requested.
3784
3855
  */
3785
- return_value__lte?: string;
3856
+ quarter?: number | null;
3857
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
3858
+ /**
3859
+ * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
3860
+ * @tags Fund Analysis
3861
+ * @name GetFundParameters
3862
+ * @summary Get Fund Parameters
3863
+ * @request GET:/funds/{fund_id}/parameters
3864
+ * @secure
3865
+ */
3866
+ getFundParameters(fundId: number, query?: {
3786
3867
  /**
3787
- * Page
3788
- * Define the page number for pagination.
3789
- * @exclusiveMin 0
3790
- * @default 1
3868
+ * Language
3869
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3870
+ * @default "en-US"
3791
3871
  */
3792
- page?: number;
3872
+ language?: BridgeWiseLanguageEnum;
3793
3873
  /**
3794
- * Page Size
3795
- * Define the number of records per page for pagination purposes.
3796
- * @exclusiveMin 0
3797
- * @default 100
3874
+ * Parameter Id
3875
+ * ID of the parameter for analysis.
3798
3876
  */
3799
- page_size?: number;
3800
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
3877
+ parameter_id?: number;
3878
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
3801
3879
  /**
3802
- * @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
3803
- * @tags Fund Metadata
3804
- * @name GetFund
3805
- * @summary Get Fund
3806
- * @request GET:/funds/{fund_id}
3880
+ * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
3881
+ * @tags Fund Analysis
3882
+ * @name GetFundSections
3883
+ * @summary Get Fund Sections
3884
+ * @request GET:/funds/{fund_id}/sections
3807
3885
  * @secure
3808
3886
  */
3809
- getFund(fundId: number, query?: {
3887
+ getFundSections(fundId: number, query?: {
3888
+ /**
3889
+ * Year
3890
+ * Specify the year for which the analysis is requested.
3891
+ */
3892
+ year?: number;
3893
+ /**
3894
+ * Quarter
3895
+ * Specify the quarter for which the analysis is requested.
3896
+ */
3897
+ quarter?: number;
3810
3898
  /**
3811
3899
  * Language
3812
3900
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3813
3901
  * @default "en-US"
3814
3902
  */
3815
3903
  language?: BridgeWiseLanguageEnum;
3816
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
3904
+ /**
3905
+ * Show All
3906
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3907
+ */
3908
+ show_all?: boolean;
3909
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
3817
3910
  }
3818
3911
  export class Holdings<HandleError extends boolean = boolean> {
3819
3912
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3908,75 +4001,54 @@ export class Holdings<HandleError extends boolean = boolean> {
3908
4001
  page_size?: number;
3909
4002
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
3910
4003
  }
3911
- export class Logos<HandleError extends boolean = boolean> {
4004
+ export class FundMarketData<HandleError extends boolean = boolean> {
3912
4005
  protected readonly apiClient: JwtClient<HandleError>;
3913
4006
  constructor(apiClient: JwtClient<HandleError>);
3914
4007
  /**
3915
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
3916
- * @tags Logos
3917
- * @name FetchLogos
3918
- * @summary Fetch Logos
3919
- * @request GET:/companies/logos
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
3920
4013
  * @secure
3921
4014
  */
3922
- fetchLogos(query?: {
4015
+ getFundsMarketData(fundId: number, query?: {
3923
4016
  /**
3924
- * Company Id In
3925
- * Specify a list of BW identifiers for bulk queries.
3926
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3927
- * @example "74822,83343211"
4017
+ * Trading Item Id
4018
+ * Specify a BW trading asset identifier for a targeted query.
3928
4019
  */
3929
- company_id__in?: string;
4020
+ trading_item_id?: number | null;
3930
4021
  /**
3931
- * Size
3932
- * Page size
3933
- * @min 1
3934
- * @max 100
3935
- * @default 50
4022
+ * Date Ge
4023
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3936
4024
  */
3937
- size?: number;
4025
+ date__ge?: string | null;
3938
4026
  /**
3939
- * Page
3940
- * Page number
3941
- * @min 1
3942
- * @default 1
4027
+ * Date Le
4028
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3943
4029
  */
3944
- page?: number;
3945
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
3946
- /**
3947
- * @description Retrieves the logo for a specified company using the provided company_id.
3948
- * @tags Logos
3949
- * @name FetchLogo
3950
- * @summary Fetch Logo
3951
- * @request GET:/companies/{company_id}/logos
3952
- * @secure
3953
- */
3954
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
3955
- }
3956
- export class Metadata<HandleError extends boolean = boolean> {
3957
- protected readonly apiClient: JwtClient<HandleError>;
3958
- constructor(apiClient: JwtClient<HandleError>);
4030
+ date__le?: string | null;
4031
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
3959
4032
  /**
3960
- * @description This endpoint provides filters
3961
- * @tags Metadata
3962
- * @name GetCompanyFilters
3963
- * @summary Get Company Filters
3964
- * @request GET:/filters
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
3965
4038
  * @secure
3966
4039
  */
3967
- getCompanyFilters(query: {
4040
+ getFundsMarketStatistics(fundId: number, query?: {
3968
4041
  /**
3969
- * Type
3970
- * Desired filter type.
4042
+ * Trading Item Id
4043
+ * Specify a BW trading asset identifier for a targeted query.
3971
4044
  */
3972
- type: BridgeWiseCompanyFilterType;
4045
+ trading_item_id?: number | null;
3973
4046
  /**
3974
- * Language
3975
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3976
- * @default "en-US"
4047
+ * Identifier In
4048
+ * Specify a list of external identifiers.
3977
4049
  */
3978
- language?: BridgeWiseLanguageEnum;
3979
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
4050
+ identifier__in?: string | null;
4051
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
3980
4052
  }
3981
4053
  export class Segmentations<HandleError extends boolean = boolean> {
3982
4054
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4034,78 +4106,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
4034
4106
  segment?: string;
4035
4107
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
4036
4108
  }
4037
- export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4038
- protected readonly apiClient: JwtClient<HandleError>;
4039
- constructor(apiClient: JwtClient<HandleError>);
4040
- /**
4041
- * @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
4042
- * @tags Technical Analysis
4043
- * @name GetCompanyTechnicalAnalysis
4044
- * @summary Get Company Technical Analysis
4045
- * @request GET:/companies/{company_id}/technical-analysis
4046
- * @secure
4047
- */
4048
- getCompanyTechnicalAnalysis(companyId: number, query?: {
4049
- /**
4050
- * Language
4051
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4052
- * @default "en-US"
4053
- */
4054
- language?: BridgeWiseLanguageEnum;
4055
- /**
4056
- * Trading Item Id
4057
- * Specify a BW trading asset identifier for a targeted query.
4058
- */
4059
- trading_item_id?: number;
4060
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
4061
- /**
4062
- * @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
4063
- * @tags Technical Analysis
4064
- * @name GetCompanyTechnicalParagraphs
4065
- * @summary Get Company Technical Paragraphs
4066
- * @request GET:/companies/{company_id}/technical-paragraphs
4067
- * @secure
4068
- */
4069
- getCompanyTechnicalParagraphs(companyId: number, query?: {
4070
- /**
4071
- * Language
4072
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4073
- * @default "en-US"
4074
- */
4075
- language?: BridgeWiseLanguageEnum;
4076
- /**
4077
- * Trading Item Id
4078
- * Specify a BW trading asset identifier for a targeted query.
4079
- */
4080
- trading_item_id?: number;
4081
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
4082
- /**
4083
- * @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
4084
- * @tags Technical Analysis
4085
- * @name GetCompanyTechnicalParameters
4086
- * @summary Get Company Technical Parameters
4087
- * @request GET:/companies/{company_id}/technical-parameters
4088
- * @secure
4089
- */
4090
- getCompanyTechnicalParameters(companyId: number, query?: {
4091
- /**
4092
- * Language
4093
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4094
- * @default "en-US"
4095
- */
4096
- language?: BridgeWiseLanguageEnum;
4097
- /**
4098
- * Trading Item Id
4099
- * Specify a BW trading asset identifier for a targeted query.
4100
- */
4101
- trading_item_id?: number;
4102
- /**
4103
- * Parameter Id
4104
- * Get desired parameter by ID.
4105
- */
4106
- parameter_id?: number;
4107
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
4108
- }
4109
4109
  export class Tenants<HandleError extends boolean = boolean> {
4110
4110
  protected readonly apiClient: JwtClient<HandleError>;
4111
4111
  constructor(apiClient: JwtClient<HandleError>);