@orbis-systems/orbis-api-clients 0.7.15 → 0.7.16

package/dist/bridgewise/index.d.ts

@@ -4093,51 +4093,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
         identifier_type: string;
     }, 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>);
@@ -4368,38 +4323,50 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
         language?: BridgeWiseLanguageEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
 }
-export class Forecasts<HandleError extends boolean = boolean> {
+export class Logos<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
+     * @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
      */
-    getCompanyForecasts(companyId: number, query?: {
+    fetchLogos(query?: {
         /**
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
+         * Company Id  In
+         * Specify a list of BW identifiers for bulk queries.
+         * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
+         * @example "74822,83343211"
          */
-        language?: BridgeWiseLanguageEnum;
-        /** Desired forecast type. */
-        forecast_type?: BridgeWiseForecastType;
+        company_id__in?: string;
         /**
-         * Page
-         * Define the page number for pagination.
-         * @exclusiveMin 0
+         * Size
+         * Page size
+         * @min 1
+         * @max 100
+         * @default 50
          */
-        page?: number;
+        size?: number;
         /**
-         * Page Size
-         * Define the number of records per page for pagination purposes.
-         * @exclusiveMin 0
+         * Page
+         * Page number
+         * @min 1
+         * @default 1
          */
-        page_size?: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
+        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 FundamentalAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -4567,6 +4534,39 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
         section_type?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], 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?: {
+        /**
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /** 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 CompanyMarketData<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5819,6 +5819,57 @@ export class Users<HandleError extends boolean = boolean> {
         authorization: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, 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?: {
+        /**
+         * 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;
+        /** 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?: {
+        /**
+         * 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 Bridget<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5886,57 +5937,6 @@ export class Bridget<HandleError extends boolean = boolean> {
         user_id?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, 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?: {
-        /**
-         * 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;
-        /** 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?: {
-        /**
-         * 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>);