@orbis-systems/orbis-api-clients 0.6.3 → 0.6.4
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.
- package/dist/aesmidas/index.d.ts +29 -3
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +14 -0
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +14 -0
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +573 -567
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +732 -732
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +731 -731
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +157 -63
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +63 -4
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +62 -3
- package/dist/insight/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1942,6 +1942,134 @@ 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
|
+
}
|
|
1945
2073
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
1946
2074
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1947
2075
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2561,6 +2689,12 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2561
2689
|
* @default "en-US"
|
|
2562
2690
|
*/
|
|
2563
2691
|
language?: BridgeWiseLanguageEnum;
|
|
2692
|
+
/**
|
|
2693
|
+
* Include
|
|
2694
|
+
* Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
|
|
2695
|
+
* @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
|
|
2696
|
+
*/
|
|
2697
|
+
include?: string;
|
|
2564
2698
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyResponse[], HandleError>>;
|
|
2565
2699
|
/**
|
|
2566
2700
|
* @description Converts external identifiers (e.g., ISIN, ticker-exchange) into Bridgewise internal identifiers. This endpoint facilitates the mapping between external and internal identifiers for seamless integration within the Bridgewise ecosystem.
|
|
@@ -2584,63 +2718,97 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2584
2718
|
identifier_type: BridgeWiseIdentifierTypeEnum;
|
|
2585
2719
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2586
2720
|
}
|
|
2587
|
-
export class
|
|
2721
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
2588
2722
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2589
2723
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2590
2724
|
/**
|
|
2591
|
-
* @description
|
|
2592
|
-
* @tags
|
|
2593
|
-
* @name
|
|
2594
|
-
* @summary
|
|
2595
|
-
* @request GET:/companies/
|
|
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
|
|
2596
2730
|
* @secure
|
|
2597
2731
|
*/
|
|
2598
|
-
|
|
2732
|
+
getCompanyNews(companyId: number, query?: {
|
|
2599
2733
|
/**
|
|
2600
|
-
*
|
|
2601
|
-
*
|
|
2602
|
-
* @
|
|
2603
|
-
* @
|
|
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))*$
|
|
2604
2738
|
*/
|
|
2605
|
-
|
|
2739
|
+
languages?: string;
|
|
2740
|
+
/**
|
|
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"
|
|
2745
|
+
*/
|
|
2746
|
+
published_date__gte?: string;
|
|
2747
|
+
/**
|
|
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"
|
|
2752
|
+
*/
|
|
2753
|
+
published_date__lte?: string;
|
|
2754
|
+
/**
|
|
2755
|
+
* Sort By
|
|
2756
|
+
* Specify the field by which to sort the results.
|
|
2757
|
+
* @default "publication_date"
|
|
2758
|
+
*/
|
|
2759
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
2606
2760
|
/**
|
|
2607
2761
|
* Size
|
|
2608
|
-
*
|
|
2609
|
-
* @
|
|
2610
|
-
* @
|
|
2611
|
-
* @default 50
|
|
2762
|
+
* Define the number of records per page for pagination purposes.
|
|
2763
|
+
* @default 10
|
|
2764
|
+
* @example 10
|
|
2612
2765
|
*/
|
|
2613
2766
|
size?: number;
|
|
2614
2767
|
/**
|
|
2615
2768
|
* Page
|
|
2616
|
-
*
|
|
2617
|
-
* @min 1
|
|
2769
|
+
* Define the page number for pagination.
|
|
2618
2770
|
* @default 1
|
|
2771
|
+
* @example 1
|
|
2619
2772
|
*/
|
|
2620
2773
|
page?: number;
|
|
2621
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2774
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
2622
2775
|
/**
|
|
2623
|
-
* @description
|
|
2624
|
-
* @tags
|
|
2625
|
-
* @name
|
|
2626
|
-
* @summary
|
|
2627
|
-
* @request GET:/companies/{company_id}/
|
|
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
|
|
2628
2781
|
* @secure
|
|
2629
2782
|
*/
|
|
2630
|
-
|
|
2783
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
2784
|
+
/**
|
|
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"
|
|
2789
|
+
*/
|
|
2790
|
+
published_date__gte?: string;
|
|
2791
|
+
/**
|
|
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"
|
|
2796
|
+
*/
|
|
2797
|
+
published_date__lte?: string;
|
|
2798
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
2631
2799
|
}
|
|
2632
|
-
export class
|
|
2800
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2633
2801
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2634
2802
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2635
2803
|
/**
|
|
2636
|
-
* @description
|
|
2637
|
-
* @tags
|
|
2638
|
-
* @name
|
|
2639
|
-
* @summary Get Company
|
|
2640
|
-
* @request GET:/companies/{company_id}/
|
|
2804
|
+
* @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.
|
|
2805
|
+
* @tags Earning Calls
|
|
2806
|
+
* @name GetCompanyEarningsCalls
|
|
2807
|
+
* @summary Get Company Earnings Calls
|
|
2808
|
+
* @request GET:/companies/{company_id}/earnings-call
|
|
2641
2809
|
* @secure
|
|
2642
2810
|
*/
|
|
2643
|
-
|
|
2811
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2644
2812
|
/**
|
|
2645
2813
|
* Language
|
|
2646
2814
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2648,31 +2816,201 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
2648
2816
|
*/
|
|
2649
2817
|
language?: BridgeWiseLanguageEnum;
|
|
2650
2818
|
/**
|
|
2651
|
-
*
|
|
2652
|
-
*
|
|
2653
|
-
*/
|
|
2654
|
-
forecast_type?: BridgeWiseForecastType;
|
|
2655
|
-
/**
|
|
2656
|
-
* Page
|
|
2657
|
-
* Define the page number for pagination.
|
|
2658
|
-
* @exclusiveMin 0
|
|
2819
|
+
* Year
|
|
2820
|
+
* Specify the year for which the analysis is requested.
|
|
2659
2821
|
*/
|
|
2660
|
-
|
|
2822
|
+
year?: number | null;
|
|
2661
2823
|
/**
|
|
2662
|
-
*
|
|
2663
|
-
*
|
|
2664
|
-
* @exclusiveMin 0
|
|
2824
|
+
* Quarter
|
|
2825
|
+
* Specify the quarter for which the analysis is requested.
|
|
2665
2826
|
*/
|
|
2666
|
-
|
|
2667
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2668
|
-
}
|
|
2669
|
-
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
2670
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2671
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2827
|
+
quarter?: number | null;
|
|
2828
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2672
2829
|
/**
|
|
2673
|
-
* @description
|
|
2674
|
-
* @tags
|
|
2675
|
-
* @name
|
|
2830
|
+
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
2831
|
+
* @tags Earning Calls
|
|
2832
|
+
* @name GetEarningsCallsRecaps
|
|
2833
|
+
* @summary Get Earnings Calls Recaps
|
|
2834
|
+
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2835
|
+
* @secure
|
|
2836
|
+
*/
|
|
2837
|
+
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
2838
|
+
/**
|
|
2839
|
+
* Language
|
|
2840
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2841
|
+
* @default "en-US"
|
|
2842
|
+
*/
|
|
2843
|
+
language?: BridgeWiseLanguageEnum;
|
|
2844
|
+
/**
|
|
2845
|
+
* Type
|
|
2846
|
+
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
2847
|
+
*/
|
|
2848
|
+
type?: BridgeWiseEarningsCallRecapEnum;
|
|
2849
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
2850
|
+
}
|
|
2851
|
+
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
2852
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2853
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2854
|
+
/**
|
|
2855
|
+
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
2856
|
+
* @tags ESG Analysis
|
|
2857
|
+
* @name GetCompanyEsgAnalysis
|
|
2858
|
+
* @summary Get Company Esg Analysis
|
|
2859
|
+
* @request GET:/companies/{company_id}/esg-analysis
|
|
2860
|
+
* @secure
|
|
2861
|
+
*/
|
|
2862
|
+
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
2863
|
+
/**
|
|
2864
|
+
* Language
|
|
2865
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2866
|
+
* @default "en-US"
|
|
2867
|
+
*/
|
|
2868
|
+
language?: BridgeWiseLanguageEnum;
|
|
2869
|
+
/**
|
|
2870
|
+
* Show All
|
|
2871
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2872
|
+
*/
|
|
2873
|
+
show_all?: boolean;
|
|
2874
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
2875
|
+
/**
|
|
2876
|
+
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
2877
|
+
* @tags ESG Analysis
|
|
2878
|
+
* @name GetCompanyEsgParagraphs
|
|
2879
|
+
* @summary Get Company Esg Paragraphs
|
|
2880
|
+
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
2881
|
+
* @secure
|
|
2882
|
+
*/
|
|
2883
|
+
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
2884
|
+
/**
|
|
2885
|
+
* Language
|
|
2886
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2887
|
+
* @default "en-US"
|
|
2888
|
+
*/
|
|
2889
|
+
language?: BridgeWiseLanguageEnum;
|
|
2890
|
+
/**
|
|
2891
|
+
* Section Type
|
|
2892
|
+
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2893
|
+
*/
|
|
2894
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
2895
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
2896
|
+
/**
|
|
2897
|
+
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
2898
|
+
* @tags ESG Analysis
|
|
2899
|
+
* @name GetCompanyEsgParameters
|
|
2900
|
+
* @summary Get Company Esg Parameters
|
|
2901
|
+
* @request GET:/companies/{company_id}/esg-parameters
|
|
2902
|
+
* @secure
|
|
2903
|
+
*/
|
|
2904
|
+
getCompanyEsgParameters(companyId: number, query?: {
|
|
2905
|
+
/**
|
|
2906
|
+
* Language
|
|
2907
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2908
|
+
* @default "en-US"
|
|
2909
|
+
*/
|
|
2910
|
+
language?: BridgeWiseLanguageEnum;
|
|
2911
|
+
/**
|
|
2912
|
+
* Parameter Id
|
|
2913
|
+
* Get desired parameter by ID.
|
|
2914
|
+
*/
|
|
2915
|
+
parameter_id?: number;
|
|
2916
|
+
/**
|
|
2917
|
+
* Section Type
|
|
2918
|
+
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2919
|
+
*/
|
|
2920
|
+
section_type?: BridgeWiseSectionTypeEnum;
|
|
2921
|
+
/**
|
|
2922
|
+
* Show All
|
|
2923
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2924
|
+
*/
|
|
2925
|
+
show_all?: boolean;
|
|
2926
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
2927
|
+
/**
|
|
2928
|
+
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
2929
|
+
* @tags ESG Analysis
|
|
2930
|
+
* @name GetCompanyEsgSections
|
|
2931
|
+
* @summary Get Company Esg Sections
|
|
2932
|
+
* @request GET:/companies/{company_id}/esg-sections
|
|
2933
|
+
* @secure
|
|
2934
|
+
*/
|
|
2935
|
+
getCompanyEsgSections(companyId: number, query?: {
|
|
2936
|
+
/**
|
|
2937
|
+
* Language
|
|
2938
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2939
|
+
* @default "en-US"
|
|
2940
|
+
*/
|
|
2941
|
+
language?: BridgeWiseLanguageEnum;
|
|
2942
|
+
/**
|
|
2943
|
+
* Section Type
|
|
2944
|
+
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2945
|
+
*/
|
|
2946
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
2947
|
+
/**
|
|
2948
|
+
* Show All
|
|
2949
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2950
|
+
*/
|
|
2951
|
+
show_all?: boolean;
|
|
2952
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
2953
|
+
/**
|
|
2954
|
+
* @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
|
|
2955
|
+
* @tags ESG Analysis
|
|
2956
|
+
* @name GetCompanyForecastsMsa
|
|
2957
|
+
* @summary Get Company Forecasts Msa
|
|
2958
|
+
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
2959
|
+
* @secure
|
|
2960
|
+
*/
|
|
2961
|
+
getCompanyForecastsMsa(companyId: number, query?: {
|
|
2962
|
+
/**
|
|
2963
|
+
* Language
|
|
2964
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2965
|
+
* @default "en-US"
|
|
2966
|
+
*/
|
|
2967
|
+
language?: BridgeWiseLanguageEnum;
|
|
2968
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
2969
|
+
}
|
|
2970
|
+
export class Forecasts<HandleError extends boolean = boolean> {
|
|
2971
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2972
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2973
|
+
/**
|
|
2974
|
+
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
2975
|
+
* @tags Forecasts
|
|
2976
|
+
* @name GetCompanyForecasts
|
|
2977
|
+
* @summary Get Company Forecasts
|
|
2978
|
+
* @request GET:/companies/{company_id}/forecasts
|
|
2979
|
+
* @secure
|
|
2980
|
+
*/
|
|
2981
|
+
getCompanyForecasts(companyId: number, query?: {
|
|
2982
|
+
/**
|
|
2983
|
+
* Language
|
|
2984
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2985
|
+
* @default "en-US"
|
|
2986
|
+
*/
|
|
2987
|
+
language?: BridgeWiseLanguageEnum;
|
|
2988
|
+
/**
|
|
2989
|
+
* Forecast Type
|
|
2990
|
+
* Desired forecast type.
|
|
2991
|
+
*/
|
|
2992
|
+
forecast_type?: BridgeWiseForecastType;
|
|
2993
|
+
/**
|
|
2994
|
+
* Page
|
|
2995
|
+
* Define the page number for pagination.
|
|
2996
|
+
* @exclusiveMin 0
|
|
2997
|
+
*/
|
|
2998
|
+
page?: number;
|
|
2999
|
+
/**
|
|
3000
|
+
* Page Size
|
|
3001
|
+
* Define the number of records per page for pagination purposes.
|
|
3002
|
+
* @exclusiveMin 0
|
|
3003
|
+
*/
|
|
3004
|
+
page_size?: number;
|
|
3005
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
3006
|
+
}
|
|
3007
|
+
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
3008
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3009
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3010
|
+
/**
|
|
3011
|
+
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
3012
|
+
* @tags Fundamental Analysis
|
|
3013
|
+
* @name GetCompanyFundamentalAnalysis
|
|
2676
3014
|
* @summary Get Company Fundamental Analysis
|
|
2677
3015
|
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
2678
3016
|
* @secure
|
|
@@ -2821,198 +3159,167 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2821
3159
|
date__lte?: string;
|
|
2822
3160
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
2823
3161
|
}
|
|
2824
|
-
export class
|
|
3162
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
2825
3163
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2826
3164
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2827
3165
|
/**
|
|
2828
|
-
* @description
|
|
2829
|
-
* @tags
|
|
2830
|
-
* @name
|
|
2831
|
-
* @summary Get
|
|
2832
|
-
* @request GET:/
|
|
2833
|
-
* @secure
|
|
2834
|
-
*/
|
|
2835
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
2836
|
-
/**
|
|
2837
|
-
* Trading Item Id
|
|
2838
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
2839
|
-
*/
|
|
2840
|
-
trading_item_id?: number | null;
|
|
2841
|
-
/**
|
|
2842
|
-
* Date Ge
|
|
2843
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
2844
|
-
*/
|
|
2845
|
-
date__ge?: string | null;
|
|
2846
|
-
/**
|
|
2847
|
-
* Date Le
|
|
2848
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
2849
|
-
*/
|
|
2850
|
-
date__le?: string | null;
|
|
2851
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
2852
|
-
/**
|
|
2853
|
-
* @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.
|
|
2854
|
-
* @tags Company Market Data
|
|
2855
|
-
* @name GetCompanyMarketStatistics
|
|
2856
|
-
* @summary Get Company Market Statistics
|
|
2857
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
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
|
|
2858
3171
|
* @secure
|
|
2859
3172
|
*/
|
|
2860
|
-
|
|
3173
|
+
getFundAnalysis(fundId: number, query?: {
|
|
2861
3174
|
/**
|
|
2862
|
-
*
|
|
2863
|
-
*
|
|
3175
|
+
* Language
|
|
3176
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3177
|
+
* @default "en-US"
|
|
2864
3178
|
*/
|
|
2865
|
-
|
|
3179
|
+
language?: BridgeWiseLanguageEnum;
|
|
2866
3180
|
/**
|
|
2867
|
-
*
|
|
2868
|
-
* Specify
|
|
3181
|
+
* Year
|
|
3182
|
+
* Specify the year for which the analysis is requested.
|
|
2869
3183
|
*/
|
|
2870
|
-
|
|
2871
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
2872
|
-
/**
|
|
2873
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
2874
|
-
* @tags Company Market Data
|
|
2875
|
-
* @name GetTradingItems
|
|
2876
|
-
* @summary Get Trading Items
|
|
2877
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
2878
|
-
* @secure
|
|
2879
|
-
*/
|
|
2880
|
-
getTradingItems(companyId: number, query?: {
|
|
3184
|
+
year?: number;
|
|
2881
3185
|
/**
|
|
2882
|
-
*
|
|
2883
|
-
*
|
|
3186
|
+
* Quarter
|
|
3187
|
+
* Specify the quarter for which the analysis is requested.
|
|
2884
3188
|
*/
|
|
2885
|
-
|
|
3189
|
+
quarter?: number;
|
|
2886
3190
|
/**
|
|
2887
|
-
*
|
|
2888
|
-
* Boolean flag. Indicate
|
|
3191
|
+
* Show All
|
|
3192
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2889
3193
|
*/
|
|
2890
|
-
|
|
2891
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2892
|
-
}
|
|
2893
|
-
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
2894
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2895
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3194
|
+
show_all?: boolean;
|
|
3195
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
2896
3196
|
/**
|
|
2897
|
-
* @description
|
|
2898
|
-
* @tags
|
|
2899
|
-
* @name
|
|
2900
|
-
* @summary Get
|
|
2901
|
-
* @request GET:/
|
|
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
|
|
2902
3202
|
* @secure
|
|
2903
3203
|
*/
|
|
2904
|
-
|
|
3204
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
2905
3205
|
/**
|
|
2906
|
-
*
|
|
3206
|
+
* Language
|
|
2907
3207
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2908
3208
|
* @default "en-US"
|
|
2909
|
-
* @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))*$
|
|
2910
|
-
*/
|
|
2911
|
-
languages?: string;
|
|
2912
|
-
/**
|
|
2913
|
-
* Published Date Gte
|
|
2914
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
2915
|
-
* @format date
|
|
2916
|
-
* @default "2025-02-10"
|
|
2917
|
-
*/
|
|
2918
|
-
published_date__gte?: string;
|
|
2919
|
-
/**
|
|
2920
|
-
* Published Date Lte
|
|
2921
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
2922
|
-
* @format date
|
|
2923
|
-
* @default "2025-02-10"
|
|
2924
|
-
*/
|
|
2925
|
-
published_date__lte?: string;
|
|
2926
|
-
/**
|
|
2927
|
-
* Sort By
|
|
2928
|
-
* Specify the field by which to sort the results.
|
|
2929
|
-
* @default "publication_date"
|
|
2930
3209
|
*/
|
|
2931
|
-
|
|
3210
|
+
language?: BridgeWiseLanguageEnum;
|
|
2932
3211
|
/**
|
|
2933
|
-
*
|
|
2934
|
-
*
|
|
2935
|
-
* @default 10
|
|
2936
|
-
* @example 10
|
|
3212
|
+
* Year
|
|
3213
|
+
* Specify the year for which the analysis is requested.
|
|
2937
3214
|
*/
|
|
2938
|
-
|
|
3215
|
+
year?: number | null;
|
|
2939
3216
|
/**
|
|
2940
|
-
*
|
|
2941
|
-
*
|
|
2942
|
-
* @default 1
|
|
2943
|
-
* @example 1
|
|
3217
|
+
* Quarter
|
|
3218
|
+
* Specify the quarter for which the analysis is requested.
|
|
2944
3219
|
*/
|
|
2945
|
-
|
|
2946
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3220
|
+
quarter?: number | null;
|
|
3221
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
2947
3222
|
/**
|
|
2948
|
-
* @description
|
|
2949
|
-
* @tags
|
|
2950
|
-
* @name
|
|
2951
|
-
* @summary Get
|
|
2952
|
-
* @request GET:/
|
|
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
|
|
2953
3228
|
* @secure
|
|
2954
3229
|
*/
|
|
2955
|
-
|
|
3230
|
+
getFundParameters(fundId: number, query?: {
|
|
2956
3231
|
/**
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
2959
|
-
* @
|
|
2960
|
-
* @default "2025-02-10"
|
|
3232
|
+
* Language
|
|
3233
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3234
|
+
* @default "en-US"
|
|
2961
3235
|
*/
|
|
2962
|
-
|
|
3236
|
+
language?: BridgeWiseLanguageEnum;
|
|
2963
3237
|
/**
|
|
2964
|
-
*
|
|
2965
|
-
*
|
|
2966
|
-
* @format date
|
|
2967
|
-
* @default "2025-02-10"
|
|
3238
|
+
* Parameter Id
|
|
3239
|
+
* ID of the parameter for analysis.
|
|
2968
3240
|
*/
|
|
2969
|
-
|
|
2970
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2971
|
-
}
|
|
2972
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
2973
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2974
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3241
|
+
parameter_id?: number;
|
|
3242
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
2975
3243
|
/**
|
|
2976
|
-
* @description
|
|
2977
|
-
* @tags
|
|
2978
|
-
* @name
|
|
2979
|
-
* @summary Get
|
|
2980
|
-
* @request GET:/
|
|
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
|
|
2981
3249
|
* @secure
|
|
2982
3250
|
*/
|
|
2983
|
-
|
|
3251
|
+
getFundSections(fundId: number, query?: {
|
|
3252
|
+
/**
|
|
3253
|
+
* Year
|
|
3254
|
+
* Specify the year for which the analysis is requested.
|
|
3255
|
+
*/
|
|
3256
|
+
year?: number;
|
|
3257
|
+
/**
|
|
3258
|
+
* Quarter
|
|
3259
|
+
* Specify the quarter for which the analysis is requested.
|
|
3260
|
+
*/
|
|
3261
|
+
quarter?: number;
|
|
2984
3262
|
/**
|
|
2985
3263
|
* Language
|
|
2986
3264
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2987
3265
|
* @default "en-US"
|
|
2988
3266
|
*/
|
|
2989
3267
|
language?: BridgeWiseLanguageEnum;
|
|
2990
|
-
|
|
3268
|
+
/**
|
|
3269
|
+
* Show All
|
|
3270
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3271
|
+
*/
|
|
3272
|
+
show_all?: boolean;
|
|
3273
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
2991
3274
|
}
|
|
2992
|
-
export class
|
|
3275
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
2993
3276
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2994
3277
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2995
3278
|
/**
|
|
2996
|
-
* @description
|
|
2997
|
-
* @tags
|
|
2998
|
-
* @name
|
|
2999
|
-
* @summary Get
|
|
3000
|
-
* @request GET:/
|
|
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
|
|
3001
3284
|
* @secure
|
|
3002
3285
|
*/
|
|
3003
|
-
|
|
3286
|
+
getFundsMarketData(fundId: number, query?: {
|
|
3004
3287
|
/**
|
|
3005
|
-
*
|
|
3006
|
-
*
|
|
3288
|
+
* Trading Item Id
|
|
3289
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3007
3290
|
*/
|
|
3008
|
-
|
|
3291
|
+
trading_item_id?: number | null;
|
|
3009
3292
|
/**
|
|
3010
|
-
*
|
|
3011
|
-
*
|
|
3012
|
-
* @default "en-US"
|
|
3293
|
+
* Date Ge
|
|
3294
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3013
3295
|
*/
|
|
3014
|
-
|
|
3015
|
-
|
|
3296
|
+
date__ge?: string | null;
|
|
3297
|
+
/**
|
|
3298
|
+
* Date Le
|
|
3299
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3300
|
+
*/
|
|
3301
|
+
date__le?: string | null;
|
|
3302
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
3303
|
+
/**
|
|
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
|
|
3309
|
+
* @secure
|
|
3310
|
+
*/
|
|
3311
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
3312
|
+
/**
|
|
3313
|
+
* Trading Item Id
|
|
3314
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3315
|
+
*/
|
|
3316
|
+
trading_item_id?: number | null;
|
|
3317
|
+
/**
|
|
3318
|
+
* Identifier In
|
|
3319
|
+
* Specify a list of external identifiers.
|
|
3320
|
+
*/
|
|
3321
|
+
identifier__in?: string | null;
|
|
3322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
3016
3323
|
}
|
|
3017
3324
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3018
3325
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3405,119 +3712,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3405
3712
|
language?: BridgeWiseLanguageEnum;
|
|
3406
3713
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3407
3714
|
}
|
|
3408
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3409
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3410
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3411
|
-
/**
|
|
3412
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3413
|
-
* @tags Fund Analysis
|
|
3414
|
-
* @name GetFundAnalysis
|
|
3415
|
-
* @summary Get Fund Analysis
|
|
3416
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
3417
|
-
* @secure
|
|
3418
|
-
*/
|
|
3419
|
-
getFundAnalysis(fundId: number, query?: {
|
|
3420
|
-
/**
|
|
3421
|
-
* Language
|
|
3422
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3423
|
-
* @default "en-US"
|
|
3424
|
-
*/
|
|
3425
|
-
language?: BridgeWiseLanguageEnum;
|
|
3426
|
-
/**
|
|
3427
|
-
* Year
|
|
3428
|
-
* Specify the year for which the analysis is requested.
|
|
3429
|
-
*/
|
|
3430
|
-
year?: number;
|
|
3431
|
-
/**
|
|
3432
|
-
* Quarter
|
|
3433
|
-
* Specify the quarter for which the analysis is requested.
|
|
3434
|
-
*/
|
|
3435
|
-
quarter?: number;
|
|
3436
|
-
/**
|
|
3437
|
-
* Show All
|
|
3438
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3439
|
-
*/
|
|
3440
|
-
show_all?: boolean;
|
|
3441
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3442
|
-
/**
|
|
3443
|
-
* @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.
|
|
3444
|
-
* @tags Fund Analysis
|
|
3445
|
-
* @name GetFundsParagraphs
|
|
3446
|
-
* @summary Get Funds Paragraphs
|
|
3447
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
3448
|
-
* @secure
|
|
3449
|
-
*/
|
|
3450
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
3451
|
-
/**
|
|
3452
|
-
* Language
|
|
3453
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3454
|
-
* @default "en-US"
|
|
3455
|
-
*/
|
|
3456
|
-
language?: BridgeWiseLanguageEnum;
|
|
3457
|
-
/**
|
|
3458
|
-
* Year
|
|
3459
|
-
* Specify the year for which the analysis is requested.
|
|
3460
|
-
*/
|
|
3461
|
-
year?: number | null;
|
|
3462
|
-
/**
|
|
3463
|
-
* Quarter
|
|
3464
|
-
* Specify the quarter for which the analysis is requested.
|
|
3465
|
-
*/
|
|
3466
|
-
quarter?: number | null;
|
|
3467
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3468
|
-
/**
|
|
3469
|
-
* @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.
|
|
3470
|
-
* @tags Fund Analysis
|
|
3471
|
-
* @name GetFundParameters
|
|
3472
|
-
* @summary Get Fund Parameters
|
|
3473
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
3474
|
-
* @secure
|
|
3475
|
-
*/
|
|
3476
|
-
getFundParameters(fundId: number, query?: {
|
|
3477
|
-
/**
|
|
3478
|
-
* Language
|
|
3479
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3480
|
-
* @default "en-US"
|
|
3481
|
-
*/
|
|
3482
|
-
language?: BridgeWiseLanguageEnum;
|
|
3483
|
-
/**
|
|
3484
|
-
* Parameter Id
|
|
3485
|
-
* ID of the parameter for analysis.
|
|
3486
|
-
*/
|
|
3487
|
-
parameter_id?: number;
|
|
3488
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3489
|
-
/**
|
|
3490
|
-
* @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.
|
|
3491
|
-
* @tags Fund Analysis
|
|
3492
|
-
* @name GetFundSections
|
|
3493
|
-
* @summary Get Fund Sections
|
|
3494
|
-
* @request GET:/funds/{fund_id}/sections
|
|
3495
|
-
* @secure
|
|
3496
|
-
*/
|
|
3497
|
-
getFundSections(fundId: number, query?: {
|
|
3498
|
-
/**
|
|
3499
|
-
* Year
|
|
3500
|
-
* Specify the year for which the analysis is requested.
|
|
3501
|
-
*/
|
|
3502
|
-
year?: number;
|
|
3503
|
-
/**
|
|
3504
|
-
* Quarter
|
|
3505
|
-
* Specify the quarter for which the analysis is requested.
|
|
3506
|
-
*/
|
|
3507
|
-
quarter?: number;
|
|
3508
|
-
/**
|
|
3509
|
-
* Language
|
|
3510
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3511
|
-
* @default "en-US"
|
|
3512
|
-
*/
|
|
3513
|
-
language?: BridgeWiseLanguageEnum;
|
|
3514
|
-
/**
|
|
3515
|
-
* Show All
|
|
3516
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3517
|
-
*/
|
|
3518
|
-
show_all?: boolean;
|
|
3519
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3520
|
-
}
|
|
3521
3715
|
export class Holdings<HandleError extends boolean = boolean> {
|
|
3522
3716
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3523
3717
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3611,54 +3805,75 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3611
3805
|
page_size?: number;
|
|
3612
3806
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
3613
3807
|
}
|
|
3614
|
-
export class
|
|
3808
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
3615
3809
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3616
3810
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3617
3811
|
/**
|
|
3618
|
-
* @description
|
|
3619
|
-
* @tags
|
|
3620
|
-
* @name
|
|
3621
|
-
* @summary
|
|
3622
|
-
* @request GET:/
|
|
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
|
|
3623
3817
|
* @secure
|
|
3624
3818
|
*/
|
|
3625
|
-
|
|
3819
|
+
fetchLogos(query?: {
|
|
3626
3820
|
/**
|
|
3627
|
-
*
|
|
3628
|
-
* Specify a
|
|
3821
|
+
* Company Id In
|
|
3822
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
3823
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3824
|
+
* @example "74822,83343211"
|
|
3629
3825
|
*/
|
|
3630
|
-
|
|
3826
|
+
company_id__in?: string;
|
|
3631
3827
|
/**
|
|
3632
|
-
*
|
|
3633
|
-
*
|
|
3828
|
+
* Size
|
|
3829
|
+
* Page size
|
|
3830
|
+
* @min 1
|
|
3831
|
+
* @max 100
|
|
3832
|
+
* @default 50
|
|
3634
3833
|
*/
|
|
3635
|
-
|
|
3834
|
+
size?: number;
|
|
3636
3835
|
/**
|
|
3637
|
-
*
|
|
3638
|
-
*
|
|
3836
|
+
* Page
|
|
3837
|
+
* Page number
|
|
3838
|
+
* @min 1
|
|
3839
|
+
* @default 1
|
|
3639
3840
|
*/
|
|
3640
|
-
|
|
3641
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3841
|
+
page?: number;
|
|
3842
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
3642
3843
|
/**
|
|
3643
|
-
* @description
|
|
3644
|
-
* @tags
|
|
3645
|
-
* @name
|
|
3646
|
-
* @summary
|
|
3647
|
-
* @request GET:/
|
|
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
|
|
3648
3849
|
* @secure
|
|
3649
3850
|
*/
|
|
3650
|
-
|
|
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>);
|
|
3856
|
+
/**
|
|
3857
|
+
* @description This endpoint provides filters
|
|
3858
|
+
* @tags Metadata
|
|
3859
|
+
* @name GetCompanyFilters
|
|
3860
|
+
* @summary Get Company Filters
|
|
3861
|
+
* @request GET:/filters
|
|
3862
|
+
* @secure
|
|
3863
|
+
*/
|
|
3864
|
+
getCompanyFilters(query: {
|
|
3651
3865
|
/**
|
|
3652
|
-
*
|
|
3653
|
-
*
|
|
3866
|
+
* Type
|
|
3867
|
+
* Desired filter type.
|
|
3654
3868
|
*/
|
|
3655
|
-
|
|
3869
|
+
type: BridgeWiseCompanyFilterType;
|
|
3656
3870
|
/**
|
|
3657
|
-
*
|
|
3658
|
-
*
|
|
3871
|
+
* Language
|
|
3872
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3873
|
+
* @default "en-US"
|
|
3659
3874
|
*/
|
|
3660
|
-
|
|
3661
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3875
|
+
language?: BridgeWiseLanguageEnum;
|
|
3876
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
3662
3877
|
}
|
|
3663
3878
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
3664
3879
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3716,6 +3931,26 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3716
3931
|
segment?: string;
|
|
3717
3932
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
3718
3933
|
}
|
|
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
|
+
}
|
|
3719
3954
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
3720
3955
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3721
3956
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3915,235 +4150,6 @@ export class Users<HandleError extends boolean = boolean> {
|
|
|
3915
4150
|
authorization: string;
|
|
3916
4151
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
3917
4152
|
}
|
|
3918
|
-
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
3919
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3920
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3921
|
-
/**
|
|
3922
|
-
* @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.
|
|
3923
|
-
* @tags Earning Calls
|
|
3924
|
-
* @name GetCompanyEarningsCalls
|
|
3925
|
-
* @summary Get Company Earnings Calls
|
|
3926
|
-
* @request GET:/companies/{company_id}/earnings-call
|
|
3927
|
-
* @secure
|
|
3928
|
-
*/
|
|
3929
|
-
getCompanyEarningsCalls(companyId: number, query?: {
|
|
3930
|
-
/**
|
|
3931
|
-
* Language
|
|
3932
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3933
|
-
* @default "en-US"
|
|
3934
|
-
*/
|
|
3935
|
-
language?: BridgeWiseLanguageEnum;
|
|
3936
|
-
/**
|
|
3937
|
-
* Year
|
|
3938
|
-
* Specify the year for which the analysis is requested.
|
|
3939
|
-
*/
|
|
3940
|
-
year?: number | null;
|
|
3941
|
-
/**
|
|
3942
|
-
* Quarter
|
|
3943
|
-
* Specify the quarter for which the analysis is requested.
|
|
3944
|
-
*/
|
|
3945
|
-
quarter?: number | null;
|
|
3946
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
3947
|
-
/**
|
|
3948
|
-
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
3949
|
-
* @tags Earning Calls
|
|
3950
|
-
* @name GetEarningsCallsRecaps
|
|
3951
|
-
* @summary Get Earnings Calls Recaps
|
|
3952
|
-
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
3953
|
-
* @secure
|
|
3954
|
-
*/
|
|
3955
|
-
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
3956
|
-
/**
|
|
3957
|
-
* Language
|
|
3958
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3959
|
-
* @default "en-US"
|
|
3960
|
-
*/
|
|
3961
|
-
language?: BridgeWiseLanguageEnum;
|
|
3962
|
-
/**
|
|
3963
|
-
* Type
|
|
3964
|
-
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
3965
|
-
*/
|
|
3966
|
-
type?: BridgeWiseEarningsCallRecapEnum;
|
|
3967
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
3968
|
-
}
|
|
3969
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
3970
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3971
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3972
|
-
/**
|
|
3973
|
-
* @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.
|
|
3974
|
-
* @tags Activities
|
|
3975
|
-
* @name GetCompanyAlerts
|
|
3976
|
-
* @summary Get Company Alerts
|
|
3977
|
-
* @request GET:/companies/{company_id}/alerts
|
|
3978
|
-
* @secure
|
|
3979
|
-
*/
|
|
3980
|
-
getCompanyAlerts(companyId: number, query?: {
|
|
3981
|
-
/**
|
|
3982
|
-
* Language
|
|
3983
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3984
|
-
* @default "en-US"
|
|
3985
|
-
*/
|
|
3986
|
-
language?: BridgeWiseLanguageEnum;
|
|
3987
|
-
/**
|
|
3988
|
-
* Alert Type
|
|
3989
|
-
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
3990
|
-
*/
|
|
3991
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
3992
|
-
/**
|
|
3993
|
-
* Sentiment
|
|
3994
|
-
* Filter alerts by their sentiment.
|
|
3995
|
-
*/
|
|
3996
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
3997
|
-
/**
|
|
3998
|
-
* Importance
|
|
3999
|
-
* 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
|
|
4000
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4001
|
-
*/
|
|
4002
|
-
importance?: string;
|
|
4003
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
4004
|
-
/**
|
|
4005
|
-
* @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.
|
|
4006
|
-
* @tags Activities
|
|
4007
|
-
* @name GetCompanyForecastsKeyDevelopment
|
|
4008
|
-
* @summary Get Company Forecasts Key Development
|
|
4009
|
-
* @request GET:/companies/{company_id}/key-developments
|
|
4010
|
-
* @secure
|
|
4011
|
-
*/
|
|
4012
|
-
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
4013
|
-
/**
|
|
4014
|
-
* Language
|
|
4015
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4016
|
-
* @default "en-US"
|
|
4017
|
-
*/
|
|
4018
|
-
language?: BridgeWiseLanguageEnum;
|
|
4019
|
-
/**
|
|
4020
|
-
* Importance
|
|
4021
|
-
* 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
|
|
4022
|
-
* @default "0,1"
|
|
4023
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4024
|
-
*/
|
|
4025
|
-
importance?: string;
|
|
4026
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
4027
|
-
}
|
|
4028
|
-
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4029
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4030
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4031
|
-
/**
|
|
4032
|
-
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
4033
|
-
* @tags ESG Analysis
|
|
4034
|
-
* @name GetCompanyEsgAnalysis
|
|
4035
|
-
* @summary Get Company Esg Analysis
|
|
4036
|
-
* @request GET:/companies/{company_id}/esg-analysis
|
|
4037
|
-
* @secure
|
|
4038
|
-
*/
|
|
4039
|
-
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
4040
|
-
/**
|
|
4041
|
-
* Language
|
|
4042
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4043
|
-
* @default "en-US"
|
|
4044
|
-
*/
|
|
4045
|
-
language?: BridgeWiseLanguageEnum;
|
|
4046
|
-
/**
|
|
4047
|
-
* Show All
|
|
4048
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4049
|
-
*/
|
|
4050
|
-
show_all?: boolean;
|
|
4051
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
4052
|
-
/**
|
|
4053
|
-
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
4054
|
-
* @tags ESG Analysis
|
|
4055
|
-
* @name GetCompanyEsgParagraphs
|
|
4056
|
-
* @summary Get Company Esg Paragraphs
|
|
4057
|
-
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
4058
|
-
* @secure
|
|
4059
|
-
*/
|
|
4060
|
-
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
4061
|
-
/**
|
|
4062
|
-
* Language
|
|
4063
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4064
|
-
* @default "en-US"
|
|
4065
|
-
*/
|
|
4066
|
-
language?: BridgeWiseLanguageEnum;
|
|
4067
|
-
/**
|
|
4068
|
-
* Section Type
|
|
4069
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
4070
|
-
*/
|
|
4071
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4072
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4073
|
-
/**
|
|
4074
|
-
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
4075
|
-
* @tags ESG Analysis
|
|
4076
|
-
* @name GetCompanyEsgParameters
|
|
4077
|
-
* @summary Get Company Esg Parameters
|
|
4078
|
-
* @request GET:/companies/{company_id}/esg-parameters
|
|
4079
|
-
* @secure
|
|
4080
|
-
*/
|
|
4081
|
-
getCompanyEsgParameters(companyId: number, query?: {
|
|
4082
|
-
/**
|
|
4083
|
-
* Language
|
|
4084
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4085
|
-
* @default "en-US"
|
|
4086
|
-
*/
|
|
4087
|
-
language?: BridgeWiseLanguageEnum;
|
|
4088
|
-
/**
|
|
4089
|
-
* Parameter Id
|
|
4090
|
-
* Get desired parameter by ID.
|
|
4091
|
-
*/
|
|
4092
|
-
parameter_id?: number;
|
|
4093
|
-
/**
|
|
4094
|
-
* Section Type
|
|
4095
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
4096
|
-
*/
|
|
4097
|
-
section_type?: BridgeWiseSectionTypeEnum;
|
|
4098
|
-
/**
|
|
4099
|
-
* Show All
|
|
4100
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4101
|
-
*/
|
|
4102
|
-
show_all?: boolean;
|
|
4103
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
4104
|
-
/**
|
|
4105
|
-
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
4106
|
-
* @tags ESG Analysis
|
|
4107
|
-
* @name GetCompanyEsgSections
|
|
4108
|
-
* @summary Get Company Esg Sections
|
|
4109
|
-
* @request GET:/companies/{company_id}/esg-sections
|
|
4110
|
-
* @secure
|
|
4111
|
-
*/
|
|
4112
|
-
getCompanyEsgSections(companyId: number, query?: {
|
|
4113
|
-
/**
|
|
4114
|
-
* Language
|
|
4115
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4116
|
-
* @default "en-US"
|
|
4117
|
-
*/
|
|
4118
|
-
language?: BridgeWiseLanguageEnum;
|
|
4119
|
-
/**
|
|
4120
|
-
* Section Type
|
|
4121
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
4122
|
-
*/
|
|
4123
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4124
|
-
/**
|
|
4125
|
-
* Show All
|
|
4126
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4127
|
-
*/
|
|
4128
|
-
show_all?: boolean;
|
|
4129
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
4130
|
-
/**
|
|
4131
|
-
* @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
|
|
4132
|
-
* @tags ESG Analysis
|
|
4133
|
-
* @name GetCompanyForecastsMsa
|
|
4134
|
-
* @summary Get Company Forecasts Msa
|
|
4135
|
-
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
4136
|
-
* @secure
|
|
4137
|
-
*/
|
|
4138
|
-
getCompanyForecastsMsa(companyId: number, query?: {
|
|
4139
|
-
/**
|
|
4140
|
-
* Language
|
|
4141
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4142
|
-
* @default "en-US"
|
|
4143
|
-
*/
|
|
4144
|
-
language?: BridgeWiseLanguageEnum;
|
|
4145
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
4146
|
-
}
|
|
4147
4153
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4148
4154
|
readonly config: JwtClientConfig<HandleError>;
|
|
4149
4155
|
activities: Activities<HandleError>;
|