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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +1038 -984
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +694 -694
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +693 -693
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +360 -361
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +914 -914
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +913 -913
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1271 -1051
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1594 -1433
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1593 -1432
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +73 -73
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +203 -203
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +202 -202
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +3935 -3935
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +3349 -3349
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +3348 -3348
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +573 -573
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +2920 -2920
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +2919 -2919
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -1942,134 +1942,6 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
1942
1942
  Gt = "gt",
1943
1943
  Lt = "lt"
1944
1944
  }
1945
- export class Activities<HandleError extends boolean = boolean> {
1946
- protected readonly apiClient: JwtClient<HandleError>;
1947
- constructor(apiClient: JwtClient<HandleError>);
1948
- /**
1949
- * @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.
1950
- * @tags Activities
1951
- * @name GetCompanyAlerts
1952
- * @summary Get Company Alerts
1953
- * @request GET:/companies/{company_id}/alerts
1954
- * @secure
1955
- */
1956
- getCompanyAlerts(companyId: number, query?: {
1957
- /**
1958
- * Language
1959
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
1960
- * @default "en-US"
1961
- */
1962
- language?: BridgeWiseLanguageEnum;
1963
- /**
1964
- * Alert Type
1965
- * Specify the group of the alert type that will be presented (fundamental or market).
1966
- */
1967
- alert_type?: BridgeWiseCompanyAlertType;
1968
- /**
1969
- * Sentiment
1970
- * Filter alerts by their sentiment.
1971
- */
1972
- sentiment?: BridgeWiseCompanyAlertSentiment;
1973
- /**
1974
- * Importance
1975
- * 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
1976
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1977
- */
1978
- importance?: string;
1979
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
1980
- /**
1981
- * @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.
1982
- * @tags Activities
1983
- * @name GetCompanyForecastsKeyDevelopment
1984
- * @summary Get Company Forecasts Key Development
1985
- * @request GET:/companies/{company_id}/key-developments
1986
- * @secure
1987
- */
1988
- getCompanyForecastsKeyDevelopment(companyId: number, query?: {
1989
- /**
1990
- * Language
1991
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
1992
- * @default "en-US"
1993
- */
1994
- language?: BridgeWiseLanguageEnum;
1995
- /**
1996
- * Importance
1997
- * 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
1998
- * @default "0,1"
1999
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2000
- */
2001
- importance?: string;
2002
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
2003
- }
2004
- export class CompanyMarketData<HandleError extends boolean = boolean> {
2005
- protected readonly apiClient: JwtClient<HandleError>;
2006
- constructor(apiClient: JwtClient<HandleError>);
2007
- /**
2008
- * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
2009
- * @tags Company Market Data
2010
- * @name GetCompanyMarketData
2011
- * @summary Get Company Market Data
2012
- * @request GET:/companies/{company_id}/market
2013
- * @secure
2014
- */
2015
- getCompanyMarketData(companyId: number, query?: {
2016
- /**
2017
- * Trading Item Id
2018
- * Specify a BW trading asset identifier for a targeted query.
2019
- */
2020
- trading_item_id?: number | null;
2021
- /**
2022
- * Date Ge
2023
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
2024
- */
2025
- date__ge?: string | null;
2026
- /**
2027
- * Date Le
2028
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
2029
- */
2030
- date__le?: string | null;
2031
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
2032
- /**
2033
- * @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.
2034
- * @tags Company Market Data
2035
- * @name GetCompanyMarketStatistics
2036
- * @summary Get Company Market Statistics
2037
- * @request GET:/companies/{company_id}/market-statistics
2038
- * @secure
2039
- */
2040
- getCompanyMarketStatistics(companyId: number, query?: {
2041
- /**
2042
- * Trading Item Id
2043
- * Specify a BW trading asset identifier for a targeted query.
2044
- */
2045
- trading_item_id?: number | null;
2046
- /**
2047
- * Identifier In
2048
- * Specify a list of external identifiers.
2049
- */
2050
- identifier__in?: string | null;
2051
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
2052
- /**
2053
- * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
2054
- * @tags Company Market Data
2055
- * @name GetTradingItems
2056
- * @summary Get Trading Items
2057
- * @request GET:/companies/{company_id}/trading-items
2058
- * @secure
2059
- */
2060
- getTradingItems(companyId: number, query?: {
2061
- /**
2062
- * Primary Flag
2063
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
2064
- */
2065
- primary_flag?: BridgeWiseStringBooleanEnum;
2066
- /**
2067
- * Security Primary Flag
2068
- * Boolean flag. Indicate if only primary asset data is required (true/false).
2069
- */
2070
- security_primary_flag?: BridgeWiseStringBooleanEnum;
2071
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2072
- }
2073
1945
  export class CompanyMetadata<HandleError extends boolean = boolean> {
2074
1946
  protected readonly apiClient: JwtClient<HandleError>;
2075
1947
  constructor(apiClient: JwtClient<HandleError>);
@@ -2718,84 +2590,108 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2718
2590
  identifier_type: BridgeWiseIdentifierTypeEnum;
2719
2591
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2720
2592
  }
2721
- export class CompanyNews<HandleError extends boolean = boolean> {
2593
+ export class Logos<HandleError extends boolean = boolean> {
2722
2594
  protected readonly apiClient: JwtClient<HandleError>;
2723
2595
  constructor(apiClient: JwtClient<HandleError>);
2724
2596
  /**
2725
- * @description This endpoint provides news articles related to the specified company.
2726
- * @tags Company News
2727
- * @name GetCompanyNews
2728
- * @summary Get Company News
2729
- * @request GET:/companies/{company_id}/news
2597
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
2598
+ * @tags Logos
2599
+ * @name FetchLogos
2600
+ * @summary Fetch Logos
2601
+ * @request GET:/companies/logos
2730
2602
  * @secure
2731
2603
  */
2732
- getCompanyNews(companyId: number, query?: {
2604
+ fetchLogos(query?: {
2733
2605
  /**
2734
- * Languages
2735
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2736
- * @default "en-US"
2737
- * @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))*$
2606
+ * Company Id In
2607
+ * Specify a list of BW identifiers for bulk queries.
2608
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2609
+ * @example "74822,83343211"
2738
2610
  */
2739
- languages?: string;
2611
+ company_id__in?: string;
2740
2612
  /**
2741
- * Published Date Gte
2742
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2743
- * @format date
2744
- * @default "2025-02-10"
2613
+ * Size
2614
+ * Page size
2615
+ * @min 1
2616
+ * @max 100
2617
+ * @default 50
2745
2618
  */
2746
- published_date__gte?: string;
2619
+ size?: number;
2747
2620
  /**
2748
- * Published Date Lte
2749
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2750
- * @format date
2751
- * @default "2025-02-10"
2621
+ * Page
2622
+ * Page number
2623
+ * @min 1
2624
+ * @default 1
2752
2625
  */
2753
- published_date__lte?: string;
2626
+ page?: number;
2627
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
2628
+ /**
2629
+ * @description Retrieves the logo for a specified company using the provided company_id.
2630
+ * @tags Logos
2631
+ * @name FetchLogo
2632
+ * @summary Fetch Logo
2633
+ * @request GET:/companies/{company_id}/logos
2634
+ * @secure
2635
+ */
2636
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
2637
+ }
2638
+ export class Activities<HandleError extends boolean = boolean> {
2639
+ protected readonly apiClient: JwtClient<HandleError>;
2640
+ constructor(apiClient: JwtClient<HandleError>);
2641
+ /**
2642
+ * @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.
2643
+ * @tags Activities
2644
+ * @name GetCompanyAlerts
2645
+ * @summary Get Company Alerts
2646
+ * @request GET:/companies/{company_id}/alerts
2647
+ * @secure
2648
+ */
2649
+ getCompanyAlerts(companyId: number, query?: {
2754
2650
  /**
2755
- * Sort By
2756
- * Specify the field by which to sort the results.
2757
- * @default "publication_date"
2651
+ * Language
2652
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2653
+ * @default "en-US"
2758
2654
  */
2759
- sort_by?: BridgeWiseCompanyNewsSortingEnum;
2655
+ language?: BridgeWiseLanguageEnum;
2760
2656
  /**
2761
- * Size
2762
- * Define the number of records per page for pagination purposes.
2763
- * @default 10
2764
- * @example 10
2657
+ * Alert Type
2658
+ * Specify the group of the alert type that will be presented (fundamental or market).
2765
2659
  */
2766
- size?: number;
2660
+ alert_type?: BridgeWiseCompanyAlertType;
2767
2661
  /**
2768
- * Page
2769
- * Define the page number for pagination.
2770
- * @default 1
2771
- * @example 1
2662
+ * Sentiment
2663
+ * Filter alerts by their sentiment.
2772
2664
  */
2773
- page?: number;
2774
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
2665
+ sentiment?: BridgeWiseCompanyAlertSentiment;
2666
+ /**
2667
+ * Importance
2668
+ * 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
2669
+ */
2670
+ importance?: string | null;
2671
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
2775
2672
  /**
2776
- * @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.
2777
- * @tags Company News
2778
- * @name GetAverageCompanyNewsSentiment
2779
- * @summary Get Average Company News Sentiment
2780
- * @request GET:/companies/{company_id}/news-sentiment
2673
+ * @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.
2674
+ * @tags Activities
2675
+ * @name GetCompanyForecastsKeyDevelopment
2676
+ * @summary Get Company Forecasts Key Development
2677
+ * @request GET:/companies/{company_id}/key-developments
2781
2678
  * @secure
2782
2679
  */
2783
- getAverageCompanyNewsSentiment(companyId: number, query?: {
2680
+ getCompanyForecastsKeyDevelopment(companyId: number, query?: {
2784
2681
  /**
2785
- * Published Date Gte
2786
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2787
- * @format date
2788
- * @default "2025-02-10"
2682
+ * Language
2683
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2684
+ * @default "en-US"
2789
2685
  */
2790
- published_date__gte?: string;
2686
+ language?: BridgeWiseLanguageEnum;
2791
2687
  /**
2792
- * Published Date Lte
2793
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2794
- * @format date
2795
- * @default "2025-02-10"
2688
+ * Importance
2689
+ * 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
2690
+ * @default "0,1"
2691
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2796
2692
  */
2797
- published_date__lte?: string;
2798
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
2693
+ importance?: string;
2694
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
2799
2695
  }
2800
2696
  export class EarningCalls<HandleError extends boolean = boolean> {
2801
2697
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3159,167 +3055,198 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3159
3055
  date__lte?: string;
3160
3056
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
3161
3057
  }
3162
- export class FundAnalysis<HandleError extends boolean = boolean> {
3058
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
3163
3059
  protected readonly apiClient: JwtClient<HandleError>;
3164
3060
  constructor(apiClient: JwtClient<HandleError>);
3165
3061
  /**
3166
- * @description Returns Bridgewise final analysis for a specified fund.
3167
- * @tags Fund Analysis
3168
- * @name GetFundAnalysis
3169
- * @summary Get Fund Analysis
3170
- * @request GET:/funds/{fund_id}/analysis
3062
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
3063
+ * @tags Company Market Data
3064
+ * @name GetCompanyMarketData
3065
+ * @summary Get Company Market Data
3066
+ * @request GET:/companies/{company_id}/market
3171
3067
  * @secure
3172
3068
  */
3173
- getFundAnalysis(fundId: number, query?: {
3174
- /**
3175
- * Language
3176
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3177
- * @default "en-US"
3178
- */
3179
- language?: BridgeWiseLanguageEnum;
3069
+ getCompanyMarketData(companyId: number, query?: {
3180
3070
  /**
3181
- * Year
3182
- * Specify the year for which the analysis is requested.
3071
+ * Trading Item Id
3072
+ * Specify a BW trading asset identifier for a targeted query.
3183
3073
  */
3184
- year?: number;
3074
+ trading_item_id?: number | null;
3185
3075
  /**
3186
- * Quarter
3187
- * Specify the quarter for which the analysis is requested.
3076
+ * Date Ge
3077
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3188
3078
  */
3189
- quarter?: number;
3079
+ date__ge?: string | null;
3190
3080
  /**
3191
- * Show All
3192
- * Boolean flag. Indicate whether to return historical data (`true/false`).
3081
+ * Date Le
3082
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3193
3083
  */
3194
- show_all?: boolean;
3195
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
3084
+ date__le?: string | null;
3085
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
3196
3086
  /**
3197
- * @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.
3198
- * @tags Fund Analysis
3199
- * @name GetFundsParagraphs
3200
- * @summary Get Funds Paragraphs
3201
- * @request GET:/funds/{fund_id}/paragraphs
3087
+ * @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.
3088
+ * @tags Company Market Data
3089
+ * @name GetCompanyMarketStatistics
3090
+ * @summary Get Company Market Statistics
3091
+ * @request GET:/companies/{company_id}/market-statistics
3202
3092
  * @secure
3203
3093
  */
3204
- getFundsParagraphs(fundId: number, query?: {
3094
+ getCompanyMarketStatistics(companyId: number, query?: {
3205
3095
  /**
3206
- * Language
3207
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3208
- * @default "en-US"
3096
+ * Trading Item Id
3097
+ * Specify a BW trading asset identifier for a targeted query.
3209
3098
  */
3210
- language?: BridgeWiseLanguageEnum;
3099
+ trading_item_id?: number | null;
3211
3100
  /**
3212
- * Year
3213
- * Specify the year for which the analysis is requested.
3101
+ * Identifier In
3102
+ * Specify a list of external identifiers.
3214
3103
  */
3215
- year?: number | null;
3104
+ identifier__in?: string | null;
3105
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
3106
+ /**
3107
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
3108
+ * @tags Company Market Data
3109
+ * @name GetTradingItems
3110
+ * @summary Get Trading Items
3111
+ * @request GET:/companies/{company_id}/trading-items
3112
+ * @secure
3113
+ */
3114
+ getTradingItems(companyId: number, query?: {
3216
3115
  /**
3217
- * Quarter
3218
- * Specify the quarter for which the analysis is requested.
3116
+ * Primary Flag
3117
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
3219
3118
  */
3220
- quarter?: number | null;
3221
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
3119
+ primary_flag?: BridgeWiseStringBooleanEnum;
3120
+ /**
3121
+ * Security Primary Flag
3122
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
3123
+ */
3124
+ security_primary_flag?: BridgeWiseStringBooleanEnum;
3125
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
3126
+ }
3127
+ export class CompanyNews<HandleError extends boolean = boolean> {
3128
+ protected readonly apiClient: JwtClient<HandleError>;
3129
+ constructor(apiClient: JwtClient<HandleError>);
3222
3130
  /**
3223
- * @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.
3224
- * @tags Fund Analysis
3225
- * @name GetFundParameters
3226
- * @summary Get Fund Parameters
3227
- * @request GET:/funds/{fund_id}/parameters
3131
+ * @description This endpoint provides news articles related to the specified company.
3132
+ * @tags Company News
3133
+ * @name GetCompanyNews
3134
+ * @summary Get Company News
3135
+ * @request GET:/companies/{company_id}/news
3228
3136
  * @secure
3229
3137
  */
3230
- getFundParameters(fundId: number, query?: {
3138
+ getCompanyNews(companyId: number, query?: {
3231
3139
  /**
3232
- * Language
3140
+ * Languages
3233
3141
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3234
3142
  * @default "en-US"
3143
+ * @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))*$
3235
3144
  */
3236
- language?: BridgeWiseLanguageEnum;
3145
+ languages?: string;
3237
3146
  /**
3238
- * Parameter Id
3239
- * ID of the parameter for analysis.
3147
+ * Published Date Gte
3148
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3149
+ * @format date
3150
+ * @default "2025-03-20"
3240
3151
  */
3241
- parameter_id?: number;
3242
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
3243
- /**
3244
- * @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.
3245
- * @tags Fund Analysis
3246
- * @name GetFundSections
3247
- * @summary Get Fund Sections
3248
- * @request GET:/funds/{fund_id}/sections
3249
- * @secure
3250
- */
3251
- getFundSections(fundId: number, query?: {
3152
+ published_date__gte?: string;
3252
3153
  /**
3253
- * Year
3254
- * Specify the year for which the analysis is requested.
3154
+ * Published Date Lte
3155
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3156
+ * @format date
3157
+ * @default "2025-03-20"
3255
3158
  */
3256
- year?: number;
3159
+ published_date__lte?: string;
3257
3160
  /**
3258
- * Quarter
3259
- * Specify the quarter for which the analysis is requested.
3161
+ * Sort By
3162
+ * Specify the field by which to sort the results.
3163
+ * @default "publication_date"
3260
3164
  */
3261
- quarter?: number;
3165
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
3262
3166
  /**
3263
- * Language
3264
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3265
- * @default "en-US"
3167
+ * Size
3168
+ * Define the number of records per page for pagination purposes.
3169
+ * @default 10
3170
+ * @example 10
3266
3171
  */
3267
- language?: BridgeWiseLanguageEnum;
3172
+ size?: number;
3268
3173
  /**
3269
- * Show All
3270
- * Boolean flag. Indicate whether to return historical data (`true/false`).
3174
+ * Page
3175
+ * Define the page number for pagination.
3176
+ * @default 1
3177
+ * @example 1
3271
3178
  */
3272
- show_all?: boolean;
3273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
3274
- }
3275
- export class FundMarketData<HandleError extends boolean = boolean> {
3276
- protected readonly apiClient: JwtClient<HandleError>;
3277
- constructor(apiClient: JwtClient<HandleError>);
3179
+ page?: number;
3180
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
3278
3181
  /**
3279
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
3280
- * @tags Fund Market Data
3281
- * @name GetFundsMarketData
3282
- * @summary Get Funds Market Data
3283
- * @request GET:/funds/{fund_id}/market
3182
+ * @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.
3183
+ * @tags Company News
3184
+ * @name GetAverageCompanyNewsSentiment
3185
+ * @summary Get Average Company News Sentiment
3186
+ * @request GET:/companies/{company_id}/news-sentiment
3284
3187
  * @secure
3285
3188
  */
3286
- getFundsMarketData(fundId: number, query?: {
3189
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
3287
3190
  /**
3288
- * Trading Item Id
3289
- * Specify a BW trading asset identifier for a targeted query.
3191
+ * Published Date Gte
3192
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3193
+ * @format date
3194
+ * @default "2025-03-20"
3290
3195
  */
3291
- trading_item_id?: number | null;
3196
+ published_date__gte?: string;
3292
3197
  /**
3293
- * Date Ge
3294
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3198
+ * Published Date Lte
3199
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3200
+ * @format date
3201
+ * @default "2025-03-20"
3295
3202
  */
3296
- date__ge?: string | null;
3203
+ published_date__lte?: string;
3204
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
3205
+ }
3206
+ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3207
+ protected readonly apiClient: JwtClient<HandleError>;
3208
+ constructor(apiClient: JwtClient<HandleError>);
3209
+ /**
3210
+ * @description This endpoint offers technical analysis of a company's stock price movements and trends.
3211
+ * @tags Technical Analysis
3212
+ * @name GetCompanyTechnicalParagraphs
3213
+ * @summary Get Company Technical Paragraphs
3214
+ * @request GET:/companies/{company_id}/technical-paragraphs
3215
+ * @secure
3216
+ */
3217
+ getCompanyTechnicalParagraphs(companyId: number, query?: {
3297
3218
  /**
3298
- * Date Le
3299
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3219
+ * Language
3220
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3221
+ * @default "en-US"
3300
3222
  */
3301
- date__le?: string | null;
3302
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
3223
+ language?: BridgeWiseLanguageEnum;
3224
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
3225
+ }
3226
+ export class Metadata<HandleError extends boolean = boolean> {
3227
+ protected readonly apiClient: JwtClient<HandleError>;
3228
+ constructor(apiClient: JwtClient<HandleError>);
3303
3229
  /**
3304
- * @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.
3305
- * @tags Fund Market Data
3306
- * @name GetFundsMarketStatistics
3307
- * @summary Get Funds Market Statistics
3308
- * @request GET:/funds/{fund_id}/market-statistics
3230
+ * @description This endpoint provides filters
3231
+ * @tags Metadata
3232
+ * @name GetCompanyFilters
3233
+ * @summary Get Company Filters
3234
+ * @request GET:/filters
3309
3235
  * @secure
3310
3236
  */
3311
- getFundsMarketStatistics(fundId: number, query?: {
3237
+ getCompanyFilters(query: {
3312
3238
  /**
3313
- * Trading Item Id
3314
- * Specify a BW trading asset identifier for a targeted query.
3239
+ * Type
3240
+ * Desired filter type.
3315
3241
  */
3316
- trading_item_id?: number | null;
3242
+ type: BridgeWiseCompanyFilterType;
3317
3243
  /**
3318
- * Identifier In
3319
- * Specify a list of external identifiers.
3244
+ * Language
3245
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3246
+ * @default "en-US"
3320
3247
  */
3321
- identifier__in?: string | null;
3322
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
3248
+ language?: BridgeWiseLanguageEnum;
3249
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
3323
3250
  }
3324
3251
  export class FundMetadata<HandleError extends boolean = boolean> {
3325
3252
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3712,6 +3639,119 @@ export class FundMetadata<HandleError extends boolean = boolean> {
3712
3639
  language?: BridgeWiseLanguageEnum;
3713
3640
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
3714
3641
  }
3642
+ export class FundAnalysis<HandleError extends boolean = boolean> {
3643
+ protected readonly apiClient: JwtClient<HandleError>;
3644
+ constructor(apiClient: JwtClient<HandleError>);
3645
+ /**
3646
+ * @description Returns Bridgewise final analysis for a specified fund.
3647
+ * @tags Fund Analysis
3648
+ * @name GetFundAnalysis
3649
+ * @summary Get Fund Analysis
3650
+ * @request GET:/funds/{fund_id}/analysis
3651
+ * @secure
3652
+ */
3653
+ getFundAnalysis(fundId: number, query?: {
3654
+ /**
3655
+ * Language
3656
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3657
+ * @default "en-US"
3658
+ */
3659
+ language?: BridgeWiseLanguageEnum;
3660
+ /**
3661
+ * Year
3662
+ * Specify the year for which the analysis is requested.
3663
+ */
3664
+ year?: number;
3665
+ /**
3666
+ * Quarter
3667
+ * Specify the quarter for which the analysis is requested.
3668
+ */
3669
+ quarter?: number;
3670
+ /**
3671
+ * Show All
3672
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3673
+ */
3674
+ show_all?: boolean;
3675
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
3676
+ /**
3677
+ * @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.
3678
+ * @tags Fund Analysis
3679
+ * @name GetFundsParagraphs
3680
+ * @summary Get Funds Paragraphs
3681
+ * @request GET:/funds/{fund_id}/paragraphs
3682
+ * @secure
3683
+ */
3684
+ getFundsParagraphs(fundId: number, query?: {
3685
+ /**
3686
+ * Language
3687
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3688
+ * @default "en-US"
3689
+ */
3690
+ language?: BridgeWiseLanguageEnum;
3691
+ /**
3692
+ * Year
3693
+ * Specify the year for which the analysis is requested.
3694
+ */
3695
+ year?: number | null;
3696
+ /**
3697
+ * Quarter
3698
+ * Specify the quarter for which the analysis is requested.
3699
+ */
3700
+ quarter?: number | null;
3701
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
3702
+ /**
3703
+ * @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.
3704
+ * @tags Fund Analysis
3705
+ * @name GetFundParameters
3706
+ * @summary Get Fund Parameters
3707
+ * @request GET:/funds/{fund_id}/parameters
3708
+ * @secure
3709
+ */
3710
+ getFundParameters(fundId: number, query?: {
3711
+ /**
3712
+ * Language
3713
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3714
+ * @default "en-US"
3715
+ */
3716
+ language?: BridgeWiseLanguageEnum;
3717
+ /**
3718
+ * Parameter Id
3719
+ * ID of the parameter for analysis.
3720
+ */
3721
+ parameter_id?: number;
3722
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
3723
+ /**
3724
+ * @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.
3725
+ * @tags Fund Analysis
3726
+ * @name GetFundSections
3727
+ * @summary Get Fund Sections
3728
+ * @request GET:/funds/{fund_id}/sections
3729
+ * @secure
3730
+ */
3731
+ getFundSections(fundId: number, query?: {
3732
+ /**
3733
+ * Year
3734
+ * Specify the year for which the analysis is requested.
3735
+ */
3736
+ year?: number;
3737
+ /**
3738
+ * Quarter
3739
+ * Specify the quarter for which the analysis is requested.
3740
+ */
3741
+ quarter?: number;
3742
+ /**
3743
+ * Language
3744
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3745
+ * @default "en-US"
3746
+ */
3747
+ language?: BridgeWiseLanguageEnum;
3748
+ /**
3749
+ * Show All
3750
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3751
+ */
3752
+ show_all?: boolean;
3753
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
3754
+ }
3715
3755
  export class Holdings<HandleError extends boolean = boolean> {
3716
3756
  protected readonly apiClient: JwtClient<HandleError>;
3717
3757
  constructor(apiClient: JwtClient<HandleError>);
@@ -3805,75 +3845,54 @@ export class Holdings<HandleError extends boolean = boolean> {
3805
3845
  page_size?: number;
3806
3846
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
3807
3847
  }
3808
- export class Logos<HandleError extends boolean = boolean> {
3848
+ export class FundMarketData<HandleError extends boolean = boolean> {
3809
3849
  protected readonly apiClient: JwtClient<HandleError>;
3810
3850
  constructor(apiClient: JwtClient<HandleError>);
3811
3851
  /**
3812
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
3813
- * @tags Logos
3814
- * @name FetchLogos
3815
- * @summary Fetch Logos
3816
- * @request GET:/companies/logos
3852
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
3853
+ * @tags Fund Market Data
3854
+ * @name GetFundsMarketData
3855
+ * @summary Get Funds Market Data
3856
+ * @request GET:/funds/{fund_id}/market
3817
3857
  * @secure
3818
3858
  */
3819
- fetchLogos(query?: {
3859
+ getFundsMarketData(fundId: number, query?: {
3820
3860
  /**
3821
- * Company Id In
3822
- * Specify a list of BW identifiers for bulk queries.
3823
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3824
- * @example "74822,83343211"
3861
+ * Trading Item Id
3862
+ * Specify a BW trading asset identifier for a targeted query.
3825
3863
  */
3826
- company_id__in?: string;
3864
+ trading_item_id?: number | null;
3827
3865
  /**
3828
- * Size
3829
- * Page size
3830
- * @min 1
3831
- * @max 100
3832
- * @default 50
3866
+ * Date Ge
3867
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3833
3868
  */
3834
- size?: number;
3869
+ date__ge?: string | null;
3835
3870
  /**
3836
- * Page
3837
- * Page number
3838
- * @min 1
3839
- * @default 1
3871
+ * Date Le
3872
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3840
3873
  */
3841
- page?: number;
3842
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
3843
- /**
3844
- * @description Retrieves the logo for a specified company using the provided company_id.
3845
- * @tags Logos
3846
- * @name FetchLogo
3847
- * @summary Fetch Logo
3848
- * @request GET:/companies/{company_id}/logos
3849
- * @secure
3850
- */
3851
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
3852
- }
3853
- export class Metadata<HandleError extends boolean = boolean> {
3854
- protected readonly apiClient: JwtClient<HandleError>;
3855
- constructor(apiClient: JwtClient<HandleError>);
3874
+ date__le?: string | null;
3875
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
3856
3876
  /**
3857
- * @description This endpoint provides filters
3858
- * @tags Metadata
3859
- * @name GetCompanyFilters
3860
- * @summary Get Company Filters
3861
- * @request GET:/filters
3877
+ * @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.
3878
+ * @tags Fund Market Data
3879
+ * @name GetFundsMarketStatistics
3880
+ * @summary Get Funds Market Statistics
3881
+ * @request GET:/funds/{fund_id}/market-statistics
3862
3882
  * @secure
3863
3883
  */
3864
- getCompanyFilters(query: {
3884
+ getFundsMarketStatistics(fundId: number, query?: {
3865
3885
  /**
3866
- * Type
3867
- * Desired filter type.
3886
+ * Trading Item Id
3887
+ * Specify a BW trading asset identifier for a targeted query.
3868
3888
  */
3869
- type: BridgeWiseCompanyFilterType;
3889
+ trading_item_id?: number | null;
3870
3890
  /**
3871
- * Language
3872
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3873
- * @default "en-US"
3891
+ * Identifier In
3892
+ * Specify a list of external identifiers.
3874
3893
  */
3875
- language?: BridgeWiseLanguageEnum;
3876
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
3894
+ identifier__in?: string | null;
3895
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
3877
3896
  }
3878
3897
  export class Segmentations<HandleError extends boolean = boolean> {
3879
3898
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3931,26 +3950,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
3931
3950
  segment?: string;
3932
3951
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
3933
3952
  }
3934
- export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3935
- protected readonly apiClient: JwtClient<HandleError>;
3936
- constructor(apiClient: JwtClient<HandleError>);
3937
- /**
3938
- * @description This endpoint offers technical analysis of a company's stock price movements and trends.
3939
- * @tags Technical Analysis
3940
- * @name GetCompanyTechnicalParagraphs
3941
- * @summary Get Company Technical Paragraphs
3942
- * @request GET:/companies/{company_id}/technical-paragraphs
3943
- * @secure
3944
- */
3945
- getCompanyTechnicalParagraphs(companyId: number, query?: {
3946
- /**
3947
- * Language
3948
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3949
- * @default "en-US"
3950
- */
3951
- language?: BridgeWiseLanguageEnum;
3952
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
3953
- }
3954
3953
  export class Tenants<HandleError extends boolean = boolean> {
3955
3954
  protected readonly apiClient: JwtClient<HandleError>;
3956
3955
  constructor(apiClient: JwtClient<HandleError>);