@orbis-systems/orbis-api-clients 0.6.9 → 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 */
@@ -2202,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.
@@ -2567,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.
@@ -2964,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).
@@ -2984,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;
         /**
@@ -3639,99 +3633,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,54 +3746,98 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
         show_all?: boolean;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
 }
-export class FundMarketData<HandleError extends boolean = boolean> {
+export class Holdings<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
-     * @tags Fund Market Data
-     * @name GetFundsMarketData
-     * @summary Get Funds Market Data
-     * @request GET:/funds/{fund_id}/market
+     * @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
      */
-    getFundsMarketData(fundId: number, query?: {
+    getCompositions(fundId: number, query?: {
         /**
-         * Trading Item Id
-         * Specify a BW trading asset identifier for a targeted query.
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
          */
-        trading_item_id?: number | null;
+        language?: BridgeWiseLanguageEnum;
         /**
-         * Date  Ge
-         * Specify the minimum date for data retrieval in YYYY-MM-DD format.
+         * Composition Type
+         * Filter data by specific components of the fund composition (e.g., stocks, others).
          */
-        date__ge?: string | null;
+        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?: {
         /**
-         * Date  Le
-         * Specify the maximum date for data retrieval in YYYY-MM-DD format.
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
          */
-        date__le?: string | null;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
+        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 detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
-     * @tags Fund Market Data
-     * @name GetFundsMarketStatistics
-     * @summary Get Funds Market Statistics
-     * @request GET:/funds/{fund_id}/market-statistics
+     * @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
      */
-    getFundsMarketStatistics(fundId: number, query?: {
+    getHoldings(fundId: number, query?: {
         /**
-         * Trading Item Id
-         * Specify a BW trading asset identifier for a targeted query.
+         * Language
+         * Define the language code (e.g., `'en-US'` for English) for the textual data output.
+         * @default "en-US"
          */
-        trading_item_id?: number | null;
+        language?: BridgeWiseLanguageEnum;
         /**
-         * Identifier  In
-         * Specify a list of external identifiers.
+         * Composition Type
+         * Filter data by specific components of the fund composition (e.g., stocks, others).
+         * @default "stocks"
          */
-        identifier__in?: string | null;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
+        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 Segmentations<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -3950,6 +3895,78 @@ export class Segmentations<HandleError extends boolean = boolean> {
         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>);
+    /**
+     * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
+     * @tags Fund Market Data
+     * @name GetFundsMarketData
+     * @summary Get Funds Market Data
+     * @request GET:/funds/{fund_id}/market
+     * @secure
+     */
+    getFundsMarketData(fundId: number, query?: {
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number | null;
+        /**
+         * Date  Ge
+         * Specify the minimum date for data retrieval in YYYY-MM-DD format.
+         */
+        date__ge?: string | null;
+        /**
+         * Date  Le
+         * Specify the maximum date for data retrieval in YYYY-MM-DD format.
+         */
+        date__le?: string | null;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
+    /**
+     * @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
+     * @tags Fund Market Data
+     * @name GetFundsMarketStatistics
+     * @summary Get Funds Market Statistics
+     * @request GET:/funds/{fund_id}/market-statistics
+     * @secure
+     */
+    getFundsMarketStatistics(fundId: number, query?: {
+        /**
+         * Trading Item Id
+         * Specify a BW trading asset identifier for a targeted query.
+         */
+        trading_item_id?: number | null;
+        /**
+         * Identifier  In
+         * Specify a list of external identifiers.
+         */
+        identifier__in?: string | null;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, 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 Tenants<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(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>;