@orbis-systems/orbis-api-clients 0.6.10 → 0.6.11

package/dist/bridgewise/index.d.ts

@@ -878,6 +878,10 @@ export interface BridgeWiseTradingItems {
     exchange_importance_level: number | null;
     /** Currency Iso3 */
     currency_iso3: string | null;
+    /** Asset Type */
+    asset_type: string | null;
+    /** Has Score */
+    has_score: boolean | null;
 }
 /** TradingItemsList */
 export type BridgeWiseTradingItemsList = BridgeWiseTradingItems[];
@@ -928,6 +932,26 @@ export enum BridgeWiseCompanyNewsSortingEnum {
     RelevancyScore = "relevancy_score",
     SocialShares = "social_shares"
 }
+/** CompanyTechnicalParagraphList */
+export type BridgeWiseCompanyTechnicalParagraphList = BridgeWiseCompanyTechnicalParagraphResponse[];
+/** CompanyTechnicalParagraphResponse */
+export interface BridgeWiseCompanyTechnicalParagraphResponse {
+    /** Analysis Type */
+    analysis_type: string;
+    /** Section Type */
+    section_type: string;
+    /** Paragraph Type */
+    paragraph_type: string;
+    /** Paragraph */
+    paragraph: string;
+    /**
+     * Language
+     * @default "en-US"
+     */
+    language?: string;
+    /** Updated At */
+    updated_at: string;
+}
 /** ESGSectionTypeEnum */
 export enum BridgeWiseESGSectionTypeEnum {
     Social = "social",
@@ -1127,6 +1151,50 @@ export interface BridgeWiseCompanyParameter {
 }
 /** CompanyParametersItemList */
 export type BridgeWiseCompanyParametersItemList = BridgeWiseCompanyParameter[];
+/** CompanyTechParameter */
+export interface BridgeWiseCompanyTechParameter {
+    /**
+     * Language
+     * @default "en-US"
+     */
+    language?: string;
+    /**
+     * Updated At
+     * @format date
+     */
+    updated_at: string;
+    /**
+     * Analysis Type
+     * @default "technical"
+     */
+    analysis_type?: string;
+    /**
+     * Analysis Type Name
+     * @default "technical"
+     */
+    analysis_type_name?: string;
+    /** Parameter Id */
+    parameter_id: number;
+    /** Parameter Name */
+    parameter_name: number | string;
+    /** Parameter Description */
+    parameter_description: number | string;
+    /** Parameter Value */
+    parameter_value: number | null;
+    /** Parameter Sentiment */
+    parameter_sentiment: string | number | null;
+    /** Parameter Currency Iso3 */
+    parameter_currency_iso3: string | null;
+    /**
+     * Parameter Type
+     * @default "unit"
+     */
+    parameter_type?: string | null;
+    /** Parameter Exchange Rate To Usd */
+    parameter_exchange_rate_to_usd: number | null;
+}
+/** CompanyTechParameterItemList */
+export type BridgeWiseCompanyTechParameterItemList = BridgeWiseCompanyTechParameter[];
 /** ESGParameterListV2 */
 export type BridgeWiseESGParameterListV2 = BridgeWiseESGParameterV2[];
 /**
@@ -1372,6 +1440,8 @@ export enum BridgeWiseAnalysisTypeEnum {
     PriceTarget = "price_target",
     Technical = "technical"
 }
+/** CompanyTechAnalysisResponse */
+export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
 /** FundamentalAnalysisResponse */
 export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
 /** FundamentalAnalysisResponseItem */
@@ -1608,13 +1678,45 @@ export interface BridgeWiseTargetPriceResponse {
     /** Currency Iso3 */
     currency_iso3: string;
 }
+/** TechAnalysisItem */
+export interface BridgeWiseTechAnalysisItem {
+    /** Language */
+    language: string;
+    /** Updated At */
+    updated_at: string | null;
+    /** Analysis Type */
+    analysis_type: string | null;
+    /** Analysis Type Name */
+    analysis_type_name: string | null;
+    /** Analysis Score */
+    analysis_score: number | null;
+    /** Analysis Score Group */
+    analysis_score_group: number | null;
+    /** Analysis Score Group Text */
+    analysis_score_group_text: number | string | null;
+    /** Analysis Score Universe Median */
+    analysis_score_universe_median: number | null;
+    /** Analysis Score Universe Avg */
+    analysis_score_universe_avg: number | null;
+    /** Analysis Rank */
+    analysis_rank: number | null;
+    /** Analysis Rank Change */
+    analysis_rank_change: number | null;
+    /** Analysis Rank Percentile */
+    analysis_rank_percentile: number | null;
+    /**
+     * Total Entities In Universe
+     * @default 1
+     */
+    total_entities_in_universe?: number | null;
+}
 /** CreateTenantApp */
 export interface BridgeWiseCreateTenantApp {
     /** Client Name */
     client_name: string;
     /**
      * Access Token Expiration
-     * @default 60
+     * @default 24
      */
     access_token_expiration?: number;
     /**
@@ -1817,6 +1919,13 @@ export interface BridgeWiseTenantResponse {
     id: string | number;
     /** Name */
     name: string;
+    /** @default "en-US" */
+    default_language?: BridgeWiseLanguageEnum | null;
+    /**
+     * Clarity Analytic
+     * @default false
+     */
+    clarity_analytic?: boolean | null;
     /** Slug */
     slug: string;
     /**
@@ -3141,14 +3250,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
          * Published Date  Gte
          * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
          * @format date
-         * @default "2025-03-20"
+         * @default "2025-04-09"
          */
         published_date__gte?: string;
         /**
          * Published Date  Lte
          * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
          * @format date
-         * @default "2025-03-20"
+         * @default "2025-04-09"
          */
         published_date__lte?: string;
         /**
@@ -3185,14 +3294,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
          * Published Date  Gte
          * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
          * @format date
-         * @default "2025-03-20"
+         * @default "2025-04-09"
          */
         published_date__gte?: string;
         /**
          * Published Date  Lte
          * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
          * @format date
-         * @default "2025-03-20"
+         * @default "2025-04-09"
          */
         published_date__lte?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
@@ -3201,7 +3310,28 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description This endpoint offers technical analysis of a company's stock price movements and trends.
+     * @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
+     * @tags Technical Analysis
+     * @name GetCompanyTechnicalAnalysis
+     * @summary Get Company Technical Analysis
+     * @request GET:/companies/{company_id}/technical-analysis
+     * @secure
+     */
+    getCompanyTechnicalAnalysis(companyId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
+    /**
+     * @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
      * @tags Technical Analysis
      * @name GetCompanyTechnicalParagraphs
      * @summary Get Company Technical Paragraphs
@@ -3215,7 +3345,38 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
          * @default "en-US"
          */
         language?: BridgeWiseLanguageEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
+    /**
+     * @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
+     * @tags Technical Analysis
+     * @name GetCompanyTechnicalParameters
+     * @summary Get Company Technical Parameters
+     * @request GET:/companies/{company_id}/technical-parameters
+     * @secure
+     */
+    getCompanyTechnicalParameters(companyId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number;
+        /**
+         * Parameter Id
+         * Get desired parameter by ID.
+         */
+        parameter_id?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
 }
 export class Metadata<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -3839,62 +4000,6 @@ export class Holdings<HandleError extends boolean = boolean> {
         page_size?: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
 }
-export class Segmentations<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @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.
-     * @tags Segmentations
-     * @name GetSegmentParameters
-     * @summary Get Segment Parameters
-     * @request GET:/funds/{fund_id}/segment-parameters
-     * @secure
-     */
-    getSegmentParameters(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Segment
-         * Filter data by specific segments within the fund holdings (e.g., sector, region).
-         */
-        segment?: string;
-        /**
-         * Segment Type
-         * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
-         */
-        segment_type?: string;
-        /**
-         * Parameter Type
-         * Desired segment parameter type.
-         */
-        parameter_type?: BridgeWiseFundsSegmentParameterEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
-    /**
-     * @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.
-     * @tags Segmentations
-     * @name GetSegment
-     * @summary Get Segment
-     * @request GET:/funds/{fund_id}/segments
-     * @secure
-     */
-    getSegment(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Segment
-         * Filter data by specific segments within the fund holdings (e.g., sector, region).
-         */
-        segment?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
-}
 export class FundMarketData<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3944,28 +4049,61 @@ export class FundMarketData<HandleError extends boolean = boolean> {
         identifier__in?: string | null;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
 }
-export class Users<HandleError extends boolean = boolean> {
+export class Segmentations<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @tags Users
-     * @name Authenticate
-     * @summary Authenticate
-     * @request POST:/users/authenticate
+     * @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.
+     * @tags Segmentations
+     * @name GetSegmentParameters
+     * @summary Get Segment Parameters
+     * @request GET:/funds/{fund_id}/segment-parameters
      * @secure
      */
-    authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
+    getSegmentParameters(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Segment
+         * Filter data by specific segments within the fund holdings (e.g., sector, region).
+         */
+        segment?: string;
+        /**
+         * Segment Type
+         * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
+         */
+        segment_type?: string;
+        /**
+         * Parameter Type
+         * Desired segment parameter type.
+         */
+        parameter_type?: BridgeWiseFundsSegmentParameterEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
     /**
-     * @tags Users
-     * @name FetchClientDetails
-     * @summary Fetch Client Details
-     * @request GET:/users/machine
+     * @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.
+     * @tags Segmentations
+     * @name GetSegment
+     * @summary Get Segment
+     * @request GET:/funds/{fund_id}/segments
      * @secure
      */
-    fetchClientDetails(headers: {
-        /** Authorization */
-        authorization: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
+    getSegment(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Segment
+         * Filter data by specific segments within the fund holdings (e.g., sector, region).
+         */
+        segment?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
 }
 export class Tenants<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -4143,6 +4281,29 @@ export class Tenants<HandleError extends boolean = boolean> {
      */
     deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
 }
+export class Users<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Users
+     * @name Authenticate
+     * @summary Authenticate
+     * @request POST:/users/authenticate
+     * @secure
+     */
+    authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
+    /**
+     * @tags Users
+     * @name FetchClientDetails
+     * @summary Fetch Client Details
+     * @request GET:/users/machine
+     * @secure
+     */
+    fetchClientDetails(headers: {
+        /** Authorization */
+        authorization: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
+}
 export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
     readonly config: JwtClientConfig<HandleError>;
     activities: Activities<HandleError>;