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

package/dist/bridgewise/index.d.ts

@@ -4,10 +4,9 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
     baseUrl: string;
     handleError?: HandleError;
     storage?: Storage;
-    defaultHeaders?: Record<string, string>;
     defaultSecure?: boolean;
     authDataStorageKey?: string;
-    withCredentials?: boolean;
+    axiosConfig?: AxiosRequestConfig;
     onAxiosError?: (error: AxiosError) => void;
     onError?: (error: unknown) => void;
 }
@@ -879,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[];
@@ -929,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",
@@ -1082,9 +1105,9 @@ export interface BridgeWiseCompanyParameter {
      */
     updated_at: string;
     /** Calendar Year */
-    calendar_year: number;
+    calendar_year: number | string;
     /** Calendar Quarter */
-    calendar_quarter: number;
+    calendar_quarter: number | string;
     /**
      * Analysis Type
      * @default "fundamental"
@@ -1128,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[];
 /**
@@ -1251,6 +1318,12 @@ export interface BridgeWiseFundParameter {
 export type BridgeWiseFundParametersItemList = BridgeWiseFundParameter[];
 /** FundSegmentsList */
 export type BridgeWiseFundSegmentsList = BridgeWiseSegmentItem[];
+/** FundamentalSectionTypeEnum */
+export enum BridgeWiseFundamentalSectionTypeEnum {
+    BalanceSheet = "balance_sheet",
+    IncomeStatement = "income_statement",
+    CashFlow = "cash_flow"
+}
 /** FundsSegmentParameterEnum */
 export enum BridgeWiseFundsSegmentParameterEnum {
     PeRatio = "pe_ratio",
@@ -1367,6 +1440,8 @@ export enum BridgeWiseAnalysisTypeEnum {
     PriceTarget = "price_target",
     Technical = "technical"
 }
+/** CompanyTechAnalysisResponse */
+export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
 /** FundamentalAnalysisResponse */
 export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
 /** FundamentalAnalysisResponseItem */
@@ -1408,12 +1483,6 @@ export interface BridgeWiseFundamentalAnalysisResponseItem {
     /** Change Since Filling */
     change_since_filling: number | null;
 }
-/** FundamentalSectionTypeEnum */
-export enum BridgeWiseFundamentalSectionTypeEnum {
-    BalanceSheet = "balance_sheet",
-    IncomeStatement = "income_statement",
-    CashFlow = "cash_flow"
-}
 /** FundamentalSectionsResponse */
 export type BridgeWiseFundamentalSectionsResponse = BridgeWiseFundamentalSectionsResponseItem[];
 /** FundamentalSectionsResponseItem */
@@ -1609,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;
     /**
@@ -1818,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;
     /**
@@ -2202,16 +2310,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
          * Net debt/EBITDA less than or equal to.
          */
         net_debt_divided_by_ebitda__lte?: number;
-        /**
-         * Net Debt To Equity  Gte
-         * Net debt to equity greater than or equal to.
-         */
-        net_debt_to_equity__gte?: number;
-        /**
-         * Net Debt To Equity  Lte
-         * Net debt to equity less than or equal to.
-         */
-        net_debt_to_equity__lte?: number;
         /**
          * Net Income Margin Percent  Gte
          * Net income margin percent greater than or equal to.
@@ -2567,6 +2665,11 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
          * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
          */
         include?: string;
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyResponse[], HandleError>>;
     /**
      * @description Converts external identifiers (e.g., ISIN, ticker-exchange) into Bridgewise internal identifiers. This endpoint facilitates the mapping between external and internal identifiers for seamless integration within the Bridgewise ecosystem.
@@ -2964,7 +3067,7 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
          * Section Type
          * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
          */
-        section_type?: BridgeWiseSectionTypeEnum;
+        section_type?: BridgeWiseFundamentalSectionTypeEnum;
         /**
          * Has Score
          * Boolean flag. Filter out companies without BW scores (not valid for analysis).
@@ -2984,7 +3087,7 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
         /**
          * Period Type
          * Define the data period format (e.g., TTM, Quarterly, Annual).
-         * @default "quarterly"
+         * @default "last_12_month"
          */
         period_type?: BridgeWisePeriodTypeEnum;
         /**
@@ -3147,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;
         /**
@@ -3191,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>>;
@@ -3207,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
@@ -3221,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>;
@@ -3639,99 +3794,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
         language?: BridgeWiseLanguageEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
 }
-export class Holdings<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
-     * @tags Holdings
-     * @name GetCompositions
-     * @summary Get Compositions
-     * @request GET:/funds/{fund_id}/compositions
-     * @secure
-     */
-    getCompositions(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Composition Type
-         * Filter data by specific components of the fund composition (e.g., stocks, others).
-         */
-        composition_type?: BridgeWiseCompositionTypeEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
-    /**
-     * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
-     * @tags Holdings
-     * @name GetHoldingStatistics
-     * @summary Get Holding Statistics
-     * @request GET:/funds/{fund_id}/holding-statistics
-     * @secure
-     */
-    getHoldingStatistics(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Composition Type
-         * Filter data by specific components of the fund composition (e.g., stocks, others).
-         * @default "stocks"
-         */
-        composition_type?: BridgeWiseCompositionTypeEnum;
-        /**
-         * Page
-         * Define the page number for pagination.
-         * @exclusiveMin 0
-         */
-        page?: number;
-        /**
-         * Page Size
-         * Define the number of records per page for pagination purposes.
-         * @exclusiveMin 0
-         */
-        page_size?: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
-    /**
-     * @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
-     * @tags Holdings
-     * @name GetHoldings
-     * @summary Get Holdings
-     * @request GET:/funds/{fund_id}/holdings
-     * @secure
-     */
-    getHoldings(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Composition Type
-         * Filter data by specific components of the fund composition (e.g., stocks, others).
-         * @default "stocks"
-         */
-        composition_type?: BridgeWiseCompositionTypeEnum;
-        /**
-         * Page
-         * Define the page number for pagination.
-         * @exclusiveMin 0
-         */
-        page?: number;
-        /**
-         * Page Size
-         * Define the number of records per page for pagination purposes.
-         * @exclusiveMin 0
-         */
-        page_size?: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
-}
 export class FundAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3845,6 +3907,99 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
         show_all?: boolean;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
 }
+export class Holdings<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
+     * @tags Holdings
+     * @name GetCompositions
+     * @summary Get Compositions
+     * @request GET:/funds/{fund_id}/compositions
+     * @secure
+     */
+    getCompositions(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Composition Type
+         * Filter data by specific components of the fund composition (e.g., stocks, others).
+         */
+        composition_type?: BridgeWiseCompositionTypeEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
+    /**
+     * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
+     * @tags Holdings
+     * @name GetHoldingStatistics
+     * @summary Get Holding Statistics
+     * @request GET:/funds/{fund_id}/holding-statistics
+     * @secure
+     */
+    getHoldingStatistics(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Composition Type
+         * Filter data by specific components of the fund composition (e.g., stocks, others).
+         * @default "stocks"
+         */
+        composition_type?: BridgeWiseCompositionTypeEnum;
+        /**
+         * Page
+         * Define the page number for pagination.
+         * @exclusiveMin 0
+         */
+        page?: number;
+        /**
+         * Page Size
+         * Define the number of records per page for pagination purposes.
+         * @exclusiveMin 0
+         */
+        page_size?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
+    /**
+     * @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
+     * @tags Holdings
+     * @name GetHoldings
+     * @summary Get Holdings
+     * @request GET:/funds/{fund_id}/holdings
+     * @secure
+     */
+    getHoldings(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Composition Type
+         * Filter data by specific components of the fund composition (e.g., stocks, others).
+         * @default "stocks"
+         */
+        composition_type?: BridgeWiseCompositionTypeEnum;
+        /**
+         * Page
+         * Define the page number for pagination.
+         * @exclusiveMin 0
+         */
+        page?: number;
+        /**
+         * Page Size
+         * Define the number of records per page for pagination purposes.
+         * @exclusiveMin 0
+         */
+        page_size?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
+}
 export class FundMarketData<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);