@orbis-systems/orbis-api-clients 0.6.2 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bridgewise/index.d.ts +304 -304
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +271 -271
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +270 -270
- package/dist/bridgewise/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1948,12 +1948,12 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
1948
1948
|
/**
|
|
1949
1949
|
* @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
1950
|
* @tags Company Metadata
|
|
1951
|
-
* @name
|
|
1951
|
+
* @name GetCompanies
|
|
1952
1952
|
* @summary Get Companies
|
|
1953
1953
|
* @request GET:/companies
|
|
1954
1954
|
* @secure
|
|
1955
1955
|
*/
|
|
1956
|
-
|
|
1956
|
+
getCompanies(query?: {
|
|
1957
1957
|
/**
|
|
1958
1958
|
* Language
|
|
1959
1959
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2549,12 +2549,12 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2549
2549
|
/**
|
|
2550
2550
|
* @description Retrieves the metadata object of a specific company identified by the company_id. It provides detailed information about the company's characteristics.
|
|
2551
2551
|
* @tags Company Metadata
|
|
2552
|
-
* @name
|
|
2552
|
+
* @name GetCompany
|
|
2553
2553
|
* @summary Get Company
|
|
2554
2554
|
* @request GET:/companies/{company_id}
|
|
2555
2555
|
* @secure
|
|
2556
2556
|
*/
|
|
2557
|
-
|
|
2557
|
+
getCompany(companyId: number, query?: {
|
|
2558
2558
|
/**
|
|
2559
2559
|
* Language
|
|
2560
2560
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2565,12 +2565,12 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2565
2565
|
/**
|
|
2566
2566
|
* @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
2567
|
* @tags Company Metadata, Fund Metadata
|
|
2568
|
-
* @name
|
|
2568
|
+
* @name GetIdentifierSearch
|
|
2569
2569
|
* @summary Get Identifier Search
|
|
2570
2570
|
* @request GET:/identifier-search
|
|
2571
2571
|
* @secure
|
|
2572
2572
|
*/
|
|
2573
|
-
|
|
2573
|
+
getIdentifierSearch(query: {
|
|
2574
2574
|
/**
|
|
2575
2575
|
* Identifier
|
|
2576
2576
|
* Specify an external identifier such as ISIN or ticker-exchange for asset identification.
|
|
@@ -2584,183 +2584,50 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2584
2584
|
identifier_type: BridgeWiseIdentifierTypeEnum;
|
|
2585
2585
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2586
2586
|
}
|
|
2587
|
-
export class
|
|
2588
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2589
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2590
|
-
/**
|
|
2591
|
-
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
2592
|
-
* @tags ESG Analysis
|
|
2593
|
-
* @name GetCompanyEsgAnalysisCompaniesCompanyIdEsgAnalysisGet
|
|
2594
|
-
* @summary Get Company Esg Analysis
|
|
2595
|
-
* @request GET:/companies/{company_id}/esg-analysis
|
|
2596
|
-
* @secure
|
|
2597
|
-
*/
|
|
2598
|
-
getCompanyEsgAnalysisCompaniesCompanyIdEsgAnalysisGet(companyId: number, query?: {
|
|
2599
|
-
/**
|
|
2600
|
-
* Language
|
|
2601
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2602
|
-
* @default "en-US"
|
|
2603
|
-
*/
|
|
2604
|
-
language?: BridgeWiseLanguageEnum;
|
|
2605
|
-
/**
|
|
2606
|
-
* Show All
|
|
2607
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2608
|
-
*/
|
|
2609
|
-
show_all?: boolean;
|
|
2610
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
2611
|
-
/**
|
|
2612
|
-
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
2613
|
-
* @tags ESG Analysis
|
|
2614
|
-
* @name GetCompanyEsgParagraphsCompaniesCompanyIdEsgParagraphsGet
|
|
2615
|
-
* @summary Get Company Esg Paragraphs
|
|
2616
|
-
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
2617
|
-
* @secure
|
|
2618
|
-
*/
|
|
2619
|
-
getCompanyEsgParagraphsCompaniesCompanyIdEsgParagraphsGet(companyId: number, query?: {
|
|
2620
|
-
/**
|
|
2621
|
-
* Language
|
|
2622
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2623
|
-
* @default "en-US"
|
|
2624
|
-
*/
|
|
2625
|
-
language?: BridgeWiseLanguageEnum;
|
|
2626
|
-
/**
|
|
2627
|
-
* Section Type
|
|
2628
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2629
|
-
*/
|
|
2630
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
2631
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
2632
|
-
/**
|
|
2633
|
-
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
2634
|
-
* @tags ESG Analysis
|
|
2635
|
-
* @name GetCompanyEsgParametersCompaniesCompanyIdEsgParametersGet
|
|
2636
|
-
* @summary Get Company Esg Parameters
|
|
2637
|
-
* @request GET:/companies/{company_id}/esg-parameters
|
|
2638
|
-
* @secure
|
|
2639
|
-
*/
|
|
2640
|
-
getCompanyEsgParametersCompaniesCompanyIdEsgParametersGet(companyId: number, query?: {
|
|
2641
|
-
/**
|
|
2642
|
-
* Language
|
|
2643
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2644
|
-
* @default "en-US"
|
|
2645
|
-
*/
|
|
2646
|
-
language?: BridgeWiseLanguageEnum;
|
|
2647
|
-
/**
|
|
2648
|
-
* Parameter Id
|
|
2649
|
-
* Get desired parameter by ID.
|
|
2650
|
-
*/
|
|
2651
|
-
parameter_id?: number;
|
|
2652
|
-
/**
|
|
2653
|
-
* Section Type
|
|
2654
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2655
|
-
*/
|
|
2656
|
-
section_type?: BridgeWiseSectionTypeEnum;
|
|
2657
|
-
/**
|
|
2658
|
-
* Show All
|
|
2659
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2660
|
-
*/
|
|
2661
|
-
show_all?: boolean;
|
|
2662
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
2663
|
-
/**
|
|
2664
|
-
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
2665
|
-
* @tags ESG Analysis
|
|
2666
|
-
* @name GetCompanyEsgSectionsCompaniesCompanyIdEsgSectionsGet
|
|
2667
|
-
* @summary Get Company Esg Sections
|
|
2668
|
-
* @request GET:/companies/{company_id}/esg-sections
|
|
2669
|
-
* @secure
|
|
2670
|
-
*/
|
|
2671
|
-
getCompanyEsgSectionsCompaniesCompanyIdEsgSectionsGet(companyId: number, query?: {
|
|
2672
|
-
/**
|
|
2673
|
-
* Language
|
|
2674
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2675
|
-
* @default "en-US"
|
|
2676
|
-
*/
|
|
2677
|
-
language?: BridgeWiseLanguageEnum;
|
|
2678
|
-
/**
|
|
2679
|
-
* Section Type
|
|
2680
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2681
|
-
*/
|
|
2682
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
2683
|
-
/**
|
|
2684
|
-
* Show All
|
|
2685
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
2686
|
-
*/
|
|
2687
|
-
show_all?: boolean;
|
|
2688
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
2689
|
-
/**
|
|
2690
|
-
* @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
|
-
* @tags ESG Analysis
|
|
2692
|
-
* @name GetCompanyForecastsMsaCompaniesCompanyIdSustainabilityIncidentsGet
|
|
2693
|
-
* @summary Get Company Forecasts Msa
|
|
2694
|
-
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
2695
|
-
* @secure
|
|
2696
|
-
*/
|
|
2697
|
-
getCompanyForecastsMsaCompaniesCompanyIdSustainabilityIncidentsGet(companyId: number, query?: {
|
|
2698
|
-
/**
|
|
2699
|
-
* Language
|
|
2700
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2701
|
-
* @default "en-US"
|
|
2702
|
-
*/
|
|
2703
|
-
language?: BridgeWiseLanguageEnum;
|
|
2704
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
2705
|
-
}
|
|
2706
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
2587
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
2707
2588
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2708
2589
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2709
2590
|
/**
|
|
2710
|
-
* @description
|
|
2711
|
-
* @tags
|
|
2712
|
-
* @name
|
|
2713
|
-
* @summary
|
|
2714
|
-
* @request GET:/companies/
|
|
2591
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
2592
|
+
* @tags Logos
|
|
2593
|
+
* @name FetchLogos
|
|
2594
|
+
* @summary Fetch Logos
|
|
2595
|
+
* @request GET:/companies/logos
|
|
2715
2596
|
* @secure
|
|
2716
2597
|
*/
|
|
2717
|
-
|
|
2598
|
+
fetchLogos(query?: {
|
|
2718
2599
|
/**
|
|
2719
|
-
*
|
|
2720
|
-
*
|
|
2721
|
-
* @
|
|
2722
|
-
|
|
2723
|
-
language?: BridgeWiseLanguageEnum;
|
|
2724
|
-
/**
|
|
2725
|
-
* Alert Type
|
|
2726
|
-
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
2600
|
+
* Company Id In
|
|
2601
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
2602
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2603
|
+
* @example "74822,83343211"
|
|
2727
2604
|
*/
|
|
2728
|
-
|
|
2605
|
+
company_id__in?: string;
|
|
2729
2606
|
/**
|
|
2730
|
-
*
|
|
2731
|
-
*
|
|
2607
|
+
* Size
|
|
2608
|
+
* Page size
|
|
2609
|
+
* @min 1
|
|
2610
|
+
* @max 100
|
|
2611
|
+
* @default 50
|
|
2732
2612
|
*/
|
|
2733
|
-
|
|
2613
|
+
size?: number;
|
|
2734
2614
|
/**
|
|
2735
|
-
*
|
|
2736
|
-
*
|
|
2737
|
-
* @
|
|
2615
|
+
* Page
|
|
2616
|
+
* Page number
|
|
2617
|
+
* @min 1
|
|
2618
|
+
* @default 1
|
|
2738
2619
|
*/
|
|
2739
|
-
|
|
2740
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2620
|
+
page?: number;
|
|
2621
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
2741
2622
|
/**
|
|
2742
|
-
* @description
|
|
2743
|
-
* @tags
|
|
2744
|
-
* @name
|
|
2745
|
-
* @summary
|
|
2746
|
-
* @request GET:/companies/{company_id}/
|
|
2623
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
2624
|
+
* @tags Logos
|
|
2625
|
+
* @name FetchLogo
|
|
2626
|
+
* @summary Fetch Logo
|
|
2627
|
+
* @request GET:/companies/{company_id}/logos
|
|
2747
2628
|
* @secure
|
|
2748
2629
|
*/
|
|
2749
|
-
|
|
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>>;
|
|
2630
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2764
2631
|
}
|
|
2765
2632
|
export class Forecasts<HandleError extends boolean = boolean> {
|
|
2766
2633
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2768,12 +2635,12 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
2768
2635
|
/**
|
|
2769
2636
|
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
2770
2637
|
* @tags Forecasts
|
|
2771
|
-
* @name
|
|
2638
|
+
* @name GetCompanyForecasts
|
|
2772
2639
|
* @summary Get Company Forecasts
|
|
2773
2640
|
* @request GET:/companies/{company_id}/forecasts
|
|
2774
2641
|
* @secure
|
|
2775
2642
|
*/
|
|
2776
|
-
|
|
2643
|
+
getCompanyForecasts(companyId: number, query?: {
|
|
2777
2644
|
/**
|
|
2778
2645
|
* Language
|
|
2779
2646
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2805,12 +2672,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2805
2672
|
/**
|
|
2806
2673
|
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
2807
2674
|
* @tags Fundamental Analysis
|
|
2808
|
-
* @name
|
|
2675
|
+
* @name GetCompanyFundamentalAnalysis
|
|
2809
2676
|
* @summary Get Company Fundamental Analysis
|
|
2810
2677
|
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
2811
2678
|
* @secure
|
|
2812
2679
|
*/
|
|
2813
|
-
|
|
2680
|
+
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
2814
2681
|
/**
|
|
2815
2682
|
* Language
|
|
2816
2683
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2826,12 +2693,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2826
2693
|
/**
|
|
2827
2694
|
* @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
2695
|
* @tags Fundamental Analysis
|
|
2829
|
-
* @name
|
|
2696
|
+
* @name GetCompanyFundamentalParagraphs
|
|
2830
2697
|
* @summary Get Company Fundamental Paragraphs
|
|
2831
2698
|
* @request GET:/companies/{company_id}/fundamental-paragraphs
|
|
2832
2699
|
* @secure
|
|
2833
2700
|
*/
|
|
2834
|
-
|
|
2701
|
+
getCompanyFundamentalParagraphs(companyId: number, query?: {
|
|
2835
2702
|
/**
|
|
2836
2703
|
* Language
|
|
2837
2704
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2847,12 +2714,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2847
2714
|
/**
|
|
2848
2715
|
* @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
2716
|
* @tags Fundamental Analysis
|
|
2850
|
-
* @name
|
|
2717
|
+
* @name GetCompanyFundamentalParameters
|
|
2851
2718
|
* @summary Get Company Fundamental Parameters
|
|
2852
2719
|
* @request GET:/companies/{company_id}/fundamental-parameters
|
|
2853
2720
|
* @secure
|
|
2854
2721
|
*/
|
|
2855
|
-
|
|
2722
|
+
getCompanyFundamentalParameters(companyId: number, query?: {
|
|
2856
2723
|
/**
|
|
2857
2724
|
* Language
|
|
2858
2725
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2905,12 +2772,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2905
2772
|
/**
|
|
2906
2773
|
* @description Provides scores for individual sections of the company's fundamental analysis, including the balance sheet, income statement, and cash flow performance.
|
|
2907
2774
|
* @tags Fundamental Analysis
|
|
2908
|
-
* @name
|
|
2775
|
+
* @name GetCompanyFundamentalSections
|
|
2909
2776
|
* @summary Get Company Fundamental Sections
|
|
2910
2777
|
* @request GET:/companies/{company_id}/fundamental-sections
|
|
2911
2778
|
* @secure
|
|
2912
2779
|
*/
|
|
2913
|
-
|
|
2780
|
+
getCompanyFundamentalSections(companyId: number, query?: {
|
|
2914
2781
|
/**
|
|
2915
2782
|
* Language
|
|
2916
2783
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2931,12 +2798,12 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
2931
2798
|
/**
|
|
2932
2799
|
* @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
2800
|
* @tags Fundamental Analysis
|
|
2934
|
-
* @name
|
|
2801
|
+
* @name GetTargetPrice
|
|
2935
2802
|
* @summary Get Target Price
|
|
2936
2803
|
* @request GET:/companies/{company_id}/target-price
|
|
2937
2804
|
* @secure
|
|
2938
2805
|
*/
|
|
2939
|
-
|
|
2806
|
+
getTargetPrice(companyId: number, query?: {
|
|
2940
2807
|
/**
|
|
2941
2808
|
* Trading Item Id
|
|
2942
2809
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -2960,12 +2827,12 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
|
2960
2827
|
/**
|
|
2961
2828
|
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
2962
2829
|
* @tags Company Market Data
|
|
2963
|
-
* @name
|
|
2830
|
+
* @name GetCompanyMarketData
|
|
2964
2831
|
* @summary Get Company Market Data
|
|
2965
2832
|
* @request GET:/companies/{company_id}/market
|
|
2966
2833
|
* @secure
|
|
2967
2834
|
*/
|
|
2968
|
-
|
|
2835
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
2969
2836
|
/**
|
|
2970
2837
|
* Trading Item Id
|
|
2971
2838
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -2985,12 +2852,12 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
|
2985
2852
|
/**
|
|
2986
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.
|
|
2987
2854
|
* @tags Company Market Data
|
|
2988
|
-
* @name
|
|
2855
|
+
* @name GetCompanyMarketStatistics
|
|
2989
2856
|
* @summary Get Company Market Statistics
|
|
2990
2857
|
* @request GET:/companies/{company_id}/market-statistics
|
|
2991
2858
|
* @secure
|
|
2992
2859
|
*/
|
|
2993
|
-
|
|
2860
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
2994
2861
|
/**
|
|
2995
2862
|
* Trading Item Id
|
|
2996
2863
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3005,12 +2872,12 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
|
3005
2872
|
/**
|
|
3006
2873
|
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3007
2874
|
* @tags Company Market Data
|
|
3008
|
-
* @name
|
|
2875
|
+
* @name GetTradingItems
|
|
3009
2876
|
* @summary Get Trading Items
|
|
3010
2877
|
* @request GET:/companies/{company_id}/trading-items
|
|
3011
2878
|
* @secure
|
|
3012
2879
|
*/
|
|
3013
|
-
|
|
2880
|
+
getTradingItems(companyId: number, query?: {
|
|
3014
2881
|
/**
|
|
3015
2882
|
* Primary Flag
|
|
3016
2883
|
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
@@ -3029,12 +2896,12 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3029
2896
|
/**
|
|
3030
2897
|
* @description This endpoint provides news articles related to the specified company.
|
|
3031
2898
|
* @tags Company News
|
|
3032
|
-
* @name
|
|
2899
|
+
* @name GetCompanyNews
|
|
3033
2900
|
* @summary Get Company News
|
|
3034
2901
|
* @request GET:/companies/{company_id}/news
|
|
3035
2902
|
* @secure
|
|
3036
2903
|
*/
|
|
3037
|
-
|
|
2904
|
+
getCompanyNews(companyId: number, query?: {
|
|
3038
2905
|
/**
|
|
3039
2906
|
* Languages
|
|
3040
2907
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3080,12 +2947,12 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3080
2947
|
/**
|
|
3081
2948
|
* @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.
|
|
3082
2949
|
* @tags Company News
|
|
3083
|
-
* @name
|
|
2950
|
+
* @name GetAverageCompanyNewsSentiment
|
|
3084
2951
|
* @summary Get Average Company News Sentiment
|
|
3085
2952
|
* @request GET:/companies/{company_id}/news-sentiment
|
|
3086
2953
|
* @secure
|
|
3087
2954
|
*/
|
|
3088
|
-
|
|
2955
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
3089
2956
|
/**
|
|
3090
2957
|
* Published Date Gte
|
|
3091
2958
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
@@ -3108,12 +2975,12 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3108
2975
|
/**
|
|
3109
2976
|
* @description This endpoint offers technical analysis of a company's stock price movements and trends.
|
|
3110
2977
|
* @tags Technical Analysis
|
|
3111
|
-
* @name
|
|
2978
|
+
* @name GetCompanyTechnicalParagraphs
|
|
3112
2979
|
* @summary Get Company Technical Paragraphs
|
|
3113
2980
|
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
3114
2981
|
* @secure
|
|
3115
2982
|
*/
|
|
3116
|
-
|
|
2983
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3117
2984
|
/**
|
|
3118
2985
|
* Language
|
|
3119
2986
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3128,12 +2995,12 @@ export class Metadata<HandleError extends boolean = boolean> {
|
|
|
3128
2995
|
/**
|
|
3129
2996
|
* @description This endpoint provides filters
|
|
3130
2997
|
* @tags Metadata
|
|
3131
|
-
* @name
|
|
2998
|
+
* @name GetCompanyFilters
|
|
3132
2999
|
* @summary Get Company Filters
|
|
3133
3000
|
* @request GET:/filters
|
|
3134
3001
|
* @secure
|
|
3135
3002
|
*/
|
|
3136
|
-
|
|
3003
|
+
getCompanyFilters(query: {
|
|
3137
3004
|
/**
|
|
3138
3005
|
* Type
|
|
3139
3006
|
* Desired filter type.
|
|
@@ -3153,12 +3020,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3153
3020
|
/**
|
|
3154
3021
|
* @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
3022
|
* @tags Fund Metadata
|
|
3156
|
-
* @name
|
|
3023
|
+
* @name GetFunds
|
|
3157
3024
|
* @summary Get Funds
|
|
3158
3025
|
* @request GET:/funds
|
|
3159
3026
|
* @secure
|
|
3160
3027
|
*/
|
|
3161
|
-
|
|
3028
|
+
getFunds(query?: {
|
|
3162
3029
|
/**
|
|
3163
3030
|
* Search
|
|
3164
3031
|
* Funds search.
|
|
@@ -3524,12 +3391,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3524
3391
|
/**
|
|
3525
3392
|
* @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
|
|
3526
3393
|
* @tags Fund Metadata
|
|
3527
|
-
* @name
|
|
3394
|
+
* @name GetFund
|
|
3528
3395
|
* @summary Get Fund
|
|
3529
3396
|
* @request GET:/funds/{fund_id}
|
|
3530
3397
|
* @secure
|
|
3531
3398
|
*/
|
|
3532
|
-
|
|
3399
|
+
getFund(fundId: number, query?: {
|
|
3533
3400
|
/**
|
|
3534
3401
|
* Language
|
|
3535
3402
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3544,12 +3411,12 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3544
3411
|
/**
|
|
3545
3412
|
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3546
3413
|
* @tags Fund Analysis
|
|
3547
|
-
* @name
|
|
3414
|
+
* @name GetFundAnalysis
|
|
3548
3415
|
* @summary Get Fund Analysis
|
|
3549
3416
|
* @request GET:/funds/{fund_id}/analysis
|
|
3550
3417
|
* @secure
|
|
3551
3418
|
*/
|
|
3552
|
-
|
|
3419
|
+
getFundAnalysis(fundId: number, query?: {
|
|
3553
3420
|
/**
|
|
3554
3421
|
* Language
|
|
3555
3422
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3575,12 +3442,12 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3575
3442
|
/**
|
|
3576
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.
|
|
3577
3444
|
* @tags Fund Analysis
|
|
3578
|
-
* @name
|
|
3445
|
+
* @name GetFundsParagraphs
|
|
3579
3446
|
* @summary Get Funds Paragraphs
|
|
3580
3447
|
* @request GET:/funds/{fund_id}/paragraphs
|
|
3581
3448
|
* @secure
|
|
3582
3449
|
*/
|
|
3583
|
-
|
|
3450
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
3584
3451
|
/**
|
|
3585
3452
|
* Language
|
|
3586
3453
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3601,12 +3468,12 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3601
3468
|
/**
|
|
3602
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.
|
|
3603
3470
|
* @tags Fund Analysis
|
|
3604
|
-
* @name
|
|
3471
|
+
* @name GetFundParameters
|
|
3605
3472
|
* @summary Get Fund Parameters
|
|
3606
3473
|
* @request GET:/funds/{fund_id}/parameters
|
|
3607
3474
|
* @secure
|
|
3608
3475
|
*/
|
|
3609
|
-
|
|
3476
|
+
getFundParameters(fundId: number, query?: {
|
|
3610
3477
|
/**
|
|
3611
3478
|
* Language
|
|
3612
3479
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3622,12 +3489,12 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3622
3489
|
/**
|
|
3623
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.
|
|
3624
3491
|
* @tags Fund Analysis
|
|
3625
|
-
* @name
|
|
3492
|
+
* @name GetFundSections
|
|
3626
3493
|
* @summary Get Fund Sections
|
|
3627
3494
|
* @request GET:/funds/{fund_id}/sections
|
|
3628
3495
|
* @secure
|
|
3629
3496
|
*/
|
|
3630
|
-
|
|
3497
|
+
getFundSections(fundId: number, query?: {
|
|
3631
3498
|
/**
|
|
3632
3499
|
* Year
|
|
3633
3500
|
* Specify the year for which the analysis is requested.
|
|
@@ -3657,12 +3524,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3657
3524
|
/**
|
|
3658
3525
|
* @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
3526
|
* @tags Holdings
|
|
3660
|
-
* @name
|
|
3527
|
+
* @name GetCompositions
|
|
3661
3528
|
* @summary Get Compositions
|
|
3662
3529
|
* @request GET:/funds/{fund_id}/compositions
|
|
3663
3530
|
* @secure
|
|
3664
3531
|
*/
|
|
3665
|
-
|
|
3532
|
+
getCompositions(fundId: number, query?: {
|
|
3666
3533
|
/**
|
|
3667
3534
|
* Language
|
|
3668
3535
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3678,12 +3545,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3678
3545
|
/**
|
|
3679
3546
|
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
3680
3547
|
* @tags Holdings
|
|
3681
|
-
* @name
|
|
3548
|
+
* @name GetHoldingStatistics
|
|
3682
3549
|
* @summary Get Holding Statistics
|
|
3683
3550
|
* @request GET:/funds/{fund_id}/holding-statistics
|
|
3684
3551
|
* @secure
|
|
3685
3552
|
*/
|
|
3686
|
-
|
|
3553
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
3687
3554
|
/**
|
|
3688
3555
|
* Language
|
|
3689
3556
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3712,12 +3579,12 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3712
3579
|
/**
|
|
3713
3580
|
* @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
3581
|
* @tags Holdings
|
|
3715
|
-
* @name
|
|
3582
|
+
* @name GetHoldings
|
|
3716
3583
|
* @summary Get Holdings
|
|
3717
3584
|
* @request GET:/funds/{fund_id}/holdings
|
|
3718
3585
|
* @secure
|
|
3719
3586
|
*/
|
|
3720
|
-
|
|
3587
|
+
getHoldings(fundId: number, query?: {
|
|
3721
3588
|
/**
|
|
3722
3589
|
* Language
|
|
3723
3590
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3750,12 +3617,12 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
3750
3617
|
/**
|
|
3751
3618
|
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
3752
3619
|
* @tags Fund Market Data
|
|
3753
|
-
* @name
|
|
3620
|
+
* @name GetFundsMarketData
|
|
3754
3621
|
* @summary Get Funds Market Data
|
|
3755
3622
|
* @request GET:/funds/{fund_id}/market
|
|
3756
3623
|
* @secure
|
|
3757
3624
|
*/
|
|
3758
|
-
|
|
3625
|
+
getFundsMarketData(fundId: number, query?: {
|
|
3759
3626
|
/**
|
|
3760
3627
|
* Trading Item Id
|
|
3761
3628
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3775,12 +3642,12 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
3775
3642
|
/**
|
|
3776
3643
|
* @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.
|
|
3777
3644
|
* @tags Fund Market Data
|
|
3778
|
-
* @name
|
|
3645
|
+
* @name GetFundsMarketStatistics
|
|
3779
3646
|
* @summary Get Funds Market Statistics
|
|
3780
3647
|
* @request GET:/funds/{fund_id}/market-statistics
|
|
3781
3648
|
* @secure
|
|
3782
3649
|
*/
|
|
3783
|
-
|
|
3650
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
3784
3651
|
/**
|
|
3785
3652
|
* Trading Item Id
|
|
3786
3653
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3799,12 +3666,12 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3799
3666
|
/**
|
|
3800
3667
|
* @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
3668
|
* @tags Segmentations
|
|
3802
|
-
* @name
|
|
3669
|
+
* @name GetSegmentParameters
|
|
3803
3670
|
* @summary Get Segment Parameters
|
|
3804
3671
|
* @request GET:/funds/{fund_id}/segment-parameters
|
|
3805
3672
|
* @secure
|
|
3806
3673
|
*/
|
|
3807
|
-
|
|
3674
|
+
getSegmentParameters(fundId: number, query?: {
|
|
3808
3675
|
/**
|
|
3809
3676
|
* Language
|
|
3810
3677
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3830,12 +3697,12 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3830
3697
|
/**
|
|
3831
3698
|
* @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
3699
|
* @tags Segmentations
|
|
3833
|
-
* @name
|
|
3700
|
+
* @name GetSegment
|
|
3834
3701
|
* @summary Get Segment
|
|
3835
3702
|
* @request GET:/funds/{fund_id}/segments
|
|
3836
3703
|
* @secure
|
|
3837
3704
|
*/
|
|
3838
|
-
|
|
3705
|
+
getSegment(fundId: number, query?: {
|
|
3839
3706
|
/**
|
|
3840
3707
|
* Language
|
|
3841
3708
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3854,20 +3721,20 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
3854
3721
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3855
3722
|
/**
|
|
3856
3723
|
* @tags Tenants
|
|
3857
|
-
* @name
|
|
3724
|
+
* @name FetchTenant
|
|
3858
3725
|
* @summary Fetch Tenant
|
|
3859
3726
|
* @request GET:/tenants/{tenant_id}
|
|
3860
3727
|
* @secure
|
|
3861
3728
|
*/
|
|
3862
|
-
|
|
3729
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
3863
3730
|
/**
|
|
3864
3731
|
* @tags Tenants
|
|
3865
|
-
* @name
|
|
3732
|
+
* @name GetHistoricalPolicyChanges
|
|
3866
3733
|
* @summary Get Historical Policy Changes
|
|
3867
3734
|
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
3868
3735
|
* @secure
|
|
3869
3736
|
*/
|
|
3870
|
-
|
|
3737
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
3871
3738
|
/**
|
|
3872
3739
|
* Company Ids
|
|
3873
3740
|
* Specify a list of BW identifiers for bulk queries.
|
|
@@ -3914,68 +3781,68 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
3914
3781
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
3915
3782
|
/**
|
|
3916
3783
|
* @tags Tenants
|
|
3917
|
-
* @name
|
|
3784
|
+
* @name CreateTenantInvestmentPoliciesConfig
|
|
3918
3785
|
* @summary Create Tenant Investment Policies Config
|
|
3919
3786
|
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
3920
3787
|
* @secure
|
|
3921
3788
|
*/
|
|
3922
|
-
|
|
3789
|
+
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3923
3790
|
/**
|
|
3924
3791
|
* @tags Tenants
|
|
3925
|
-
* @name
|
|
3792
|
+
* @name ListTenantInvestmentPoliciesConfigs
|
|
3926
3793
|
* @summary List Tenant Investment Policies Configs
|
|
3927
3794
|
* @request GET:/tenants/{tenant_id}/investment-policies-config
|
|
3928
3795
|
* @secure
|
|
3929
3796
|
*/
|
|
3930
|
-
|
|
3797
|
+
listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
3931
3798
|
/**
|
|
3932
3799
|
* @tags Tenants
|
|
3933
|
-
* @name
|
|
3800
|
+
* @name CreateTenantInvestmentPoliciesConfigBulk
|
|
3934
3801
|
* @summary Create Tenant Investment Policies Config Bulk
|
|
3935
3802
|
* @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
|
|
3936
3803
|
* @secure
|
|
3937
3804
|
*/
|
|
3938
|
-
|
|
3805
|
+
createTenantInvestmentPoliciesConfigBulk(tenantId: string, data: BridgeWiseInvestmentPolicyConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
3939
3806
|
/**
|
|
3940
3807
|
* @tags Tenants
|
|
3941
|
-
* @name
|
|
3808
|
+
* @name GetTenantInvestmentPoliciesConfig
|
|
3942
3809
|
* @summary Get Tenant Investment Policies Config
|
|
3943
3810
|
* @request GET:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3944
3811
|
* @secure
|
|
3945
3812
|
*/
|
|
3946
|
-
|
|
3813
|
+
getTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3947
3814
|
/**
|
|
3948
3815
|
* @tags Tenants
|
|
3949
|
-
* @name
|
|
3816
|
+
* @name PatchTenantInvestmentPoliciesConfig
|
|
3950
3817
|
* @summary Patch Tenant Investment Policies Config
|
|
3951
3818
|
* @request PATCH:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3952
3819
|
* @secure
|
|
3953
3820
|
*/
|
|
3954
|
-
|
|
3821
|
+
patchTenantInvestmentPoliciesConfig(configId: number, tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
3955
3822
|
/**
|
|
3956
3823
|
* @tags Tenants
|
|
3957
|
-
* @name
|
|
3824
|
+
* @name DeleteTenantInvestmentPoliciesConfig
|
|
3958
3825
|
* @summary Delete Tenant Investment Policies Config
|
|
3959
3826
|
* @request DELETE:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
3960
3827
|
* @secure
|
|
3961
3828
|
*/
|
|
3962
|
-
|
|
3829
|
+
deleteTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
3963
3830
|
/**
|
|
3964
3831
|
* @tags Tenants
|
|
3965
|
-
* @name
|
|
3832
|
+
* @name CreateCognitoClientApplication
|
|
3966
3833
|
* @summary Create Cognito Client Application
|
|
3967
3834
|
* @request POST:/tenants/{tenant_id}/machine
|
|
3968
3835
|
* @secure
|
|
3969
3836
|
*/
|
|
3970
|
-
|
|
3837
|
+
createCognitoClientApplication(tenantId: string, data: BridgeWiseCreateTenantApp, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantApp, HandleError>>;
|
|
3971
3838
|
/**
|
|
3972
3839
|
* @tags Tenants
|
|
3973
|
-
* @name
|
|
3840
|
+
* @name GetRecommendations
|
|
3974
3841
|
* @summary Get Recommendations
|
|
3975
3842
|
* @request GET:/tenants/{tenant_id}/recommendations
|
|
3976
3843
|
* @secure
|
|
3977
3844
|
*/
|
|
3978
|
-
|
|
3845
|
+
getRecommendations(tenantId: string, query: {
|
|
3979
3846
|
/**
|
|
3980
3847
|
* Company Ids
|
|
3981
3848
|
* Specify a list of BW identifiers for bulk queries.
|
|
@@ -3986,125 +3853,80 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
3986
3853
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendation[], HandleError>>;
|
|
3987
3854
|
/**
|
|
3988
3855
|
* @tags Tenants
|
|
3989
|
-
* @name
|
|
3856
|
+
* @name CreateTenantRecommendationsConfig
|
|
3990
3857
|
* @summary Create Tenant Recommendations Config
|
|
3991
3858
|
* @request POST:/tenants/{tenant_id}/recommendations-config
|
|
3992
3859
|
* @secure
|
|
3993
3860
|
*/
|
|
3994
|
-
|
|
3861
|
+
createTenantRecommendationsConfig(tenantId: string, data: BridgeWiseRecommendationConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
3995
3862
|
/**
|
|
3996
3863
|
* @tags Tenants
|
|
3997
|
-
* @name
|
|
3864
|
+
* @name CreateTenantRecommendationsConfigBulk
|
|
3998
3865
|
* @summary Create Tenant Recommendations Config Bulk
|
|
3999
3866
|
* @request POST:/tenants/{tenant_id}/recommendations-config/bulk
|
|
4000
3867
|
* @secure
|
|
4001
3868
|
*/
|
|
4002
|
-
|
|
3869
|
+
createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
|
|
4003
3870
|
/**
|
|
4004
3871
|
* @tags Tenants
|
|
4005
|
-
* @name
|
|
3872
|
+
* @name GetTenantRecommendationsConfig
|
|
4006
3873
|
* @summary Get Tenant Recommendations Config
|
|
4007
3874
|
* @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4008
3875
|
* @secure
|
|
4009
3876
|
*/
|
|
4010
|
-
|
|
3877
|
+
getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
4011
3878
|
/**
|
|
4012
3879
|
* @tags Tenants
|
|
4013
|
-
* @name
|
|
3880
|
+
* @name PatchTenantRecommendationsConfig
|
|
4014
3881
|
* @summary Patch Tenant Recommendations Config
|
|
4015
3882
|
* @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4016
3883
|
* @secure
|
|
4017
3884
|
*/
|
|
4018
|
-
|
|
3885
|
+
patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
4019
3886
|
/**
|
|
4020
3887
|
* @tags Tenants
|
|
4021
|
-
* @name
|
|
3888
|
+
* @name DeleteTenantRecommendationsConfig
|
|
4022
3889
|
* @summary Delete Tenant Recommendations Config
|
|
4023
3890
|
* @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
4024
3891
|
* @secure
|
|
4025
3892
|
*/
|
|
4026
|
-
|
|
3893
|
+
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4027
3894
|
}
|
|
4028
3895
|
export class Users<HandleError extends boolean = boolean> {
|
|
4029
3896
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4030
3897
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4031
3898
|
/**
|
|
4032
3899
|
* @tags Users
|
|
4033
|
-
* @name
|
|
3900
|
+
* @name Authenticate
|
|
4034
3901
|
* @summary Authenticate
|
|
4035
3902
|
* @request POST:/users/authenticate
|
|
4036
3903
|
* @secure
|
|
4037
3904
|
*/
|
|
4038
|
-
|
|
3905
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4039
3906
|
/**
|
|
4040
3907
|
* @tags Users
|
|
4041
|
-
* @name
|
|
3908
|
+
* @name FetchClientDetails
|
|
4042
3909
|
* @summary Fetch Client Details
|
|
4043
3910
|
* @request GET:/users/machine
|
|
4044
3911
|
* @secure
|
|
4045
3912
|
*/
|
|
4046
|
-
|
|
3913
|
+
fetchClientDetails(headers: {
|
|
4047
3914
|
/** Authorization */
|
|
4048
3915
|
authorization: string;
|
|
4049
3916
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4050
3917
|
}
|
|
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
3918
|
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
4097
3919
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4098
3920
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4099
3921
|
/**
|
|
4100
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.
|
|
4101
3923
|
* @tags Earning Calls
|
|
4102
|
-
* @name
|
|
3924
|
+
* @name GetCompanyEarningsCalls
|
|
4103
3925
|
* @summary Get Company Earnings Calls
|
|
4104
3926
|
* @request GET:/companies/{company_id}/earnings-call
|
|
4105
3927
|
* @secure
|
|
4106
3928
|
*/
|
|
4107
|
-
|
|
3929
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
4108
3930
|
/**
|
|
4109
3931
|
* Language
|
|
4110
3932
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -4125,12 +3947,12 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4125
3947
|
/**
|
|
4126
3948
|
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
4127
3949
|
* @tags Earning Calls
|
|
4128
|
-
* @name
|
|
3950
|
+
* @name GetEarningsCallsRecaps
|
|
4129
3951
|
* @summary Get Earnings Calls Recaps
|
|
4130
3952
|
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
4131
3953
|
* @secure
|
|
4132
3954
|
*/
|
|
4133
|
-
|
|
3955
|
+
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
4134
3956
|
/**
|
|
4135
3957
|
* Language
|
|
4136
3958
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -4144,6 +3966,184 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4144
3966
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4145
3967
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
4146
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
4147
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4148
4148
|
readonly config: JwtClientConfig<HandleError>;
|
|
4149
4149
|
activities: Activities<HandleError>;
|