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

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;
 }
@@ -1082,9 +1081,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"
@@ -1251,6 +1250,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",
@@ -1408,12 +1413,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 */
@@ -1942,51 +1941,6 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
     Gt = "gt",
     Lt = "lt"
 }
-export class Logos<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
-     * @tags Logos
-     * @name FetchLogos
-     * @summary Fetch Logos
-     * @request GET:/companies/logos
-     * @secure
-     */
-    fetchLogos(query?: {
-        /**
-         * Company Id  In
-         * Specify a list of BW identifiers for bulk queries.
-         * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
-         * @example "74822,83343211"
-         */
-        company_id__in?: string;
-        /**
-         * Size
-         * Page size
-         * @min 1
-         * @max 100
-         * @default 50
-         */
-        size?: number;
-        /**
-         * Page
-         * Page number
-         * @min 1
-         * @default 1
-         */
-        page?: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
-    /**
-     * @description Retrieves the logo for a specified company using the provided company_id.
-     * @tags Logos
-     * @name FetchLogo
-     * @summary Fetch Logo
-     * @request GET:/companies/{company_id}/logos
-     * @secure
-     */
-    fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
-}
 export class CompanyMetadata<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -2247,16 +2201,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.
@@ -2612,6 +2556,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.
@@ -2635,6 +2584,51 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
         identifier_type: BridgeWiseIdentifierTypeEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
 }
+export class Logos<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
+     * @tags Logos
+     * @name FetchLogos
+     * @summary Fetch Logos
+     * @request GET:/companies/logos
+     * @secure
+     */
+    fetchLogos(query?: {
+        /**
+         * Company Id  In
+         * Specify a list of BW identifiers for bulk queries.
+         * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
+         * @example "74822,83343211"
+         */
+        company_id__in?: string;
+        /**
+         * Size
+         * Page size
+         * @min 1
+         * @max 100
+         * @default 50
+         */
+        size?: number;
+        /**
+         * Page
+         * Page number
+         * @min 1
+         * @default 1
+         */
+        page?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
+    /**
+     * @description Retrieves the logo for a specified company using the provided company_id.
+     * @tags Logos
+     * @name FetchLogo
+     * @summary Fetch Logo
+     * @request GET:/companies/{company_id}/logos
+     * @secure
+     */
+    fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
+}
 export class Activities<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -2863,6 +2857,43 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
         language?: BridgeWiseLanguageEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
 }
+export class Forecasts<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description <b>!!!WILL BE DEPRECATED!!!</b>
+     * @tags Forecasts
+     * @name GetCompanyForecasts
+     * @summary Get Company Forecasts
+     * @request GET:/companies/{company_id}/forecasts
+     * @secure
+     */
+    getCompanyForecasts(companyId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Forecast Type
+         * Desired forecast type.
+         */
+        forecast_type?: BridgeWiseForecastType;
+        /**
+         * 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<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
+}
 export class FundamentalAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -2927,7 +2958,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).
@@ -2947,7 +2978,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;
         /**
@@ -3087,43 +3118,6 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
         security_primary_flag?: BridgeWiseStringBooleanEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
 }
-export class Forecasts<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description <b>!!!WILL BE DEPRECATED!!!</b>
-     * @tags Forecasts
-     * @name GetCompanyForecasts
-     * @summary Get Company Forecasts
-     * @request GET:/companies/{company_id}/forecasts
-     * @secure
-     */
-    getCompanyForecasts(companyId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Forecast Type
-         * Desired forecast type.
-         */
-        forecast_type?: BridgeWiseForecastType;
-        /**
-         * 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<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
-}
 export class CompanyNews<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3845,6 +3839,62 @@ 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>);
@@ -3894,61 +3944,28 @@ export class FundMarketData<HandleError extends boolean = boolean> {
         identifier__in?: string | null;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
 }
-export class Segmentations<HandleError extends boolean = boolean> {
+export class Users<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
+     * @tags Users
+     * @name Authenticate
+     * @summary Authenticate
+     * @request POST:/users/authenticate
      * @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>>;
+    authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, 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
+     * @tags Users
+     * @name FetchClientDetails
+     * @summary Fetch Client Details
+     * @request GET:/users/machine
      * @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>>;
+    fetchClientDetails(headers: {
+        /** Authorization */
+        authorization: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
 }
 export class Tenants<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -4126,29 +4143,6 @@ 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>;
@@ -4160,6 +4154,7 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
     fundamentalAnalysis: FundamentalAnalysis<HandleError>;
     fundAnalysis: FundAnalysis<HandleError>;
     fundMarketData: FundMarketData<HandleError>;
+    fundMetadata: FundMetadata<HandleError>;
     holdings: Holdings<HandleError>;
     logos: Logos<HandleError>;
     metadata: Metadata<HandleError>;