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

package/dist/bridgewise/index.d.ts

@@ -2693,6 +2693,57 @@ export class Activities<HandleError extends boolean = boolean> {
         importance?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
 }
+export class EarningCalls<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
+     * @tags Earning Calls
+     * @name GetCompanyEarningsCalls
+     * @summary Get Company Earnings Calls
+     * @request GET:/companies/{company_id}/earnings-call
+     * @secure
+     */
+    getCompanyEarningsCalls(companyId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Year
+         * Specify the year for which the analysis is requested.
+         */
+        year?: number | null;
+        /**
+         * Quarter
+         * Specify the quarter for which the analysis is requested.
+         */
+        quarter?: number | null;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
+    /**
+     * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
+     * @tags Earning Calls
+     * @name GetEarningsCallsRecaps
+     * @summary Get Earnings Calls Recaps
+     * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
+     * @secure
+     */
+    getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Type
+         * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
+         */
+        type?: BridgeWiseEarningsCallRecapEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
+}
 export class EsgAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -2812,94 +2863,6 @@ 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 EarningCalls<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
-     * @tags Earning Calls
-     * @name GetCompanyEarningsCalls
-     * @summary Get Company Earnings Calls
-     * @request GET:/companies/{company_id}/earnings-call
-     * @secure
-     */
-    getCompanyEarningsCalls(companyId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Year
-         * Specify the year for which the analysis is requested.
-         */
-        year?: number | null;
-        /**
-         * Quarter
-         * Specify the quarter for which the analysis is requested.
-         */
-        quarter?: number | null;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
-    /**
-     * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
-     * @tags Earning Calls
-     * @name GetEarningsCallsRecaps
-     * @summary Get Earnings Calls Recaps
-     * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
-     * @secure
-     */
-    getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Type
-         * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
-         */
-        type?: BridgeWiseEarningsCallRecapEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
-}
 export class FundamentalAnalysis<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3124,6 +3087,43 @@ 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,119 @@ export class FundMetadata<HandleError extends boolean = boolean> {
         language?: BridgeWiseLanguageEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
 }
+export class FundAnalysis<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Returns Bridgewise final analysis for a specified fund.
+     * @tags Fund Analysis
+     * @name GetFundAnalysis
+     * @summary Get Fund Analysis
+     * @request GET:/funds/{fund_id}/analysis
+     * @secure
+     */
+    getFundAnalysis(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Year
+         * Specify the year for which the analysis is requested.
+         */
+        year?: number;
+        /**
+         * Quarter
+         * Specify the quarter for which the analysis is requested.
+         */
+        quarter?: number;
+        /**
+         * Show All
+         * Boolean flag. Indicate whether to return historical data (`true/false`).
+         */
+        show_all?: boolean;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
+    /**
+     * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
+     * @tags Fund Analysis
+     * @name GetFundsParagraphs
+     * @summary Get Funds Paragraphs
+     * @request GET:/funds/{fund_id}/paragraphs
+     * @secure
+     */
+    getFundsParagraphs(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Year
+         * Specify the year for which the analysis is requested.
+         */
+        year?: number | null;
+        /**
+         * Quarter
+         * Specify the quarter for which the analysis is requested.
+         */
+        quarter?: number | null;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
+    /**
+     * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
+     * @tags Fund Analysis
+     * @name GetFundParameters
+     * @summary Get Fund Parameters
+     * @request GET:/funds/{fund_id}/parameters
+     * @secure
+     */
+    getFundParameters(fundId: number, query?: {
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Parameter Id
+         * ID of the parameter for analysis.
+         */
+        parameter_id?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
+    /**
+     * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
+     * @tags Fund Analysis
+     * @name GetFundSections
+     * @summary Get Fund Sections
+     * @request GET:/funds/{fund_id}/sections
+     * @secure
+     */
+    getFundSections(fundId: number, query?: {
+        /**
+         * Year
+         * Specify the year for which the analysis is requested.
+         */
+        year?: number;
+        /**
+         * Quarter
+         * Specify the quarter for which the analysis is requested.
+         */
+        quarter?: number;
+        /**
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
+         */
+        language?: BridgeWiseLanguageEnum;
+        /**
+         * Show All
+         * Boolean flag. Indicate whether to return historical data (`true/false`).
+         */
+        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>);
@@ -4013,119 +4126,6 @@ export class Tenants<HandleError extends boolean = boolean> {
      */
     deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
 }
-export class FundAnalysis<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Returns Bridgewise final analysis for a specified fund.
-     * @tags Fund Analysis
-     * @name GetFundAnalysis
-     * @summary Get Fund Analysis
-     * @request GET:/funds/{fund_id}/analysis
-     * @secure
-     */
-    getFundAnalysis(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Year
-         * Specify the year for which the analysis is requested.
-         */
-        year?: number;
-        /**
-         * Quarter
-         * Specify the quarter for which the analysis is requested.
-         */
-        quarter?: number;
-        /**
-         * Show All
-         * Boolean flag. Indicate whether to return historical data (`true/false`).
-         */
-        show_all?: boolean;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
-    /**
-     * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
-     * @tags Fund Analysis
-     * @name GetFundsParagraphs
-     * @summary Get Funds Paragraphs
-     * @request GET:/funds/{fund_id}/paragraphs
-     * @secure
-     */
-    getFundsParagraphs(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Year
-         * Specify the year for which the analysis is requested.
-         */
-        year?: number | null;
-        /**
-         * Quarter
-         * Specify the quarter for which the analysis is requested.
-         */
-        quarter?: number | null;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
-    /**
-     * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
-     * @tags Fund Analysis
-     * @name GetFundParameters
-     * @summary Get Fund Parameters
-     * @request GET:/funds/{fund_id}/parameters
-     * @secure
-     */
-    getFundParameters(fundId: number, query?: {
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Parameter Id
-         * ID of the parameter for analysis.
-         */
-        parameter_id?: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
-    /**
-     * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
-     * @tags Fund Analysis
-     * @name GetFundSections
-     * @summary Get Fund Sections
-     * @request GET:/funds/{fund_id}/sections
-     * @secure
-     */
-    getFundSections(fundId: number, query?: {
-        /**
-         * Year
-         * Specify the year for which the analysis is requested.
-         */
-        year?: number;
-        /**
-         * Quarter
-         * Specify the quarter for which the analysis is requested.
-         */
-        quarter?: number;
-        /**
-         * Language
-         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
-         * @default "en-US"
-         */
-        language?: BridgeWiseLanguageEnum;
-        /**
-         * Show All
-         * Boolean flag. Indicate whether to return historical data (`true/false`).
-         */
-        show_all?: boolean;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
-}
 export class Users<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);