@orbis-systems/orbis-api-clients 0.7.5 → 0.7.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +43 -41
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +232 -213
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +243 -200
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +117 -117
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +772 -768
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +363 -351
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +13 -13
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -597,7 +597,7 @@ export interface BridgeWiseCompanyResponse {
597
597
  * Include
598
598
  * @default []
599
599
  */
600
- include?: object[];
600
+ include?: Record<string, any>[];
601
601
  }
602
602
  /** CompositionTypeEnum */
603
603
  export enum BridgeWiseCompositionTypeEnum {
@@ -639,6 +639,37 @@ export interface BridgeWiseConsensusRatingsResponse {
639
639
  }
640
640
  /** FundHoldingsList */
641
641
  export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
642
+ /** FundTradingItems */
643
+ export interface BridgeWiseFundTradingItems {
644
+ /** Fund Id */
645
+ fund_id: number | null;
646
+ /** Security Id */
647
+ security_id: number | null;
648
+ /** Security Primary Flag */
649
+ security_primary_flag: boolean | null;
650
+ /** Trading Item Id */
651
+ trading_item_id: number | null;
652
+ /** Primary Flag */
653
+ primary_flag: boolean | null;
654
+ /** Ticker Symbol */
655
+ ticker_symbol: string | null;
656
+ /** Exchange Symbol */
657
+ exchange_symbol: string | null;
658
+ /** Exchange Name */
659
+ exchange_name: string | null;
660
+ /** Exchange Id */
661
+ exchange_id: number | null;
662
+ /** Exchange Importance Level */
663
+ exchange_importance_level: number | null;
664
+ /** Currency Iso3 */
665
+ currency_iso3: string | null;
666
+ /** Asset Type */
667
+ asset_type: string | null;
668
+ /** Has Score */
669
+ has_score: boolean | null;
670
+ }
671
+ /** FundTradingItemsList */
672
+ export type BridgeWiseFundTradingItemsList = BridgeWiseFundTradingItems[];
642
673
  /** FundsCompositionItem */
643
674
  export interface BridgeWiseFundsCompositionItem {
644
675
  /** Updated At */
@@ -877,11 +908,6 @@ export interface BridgeWisePageLogo {
877
908
  /** Pages */
878
909
  pages?: number | null;
879
910
  }
880
- /** StringBooleanEnum */
881
- export enum BridgeWiseStringBooleanEnum {
882
- True = "true",
883
- False = "false"
884
- }
885
911
  /** TradingItems */
886
912
  export interface BridgeWiseTradingItems {
887
913
  /** Company Id */
@@ -1209,8 +1235,10 @@ export interface BridgeWiseCompanyTechParameter {
1209
1235
  parameter_description: number | string;
1210
1236
  /** Parameter Value */
1211
1237
  parameter_value: number | null;
1212
- /** Parameter Sentiment */
1213
- parameter_sentiment: string | number | null;
1238
+ /** Score Group */
1239
+ score_group: string | number | null;
1240
+ /** Score Group Text */
1241
+ score_group_text: string | number | null;
1214
1242
  /** Parameter Currency Iso3 */
1215
1243
  parameter_currency_iso3: string | null;
1216
1244
  /**
@@ -1332,11 +1360,6 @@ export interface BridgeWiseFundParameter {
1332
1360
  parameter_description?: number | string | null;
1333
1361
  /** Has Score */
1334
1362
  has_score: boolean;
1335
- /**
1336
- * Is Penalized
1337
- * @default false
1338
- */
1339
- is_penalized?: boolean;
1340
1363
  /** Parameter Score Group */
1341
1364
  parameter_score_group: number | null;
1342
1365
  /** Parameter Score Group Text */
@@ -1715,6 +1738,27 @@ export interface BridgeWiseSectionsResponseItem {
1715
1738
  /** Section Percentile */
1716
1739
  section_percentile?: number | null;
1717
1740
  }
1741
+ /** SectorStrengthModel */
1742
+ export interface BridgeWiseSectorStrengthModel {
1743
+ /** Sector Id */
1744
+ sector_id: number;
1745
+ /** Year */
1746
+ year: number;
1747
+ /** Quarter */
1748
+ quarter: number;
1749
+ /** Sector Score */
1750
+ sector_score: number;
1751
+ /** Sector Name */
1752
+ sector_name: number | string | null;
1753
+ /** Updated At */
1754
+ updated_at: string | null;
1755
+ /** Score Group */
1756
+ score_group: number | null;
1757
+ /** Score Group Text */
1758
+ score_group_text: number | string | null;
1759
+ }
1760
+ /** SectorStrengthRoot */
1761
+ export type BridgeWiseSectorStrengthRoot = BridgeWiseSectorStrengthModel[];
1718
1762
  /** TargetPriceList */
1719
1763
  export type BridgeWiseTargetPriceList = BridgeWiseTargetPriceResponse[];
1720
1764
  /** TargetPriceResponse */
@@ -2172,7 +2216,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2172
2216
  */
2173
2217
  getCompanies(query?: {
2174
2218
  /**
2175
- * Language
2176
2219
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2177
2220
  * @default "en-US"
2178
2221
  */
@@ -2763,7 +2806,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
2763
2806
  */
2764
2807
  getCompany(companyId: number, query?: {
2765
2808
  /**
2766
- * Language
2767
2809
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2768
2810
  * @default "en-US"
2769
2811
  */
@@ -2816,20 +2858,13 @@ export class Activities<HandleError extends boolean = boolean> {
2816
2858
  */
2817
2859
  getCompanyAlerts(companyId: number, query?: {
2818
2860
  /**
2819
- * Language
2820
2861
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2821
2862
  * @default "en-US"
2822
2863
  */
2823
2864
  language?: BridgeWiseLanguageEnum;
2824
- /**
2825
- * Alert Type
2826
- * Specify the group of the alert type that will be presented (fundamental or market).
2827
- */
2865
+ /** Specify the group of the alert type that will be presented (fundamental or market). */
2828
2866
  alert_type?: BridgeWiseCompanyAlertType;
2829
- /**
2830
- * Sentiment
2831
- * Filter alerts by their sentiment.
2832
- */
2867
+ /** Filter alerts by their sentiment. */
2833
2868
  sentiment?: BridgeWiseCompanyAlertSentiment;
2834
2869
  /**
2835
2870
  * Importance
@@ -2847,7 +2882,6 @@ export class Activities<HandleError extends boolean = boolean> {
2847
2882
  */
2848
2883
  getCompanyForecastsKeyDevelopment(companyId: number, query?: {
2849
2884
  /**
2850
- * Language
2851
2885
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2852
2886
  * @default "en-US"
2853
2887
  */
@@ -2861,36 +2895,6 @@ export class Activities<HandleError extends boolean = boolean> {
2861
2895
  importance?: string;
2862
2896
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
2863
2897
  }
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
2898
  export class EarningCalls<HandleError extends boolean = boolean> {
2895
2899
  protected readonly apiClient: JwtClient<HandleError>;
2896
2900
  constructor(apiClient: JwtClient<HandleError>);
@@ -2904,7 +2908,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
2904
2908
  */
2905
2909
  getCompanyEarningsCalls(companyId: number, query?: {
2906
2910
  /**
2907
- * Language
2908
2911
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2909
2912
  * @default "en-US"
2910
2913
  */
@@ -2930,15 +2933,11 @@ export class EarningCalls<HandleError extends boolean = boolean> {
2930
2933
  */
2931
2934
  getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
2932
2935
  /**
2933
- * Language
2934
2936
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2935
2937
  * @default "en-US"
2936
2938
  */
2937
2939
  language?: BridgeWiseLanguageEnum;
2938
- /**
2939
- * Type
2940
- * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
2941
- */
2940
+ /** Specify the type of earnings call recap to receive (e.g., highlights, lowlights). */
2942
2941
  type?: BridgeWiseEarningsCallRecapEnum;
2943
2942
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
2944
2943
  }
@@ -2955,7 +2954,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
2955
2954
  */
2956
2955
  getCompanyEsgAnalysis(companyId: number, query?: {
2957
2956
  /**
2958
- * Language
2959
2957
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2960
2958
  * @default "en-US"
2961
2959
  */
@@ -2976,15 +2974,11 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
2976
2974
  */
2977
2975
  getCompanyEsgParagraphs(companyId: number, query?: {
2978
2976
  /**
2979
- * Language
2980
2977
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2981
2978
  * @default "en-US"
2982
2979
  */
2983
2980
  language?: BridgeWiseLanguageEnum;
2984
- /**
2985
- * Section Type
2986
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
2987
- */
2981
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
2988
2982
  section_type?: BridgeWiseESGSectionTypeEnum;
2989
2983
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
2990
2984
  /**
@@ -2997,7 +2991,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
2997
2991
  */
2998
2992
  getCompanyEsgParameters(companyId: number, query?: {
2999
2993
  /**
3000
- * Language
3001
2994
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3002
2995
  * @default "en-US"
3003
2996
  */
@@ -3007,10 +3000,7 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
3007
3000
  * Get desired parameter by ID.
3008
3001
  */
3009
3002
  parameter_id?: number;
3010
- /**
3011
- * Section Type
3012
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
3013
- */
3003
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
3014
3004
  section_type?: BridgeWiseSectionTypeEnum;
3015
3005
  /**
3016
3006
  * Show All
@@ -3028,15 +3018,11 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
3028
3018
  */
3029
3019
  getCompanyEsgSections(companyId: number, query?: {
3030
3020
  /**
3031
- * Language
3032
3021
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3033
3022
  * @default "en-US"
3034
3023
  */
3035
3024
  language?: BridgeWiseLanguageEnum;
3036
- /**
3037
- * Section Type
3038
- * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
3039
- */
3025
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
3040
3026
  section_type?: BridgeWiseESGSectionTypeEnum;
3041
3027
  /**
3042
3028
  * Show All
@@ -3054,7 +3040,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
3054
3040
  */
3055
3041
  getCompanyForecastsMsa(companyId: number, query?: {
3056
3042
  /**
3057
- * Language
3058
3043
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3059
3044
  * @default "en-US"
3060
3045
  */
@@ -3074,15 +3059,11 @@ export class Forecasts<HandleError extends boolean = boolean> {
3074
3059
  */
3075
3060
  getCompanyForecasts(companyId: number, query?: {
3076
3061
  /**
3077
- * Language
3078
3062
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3079
3063
  * @default "en-US"
3080
3064
  */
3081
3065
  language?: BridgeWiseLanguageEnum;
3082
- /**
3083
- * Forecast Type
3084
- * Desired forecast type.
3085
- */
3066
+ /** Desired forecast type. */
3086
3067
  forecast_type?: BridgeWiseForecastType;
3087
3068
  /**
3088
3069
  * Page
@@ -3111,7 +3092,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3111
3092
  */
3112
3093
  getCompanyFundamentalAnalysis(companyId: number, query?: {
3113
3094
  /**
3114
- * Language
3115
3095
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3116
3096
  * @default "en-US"
3117
3097
  */
@@ -3132,15 +3112,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3132
3112
  */
3133
3113
  getCompanyFundamentalParagraphs(companyId: number, query?: {
3134
3114
  /**
3135
- * Language
3136
3115
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3137
3116
  * @default "en-US"
3138
3117
  */
3139
3118
  language?: BridgeWiseLanguageEnum;
3140
- /**
3141
- * Section Type
3142
- * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
3143
- */
3119
+ /** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
3144
3120
  section_type?: BridgeWiseFundamentalParagraphSectionTypeEnum;
3145
3121
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
3146
3122
  /**
@@ -3153,15 +3129,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3153
3129
  */
3154
3130
  getCompanyFundamentalParameters(companyId: number, query?: {
3155
3131
  /**
3156
- * Language
3157
3132
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3158
3133
  * @default "en-US"
3159
3134
  */
3160
3135
  language?: BridgeWiseLanguageEnum;
3161
- /**
3162
- * Section Type
3163
- * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
3164
- */
3136
+ /** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
3165
3137
  section_type?: BridgeWiseFundamentalSectionTypeEnum;
3166
3138
  /**
3167
3139
  * Has Score
@@ -3180,7 +3152,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3180
3152
  */
3181
3153
  quarter?: number;
3182
3154
  /**
3183
- * Period Type
3184
3155
  * Define the data period format (e.g., TTM, Quarterly, Annual).
3185
3156
  * @default "last_12_month"
3186
3157
  */
@@ -3211,15 +3182,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3211
3182
  */
3212
3183
  getCompanyFundamentalSections(companyId: number, query?: {
3213
3184
  /**
3214
- * Language
3215
3185
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3216
3186
  * @default "en-US"
3217
3187
  */
3218
3188
  language?: BridgeWiseLanguageEnum;
3219
- /**
3220
- * Section Type
3221
- * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
3222
- */
3189
+ /** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
3223
3190
  section_type?: BridgeWiseFundamentalSectionTypeEnum;
3224
3191
  /**
3225
3192
  * Show All
@@ -3253,6 +3220,35 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
3253
3220
  date__lte?: string;
3254
3221
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
3255
3222
  }
3223
+ export class ConsensusAnalysts<HandleError extends boolean = boolean> {
3224
+ protected readonly apiClient: JwtClient<HandleError>;
3225
+ constructor(apiClient: JwtClient<HandleError>);
3226
+ /**
3227
+ * @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.
3228
+ * @tags Consensus Analysts
3229
+ * @name GetConsensusRatings
3230
+ * @summary Get Consensus Ratings
3231
+ * @request GET:/companies/{company_id}/consensus-ratings
3232
+ * @secure
3233
+ */
3234
+ getConsensusRatings(companyId: number, query?: {
3235
+ /**
3236
+ * Trading Item Id
3237
+ * Specify a BW trading asset identifier for a targeted query.
3238
+ */
3239
+ trading_item_id?: number;
3240
+ /**
3241
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3242
+ * @default "en-US"
3243
+ */
3244
+ language?: BridgeWiseLanguageEnum;
3245
+ /**
3246
+ * Date Gte
3247
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3248
+ */
3249
+ date__gte?: string | null;
3250
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
3251
+ }
3256
3252
  export class CompanyMarketData<HandleError extends boolean = boolean> {
3257
3253
  protected readonly apiClient: JwtClient<HandleError>;
3258
3254
  constructor(apiClient: JwtClient<HandleError>);
@@ -3314,12 +3310,12 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
3314
3310
  * Primary Flag
3315
3311
  * Boolean flag. Indicate if only primary trading item data is required (true/false).
3316
3312
  */
3317
- primary_flag?: BridgeWiseStringBooleanEnum;
3313
+ primary_flag?: boolean;
3318
3314
  /**
3319
3315
  * Security Primary Flag
3320
3316
  * Boolean flag. Indicate if only primary asset data is required (true/false).
3321
3317
  */
3322
- security_primary_flag?: BridgeWiseStringBooleanEnum;
3318
+ security_primary_flag?: boolean;
3323
3319
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
3324
3320
  }
3325
3321
  export class CompanyNews<HandleError extends boolean = boolean> {
@@ -3345,18 +3341,17 @@ export class CompanyNews<HandleError extends boolean = boolean> {
3345
3341
  * Published Date Gte
3346
3342
  * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3347
3343
  * @format date
3348
- * @default "2025-04-09"
3344
+ * @default "2025-06-02"
3349
3345
  */
3350
3346
  published_date__gte?: string;
3351
3347
  /**
3352
3348
  * Published Date Lte
3353
3349
  * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3354
3350
  * @format date
3355
- * @default "2025-04-09"
3351
+ * @default "2025-06-02"
3356
3352
  */
3357
3353
  published_date__lte?: string;
3358
3354
  /**
3359
- * Sort By
3360
3355
  * Specify the field by which to sort the results.
3361
3356
  * @default "publication_date"
3362
3357
  */
@@ -3389,14 +3384,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
3389
3384
  * Published Date Gte
3390
3385
  * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
3391
3386
  * @format date
3392
- * @default "2025-04-09"
3387
+ * @default "2025-06-02"
3393
3388
  */
3394
3389
  published_date__gte?: string;
3395
3390
  /**
3396
3391
  * Published Date Lte
3397
3392
  * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
3398
3393
  * @format date
3399
- * @default "2025-04-09"
3394
+ * @default "2025-06-02"
3400
3395
  */
3401
3396
  published_date__lte?: string;
3402
3397
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
@@ -3414,7 +3409,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3414
3409
  */
3415
3410
  getCompanyTechnicalAnalysis(companyId: number, query?: {
3416
3411
  /**
3417
- * Language
3418
3412
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3419
3413
  * @default "en-US"
3420
3414
  */
@@ -3435,7 +3429,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3435
3429
  */
3436
3430
  getCompanyTechnicalParagraphs(companyId: number, query?: {
3437
3431
  /**
3438
- * Language
3439
3432
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3440
3433
  * @default "en-US"
3441
3434
  */
@@ -3456,7 +3449,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
3456
3449
  */
3457
3450
  getCompanyTechnicalParameters(companyId: number, query?: {
3458
3451
  /**
3459
- * Language
3460
3452
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3461
3453
  * @default "en-US"
3462
3454
  */
@@ -3485,13 +3477,9 @@ export class Metadata<HandleError extends boolean = boolean> {
3485
3477
  * @secure
3486
3478
  */
3487
3479
  getCompanyFilters(query: {
3488
- /**
3489
- * Type
3490
- * Desired filter type.
3491
- */
3480
+ /** Desired filter type. */
3492
3481
  type: BridgeWiseCompanyFilterType;
3493
3482
  /**
3494
- * Language
3495
3483
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3496
3484
  * @default "en-US"
3497
3485
  */
@@ -3526,7 +3514,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
3526
3514
  */
3527
3515
  sort_by?: string;
3528
3516
  /**
3529
- * Language
3530
3517
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3531
3518
  * @default "en-US"
3532
3519
  */
@@ -3882,7 +3869,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
3882
3869
  */
3883
3870
  getFund(fundId: number, query?: {
3884
3871
  /**
3885
- * Language
3886
3872
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3887
3873
  * @default "en-US"
3888
3874
  */
@@ -3902,7 +3888,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3902
3888
  */
3903
3889
  getFundAnalysis(fundId: number, query?: {
3904
3890
  /**
3905
- * Language
3906
3891
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3907
3892
  * @default "en-US"
3908
3893
  */
@@ -3933,7 +3918,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3933
3918
  */
3934
3919
  getFundsParagraphs(fundId: number, query?: {
3935
3920
  /**
3936
- * Language
3937
3921
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3938
3922
  * @default "en-US"
3939
3923
  */
@@ -3959,7 +3943,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3959
3943
  */
3960
3944
  getFundParameters(fundId: number, query?: {
3961
3945
  /**
3962
- * Language
3963
3946
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3964
3947
  * @default "en-US"
3965
3948
  */
@@ -3990,7 +3973,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
3990
3973
  */
3991
3974
  quarter?: number;
3992
3975
  /**
3993
- * Language
3994
3976
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3995
3977
  * @default "en-US"
3996
3978
  */
@@ -4015,15 +3997,11 @@ export class Holdings<HandleError extends boolean = boolean> {
4015
3997
  */
4016
3998
  getCompositions(fundId: number, query?: {
4017
3999
  /**
4018
- * Language
4019
4000
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4020
4001
  * @default "en-US"
4021
4002
  */
4022
4003
  language?: BridgeWiseLanguageEnum;
4023
- /**
4024
- * Composition Type
4025
- * Filter data by specific components of the fund composition (e.g., stocks, others).
4026
- */
4004
+ /** Filter data by specific components of the fund composition (e.g., stocks, others). */
4027
4005
  composition_type?: BridgeWiseCompositionTypeEnum;
4028
4006
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
4029
4007
  /**
@@ -4036,13 +4014,11 @@ export class Holdings<HandleError extends boolean = boolean> {
4036
4014
  */
4037
4015
  getHoldingStatistics(fundId: number, query?: {
4038
4016
  /**
4039
- * Language
4040
4017
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4041
4018
  * @default "en-US"
4042
4019
  */
4043
4020
  language?: BridgeWiseLanguageEnum;
4044
4021
  /**
4045
- * Composition Type
4046
4022
  * Filter data by specific components of the fund composition (e.g., stocks, others).
4047
4023
  * @default "stocks"
4048
4024
  */
@@ -4070,13 +4046,11 @@ export class Holdings<HandleError extends boolean = boolean> {
4070
4046
  */
4071
4047
  getHoldings(fundId: number, query?: {
4072
4048
  /**
4073
- * Language
4074
4049
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4075
4050
  * @default "en-US"
4076
4051
  */
4077
4052
  language?: BridgeWiseLanguageEnum;
4078
4053
  /**
4079
- * Composition Type
4080
4054
  * Filter data by specific components of the fund composition (e.g., stocks, others).
4081
4055
  * @default "stocks"
4082
4056
  */
@@ -4113,13 +4087,138 @@ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
4113
4087
  */
4114
4088
  limit?: number;
4115
4089
  /**
4116
- * Language
4117
4090
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4118
4091
  * @default "en-US"
4119
4092
  */
4120
4093
  language?: BridgeWiseLanguageEnum;
4121
4094
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
4122
4095
  }
4096
+ export class FundMarketData<HandleError extends boolean = boolean> {
4097
+ protected readonly apiClient: JwtClient<HandleError>;
4098
+ constructor(apiClient: JwtClient<HandleError>);
4099
+ /**
4100
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
4101
+ * @tags Fund Market Data
4102
+ * @name GetFundsMarketData
4103
+ * @summary Get Funds Market Data
4104
+ * @request GET:/funds/{fund_id}/market
4105
+ * @secure
4106
+ */
4107
+ getFundsMarketData(fundId: number, query?: {
4108
+ /**
4109
+ * Trading Item Id
4110
+ * Specify a BW trading asset identifier for a targeted query.
4111
+ */
4112
+ trading_item_id?: number | null;
4113
+ /**
4114
+ * Date Ge
4115
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4116
+ */
4117
+ date__ge?: string | null;
4118
+ /**
4119
+ * Date Le
4120
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4121
+ */
4122
+ date__le?: string | null;
4123
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
4124
+ /**
4125
+ * @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.
4126
+ * @tags Fund Market Data
4127
+ * @name GetFundsMarketStatistics
4128
+ * @summary Get Funds Market Statistics
4129
+ * @request GET:/funds/{fund_id}/market-statistics
4130
+ * @secure
4131
+ */
4132
+ getFundsMarketStatistics(fundId: number, query?: {
4133
+ /**
4134
+ * Trading Item Id
4135
+ * Specify a BW trading asset identifier for a targeted query.
4136
+ */
4137
+ trading_item_id?: number | null;
4138
+ /**
4139
+ * Identifier In
4140
+ * Specify a list of external identifiers.
4141
+ */
4142
+ identifier__in?: string | null;
4143
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
4144
+ /**
4145
+ * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
4146
+ * @tags Fund Market Data
4147
+ * @name GetFundTradingItems
4148
+ * @summary Get Fund Trading Items
4149
+ * @request GET:/funds/{fund_id}/trading-items
4150
+ * @secure
4151
+ */
4152
+ getFundTradingItems(fundId: number, query?: {
4153
+ /**
4154
+ * Primary Flag
4155
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
4156
+ */
4157
+ primary_flag?: boolean;
4158
+ /**
4159
+ * Security Primary Flag
4160
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
4161
+ */
4162
+ security_primary_flag?: boolean;
4163
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
4164
+ }
4165
+ export class Users<HandleError extends boolean = boolean> {
4166
+ protected readonly apiClient: JwtClient<HandleError>;
4167
+ constructor(apiClient: JwtClient<HandleError>);
4168
+ /**
4169
+ * @tags Users
4170
+ * @name Authenticate
4171
+ * @summary Authenticate
4172
+ * @request POST:/users/authenticate
4173
+ * @secure
4174
+ */
4175
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
4176
+ /**
4177
+ * @tags Users
4178
+ * @name FetchClientDetails
4179
+ * @summary Fetch Client Details
4180
+ * @request GET:/users/machine
4181
+ * @secure
4182
+ */
4183
+ fetchClientDetails(headers: {
4184
+ /** Authorization */
4185
+ authorization: string;
4186
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
4187
+ }
4188
+ export class SectorAnalysis<HandleError extends boolean = boolean> {
4189
+ protected readonly apiClient: JwtClient<HandleError>;
4190
+ constructor(apiClient: JwtClient<HandleError>);
4191
+ /**
4192
+ * @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
4193
+ * @tags Sector Analysis
4194
+ * @name GetSectorAnalysis
4195
+ * @summary Get Sector Analysis
4196
+ * @request GET:/sectors/{sector_id}/analysis
4197
+ * @secure
4198
+ */
4199
+ getSectorAnalysis(sectorId: number, query?: {
4200
+ /**
4201
+ * Year
4202
+ * Specify the year for which the analysis is requested.
4203
+ */
4204
+ year?: number;
4205
+ /**
4206
+ * Quarter
4207
+ * Specify the quarter for which the analysis is requested.
4208
+ */
4209
+ quarter?: number;
4210
+ /**
4211
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4212
+ * @default "en-US"
4213
+ */
4214
+ language?: BridgeWiseLanguageEnum;
4215
+ /**
4216
+ * Limit
4217
+ * Number of sector strength periods to be returned (default is 1).
4218
+ */
4219
+ limit?: number;
4220
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
4221
+ }
4123
4222
  export class Segmentations<HandleError extends boolean = boolean> {
4124
4223
  protected readonly apiClient: JwtClient<HandleError>;
4125
4224
  constructor(apiClient: JwtClient<HandleError>);
@@ -4133,7 +4232,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
4133
4232
  */
4134
4233
  getSegmentParameters(fundId: number, query?: {
4135
4234
  /**
4136
- * Language
4137
4235
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4138
4236
  * @default "en-US"
4139
4237
  */
@@ -4148,10 +4246,7 @@ export class Segmentations<HandleError extends boolean = boolean> {
4148
4246
  * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
4149
4247
  */
4150
4248
  segment_type?: string;
4151
- /**
4152
- * Parameter Type
4153
- * Desired segment parameter type.
4154
- */
4249
+ /** Desired segment parameter type. */
4155
4250
  parameter_type?: BridgeWiseFundsSegmentParameterEnum;
4156
4251
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
4157
4252
  /**
@@ -4164,7 +4259,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
4164
4259
  */
4165
4260
  getSegment(fundId: number, query?: {
4166
4261
  /**
4167
- * Language
4168
4262
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4169
4263
  * @default "en-US"
4170
4264
  */
@@ -4176,29 +4270,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
4176
4270
  segment?: string;
4177
4271
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
4178
4272
  }
4179
- export class Users<HandleError extends boolean = boolean> {
4180
- protected readonly apiClient: JwtClient<HandleError>;
4181
- constructor(apiClient: JwtClient<HandleError>);
4182
- /**
4183
- * @tags Users
4184
- * @name Authenticate
4185
- * @summary Authenticate
4186
- * @request POST:/users/authenticate
4187
- * @secure
4188
- */
4189
- authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
4190
- /**
4191
- * @tags Users
4192
- * @name FetchClientDetails
4193
- * @summary Fetch Client Details
4194
- * @request GET:/users/machine
4195
- * @secure
4196
- */
4197
- fetchClientDetails(headers: {
4198
- /** Authorization */
4199
- authorization: string;
4200
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
4201
- }
4202
4273
  export class Tenants<HandleError extends boolean = boolean> {
4203
4274
  protected readonly apiClient: JwtClient<HandleError>;
4204
4275
  constructor(apiClient: JwtClient<HandleError>);
@@ -4242,10 +4313,7 @@ export class Tenants<HandleError extends boolean = boolean> {
4242
4313
  * Specify the current value reflecting the policy change
4243
4314
  */
4244
4315
  current_value?: number | boolean;
4245
- /**
4246
- * Event Type
4247
- * Type of event that is being requested.
4248
- */
4316
+ /** Type of event that is being requested. */
4249
4317
  event_type?: BridgeWiseEventTypeEnum;
4250
4318
  /**
4251
4319
  * Size
@@ -4375,55 +4443,6 @@ export class Tenants<HandleError extends boolean = boolean> {
4375
4443
  */
4376
4444
  deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
4377
4445
  }
4378
- export class FundMarketData<HandleError extends boolean = boolean> {
4379
- protected readonly apiClient: JwtClient<HandleError>;
4380
- constructor(apiClient: JwtClient<HandleError>);
4381
- /**
4382
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
4383
- * @tags Fund Market Data
4384
- * @name GetFundsMarketData
4385
- * @summary Get Funds Market Data
4386
- * @request GET:/funds/{fund_id}/market
4387
- * @secure
4388
- */
4389
- getFundsMarketData(fundId: number, query?: {
4390
- /**
4391
- * Trading Item Id
4392
- * Specify a BW trading asset identifier for a targeted query.
4393
- */
4394
- trading_item_id?: number | null;
4395
- /**
4396
- * Date Ge
4397
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4398
- */
4399
- date__ge?: string | null;
4400
- /**
4401
- * Date Le
4402
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4403
- */
4404
- date__le?: string | null;
4405
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
4406
- /**
4407
- * @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.
4408
- * @tags Fund Market Data
4409
- * @name GetFundsMarketStatistics
4410
- * @summary Get Funds Market Statistics
4411
- * @request GET:/funds/{fund_id}/market-statistics
4412
- * @secure
4413
- */
4414
- getFundsMarketStatistics(fundId: number, query?: {
4415
- /**
4416
- * Trading Item Id
4417
- * Specify a BW trading asset identifier for a targeted query.
4418
- */
4419
- trading_item_id?: number | null;
4420
- /**
4421
- * Identifier In
4422
- * Specify a list of external identifiers.
4423
- */
4424
- identifier__in?: string | null;
4425
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
4426
- }
4427
4446
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4428
4447
  readonly config: JwtClientConfig<HandleError>;
4429
4448
  activities: Activities<HandleError>;