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

package/dist/bridgewise/index.d.ts

@@ -1942,51 +1942,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>);
@@ -2635,6 +2590,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 +2863,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>);
@@ -3087,43 +3124,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>);
@@ -3639,6 +3639,99 @@ 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>);
@@ -3752,99 +3845,6 @@ 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>);
@@ -4160,6 +4160,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>;