@orbis-systems/orbis-api-clients 0.6.2 → 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 +560 -554
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +712 -712
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +711 -711
- 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,18 +1942,146 @@ 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>);
|
|
1948
2076
|
/**
|
|
1949
2077
|
* @description Enables users to search and filter companies based on a range of financial and non-financial criteria, returning a detailed list of companies that match the specified parameters.
|
|
1950
2078
|
* @tags Company Metadata
|
|
1951
|
-
* @name
|
|
2079
|
+
* @name GetCompanies
|
|
1952
2080
|
* @summary Get Companies
|
|
1953
2081
|
* @request GET:/companies
|
|
1954
2082
|
* @secure
|
|
1955
2083
|
*/
|
|
1956
|
-
|
|
2084
|
+
getCompanies(query?: {
|
|
1957
2085
|
/**
|
|
1958
2086
|
* Language
|
|
1959
2087
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2549,28 +2677,34 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2549
2677
|
/**
|
|
2550
2678
|
* @description Retrieves the metadata object of a specific company identified by the company_id. It provides detailed information about the company's characteristics.
|
|
2551
2679
|
* @tags Company Metadata
|
|
2552
|
-
* @name
|
|
2680
|
+
* @name GetCompany
|
|
2553
2681
|
* @summary Get Company
|
|
2554
2682
|
* @request GET:/companies/{company_id}
|
|
2555
2683
|
* @secure
|
|
2556
2684
|
*/
|
|
2557
|
-
|
|
2685
|
+
getCompany(companyId: number, query?: {
|
|
2558
2686
|
/**
|
|
2559
2687
|
* Language
|
|
2560
2688
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
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.
|
|
2567
2701
|
* @tags Company Metadata, Fund Metadata
|
|
2568
|
-
* @name
|
|
2702
|
+
* @name GetIdentifierSearch
|
|
2569
2703
|
* @summary Get Identifier Search
|
|
2570
2704
|
* @request GET:/identifier-search
|
|
2571
2705
|
* @secure
|
|
2572
2706
|
*/
|
|
2573
|
-
|
|
2707
|
+
getIdentifierSearch(query: {
|
|
2574
2708
|
/**
|
|
2575
2709
|
* Identifier
|
|
2576
2710
|
* Specify an external identifier such as ISIN or ticker-exchange for asset identification.
|
|
@@ -2584,18 +2718,148 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2584
2718
|
identifier_type: BridgeWiseIdentifierTypeEnum;
|
|
2585
2719
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2586
2720
|
}
|
|
2721
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
2722
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2723
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2724
|
+
/**
|
|
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
|
|
2730
|
+
* @secure
|
|
2731
|
+
*/
|
|
2732
|
+
getCompanyNews(companyId: number, query?: {
|
|
2733
|
+
/**
|
|
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))*$
|
|
2738
|
+
*/
|
|
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;
|
|
2760
|
+
/**
|
|
2761
|
+
* Size
|
|
2762
|
+
* Define the number of records per page for pagination purposes.
|
|
2763
|
+
* @default 10
|
|
2764
|
+
* @example 10
|
|
2765
|
+
*/
|
|
2766
|
+
size?: number;
|
|
2767
|
+
/**
|
|
2768
|
+
* Page
|
|
2769
|
+
* Define the page number for pagination.
|
|
2770
|
+
* @default 1
|
|
2771
|
+
* @example 1
|
|
2772
|
+
*/
|
|
2773
|
+
page?: number;
|
|
2774
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
2775
|
+
/**
|
|
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
|
|
2781
|
+
* @secure
|
|
2782
|
+
*/
|
|
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>>;
|
|
2799
|
+
}
|
|
2800
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2801
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2802
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2803
|
+
/**
|
|
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
|
|
2809
|
+
* @secure
|
|
2810
|
+
*/
|
|
2811
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2812
|
+
/**
|
|
2813
|
+
* Language
|
|
2814
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2815
|
+
* @default "en-US"
|
|
2816
|
+
*/
|
|
2817
|
+
language?: BridgeWiseLanguageEnum;
|
|
2818
|
+
/**
|
|
2819
|
+
* Year
|
|
2820
|
+
* Specify the year for which the analysis is requested.
|
|
2821
|
+
*/
|
|
2822
|
+
year?: number | null;
|
|
2823
|
+
/**
|
|
2824
|
+
* Quarter
|
|
2825
|
+
* Specify the quarter for which the analysis is requested.
|
|
2826
|
+
*/
|
|
2827
|
+
quarter?: number | null;
|
|
2828
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2829
|
+
/**
|
|
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
|
+
}
|
|
2587
2851
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
2588
2852
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2589
2853
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2590
2854
|
/**
|
|
2591
2855
|
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
2592
2856
|
* @tags ESG Analysis
|
|
2593
|
-
* @name
|
|
2857
|
+
* @name GetCompanyEsgAnalysis
|
|
2594
2858
|
* @summary Get Company Esg Analysis
|
|
2595
2859
|
* @request GET:/companies/{company_id}/esg-analysis
|
|
2596
2860
|
* @secure
|
|
2597
2861
|
*/
|
|
2598
|
-
|
|
2862
|
+
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
2599
2863
|
/**
|
|
2600
2864
|
* Language
|
|
2601
2865
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2611,12 +2875,12 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2611
2875
|
/**
|
|
2612
2876
|
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
2613
2877
|
* @tags ESG Analysis
|
|
2614
|
-
* @name
|
|
2878
|
+
* @name GetCompanyEsgParagraphs
|
|
2615
2879
|
* @summary Get Company Esg Paragraphs
|
|
2616
2880
|
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
2617
2881
|
* @secure
|
|
2618
2882
|
*/
|
|
2619
|
-
|
|
2883
|
+
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
2620
2884
|
/**
|
|
2621
2885
|
* Language
|
|
2622
2886
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2632,12 +2896,12 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2632
2896
|
/**
|
|
2633
2897
|
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
2634
2898
|
* @tags ESG Analysis
|
|
2635
|
-
* @name
|
|
2899
|
+
* @name GetCompanyEsgParameters
|
|
2636
2900
|
* @summary Get Company Esg Parameters
|
|
2637
2901
|
* @request GET:/companies/{company_id}/esg-parameters
|
|
2638
2902
|
* @secure
|
|
2639
2903
|
*/
|
|
2640
|
-
|
|
2904
|
+
getCompanyEsgParameters(companyId: number, query?: {
|
|
2641
2905
|
/**
|
|
2642
2906
|
* Language
|
|
2643
2907
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2663,12 +2927,12 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2663
2927
|
/**
|
|
2664
2928
|
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
2665
2929
|
* @tags ESG Analysis
|
|
2666
|
-
* @name
|
|
2930
|
+
* @name GetCompanyEsgSections
|
|
2667
2931
|
* @summary Get Company Esg Sections
|
|
2668
2932
|
* @request GET:/companies/{company_id}/esg-sections
|
|
2669
2933
|
* @secure
|
|
2670
2934
|
*/
|
|
2671
|
-
|
|
2935
|
+
getCompanyEsgSections(companyId: number, query?: {
|
|
2672
2936
|
/**
|
|
2673
2937
|
* Language
|
|
2674
2938
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2689,12 +2953,12 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2689
2953
|
/**
|
|
2690
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.
|
|
2691
2955
|
* @tags ESG Analysis
|
|
2692
|
-
* @name
|
|
2956
|
+
* @name GetCompanyForecastsMsa
|
|
2693
2957
|
* @summary Get Company Forecasts Msa
|
|
2694
2958
|
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
2695
2959
|
* @secure
|
|
2696
2960
|
*/
|
|
2697
|
-
|
|
2961
|
+
getCompanyForecastsMsa(companyId: number, query?: {
|
|
2698
2962
|
/**
|
|
2699
2963
|
* Language
|
|
2700
2964
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2703,18 +2967,18 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2703
2967
|
language?: BridgeWiseLanguageEnum;
|
|
2704
2968
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
2705
2969
|
}
|
|
2706
|
-
export class
|
|
2970
|
+
export class Forecasts<HandleError extends boolean = boolean> {
|
|
2707
2971
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2708
2972
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2709
2973
|
/**
|
|
2710
|
-
* @description
|
|
2711
|
-
* @tags
|
|
2712
|
-
* @name
|
|
2713
|
-
* @summary Get Company
|
|
2714
|
-
* @request GET:/companies/{company_id}/
|
|
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
|
|
2715
2979
|
* @secure
|
|
2716
2980
|
*/
|
|
2717
|
-
|
|
2981
|
+
getCompanyForecasts(companyId: number, query?: {
|
|
2718
2982
|
/**
|
|
2719
2983
|
* Language
|
|
2720
2984
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2722,67 +2986,8 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2722
2986
|
*/
|
|
2723
2987
|
language?: BridgeWiseLanguageEnum;
|
|
2724
2988
|
/**
|
|
2725
|
-
*
|
|
2726
|
-
*
|
|
2727
|
-
*/
|
|
2728
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
2729
|
-
/**
|
|
2730
|
-
* Sentiment
|
|
2731
|
-
* Filter alerts by their sentiment.
|
|
2732
|
-
*/
|
|
2733
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2734
|
-
/**
|
|
2735
|
-
* Importance
|
|
2736
|
-
* 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
|
|
2737
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2738
|
-
*/
|
|
2739
|
-
importance?: string;
|
|
2740
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
2741
|
-
/**
|
|
2742
|
-
* @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.
|
|
2743
|
-
* @tags Activities
|
|
2744
|
-
* @name GetCompanyForecastsKeyDevelopmentCompaniesCompanyIdKeyDevelopmentsGet
|
|
2745
|
-
* @summary Get Company Forecasts Key Development
|
|
2746
|
-
* @request GET:/companies/{company_id}/key-developments
|
|
2747
|
-
* @secure
|
|
2748
|
-
*/
|
|
2749
|
-
getCompanyForecastsKeyDevelopmentCompaniesCompanyIdKeyDevelopmentsGet(companyId: number, query?: {
|
|
2750
|
-
/**
|
|
2751
|
-
* Language
|
|
2752
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2753
|
-
* @default "en-US"
|
|
2754
|
-
*/
|
|
2755
|
-
language?: BridgeWiseLanguageEnum;
|
|
2756
|
-
/**
|
|
2757
|
-
* Importance
|
|
2758
|
-
* 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
|
|
2759
|
-
* @default "0,1"
|
|
2760
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2761
|
-
*/
|
|
2762
|
-
importance?: string;
|
|
2763
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2764
|
-
}
|
|
2765
|
-
export class Forecasts<HandleError extends boolean = boolean> {
|
|
2766
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2767
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2768
|
-
/**
|
|
2769
|
-
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
2770
|
-
* @tags Forecasts
|
|
2771
|
-
* @name GetCompanyForecastsCompaniesCompanyIdForecastsGet
|
|
2772
|
-
* @summary Get Company Forecasts
|
|
2773
|
-
* @request GET:/companies/{company_id}/forecasts
|
|
2774
|
-
* @secure
|
|
2775
|
-
*/
|
|
2776
|
-
getCompanyForecastsCompaniesCompanyIdForecastsGet(companyId: number, query?: {
|
|
2777
|
-
/**
|
|
2778
|
-
* Language
|
|
2779
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2780
|
-
* @default "en-US"
|
|
2781
|
-
*/
|
|
2782
|
-
language?: BridgeWiseLanguageEnum;
|
|
2783
|
-
/**
|
|
2784
|
-
* Forecast Type
|
|
2785
|
-
* Desired forecast type.
|
|
2989
|
+
* Forecast Type
|
|
2990
|
+
* Desired forecast type.
|
|
2786
2991
|
*/
|
|
2787
2992
|
forecast_type?: BridgeWiseForecastType;
|
|
2788
2993
|
/**
|
|
@@ -2805,12 +3010,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2805
3010
|
/**
|
|
2806
3011
|
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
2807
3012
|
* @tags Fundamental Analysis
|
|
2808
|
-
* @name
|
|
3013
|
+
* @name GetCompanyFundamentalAnalysis
|
|
2809
3014
|
* @summary Get Company Fundamental Analysis
|
|
2810
3015
|
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
2811
3016
|
* @secure
|
|
2812
3017
|
*/
|
|
2813
|
-
|
|
3018
|
+
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
2814
3019
|
/**
|
|
2815
3020
|
* Language
|
|
2816
3021
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2826,12 +3031,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2826
3031
|
/**
|
|
2827
3032
|
* @description This endpoint provides detailed textual analyses focused on a company's financial health, including its profitability, balance sheet, cash flow and income statement.
|
|
2828
3033
|
* @tags Fundamental Analysis
|
|
2829
|
-
* @name
|
|
3034
|
+
* @name GetCompanyFundamentalParagraphs
|
|
2830
3035
|
* @summary Get Company Fundamental Paragraphs
|
|
2831
3036
|
* @request GET:/companies/{company_id}/fundamental-paragraphs
|
|
2832
3037
|
* @secure
|
|
2833
3038
|
*/
|
|
2834
|
-
|
|
3039
|
+
getCompanyFundamentalParagraphs(companyId: number, query?: {
|
|
2835
3040
|
/**
|
|
2836
3041
|
* Language
|
|
2837
3042
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2847,12 +3052,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2847
3052
|
/**
|
|
2848
3053
|
* @description Offers an in-depth breakdown of the parameters used in the fundamental analysis, detailing more than 100 key metrics within the income statement, balance sheet and cash flow financial statements.
|
|
2849
3054
|
* @tags Fundamental Analysis
|
|
2850
|
-
* @name
|
|
3055
|
+
* @name GetCompanyFundamentalParameters
|
|
2851
3056
|
* @summary Get Company Fundamental Parameters
|
|
2852
3057
|
* @request GET:/companies/{company_id}/fundamental-parameters
|
|
2853
3058
|
* @secure
|
|
2854
3059
|
*/
|
|
2855
|
-
|
|
3060
|
+
getCompanyFundamentalParameters(companyId: number, query?: {
|
|
2856
3061
|
/**
|
|
2857
3062
|
* Language
|
|
2858
3063
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2905,12 +3110,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2905
3110
|
/**
|
|
2906
3111
|
* @description Provides scores for individual sections of the company's fundamental analysis, including the balance sheet, income statement, and cash flow performance.
|
|
2907
3112
|
* @tags Fundamental Analysis
|
|
2908
|
-
* @name
|
|
3113
|
+
* @name GetCompanyFundamentalSections
|
|
2909
3114
|
* @summary Get Company Fundamental Sections
|
|
2910
3115
|
* @request GET:/companies/{company_id}/fundamental-sections
|
|
2911
3116
|
* @secure
|
|
2912
3117
|
*/
|
|
2913
|
-
|
|
3118
|
+
getCompanyFundamentalSections(companyId: number, query?: {
|
|
2914
3119
|
/**
|
|
2915
3120
|
* Language
|
|
2916
3121
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2931,12 +3136,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2931
3136
|
/**
|
|
2932
3137
|
* @description Provides Bridgewise's proprietary price target estimation for a specific company, including its percentage difference from the current stock price and the calculated probability of reaching this target.
|
|
2933
3138
|
* @tags Fundamental Analysis
|
|
2934
|
-
* @name
|
|
3139
|
+
* @name GetTargetPrice
|
|
2935
3140
|
* @summary Get Target Price
|
|
2936
3141
|
* @request GET:/companies/{company_id}/target-price
|
|
2937
3142
|
* @secure
|
|
2938
3143
|
*/
|
|
2939
|
-
|
|
3144
|
+
getTargetPrice(companyId: number, query?: {
|
|
2940
3145
|
/**
|
|
2941
3146
|
* Trading Item Id
|
|
2942
3147
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -2954,198 +3159,167 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2954
3159
|
date__lte?: string;
|
|
2955
3160
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
2956
3161
|
}
|
|
2957
|
-
export class
|
|
3162
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
2958
3163
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2959
3164
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2960
3165
|
/**
|
|
2961
|
-
* @description
|
|
2962
|
-
* @tags
|
|
2963
|
-
* @name
|
|
2964
|
-
* @summary Get
|
|
2965
|
-
* @request GET:/
|
|
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
|
|
2966
3171
|
* @secure
|
|
2967
3172
|
*/
|
|
2968
|
-
|
|
2969
|
-
/**
|
|
2970
|
-
* Trading Item Id
|
|
2971
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
2972
|
-
*/
|
|
2973
|
-
trading_item_id?: number | null;
|
|
3173
|
+
getFundAnalysis(fundId: number, query?: {
|
|
2974
3174
|
/**
|
|
2975
|
-
*
|
|
2976
|
-
*
|
|
3175
|
+
* Language
|
|
3176
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3177
|
+
* @default "en-US"
|
|
2977
3178
|
*/
|
|
2978
|
-
|
|
3179
|
+
language?: BridgeWiseLanguageEnum;
|
|
2979
3180
|
/**
|
|
2980
|
-
*
|
|
2981
|
-
* Specify the
|
|
3181
|
+
* Year
|
|
3182
|
+
* Specify the year for which the analysis is requested.
|
|
2982
3183
|
*/
|
|
2983
|
-
|
|
2984
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
2985
|
-
/**
|
|
2986
|
-
* @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.
|
|
2987
|
-
* @tags Company Market Data
|
|
2988
|
-
* @name GetCompanyMarketStatisticsCompaniesCompanyIdMarketStatisticsGet
|
|
2989
|
-
* @summary Get Company Market Statistics
|
|
2990
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
2991
|
-
* @secure
|
|
2992
|
-
*/
|
|
2993
|
-
getCompanyMarketStatisticsCompaniesCompanyIdMarketStatisticsGet(companyId: number, query?: {
|
|
3184
|
+
year?: number;
|
|
2994
3185
|
/**
|
|
2995
|
-
*
|
|
2996
|
-
* Specify
|
|
3186
|
+
* Quarter
|
|
3187
|
+
* Specify the quarter for which the analysis is requested.
|
|
2997
3188
|
*/
|
|
2998
|
-
|
|
3189
|
+
quarter?: number;
|
|
2999
3190
|
/**
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3191
|
+
* Show All
|
|
3192
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3002
3193
|
*/
|
|
3003
|
-
|
|
3004
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3194
|
+
show_all?: boolean;
|
|
3195
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3005
3196
|
/**
|
|
3006
|
-
* @description Returns
|
|
3007
|
-
* @tags
|
|
3008
|
-
* @name
|
|
3009
|
-
* @summary Get
|
|
3010
|
-
* @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
|
|
3011
3202
|
* @secure
|
|
3012
3203
|
*/
|
|
3013
|
-
|
|
3204
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
3014
3205
|
/**
|
|
3015
|
-
*
|
|
3016
|
-
*
|
|
3206
|
+
* Language
|
|
3207
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3208
|
+
* @default "en-US"
|
|
3017
3209
|
*/
|
|
3018
|
-
|
|
3210
|
+
language?: BridgeWiseLanguageEnum;
|
|
3019
3211
|
/**
|
|
3020
|
-
*
|
|
3021
|
-
*
|
|
3212
|
+
* Year
|
|
3213
|
+
* Specify the year for which the analysis is requested.
|
|
3022
3214
|
*/
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3215
|
+
year?: number | null;
|
|
3216
|
+
/**
|
|
3217
|
+
* Quarter
|
|
3218
|
+
* Specify the quarter for which the analysis is requested.
|
|
3219
|
+
*/
|
|
3220
|
+
quarter?: number | null;
|
|
3221
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3029
3222
|
/**
|
|
3030
|
-
* @description
|
|
3031
|
-
* @tags
|
|
3032
|
-
* @name
|
|
3033
|
-
* @summary Get
|
|
3034
|
-
* @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
|
|
3035
3228
|
* @secure
|
|
3036
3229
|
*/
|
|
3037
|
-
|
|
3230
|
+
getFundParameters(fundId: number, query?: {
|
|
3038
3231
|
/**
|
|
3039
|
-
*
|
|
3232
|
+
* Language
|
|
3040
3233
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3041
3234
|
* @default "en-US"
|
|
3042
|
-
* @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))*$
|
|
3043
3235
|
*/
|
|
3044
|
-
|
|
3236
|
+
language?: BridgeWiseLanguageEnum;
|
|
3045
3237
|
/**
|
|
3046
|
-
*
|
|
3047
|
-
*
|
|
3048
|
-
* @format date
|
|
3049
|
-
* @default "2025-02-10"
|
|
3238
|
+
* Parameter Id
|
|
3239
|
+
* ID of the parameter for analysis.
|
|
3050
3240
|
*/
|
|
3051
|
-
|
|
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?: {
|
|
3052
3252
|
/**
|
|
3053
|
-
*
|
|
3054
|
-
*
|
|
3055
|
-
* @format date
|
|
3056
|
-
* @default "2025-02-10"
|
|
3253
|
+
* Year
|
|
3254
|
+
* Specify the year for which the analysis is requested.
|
|
3057
3255
|
*/
|
|
3058
|
-
|
|
3256
|
+
year?: number;
|
|
3059
3257
|
/**
|
|
3060
|
-
*
|
|
3061
|
-
* Specify the
|
|
3062
|
-
* @default "publication_date"
|
|
3258
|
+
* Quarter
|
|
3259
|
+
* Specify the quarter for which the analysis is requested.
|
|
3063
3260
|
*/
|
|
3064
|
-
|
|
3261
|
+
quarter?: number;
|
|
3065
3262
|
/**
|
|
3066
|
-
*
|
|
3067
|
-
* Define the
|
|
3068
|
-
* @default
|
|
3069
|
-
* @example 10
|
|
3263
|
+
* Language
|
|
3264
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3265
|
+
* @default "en-US"
|
|
3070
3266
|
*/
|
|
3071
|
-
|
|
3267
|
+
language?: BridgeWiseLanguageEnum;
|
|
3072
3268
|
/**
|
|
3073
|
-
*
|
|
3074
|
-
*
|
|
3075
|
-
* @default 1
|
|
3076
|
-
* @example 1
|
|
3269
|
+
* Show All
|
|
3270
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3077
3271
|
*/
|
|
3078
|
-
|
|
3079
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
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>);
|
|
3080
3278
|
/**
|
|
3081
|
-
* @description
|
|
3082
|
-
* @tags
|
|
3083
|
-
* @name
|
|
3084
|
-
* @summary Get
|
|
3085
|
-
* @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
|
|
3086
3284
|
* @secure
|
|
3087
3285
|
*/
|
|
3088
|
-
|
|
3286
|
+
getFundsMarketData(fundId: number, query?: {
|
|
3089
3287
|
/**
|
|
3090
|
-
*
|
|
3091
|
-
*
|
|
3092
|
-
* @format date
|
|
3093
|
-
* @default "2025-02-10"
|
|
3288
|
+
* Trading Item Id
|
|
3289
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3094
3290
|
*/
|
|
3095
|
-
|
|
3291
|
+
trading_item_id?: number | null;
|
|
3096
3292
|
/**
|
|
3097
|
-
*
|
|
3098
|
-
*
|
|
3099
|
-
* @format date
|
|
3100
|
-
* @default "2025-02-10"
|
|
3293
|
+
* Date Ge
|
|
3294
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3101
3295
|
*/
|
|
3102
|
-
|
|
3103
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
3104
|
-
}
|
|
3105
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
3106
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3107
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3108
|
-
/**
|
|
3109
|
-
* @description This endpoint offers technical analysis of a company's stock price movements and trends.
|
|
3110
|
-
* @tags Technical Analysis
|
|
3111
|
-
* @name GetCompanyTechnicalParagraphsCompaniesCompanyIdTechnicalParagraphsGet
|
|
3112
|
-
* @summary Get Company Technical Paragraphs
|
|
3113
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
3114
|
-
* @secure
|
|
3115
|
-
*/
|
|
3116
|
-
getCompanyTechnicalParagraphsCompaniesCompanyIdTechnicalParagraphsGet(companyId: number, query?: {
|
|
3296
|
+
date__ge?: string | null;
|
|
3117
3297
|
/**
|
|
3118
|
-
*
|
|
3119
|
-
*
|
|
3120
|
-
* @default "en-US"
|
|
3298
|
+
* Date Le
|
|
3299
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3121
3300
|
*/
|
|
3122
|
-
|
|
3123
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3124
|
-
}
|
|
3125
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
3126
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3127
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3301
|
+
date__le?: string | null;
|
|
3302
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
3128
3303
|
/**
|
|
3129
|
-
* @description
|
|
3130
|
-
* @tags
|
|
3131
|
-
* @name
|
|
3132
|
-
* @summary Get
|
|
3133
|
-
* @request GET:/
|
|
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
|
|
3134
3309
|
* @secure
|
|
3135
3310
|
*/
|
|
3136
|
-
|
|
3311
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
3137
3312
|
/**
|
|
3138
|
-
*
|
|
3139
|
-
*
|
|
3313
|
+
* Trading Item Id
|
|
3314
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3140
3315
|
*/
|
|
3141
|
-
|
|
3316
|
+
trading_item_id?: number | null;
|
|
3142
3317
|
/**
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3145
|
-
* @default "en-US"
|
|
3318
|
+
* Identifier In
|
|
3319
|
+
* Specify a list of external identifiers.
|
|
3146
3320
|
*/
|
|
3147
|
-
|
|
3148
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3321
|
+
identifier__in?: string | null;
|
|
3322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
3149
3323
|
}
|
|
3150
3324
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3151
3325
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3153,12 +3327,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3153
3327
|
/**
|
|
3154
3328
|
* @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
|
|
3155
3329
|
* @tags Fund Metadata
|
|
3156
|
-
* @name
|
|
3330
|
+
* @name GetFunds
|
|
3157
3331
|
* @summary Get Funds
|
|
3158
3332
|
* @request GET:/funds
|
|
3159
3333
|
* @secure
|
|
3160
3334
|
*/
|
|
3161
|
-
|
|
3335
|
+
getFunds(query?: {
|
|
3162
3336
|
/**
|
|
3163
3337
|
* Search
|
|
3164
3338
|
* Funds search.
|
|
@@ -3482,174 +3656,61 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3482
3656
|
*/
|
|
3483
3657
|
section_performance_score__gte?: number;
|
|
3484
3658
|
/**
|
|
3485
|
-
* Section Performance Score Lte
|
|
3486
|
-
* Section performance score less than or equal to.
|
|
3487
|
-
*/
|
|
3488
|
-
section_performance_score__lte?: number;
|
|
3489
|
-
/**
|
|
3490
|
-
* Return Range Gte
|
|
3491
|
-
* Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
|
|
3492
|
-
*/
|
|
3493
|
-
return_range__gte?: string;
|
|
3494
|
-
/**
|
|
3495
|
-
* Return Value Gte
|
|
3496
|
-
* Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
|
|
3497
|
-
*/
|
|
3498
|
-
return_value__gte?: string;
|
|
3499
|
-
/**
|
|
3500
|
-
* Return Range Lte
|
|
3501
|
-
* Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
|
|
3502
|
-
*/
|
|
3503
|
-
return_range__lte?: string;
|
|
3504
|
-
/**
|
|
3505
|
-
* Return Value Lte
|
|
3506
|
-
* Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
|
|
3507
|
-
*/
|
|
3508
|
-
return_value__lte?: string;
|
|
3509
|
-
/**
|
|
3510
|
-
* Page
|
|
3511
|
-
* Define the page number for pagination.
|
|
3512
|
-
* @exclusiveMin 0
|
|
3513
|
-
* @default 1
|
|
3514
|
-
*/
|
|
3515
|
-
page?: number;
|
|
3516
|
-
/**
|
|
3517
|
-
* Page Size
|
|
3518
|
-
* Define the number of records per page for pagination purposes.
|
|
3519
|
-
* @exclusiveMin 0
|
|
3520
|
-
* @default 100
|
|
3521
|
-
*/
|
|
3522
|
-
page_size?: number;
|
|
3523
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
|
|
3524
|
-
/**
|
|
3525
|
-
* @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
|
|
3526
|
-
* @tags Fund Metadata
|
|
3527
|
-
* @name GetFundFundsFundIdGet
|
|
3528
|
-
* @summary Get Fund
|
|
3529
|
-
* @request GET:/funds/{fund_id}
|
|
3530
|
-
* @secure
|
|
3531
|
-
*/
|
|
3532
|
-
getFundFundsFundIdGet(fundId: number, query?: {
|
|
3533
|
-
/**
|
|
3534
|
-
* Language
|
|
3535
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3536
|
-
* @default "en-US"
|
|
3537
|
-
*/
|
|
3538
|
-
language?: BridgeWiseLanguageEnum;
|
|
3539
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3540
|
-
}
|
|
3541
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3542
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3543
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3544
|
-
/**
|
|
3545
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3546
|
-
* @tags Fund Analysis
|
|
3547
|
-
* @name GetFundAnalysisFundsFundIdAnalysisGet
|
|
3548
|
-
* @summary Get Fund Analysis
|
|
3549
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
3550
|
-
* @secure
|
|
3551
|
-
*/
|
|
3552
|
-
getFundAnalysisFundsFundIdAnalysisGet(fundId: number, query?: {
|
|
3553
|
-
/**
|
|
3554
|
-
* Language
|
|
3555
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3556
|
-
* @default "en-US"
|
|
3557
|
-
*/
|
|
3558
|
-
language?: BridgeWiseLanguageEnum;
|
|
3559
|
-
/**
|
|
3560
|
-
* Year
|
|
3561
|
-
* Specify the year for which the analysis is requested.
|
|
3562
|
-
*/
|
|
3563
|
-
year?: number;
|
|
3564
|
-
/**
|
|
3565
|
-
* Quarter
|
|
3566
|
-
* Specify the quarter for which the analysis is requested.
|
|
3567
|
-
*/
|
|
3568
|
-
quarter?: number;
|
|
3569
|
-
/**
|
|
3570
|
-
* Show All
|
|
3571
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3572
|
-
*/
|
|
3573
|
-
show_all?: boolean;
|
|
3574
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3575
|
-
/**
|
|
3576
|
-
* @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.
|
|
3577
|
-
* @tags Fund Analysis
|
|
3578
|
-
* @name GetFundsParagraphsFundsFundIdParagraphsGet
|
|
3579
|
-
* @summary Get Funds Paragraphs
|
|
3580
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
3581
|
-
* @secure
|
|
3582
|
-
*/
|
|
3583
|
-
getFundsParagraphsFundsFundIdParagraphsGet(fundId: number, query?: {
|
|
3584
|
-
/**
|
|
3585
|
-
* Language
|
|
3586
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3587
|
-
* @default "en-US"
|
|
3659
|
+
* Section Performance Score Lte
|
|
3660
|
+
* Section performance score less than or equal to.
|
|
3588
3661
|
*/
|
|
3589
|
-
|
|
3662
|
+
section_performance_score__lte?: number;
|
|
3590
3663
|
/**
|
|
3591
|
-
*
|
|
3592
|
-
*
|
|
3664
|
+
* Return Range Gte
|
|
3665
|
+
* Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
|
|
3593
3666
|
*/
|
|
3594
|
-
|
|
3667
|
+
return_range__gte?: string;
|
|
3595
3668
|
/**
|
|
3596
|
-
*
|
|
3597
|
-
*
|
|
3669
|
+
* Return Value Gte
|
|
3670
|
+
* Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
|
|
3598
3671
|
*/
|
|
3599
|
-
|
|
3600
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3601
|
-
/**
|
|
3602
|
-
* @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.
|
|
3603
|
-
* @tags Fund Analysis
|
|
3604
|
-
* @name GetFundParametersFundsFundIdParametersGet
|
|
3605
|
-
* @summary Get Fund Parameters
|
|
3606
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
3607
|
-
* @secure
|
|
3608
|
-
*/
|
|
3609
|
-
getFundParametersFundsFundIdParametersGet(fundId: number, query?: {
|
|
3672
|
+
return_value__gte?: string;
|
|
3610
3673
|
/**
|
|
3611
|
-
*
|
|
3612
|
-
*
|
|
3613
|
-
* @default "en-US"
|
|
3674
|
+
* Return Range Lte
|
|
3675
|
+
* Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
|
|
3614
3676
|
*/
|
|
3615
|
-
|
|
3677
|
+
return_range__lte?: string;
|
|
3616
3678
|
/**
|
|
3617
|
-
*
|
|
3618
|
-
*
|
|
3679
|
+
* Return Value Lte
|
|
3680
|
+
* Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
|
|
3619
3681
|
*/
|
|
3620
|
-
|
|
3621
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3622
|
-
/**
|
|
3623
|
-
* @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.
|
|
3624
|
-
* @tags Fund Analysis
|
|
3625
|
-
* @name GetFundSectionsFundsFundIdSectionsGet
|
|
3626
|
-
* @summary Get Fund Sections
|
|
3627
|
-
* @request GET:/funds/{fund_id}/sections
|
|
3628
|
-
* @secure
|
|
3629
|
-
*/
|
|
3630
|
-
getFundSectionsFundsFundIdSectionsGet(fundId: number, query?: {
|
|
3682
|
+
return_value__lte?: string;
|
|
3631
3683
|
/**
|
|
3632
|
-
*
|
|
3633
|
-
*
|
|
3684
|
+
* Page
|
|
3685
|
+
* Define the page number for pagination.
|
|
3686
|
+
* @exclusiveMin 0
|
|
3687
|
+
* @default 1
|
|
3634
3688
|
*/
|
|
3635
|
-
|
|
3689
|
+
page?: number;
|
|
3636
3690
|
/**
|
|
3637
|
-
*
|
|
3638
|
-
*
|
|
3691
|
+
* Page Size
|
|
3692
|
+
* Define the number of records per page for pagination purposes.
|
|
3693
|
+
* @exclusiveMin 0
|
|
3694
|
+
* @default 100
|
|
3639
3695
|
*/
|
|
3640
|
-
|
|
3696
|
+
page_size?: number;
|
|
3697
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
|
|
3698
|
+
/**
|
|
3699
|
+
* @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
|
|
3700
|
+
* @tags Fund Metadata
|
|
3701
|
+
* @name GetFund
|
|
3702
|
+
* @summary Get Fund
|
|
3703
|
+
* @request GET:/funds/{fund_id}
|
|
3704
|
+
* @secure
|
|
3705
|
+
*/
|
|
3706
|
+
getFund(fundId: number, query?: {
|
|
3641
3707
|
/**
|
|
3642
3708
|
* Language
|
|
3643
3709
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3644
3710
|
* @default "en-US"
|
|
3645
3711
|
*/
|
|
3646
3712
|
language?: BridgeWiseLanguageEnum;
|
|
3647
|
-
|
|
3648
|
-
* Show All
|
|
3649
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3650
|
-
*/
|
|
3651
|
-
show_all?: boolean;
|
|
3652
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3713
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3653
3714
|
}
|
|
3654
3715
|
export class Holdings<HandleError extends boolean = boolean> {
|
|
3655
3716
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3657,12 +3718,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3657
3718
|
/**
|
|
3658
3719
|
* @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
|
|
3659
3720
|
* @tags Holdings
|
|
3660
|
-
* @name
|
|
3721
|
+
* @name GetCompositions
|
|
3661
3722
|
* @summary Get Compositions
|
|
3662
3723
|
* @request GET:/funds/{fund_id}/compositions
|
|
3663
3724
|
* @secure
|
|
3664
3725
|
*/
|
|
3665
|
-
|
|
3726
|
+
getCompositions(fundId: number, query?: {
|
|
3666
3727
|
/**
|
|
3667
3728
|
* Language
|
|
3668
3729
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3678,12 +3739,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3678
3739
|
/**
|
|
3679
3740
|
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
3680
3741
|
* @tags Holdings
|
|
3681
|
-
* @name
|
|
3742
|
+
* @name GetHoldingStatistics
|
|
3682
3743
|
* @summary Get Holding Statistics
|
|
3683
3744
|
* @request GET:/funds/{fund_id}/holding-statistics
|
|
3684
3745
|
* @secure
|
|
3685
3746
|
*/
|
|
3686
|
-
|
|
3747
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
3687
3748
|
/**
|
|
3688
3749
|
* Language
|
|
3689
3750
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3712,12 +3773,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3712
3773
|
/**
|
|
3713
3774
|
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
3714
3775
|
* @tags Holdings
|
|
3715
|
-
* @name
|
|
3776
|
+
* @name GetHoldings
|
|
3716
3777
|
* @summary Get Holdings
|
|
3717
3778
|
* @request GET:/funds/{fund_id}/holdings
|
|
3718
3779
|
* @secure
|
|
3719
3780
|
*/
|
|
3720
|
-
|
|
3781
|
+
getHoldings(fundId: number, query?: {
|
|
3721
3782
|
/**
|
|
3722
3783
|
* Language
|
|
3723
3784
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3744,54 +3805,75 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3744
3805
|
page_size?: number;
|
|
3745
3806
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
3746
3807
|
}
|
|
3747
|
-
export class
|
|
3808
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
3748
3809
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3749
3810
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3750
3811
|
/**
|
|
3751
|
-
* @description
|
|
3752
|
-
* @tags
|
|
3753
|
-
* @name
|
|
3754
|
-
* @summary
|
|
3755
|
-
* @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
|
|
3756
3817
|
* @secure
|
|
3757
3818
|
*/
|
|
3758
|
-
|
|
3819
|
+
fetchLogos(query?: {
|
|
3759
3820
|
/**
|
|
3760
|
-
*
|
|
3761
|
-
* 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"
|
|
3762
3825
|
*/
|
|
3763
|
-
|
|
3826
|
+
company_id__in?: string;
|
|
3764
3827
|
/**
|
|
3765
|
-
*
|
|
3766
|
-
*
|
|
3828
|
+
* Size
|
|
3829
|
+
* Page size
|
|
3830
|
+
* @min 1
|
|
3831
|
+
* @max 100
|
|
3832
|
+
* @default 50
|
|
3767
3833
|
*/
|
|
3768
|
-
|
|
3834
|
+
size?: number;
|
|
3769
3835
|
/**
|
|
3770
|
-
*
|
|
3771
|
-
*
|
|
3836
|
+
* Page
|
|
3837
|
+
* Page number
|
|
3838
|
+
* @min 1
|
|
3839
|
+
* @default 1
|
|
3772
3840
|
*/
|
|
3773
|
-
|
|
3774
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3841
|
+
page?: number;
|
|
3842
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
3775
3843
|
/**
|
|
3776
|
-
* @description
|
|
3777
|
-
* @tags
|
|
3778
|
-
* @name
|
|
3779
|
-
* @summary
|
|
3780
|
-
* @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
|
|
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>);
|
|
3856
|
+
/**
|
|
3857
|
+
* @description This endpoint provides filters
|
|
3858
|
+
* @tags Metadata
|
|
3859
|
+
* @name GetCompanyFilters
|
|
3860
|
+
* @summary Get Company Filters
|
|
3861
|
+
* @request GET:/filters
|
|
3781
3862
|
* @secure
|
|
3782
3863
|
*/
|
|
3783
|
-
|
|
3864
|
+
getCompanyFilters(query: {
|
|
3784
3865
|
/**
|
|
3785
|
-
*
|
|
3786
|
-
*
|
|
3866
|
+
* Type
|
|
3867
|
+
* Desired filter type.
|
|
3787
3868
|
*/
|
|
3788
|
-
|
|
3869
|
+
type: BridgeWiseCompanyFilterType;
|
|
3789
3870
|
/**
|
|
3790
|
-
*
|
|
3791
|
-
*
|
|
3871
|
+
* Language
|
|
3872
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3873
|
+
* @default "en-US"
|
|
3792
3874
|
*/
|
|
3793
|
-
|
|
3794
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3875
|
+
language?: BridgeWiseLanguageEnum;
|
|
3876
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
3795
3877
|
}
|
|
3796
3878
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
3797
3879
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3799,12 +3881,12 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3799
3881
|
/**
|
|
3800
3882
|
* @description Provides key financial metrics for each segment within the specified fund, such as weighted averages of P/E ratio, P/B ratio, P/S ratio, Net Debt to EBITDA, Revenue Growth Rate, and Relative Market Value. It also includes the Weighted Average Segment Strength based on Bridgewise scores.
|
|
3801
3883
|
* @tags Segmentations
|
|
3802
|
-
* @name
|
|
3884
|
+
* @name GetSegmentParameters
|
|
3803
3885
|
* @summary Get Segment Parameters
|
|
3804
3886
|
* @request GET:/funds/{fund_id}/segment-parameters
|
|
3805
3887
|
* @secure
|
|
3806
3888
|
*/
|
|
3807
|
-
|
|
3889
|
+
getSegmentParameters(fundId: number, query?: {
|
|
3808
3890
|
/**
|
|
3809
3891
|
* Language
|
|
3810
3892
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3830,12 +3912,12 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3830
3912
|
/**
|
|
3831
3913
|
* @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
|
|
3832
3914
|
* @tags Segmentations
|
|
3833
|
-
* @name
|
|
3915
|
+
* @name GetSegment
|
|
3834
3916
|
* @summary Get Segment
|
|
3835
3917
|
* @request GET:/funds/{fund_id}/segments
|
|
3836
3918
|
* @secure
|
|
3837
3919
|
*/
|
|
3838
|
-
|
|
3920
|
+
getSegment(fundId: number, query?: {
|
|
3839
3921
|
/**
|
|
3840
3922
|
* Language
|
|
3841
3923
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3849,25 +3931,45 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3849
3931
|
segment?: string;
|
|
3850
3932
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
3851
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
|
+
}
|
|
3852
3954
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
3853
3955
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3854
3956
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3855
3957
|
/**
|
|
3856
3958
|
* @tags Tenants
|
|
3857
|
-
* @name
|
|
3959
|
+
* @name FetchTenant
|
|
3858
3960
|
* @summary Fetch Tenant
|
|
3859
3961
|
* @request GET:/tenants/{tenant_id}
|
|
3860
3962
|
* @secure
|
|
3861
3963
|
*/
|
|
3862
|
-
|
|
3964
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
3863
3965
|
/**
|
|
3864
3966
|
* @tags Tenants
|
|
3865
|
-
* @name
|
|
3967
|
+
* @name GetHistoricalPolicyChanges
|
|
3866
3968
|
* @summary Get Historical Policy Changes
|
|
3867
3969
|
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
3868
3970
|
* @secure
|
|
3869
3971
|
*/
|
|
3870
|
-
|
|
3972
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
3871
3973
|
/**
|
|
3872
3974
|
* Company Ids
|
|
3873
3975
|
* Specify a list of BW identifiers for bulk queries.
|
|
@@ -3914,68 +4016,68 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
3914
4016
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
3915
4017
|
/**
|
|
3916
4018
|
* @tags Tenants
|
|
3917
|
-
* @name
|
|
4019
|
+
* @name CreateTenantInvestmentPoliciesConfig
|
|
3918
4020
|
* @summary Create Tenant Investment Policies Config
|
|
3919
4021
|
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
3920
4022
|
* @secure
|
|
3921
4023
|
*/
|
|
3922
|
-
|
|
4024
|
+
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3923
4025
|
/**
|
|
3924
4026
|
* @tags Tenants
|
|
3925
|
-
* @name
|
|
4027
|
+
* @name ListTenantInvestmentPoliciesConfigs
|
|
3926
4028
|
* @summary List Tenant Investment Policies Configs
|
|
3927
4029
|
* @request GET:/tenants/{tenant_id}/investment-policies-config
|
|
3928
4030
|
* @secure
|
|
3929
4031
|
*/
|
|
3930
|
-
|
|
4032
|
+
listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
3931
4033
|
/**
|
|
3932
4034
|
* @tags Tenants
|
|
3933
|
-
* @name
|
|
4035
|
+
* @name CreateTenantInvestmentPoliciesConfigBulk
|
|
3934
4036
|
* @summary Create Tenant Investment Policies Config Bulk
|
|
3935
4037
|
* @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
|
|
3936
4038
|
* @secure
|
|
3937
4039
|
*/
|
|
3938
|
-
|
|
4040
|
+
createTenantInvestmentPoliciesConfigBulk(tenantId: string, data: BridgeWiseInvestmentPolicyConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
3939
4041
|
/**
|
|
3940
4042
|
* @tags Tenants
|
|
3941
|
-
* @name
|
|
4043
|
+
* @name GetTenantInvestmentPoliciesConfig
|
|
3942
4044
|
* @summary Get Tenant Investment Policies Config
|
|
3943
4045
|
* @request GET:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3944
4046
|
* @secure
|
|
3945
4047
|
*/
|
|
3946
|
-
|
|
4048
|
+
getTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3947
4049
|
/**
|
|
3948
4050
|
* @tags Tenants
|
|
3949
|
-
* @name
|
|
4051
|
+
* @name PatchTenantInvestmentPoliciesConfig
|
|
3950
4052
|
* @summary Patch Tenant Investment Policies Config
|
|
3951
4053
|
* @request PATCH:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3952
4054
|
* @secure
|
|
3953
4055
|
*/
|
|
3954
|
-
|
|
4056
|
+
patchTenantInvestmentPoliciesConfig(configId: number, tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3955
4057
|
/**
|
|
3956
4058
|
* @tags Tenants
|
|
3957
|
-
* @name
|
|
4059
|
+
* @name DeleteTenantInvestmentPoliciesConfig
|
|
3958
4060
|
* @summary Delete Tenant Investment Policies Config
|
|
3959
4061
|
* @request DELETE:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3960
4062
|
* @secure
|
|
3961
4063
|
*/
|
|
3962
|
-
|
|
4064
|
+
deleteTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
3963
4065
|
/**
|
|
3964
4066
|
* @tags Tenants
|
|
3965
|
-
* @name
|
|
4067
|
+
* @name CreateCognitoClientApplication
|
|
3966
4068
|
* @summary Create Cognito Client Application
|
|
3967
4069
|
* @request POST:/tenants/{tenant_id}/machine
|
|
3968
4070
|
* @secure
|
|
3969
4071
|
*/
|
|
3970
|
-
|
|
4072
|
+
createCognitoClientApplication(tenantId: string, data: BridgeWiseCreateTenantApp, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantApp, HandleError>>;
|
|
3971
4073
|
/**
|
|
3972
4074
|
* @tags Tenants
|
|
3973
|
-
* @name
|
|
4075
|
+
* @name GetRecommendations
|
|
3974
4076
|
* @summary Get Recommendations
|
|
3975
4077
|
* @request GET:/tenants/{tenant_id}/recommendations
|
|
3976
4078
|
* @secure
|
|
3977
4079
|
*/
|
|
3978
|
-
|
|
4080
|
+
getRecommendations(tenantId: string, query: {
|
|
3979
4081
|
/**
|
|
3980
4082
|
* Company Ids
|
|
3981
4083
|
* Specify a list of BW identifiers for bulk queries.
|
|
@@ -3986,164 +4088,68 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
3986
4088
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendation[], HandleError>>;
|
|
3987
4089
|
/**
|
|
3988
4090
|
* @tags Tenants
|
|
3989
|
-
* @name
|
|
4091
|
+
* @name CreateTenantRecommendationsConfig
|
|
3990
4092
|
* @summary Create Tenant Recommendations Config
|
|
3991
4093
|
* @request POST:/tenants/{tenant_id}/recommendations-config
|
|
3992
4094
|
* @secure
|
|
3993
4095
|
*/
|
|
3994
|
-
|
|
4096
|
+
createTenantRecommendationsConfig(tenantId: string, data: BridgeWiseRecommendationConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
3995
4097
|
/**
|
|
3996
4098
|
* @tags Tenants
|
|
3997
|
-
* @name
|
|
4099
|
+
* @name CreateTenantRecommendationsConfigBulk
|
|
3998
4100
|
* @summary Create Tenant Recommendations Config Bulk
|
|
3999
4101
|
* @request POST:/tenants/{tenant_id}/recommendations-config/bulk
|
|
4000
4102
|
* @secure
|
|
4001
4103
|
*/
|
|
4002
|
-
|
|
4104
|
+
createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
|
|
4003
4105
|
/**
|
|
4004
4106
|
* @tags Tenants
|
|
4005
|
-
* @name
|
|
4107
|
+
* @name GetTenantRecommendationsConfig
|
|
4006
4108
|
* @summary Get Tenant Recommendations Config
|
|
4007
4109
|
* @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4008
4110
|
* @secure
|
|
4009
4111
|
*/
|
|
4010
|
-
|
|
4112
|
+
getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
4011
4113
|
/**
|
|
4012
4114
|
* @tags Tenants
|
|
4013
|
-
* @name
|
|
4115
|
+
* @name PatchTenantRecommendationsConfig
|
|
4014
4116
|
* @summary Patch Tenant Recommendations Config
|
|
4015
4117
|
* @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4016
4118
|
* @secure
|
|
4017
4119
|
*/
|
|
4018
|
-
|
|
4120
|
+
patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
4019
4121
|
/**
|
|
4020
4122
|
* @tags Tenants
|
|
4021
|
-
* @name
|
|
4123
|
+
* @name DeleteTenantRecommendationsConfig
|
|
4022
4124
|
* @summary Delete Tenant Recommendations Config
|
|
4023
4125
|
* @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4024
4126
|
* @secure
|
|
4025
4127
|
*/
|
|
4026
|
-
|
|
4128
|
+
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4027
4129
|
}
|
|
4028
4130
|
export class Users<HandleError extends boolean = boolean> {
|
|
4029
4131
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4030
4132
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4031
4133
|
/**
|
|
4032
4134
|
* @tags Users
|
|
4033
|
-
* @name
|
|
4135
|
+
* @name Authenticate
|
|
4034
4136
|
* @summary Authenticate
|
|
4035
4137
|
* @request POST:/users/authenticate
|
|
4036
4138
|
* @secure
|
|
4037
4139
|
*/
|
|
4038
|
-
|
|
4140
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4039
4141
|
/**
|
|
4040
4142
|
* @tags Users
|
|
4041
|
-
* @name
|
|
4143
|
+
* @name FetchClientDetails
|
|
4042
4144
|
* @summary Fetch Client Details
|
|
4043
4145
|
* @request GET:/users/machine
|
|
4044
4146
|
* @secure
|
|
4045
4147
|
*/
|
|
4046
|
-
|
|
4148
|
+
fetchClientDetails(headers: {
|
|
4047
4149
|
/** Authorization */
|
|
4048
4150
|
authorization: string;
|
|
4049
4151
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4050
4152
|
}
|
|
4051
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
4052
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4053
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4054
|
-
/**
|
|
4055
|
-
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4056
|
-
* @tags Logos
|
|
4057
|
-
* @name FetchLogosCompaniesLogosGet
|
|
4058
|
-
* @summary Fetch Logos
|
|
4059
|
-
* @request GET:/companies/logos
|
|
4060
|
-
* @secure
|
|
4061
|
-
*/
|
|
4062
|
-
fetchLogosCompaniesLogosGet(query?: {
|
|
4063
|
-
/**
|
|
4064
|
-
* Company Id In
|
|
4065
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
4066
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4067
|
-
* @example "74822,83343211"
|
|
4068
|
-
*/
|
|
4069
|
-
company_id__in?: string;
|
|
4070
|
-
/**
|
|
4071
|
-
* Size
|
|
4072
|
-
* Page size
|
|
4073
|
-
* @min 1
|
|
4074
|
-
* @max 100
|
|
4075
|
-
* @default 50
|
|
4076
|
-
*/
|
|
4077
|
-
size?: number;
|
|
4078
|
-
/**
|
|
4079
|
-
* Page
|
|
4080
|
-
* Page number
|
|
4081
|
-
* @min 1
|
|
4082
|
-
* @default 1
|
|
4083
|
-
*/
|
|
4084
|
-
page?: number;
|
|
4085
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4086
|
-
/**
|
|
4087
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4088
|
-
* @tags Logos
|
|
4089
|
-
* @name FetchLogoCompaniesCompanyIdLogosGet
|
|
4090
|
-
* @summary Fetch Logo
|
|
4091
|
-
* @request GET:/companies/{company_id}/logos
|
|
4092
|
-
* @secure
|
|
4093
|
-
*/
|
|
4094
|
-
fetchLogoCompaniesCompanyIdLogosGet(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4095
|
-
}
|
|
4096
|
-
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
4097
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4098
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4099
|
-
/**
|
|
4100
|
-
* @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.
|
|
4101
|
-
* @tags Earning Calls
|
|
4102
|
-
* @name GetCompanyEarningsCallsCompaniesCompanyIdEarningsCallGet
|
|
4103
|
-
* @summary Get Company Earnings Calls
|
|
4104
|
-
* @request GET:/companies/{company_id}/earnings-call
|
|
4105
|
-
* @secure
|
|
4106
|
-
*/
|
|
4107
|
-
getCompanyEarningsCallsCompaniesCompanyIdEarningsCallGet(companyId: number, query?: {
|
|
4108
|
-
/**
|
|
4109
|
-
* Language
|
|
4110
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4111
|
-
* @default "en-US"
|
|
4112
|
-
*/
|
|
4113
|
-
language?: BridgeWiseLanguageEnum;
|
|
4114
|
-
/**
|
|
4115
|
-
* Year
|
|
4116
|
-
* Specify the year for which the analysis is requested.
|
|
4117
|
-
*/
|
|
4118
|
-
year?: number | null;
|
|
4119
|
-
/**
|
|
4120
|
-
* Quarter
|
|
4121
|
-
* Specify the quarter for which the analysis is requested.
|
|
4122
|
-
*/
|
|
4123
|
-
quarter?: number | null;
|
|
4124
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
4125
|
-
/**
|
|
4126
|
-
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
4127
|
-
* @tags Earning Calls
|
|
4128
|
-
* @name GetEarningsCallsRecapsCompaniesCompanyIdEarningsCallYearQuarterRecapsGet
|
|
4129
|
-
* @summary Get Earnings Calls Recaps
|
|
4130
|
-
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
4131
|
-
* @secure
|
|
4132
|
-
*/
|
|
4133
|
-
getEarningsCallsRecapsCompaniesCompanyIdEarningsCallYearQuarterRecapsGet(yearQuarter: string, companyId: number, query?: {
|
|
4134
|
-
/**
|
|
4135
|
-
* Language
|
|
4136
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4137
|
-
* @default "en-US"
|
|
4138
|
-
*/
|
|
4139
|
-
language?: BridgeWiseLanguageEnum;
|
|
4140
|
-
/**
|
|
4141
|
-
* Type
|
|
4142
|
-
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
4143
|
-
*/
|
|
4144
|
-
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4145
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], 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>;
|