@orbis-systems/orbis-api-clients 0.7.3 → 0.7.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 +301 -129
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +345 -224
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +135 -114
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +46 -46
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +979 -971
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +312 -312
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +209 -209
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -604,6 +604,39 @@ export enum BridgeWiseCompositionTypeEnum {
|
|
|
604
604
|
Stocks = "stocks",
|
|
605
605
|
Others = "others"
|
|
606
606
|
}
|
|
607
|
+
/** ConsensusRatingsList */
|
|
608
|
+
export type BridgeWiseConsensusRatingsList = BridgeWiseConsensusRatingsResponse[];
|
|
609
|
+
/** ConsensusRatingsResponse */
|
|
610
|
+
export interface BridgeWiseConsensusRatingsResponse {
|
|
611
|
+
/**
|
|
612
|
+
* Language
|
|
613
|
+
* @default "en-US"
|
|
614
|
+
*/
|
|
615
|
+
language?: string;
|
|
616
|
+
/** Date */
|
|
617
|
+
date: string;
|
|
618
|
+
/**
|
|
619
|
+
* Updated At
|
|
620
|
+
* @format date-time
|
|
621
|
+
*/
|
|
622
|
+
updated_at: string;
|
|
623
|
+
/** Trading Item Id */
|
|
624
|
+
trading_item_id: number;
|
|
625
|
+
/** Security Id */
|
|
626
|
+
security_id: number;
|
|
627
|
+
/** Company Id */
|
|
628
|
+
company_id: number;
|
|
629
|
+
/** Analysts Consensus Name */
|
|
630
|
+
analysts_consensus_name: string;
|
|
631
|
+
/** Analysts Consensus Score Type */
|
|
632
|
+
analysts_consensus_score_type: string;
|
|
633
|
+
/** Analysts Consensus Rating Analyst Count */
|
|
634
|
+
analysts_consensus_rating_analyst_count: number;
|
|
635
|
+
/** Analysts Consensus Rating Score Group */
|
|
636
|
+
analysts_consensus_rating_score_group: number;
|
|
637
|
+
/** Analysts Consensus Rating Score Group Text */
|
|
638
|
+
analysts_consensus_rating_score_group_text: string;
|
|
639
|
+
}
|
|
607
640
|
/** FundHoldingsList */
|
|
608
641
|
export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
|
|
609
642
|
/** FundsCompositionItem */
|
|
@@ -702,12 +735,6 @@ export interface BridgeWiseHoldingsStatisticsItem {
|
|
|
702
735
|
/** Fund Analysis Score Group Text */
|
|
703
736
|
fund_analysis_score_group_text: string | null;
|
|
704
737
|
}
|
|
705
|
-
/** IdentifierTypeEnum */
|
|
706
|
-
export enum BridgeWiseIdentifierTypeEnum {
|
|
707
|
-
TickerExchange = "ticker_exchange",
|
|
708
|
-
Isin = "isin",
|
|
709
|
-
Custom = "custom"
|
|
710
|
-
}
|
|
711
738
|
/** ImageExtensionEnum */
|
|
712
739
|
export enum BridgeWiseImageExtensionEnum {
|
|
713
740
|
Png = "png",
|
|
@@ -1443,6 +1470,42 @@ export enum BridgeWiseAnalysisTypeEnum {
|
|
|
1443
1470
|
}
|
|
1444
1471
|
/** CompanyTechAnalysisResponse */
|
|
1445
1472
|
export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
|
|
1473
|
+
/** EsgFundsAnalysis */
|
|
1474
|
+
export interface BridgeWiseEsgFundsAnalysis {
|
|
1475
|
+
/**
|
|
1476
|
+
* Language
|
|
1477
|
+
* @default "en-US"
|
|
1478
|
+
*/
|
|
1479
|
+
language?: string;
|
|
1480
|
+
/** Updated At */
|
|
1481
|
+
updated_at: string;
|
|
1482
|
+
/** Analysis Score */
|
|
1483
|
+
analysis_score: number;
|
|
1484
|
+
/** Year */
|
|
1485
|
+
year: number;
|
|
1486
|
+
/** Month */
|
|
1487
|
+
month: number;
|
|
1488
|
+
/** Analysis Rank In Sector */
|
|
1489
|
+
analysis_rank_in_sector: number;
|
|
1490
|
+
/** Analysis Score Group Text */
|
|
1491
|
+
analysis_score_group_text: string | number;
|
|
1492
|
+
/** Analysis Score Group */
|
|
1493
|
+
analysis_score_group: string | number;
|
|
1494
|
+
/** Pct From Aum */
|
|
1495
|
+
pct_from_aum?: number | null;
|
|
1496
|
+
/** Analysis Percentile */
|
|
1497
|
+
analysis_percentile: number;
|
|
1498
|
+
/** Analysis Rank */
|
|
1499
|
+
analysis_rank: number;
|
|
1500
|
+
/** Analysis Percentile Of Sector */
|
|
1501
|
+
analysis_percentile_of_sector: number;
|
|
1502
|
+
/** Total Funds In Sector */
|
|
1503
|
+
total_funds_in_sector: number;
|
|
1504
|
+
/** Analysis Score Sector Median */
|
|
1505
|
+
analysis_score_sector_median: number;
|
|
1506
|
+
/** Analysis Score Sector Avg */
|
|
1507
|
+
analysis_score_sector_avg: number;
|
|
1508
|
+
}
|
|
1446
1509
|
/** FundamentalAnalysisResponse */
|
|
1447
1510
|
export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
|
|
1448
1511
|
/** FundamentalAnalysisResponseItem */
|
|
@@ -2662,7 +2725,7 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2662
2725
|
language?: BridgeWiseLanguageEnum;
|
|
2663
2726
|
/**
|
|
2664
2727
|
* Include
|
|
2665
|
-
* 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.
|
|
2728
|
+
* 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`, `technical_analysis`. 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.
|
|
2666
2729
|
* @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
|
|
2667
2730
|
*/
|
|
2668
2731
|
include?: string;
|
|
@@ -2689,11 +2752,196 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2689
2752
|
/**
|
|
2690
2753
|
* Identifier Type
|
|
2691
2754
|
* Define the type of the external identifier provided.
|
|
2692
|
-
* e.g., ISIN, ticker-exchange.
|
|
2755
|
+
* e.g., ISIN, ticker-exchange. The field accepts either a single value or multiple comma-separated values. <br>Example: ticker_exchange, isin, custom, tase</br>
|
|
2756
|
+
* @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
|
|
2693
2757
|
*/
|
|
2694
|
-
identifier_type:
|
|
2758
|
+
identifier_type: string;
|
|
2695
2759
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2696
2760
|
}
|
|
2761
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
2762
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2763
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2764
|
+
/**
|
|
2765
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
2766
|
+
* @tags Logos
|
|
2767
|
+
* @name FetchLogos
|
|
2768
|
+
* @summary Fetch Logos
|
|
2769
|
+
* @request GET:/companies/logos
|
|
2770
|
+
* @secure
|
|
2771
|
+
*/
|
|
2772
|
+
fetchLogos(query?: {
|
|
2773
|
+
/**
|
|
2774
|
+
* Company Id In
|
|
2775
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
2776
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2777
|
+
* @example "74822,83343211"
|
|
2778
|
+
*/
|
|
2779
|
+
company_id__in?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* Size
|
|
2782
|
+
* Page size
|
|
2783
|
+
* @min 1
|
|
2784
|
+
* @max 100
|
|
2785
|
+
* @default 50
|
|
2786
|
+
*/
|
|
2787
|
+
size?: number;
|
|
2788
|
+
/**
|
|
2789
|
+
* Page
|
|
2790
|
+
* Page number
|
|
2791
|
+
* @min 1
|
|
2792
|
+
* @default 1
|
|
2793
|
+
*/
|
|
2794
|
+
page?: number;
|
|
2795
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
2796
|
+
/**
|
|
2797
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
2798
|
+
* @tags Logos
|
|
2799
|
+
* @name FetchLogo
|
|
2800
|
+
* @summary Fetch Logo
|
|
2801
|
+
* @request GET:/companies/{company_id}/logos
|
|
2802
|
+
* @secure
|
|
2803
|
+
*/
|
|
2804
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2805
|
+
}
|
|
2806
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
2807
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2808
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2809
|
+
/**
|
|
2810
|
+
* @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.
|
|
2811
|
+
* @tags Activities
|
|
2812
|
+
* @name GetCompanyAlerts
|
|
2813
|
+
* @summary Get Company Alerts
|
|
2814
|
+
* @request GET:/companies/{company_id}/alerts
|
|
2815
|
+
* @secure
|
|
2816
|
+
*/
|
|
2817
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
2818
|
+
/**
|
|
2819
|
+
* Language
|
|
2820
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2821
|
+
* @default "en-US"
|
|
2822
|
+
*/
|
|
2823
|
+
language?: BridgeWiseLanguageEnum;
|
|
2824
|
+
/**
|
|
2825
|
+
* Alert Type
|
|
2826
|
+
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
2827
|
+
*/
|
|
2828
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
2829
|
+
/**
|
|
2830
|
+
* Sentiment
|
|
2831
|
+
* Filter alerts by their sentiment.
|
|
2832
|
+
*/
|
|
2833
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2834
|
+
/**
|
|
2835
|
+
* Importance
|
|
2836
|
+
* 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
|
|
2837
|
+
*/
|
|
2838
|
+
importance?: string | null;
|
|
2839
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
2840
|
+
/**
|
|
2841
|
+
* @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.
|
|
2842
|
+
* @tags Activities
|
|
2843
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
2844
|
+
* @summary Get Company Forecasts Key Development
|
|
2845
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
2846
|
+
* @secure
|
|
2847
|
+
*/
|
|
2848
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
2849
|
+
/**
|
|
2850
|
+
* Language
|
|
2851
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2852
|
+
* @default "en-US"
|
|
2853
|
+
*/
|
|
2854
|
+
language?: BridgeWiseLanguageEnum;
|
|
2855
|
+
/**
|
|
2856
|
+
* Importance
|
|
2857
|
+
* 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
|
|
2858
|
+
* @default "0,1"
|
|
2859
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2860
|
+
*/
|
|
2861
|
+
importance?: string;
|
|
2862
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2863
|
+
}
|
|
2864
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
2865
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2866
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2867
|
+
/**
|
|
2868
|
+
* @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
|
|
2869
|
+
* @tags Consensus Analysts
|
|
2870
|
+
* @name GetConsensusRatings
|
|
2871
|
+
* @summary Get Consensus Ratings
|
|
2872
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
2873
|
+
* @secure
|
|
2874
|
+
*/
|
|
2875
|
+
getConsensusRatings(companyId: number, query?: {
|
|
2876
|
+
/**
|
|
2877
|
+
* Trading Item Id
|
|
2878
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
2879
|
+
*/
|
|
2880
|
+
trading_item_id?: number;
|
|
2881
|
+
/**
|
|
2882
|
+
* Language
|
|
2883
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2884
|
+
* @default "en-US"
|
|
2885
|
+
*/
|
|
2886
|
+
language?: BridgeWiseLanguageEnum;
|
|
2887
|
+
/**
|
|
2888
|
+
* Date Gte
|
|
2889
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
2890
|
+
*/
|
|
2891
|
+
date__gte?: string | null;
|
|
2892
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
2893
|
+
}
|
|
2894
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2895
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2896
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2897
|
+
/**
|
|
2898
|
+
* @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.
|
|
2899
|
+
* @tags Earning Calls
|
|
2900
|
+
* @name GetCompanyEarningsCalls
|
|
2901
|
+
* @summary Get Company Earnings Calls
|
|
2902
|
+
* @request GET:/companies/{company_id}/earnings-call
|
|
2903
|
+
* @secure
|
|
2904
|
+
*/
|
|
2905
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2906
|
+
/**
|
|
2907
|
+
* Language
|
|
2908
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2909
|
+
* @default "en-US"
|
|
2910
|
+
*/
|
|
2911
|
+
language?: BridgeWiseLanguageEnum;
|
|
2912
|
+
/**
|
|
2913
|
+
* Year
|
|
2914
|
+
* Specify the year for which the analysis is requested.
|
|
2915
|
+
*/
|
|
2916
|
+
year?: number | null;
|
|
2917
|
+
/**
|
|
2918
|
+
* Quarter
|
|
2919
|
+
* Specify the quarter for which the analysis is requested.
|
|
2920
|
+
*/
|
|
2921
|
+
quarter?: number | null;
|
|
2922
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2923
|
+
/**
|
|
2924
|
+
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
2925
|
+
* @tags Earning Calls
|
|
2926
|
+
* @name GetEarningsCallsRecaps
|
|
2927
|
+
* @summary Get Earnings Calls Recaps
|
|
2928
|
+
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2929
|
+
* @secure
|
|
2930
|
+
*/
|
|
2931
|
+
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
2932
|
+
/**
|
|
2933
|
+
* Language
|
|
2934
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2935
|
+
* @default "en-US"
|
|
2936
|
+
*/
|
|
2937
|
+
language?: BridgeWiseLanguageEnum;
|
|
2938
|
+
/**
|
|
2939
|
+
* Type
|
|
2940
|
+
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
2941
|
+
*/
|
|
2942
|
+
type?: BridgeWiseEarningsCallRecapEnum;
|
|
2943
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
2944
|
+
}
|
|
2697
2945
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
2698
2946
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2699
2947
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3005,160 +3253,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3005
3253
|
date__lte?: string;
|
|
3006
3254
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3007
3255
|
}
|
|
3008
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
3009
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3010
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3011
|
-
/**
|
|
3012
|
-
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
3013
|
-
* @tags Activities
|
|
3014
|
-
* @name GetCompanyAlerts
|
|
3015
|
-
* @summary Get Company Alerts
|
|
3016
|
-
* @request GET:/companies/{company_id}/alerts
|
|
3017
|
-
* @secure
|
|
3018
|
-
*/
|
|
3019
|
-
getCompanyAlerts(companyId: number, query?: {
|
|
3020
|
-
/**
|
|
3021
|
-
* Language
|
|
3022
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3023
|
-
* @default "en-US"
|
|
3024
|
-
*/
|
|
3025
|
-
language?: BridgeWiseLanguageEnum;
|
|
3026
|
-
/**
|
|
3027
|
-
* Alert Type
|
|
3028
|
-
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
3029
|
-
*/
|
|
3030
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
3031
|
-
/**
|
|
3032
|
-
* Sentiment
|
|
3033
|
-
* Filter alerts by their sentiment.
|
|
3034
|
-
*/
|
|
3035
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
3036
|
-
/**
|
|
3037
|
-
* Importance
|
|
3038
|
-
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3039
|
-
*/
|
|
3040
|
-
importance?: string | null;
|
|
3041
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
3042
|
-
/**
|
|
3043
|
-
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
3044
|
-
* @tags Activities
|
|
3045
|
-
* @name GetCompanyForecastsKeyDevelopment
|
|
3046
|
-
* @summary Get Company Forecasts Key Development
|
|
3047
|
-
* @request GET:/companies/{company_id}/key-developments
|
|
3048
|
-
* @secure
|
|
3049
|
-
*/
|
|
3050
|
-
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
3051
|
-
/**
|
|
3052
|
-
* Language
|
|
3053
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3054
|
-
* @default "en-US"
|
|
3055
|
-
*/
|
|
3056
|
-
language?: BridgeWiseLanguageEnum;
|
|
3057
|
-
/**
|
|
3058
|
-
* Importance
|
|
3059
|
-
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3060
|
-
* @default "0,1"
|
|
3061
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3062
|
-
*/
|
|
3063
|
-
importance?: string;
|
|
3064
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
3065
|
-
}
|
|
3066
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
3067
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3068
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3069
|
-
/**
|
|
3070
|
-
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
3071
|
-
* @tags Logos
|
|
3072
|
-
* @name FetchLogos
|
|
3073
|
-
* @summary Fetch Logos
|
|
3074
|
-
* @request GET:/companies/logos
|
|
3075
|
-
* @secure
|
|
3076
|
-
*/
|
|
3077
|
-
fetchLogos(query?: {
|
|
3078
|
-
/**
|
|
3079
|
-
* Company Id In
|
|
3080
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
3081
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3082
|
-
* @example "74822,83343211"
|
|
3083
|
-
*/
|
|
3084
|
-
company_id__in?: string;
|
|
3085
|
-
/**
|
|
3086
|
-
* Size
|
|
3087
|
-
* Page size
|
|
3088
|
-
* @min 1
|
|
3089
|
-
* @max 100
|
|
3090
|
-
* @default 50
|
|
3091
|
-
*/
|
|
3092
|
-
size?: number;
|
|
3093
|
-
/**
|
|
3094
|
-
* Page
|
|
3095
|
-
* Page number
|
|
3096
|
-
* @min 1
|
|
3097
|
-
* @default 1
|
|
3098
|
-
*/
|
|
3099
|
-
page?: number;
|
|
3100
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
3101
|
-
/**
|
|
3102
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
3103
|
-
* @tags Logos
|
|
3104
|
-
* @name FetchLogo
|
|
3105
|
-
* @summary Fetch Logo
|
|
3106
|
-
* @request GET:/companies/{company_id}/logos
|
|
3107
|
-
* @secure
|
|
3108
|
-
*/
|
|
3109
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
3110
|
-
}
|
|
3111
|
-
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
3112
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3113
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3114
|
-
/**
|
|
3115
|
-
* @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
|
|
3116
|
-
* @tags Earning Calls
|
|
3117
|
-
* @name GetCompanyEarningsCalls
|
|
3118
|
-
* @summary Get Company Earnings Calls
|
|
3119
|
-
* @request GET:/companies/{company_id}/earnings-call
|
|
3120
|
-
* @secure
|
|
3121
|
-
*/
|
|
3122
|
-
getCompanyEarningsCalls(companyId: number, query?: {
|
|
3123
|
-
/**
|
|
3124
|
-
* Language
|
|
3125
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3126
|
-
* @default "en-US"
|
|
3127
|
-
*/
|
|
3128
|
-
language?: BridgeWiseLanguageEnum;
|
|
3129
|
-
/**
|
|
3130
|
-
* Year
|
|
3131
|
-
* Specify the year for which the analysis is requested.
|
|
3132
|
-
*/
|
|
3133
|
-
year?: number | null;
|
|
3134
|
-
/**
|
|
3135
|
-
* Quarter
|
|
3136
|
-
* Specify the quarter for which the analysis is requested.
|
|
3137
|
-
*/
|
|
3138
|
-
quarter?: number | null;
|
|
3139
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
3140
|
-
/**
|
|
3141
|
-
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
3142
|
-
* @tags Earning Calls
|
|
3143
|
-
* @name GetEarningsCallsRecaps
|
|
3144
|
-
* @summary Get Earnings Calls Recaps
|
|
3145
|
-
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
3146
|
-
* @secure
|
|
3147
|
-
*/
|
|
3148
|
-
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
3149
|
-
/**
|
|
3150
|
-
* Language
|
|
3151
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3152
|
-
* @default "en-US"
|
|
3153
|
-
*/
|
|
3154
|
-
language?: BridgeWiseLanguageEnum;
|
|
3155
|
-
/**
|
|
3156
|
-
* Type
|
|
3157
|
-
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
3158
|
-
*/
|
|
3159
|
-
type?: BridgeWiseEarningsCallRecapEnum;
|
|
3160
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
3161
|
-
}
|
|
3162
3256
|
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3163
3257
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3164
3258
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4001,6 +4095,31 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4001
4095
|
page_size?: number;
|
|
4002
4096
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4003
4097
|
}
|
|
4098
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
4099
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4100
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4101
|
+
/**
|
|
4102
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
4103
|
+
* @tags Fund ESG Analysis
|
|
4104
|
+
* @name GetFundEsgAnalysis
|
|
4105
|
+
* @summary Get Fund Esg Analysis
|
|
4106
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
4107
|
+
* @secure
|
|
4108
|
+
*/
|
|
4109
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
4110
|
+
/**
|
|
4111
|
+
* Limit
|
|
4112
|
+
* Number of historical periods to be returned (default is 1).
|
|
4113
|
+
*/
|
|
4114
|
+
limit?: number;
|
|
4115
|
+
/**
|
|
4116
|
+
* Language
|
|
4117
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4118
|
+
* @default "en-US"
|
|
4119
|
+
*/
|
|
4120
|
+
language?: BridgeWiseLanguageEnum;
|
|
4121
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
4122
|
+
}
|
|
4004
4123
|
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
4005
4124
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4006
4125
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4050,61 +4169,28 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
4050
4169
|
identifier__in?: string | null;
|
|
4051
4170
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
4052
4171
|
}
|
|
4053
|
-
export class
|
|
4172
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
4054
4173
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4055
4174
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4056
4175
|
/**
|
|
4057
|
-
* @
|
|
4058
|
-
* @
|
|
4059
|
-
* @
|
|
4060
|
-
* @
|
|
4061
|
-
* @request GET:/funds/{fund_id}/segment-parameters
|
|
4176
|
+
* @tags Users
|
|
4177
|
+
* @name Authenticate
|
|
4178
|
+
* @summary Authenticate
|
|
4179
|
+
* @request POST:/users/authenticate
|
|
4062
4180
|
* @secure
|
|
4063
4181
|
*/
|
|
4064
|
-
|
|
4065
|
-
/**
|
|
4066
|
-
* Language
|
|
4067
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4068
|
-
* @default "en-US"
|
|
4069
|
-
*/
|
|
4070
|
-
language?: BridgeWiseLanguageEnum;
|
|
4071
|
-
/**
|
|
4072
|
-
* Segment
|
|
4073
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4074
|
-
*/
|
|
4075
|
-
segment?: string;
|
|
4076
|
-
/**
|
|
4077
|
-
* Segment Type
|
|
4078
|
-
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
4079
|
-
*/
|
|
4080
|
-
segment_type?: string;
|
|
4081
|
-
/**
|
|
4082
|
-
* Parameter Type
|
|
4083
|
-
* Desired segment parameter type.
|
|
4084
|
-
*/
|
|
4085
|
-
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
4086
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
4182
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4087
4183
|
/**
|
|
4088
|
-
* @
|
|
4089
|
-
* @
|
|
4090
|
-
* @
|
|
4091
|
-
* @
|
|
4092
|
-
* @request GET:/funds/{fund_id}/segments
|
|
4184
|
+
* @tags Users
|
|
4185
|
+
* @name FetchClientDetails
|
|
4186
|
+
* @summary Fetch Client Details
|
|
4187
|
+
* @request GET:/users/machine
|
|
4093
4188
|
* @secure
|
|
4094
4189
|
*/
|
|
4095
|
-
|
|
4096
|
-
/**
|
|
4097
|
-
|
|
4098
|
-
|
|
4099
|
-
* @default "en-US"
|
|
4100
|
-
*/
|
|
4101
|
-
language?: BridgeWiseLanguageEnum;
|
|
4102
|
-
/**
|
|
4103
|
-
* Segment
|
|
4104
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4105
|
-
*/
|
|
4106
|
-
segment?: string;
|
|
4107
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4190
|
+
fetchClientDetails(headers: {
|
|
4191
|
+
/** Authorization */
|
|
4192
|
+
authorization: string;
|
|
4193
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4108
4194
|
}
|
|
4109
4195
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
4110
4196
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4282,28 +4368,61 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4282
4368
|
*/
|
|
4283
4369
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4284
4370
|
}
|
|
4285
|
-
export class
|
|
4371
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
4286
4372
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4287
4373
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4288
4374
|
/**
|
|
4289
|
-
* @
|
|
4290
|
-
* @
|
|
4291
|
-
* @
|
|
4292
|
-
* @
|
|
4375
|
+
* @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.
|
|
4376
|
+
* @tags Segmentations
|
|
4377
|
+
* @name GetSegmentParameters
|
|
4378
|
+
* @summary Get Segment Parameters
|
|
4379
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
4293
4380
|
* @secure
|
|
4294
4381
|
*/
|
|
4295
|
-
|
|
4382
|
+
getSegmentParameters(fundId: number, query?: {
|
|
4383
|
+
/**
|
|
4384
|
+
* Language
|
|
4385
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4386
|
+
* @default "en-US"
|
|
4387
|
+
*/
|
|
4388
|
+
language?: BridgeWiseLanguageEnum;
|
|
4389
|
+
/**
|
|
4390
|
+
* Segment
|
|
4391
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4392
|
+
*/
|
|
4393
|
+
segment?: string;
|
|
4394
|
+
/**
|
|
4395
|
+
* Segment Type
|
|
4396
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
4397
|
+
*/
|
|
4398
|
+
segment_type?: string;
|
|
4399
|
+
/**
|
|
4400
|
+
* Parameter Type
|
|
4401
|
+
* Desired segment parameter type.
|
|
4402
|
+
*/
|
|
4403
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
4404
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
4296
4405
|
/**
|
|
4297
|
-
* @
|
|
4298
|
-
* @
|
|
4299
|
-
* @
|
|
4300
|
-
* @
|
|
4406
|
+
* @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.
|
|
4407
|
+
* @tags Segmentations
|
|
4408
|
+
* @name GetSegment
|
|
4409
|
+
* @summary Get Segment
|
|
4410
|
+
* @request GET:/funds/{fund_id}/segments
|
|
4301
4411
|
* @secure
|
|
4302
4412
|
*/
|
|
4303
|
-
|
|
4304
|
-
/**
|
|
4305
|
-
|
|
4306
|
-
|
|
4413
|
+
getSegment(fundId: number, query?: {
|
|
4414
|
+
/**
|
|
4415
|
+
* Language
|
|
4416
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4417
|
+
* @default "en-US"
|
|
4418
|
+
*/
|
|
4419
|
+
language?: BridgeWiseLanguageEnum;
|
|
4420
|
+
/**
|
|
4421
|
+
* Segment
|
|
4422
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4423
|
+
*/
|
|
4424
|
+
segment?: string;
|
|
4425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4307
4426
|
}
|
|
4308
4427
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4309
4428
|
readonly config: JwtClientConfig<HandleError>;
|
|
@@ -4311,10 +4430,12 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
4311
4430
|
companyMarketData: CompanyMarketData<HandleError>;
|
|
4312
4431
|
companyMetadata: CompanyMetadata<HandleError>;
|
|
4313
4432
|
companyNews: CompanyNews<HandleError>;
|
|
4433
|
+
consensusAnalysts: ConsensusAnalysts<HandleError>;
|
|
4314
4434
|
earningCalls: EarningCalls<HandleError>;
|
|
4315
4435
|
esgAnalysis: EsgAnalysis<HandleError>;
|
|
4316
4436
|
fundamentalAnalysis: FundamentalAnalysis<HandleError>;
|
|
4317
4437
|
fundAnalysis: FundAnalysis<HandleError>;
|
|
4438
|
+
fundEsgAnalysis: FundEsgAnalysis<HandleError>;
|
|
4318
4439
|
fundMarketData: FundMarketData<HandleError>;
|
|
4319
4440
|
fundMetadata: FundMetadata<HandleError>;
|
|
4320
4441
|
holdings: Holdings<HandleError>;
|