@orbis-systems/orbis-api-clients 0.7.4 → 0.7.6

package/dist/insight/index.d.ts

@@ -3251,6 +3251,8 @@ export interface InsightPreIPOCompany {
     num_investors: number;
     num_jobs: number;
     num_shares_outstanding: number;
+    reference_price: number;
+    reference_price_date: string;
     total_funding: number;
     total_funding_rounds: number;
     twelve_month_trailing_revenue: number;
@@ -3329,6 +3331,7 @@ export interface InsightPreIPOCompanyResearchDocument {
     link: string;
     pre_ipo_company_id: string;
     preview_meta: string;
+    published_date: string;
     relation: string;
     research_document_id: string;
     source: string;
@@ -4239,6 +4242,18 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** sort field */
+export enum InsightGetPreIpoCompaniesParamsOrderFieldEnum {
+    Id = "id",
+    Name = "name",
+    LastValuation = "last_valuation",
+    TotalFunding = "total_funding"
+}
+/** sort direction */
+export enum InsightGetPreIpoCompaniesParamsOrderDirectionEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
 /** search by research type */
 export enum InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum {
     INTERVIEW = "INTERVIEW",
@@ -4292,45 +4307,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
     Date = "date",
     Rank = "rank"
 }
-export class CompanyProfile<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get company profile, industries classification and closest earning release
-     * @tags CompanyProfile
-     * @name GetCompanyProfile
-     * @summary get company profile
-     * @request GET:/company-profile
-     * @secure
-     */
-    getCompanyProfile(query: {
-        /** Company symbol */
-        symbol: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
-    /**
-     * @description get combined profile, equities and funds
-     * @tags CompanyProfile
-     * @name GetCombinedProfile
-     * @summary get company profile
-     * @request GET:/quote-profile
-     * @secure
-     */
-    getCombinedProfile(query: {
-        /** Company symbol */
-        symbol: string;
-        /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
-        symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
-    /**
-     * @description sort input array of symbols by type
-     * @tags CompanyProfile
-     * @name GetSymbolsPerSymbolType
-     * @summary sort input array of symbols by type
-     * @request POST:/symbols-per-type
-     * @secure
-     */
-    getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
-}
 export class WorldMarkets<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4513,6 +4489,45 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
         id: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
+export class CompanyProfile<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get company profile, industries classification and closest earning release
+     * @tags CompanyProfile
+     * @name GetCompanyProfile
+     * @summary get company profile
+     * @request GET:/company-profile
+     * @secure
+     */
+    getCompanyProfile(query: {
+        /** Company symbol */
+        symbol: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
+    /**
+     * @description get combined profile, equities and funds
+     * @tags CompanyProfile
+     * @name GetCombinedProfile
+     * @summary get company profile
+     * @request GET:/quote-profile
+     * @secure
+     */
+    getCombinedProfile(query: {
+        /** Company symbol */
+        symbol: string;
+        /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
+        symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
+    /**
+     * @description sort input array of symbols by type
+     * @tags CompanyProfile
+     * @name GetSymbolsPerSymbolType
+     * @summary sort input array of symbols by type
+     * @request POST:/symbols-per-type
+     * @secure
+     */
+    getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
+}
 export class CustomLists<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4770,6 +4785,102 @@ export class Fundamentals<HandleError extends boolean = boolean> {
      */
     getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
 }
+export class StockScreener<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description data for visual heat map
+     * @tags StockScreener
+     * @name StockMarketHeatmap
+     * @summary data for visual heat map
+     * @request GET:/heatmaps
+     * @secure
+     */
+    stockMarketHeatmap(query?: {
+        /** Name of symbol list to fetch details for. Empty is default */
+        heatmap_name?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
+    /**
+     * @description create or update heat map preset
+     * @tags StockScreener
+     * @name CreateStockMarketHeatmapPreset
+     * @summary create or update heat map preset
+     * @request POST:/heatmaps
+     * @secure
+     */
+    createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Sector and Industry Group performance
+     * @tags StockScreener
+     * @name IndustriesPerformance
+     * @summary get industries performance
+     * @request POST:/industries-performance
+     * @secure
+     */
+    industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
+    /**
+     * @description filter stocks by params
+     * @tags StockScreener
+     * @name StockScreener
+     * @summary filter stocks by params
+     * @request POST:/stock-screener
+     * @secure
+     */
+    stockScreener(filter: InsightStockScreenerV1Request, headers?: {
+        /** Authorization */
+        Authorization?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
+    /**
+     * @description get screener presets
+     * @tags StockScreener
+     * @name GetScreenerPresets
+     * @summary get screener presets
+     * @request GET:/stock-screener/presets
+     * @secure
+     */
+    getScreenerPresets(query: {
+        /** how many records to return */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
+    /**
+     * @description update screener preset
+     * @tags StockScreener
+     * @name UpdateScreenerPreset
+     * @summary update screener preset
+     * @request PUT:/stock-screener/presets
+     * @secure
+     */
+    updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
+    /**
+     * @description create screener preset
+     * @tags StockScreener
+     * @name CreateOrScreenerPreset
+     * @summary create screener preset
+     * @request POST:/stock-screener/presets
+     * @secure
+     */
+    createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
+    /**
+     * @description remove screener preset
+     * @tags StockScreener
+     * @name RemoveScreenerPreset
+     * @summary remove screener preset
+     * @request DELETE:/stock-screener/presets
+     * @secure
+     */
+    removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description get top symbols
+     * @tags StockScreener
+     * @name GetTopSymbols
+     * @summary get top symbols
+     * @request POST:/stock-screener/top
+     * @secure
+     */
+    getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
+}
 export class Funds<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4884,102 +4995,6 @@ export class Funds<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
 }
-export class StockScreener<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description data for visual heat map
-     * @tags StockScreener
-     * @name StockMarketHeatmap
-     * @summary data for visual heat map
-     * @request GET:/heatmaps
-     * @secure
-     */
-    stockMarketHeatmap(query?: {
-        /** Name of symbol list to fetch details for. Empty is default */
-        heatmap_name?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
-    /**
-     * @description create or update heat map preset
-     * @tags StockScreener
-     * @name CreateStockMarketHeatmapPreset
-     * @summary create or update heat map preset
-     * @request POST:/heatmaps
-     * @secure
-     */
-    createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description Sector and Industry Group performance
-     * @tags StockScreener
-     * @name IndustriesPerformance
-     * @summary get industries performance
-     * @request POST:/industries-performance
-     * @secure
-     */
-    industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
-    /**
-     * @description filter stocks by params
-     * @tags StockScreener
-     * @name StockScreener
-     * @summary filter stocks by params
-     * @request POST:/stock-screener
-     * @secure
-     */
-    stockScreener(filter: InsightStockScreenerV1Request, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
-    /**
-     * @description get screener presets
-     * @tags StockScreener
-     * @name GetScreenerPresets
-     * @summary get screener presets
-     * @request GET:/stock-screener/presets
-     * @secure
-     */
-    getScreenerPresets(query: {
-        /** how many records to return */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
-    /**
-     * @description update screener preset
-     * @tags StockScreener
-     * @name UpdateScreenerPreset
-     * @summary update screener preset
-     * @request PUT:/stock-screener/presets
-     * @secure
-     */
-    updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
-    /**
-     * @description create screener preset
-     * @tags StockScreener
-     * @name CreateOrScreenerPreset
-     * @summary create screener preset
-     * @request POST:/stock-screener/presets
-     * @secure
-     */
-    createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
-    /**
-     * @description remove screener preset
-     * @tags StockScreener
-     * @name RemoveScreenerPreset
-     * @summary remove screener preset
-     * @request DELETE:/stock-screener/presets
-     * @secure
-     */
-    removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description get top symbols
-     * @tags StockScreener
-     * @name GetTopSymbols
-     * @summary get top symbols
-     * @request POST:/stock-screener/top
-     * @secure
-     */
-    getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
-}
 export class Quotes<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5019,19 +5034,6 @@ export class Quotes<HandleError extends boolean = boolean> {
         symbols: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
 }
-export class Intraday<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Returns an array of intraday chart data values for the given ticker.
-     * @tags Intraday
-     * @name IntradayQuotes
-     * @summary Get an array of intraday chart data values for the given ticker
-     * @request POST:/intraday/quotes
-     * @secure
-     */
-    intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
-}
 export class PreIpoCompanies<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5052,6 +5054,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
         limit: number;
         /** how many records to skip */
         offset: number;
+        /** sort field */
+        order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
+        /** sort direction */
+        order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
     /**
      * @description get pre ipo company by id
@@ -5222,6 +5228,19 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
      */
     getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
 }
+export class Intraday<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Returns an array of intraday chart data values for the given ticker.
+     * @tags Intraday
+     * @name IntradayQuotes
+     * @summary Get an array of intraday chart data values for the given ticker
+     * @request POST:/intraday/quotes
+     * @secure
+     */
+    intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
+}
 export class Ipos<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5944,19 +5963,6 @@ export class TipRank<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
 }
-export class UsageTracking<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get usage date per branch for a period
-     * @tags UsageTracking
-     * @name GetUsageData
-     * @summary get insight usage data
-     * @request POST:/tracking/usage
-     * @secure
-     */
-    getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
-}
 export class Public<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -6083,6 +6089,28 @@ export class Public<HandleError extends boolean = boolean> {
         offset: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
 }
+export class Ownerships<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get ownerships by id datadata
+     * @tags Ownerships
+     * @name GetOwnershipsByIdData
+     * @summary get ownerships by id data
+     * @request POST:/ownerships
+     * @secure
+     */
+    getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+    /**
+     * @description get ownerships by symbol data
+     * @tags Ownerships
+     * @name GetOwnershipsBySymbolData
+     * @summary get ownerships by symbol data
+     * @request POST:/symbol-ownerships
+     * @secure
+     */
+    getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+}
 export class Passport<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -6141,27 +6169,18 @@ export class Passport<HandleError extends boolean = boolean> {
      */
     passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
 }
-export class Ownerships<HandleError extends boolean = boolean> {
+export class UsageTracking<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description get ownerships by id datadata
-     * @tags Ownerships
-     * @name GetOwnershipsByIdData
-     * @summary get ownerships by id data
-     * @request POST:/ownerships
-     * @secure
-     */
-    getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
-    /**
-     * @description get ownerships by symbol data
-     * @tags Ownerships
-     * @name GetOwnershipsBySymbolData
-     * @summary get ownerships by symbol data
-     * @request POST:/symbol-ownerships
+     * @description get usage date per branch for a period
+     * @tags UsageTracking
+     * @name GetUsageData
+     * @summary get insight usage data
+     * @request POST:/tracking/usage
      * @secure
      */
-    getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+    getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
 }
 export interface InsightBeforeAndAfterV2 {
     after?: string;
@@ -6388,19 +6407,6 @@ export enum InsightOrderingDirectionEnumV2 {
     Asc = "asc",
     Desc = "desc"
 }
-export class FixedIncomeV2<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get fixed income entries
-     * @tags FixedIncome
-     * @name GetFixedIncomeEntries
-     * @summary get fixed income entries
-     * @request POST:/fixed-income
-     * @secure
-     */
-    getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
-}
 export class StockScreenerV2<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -6423,6 +6429,19 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
      */
     getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
 }
+export class FixedIncomeV2<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get fixed income entries
+     * @tags FixedIncome
+     * @name GetFixedIncomeEntries
+     * @summary get fixed income entries
+     * @request POST:/fixed-income
+     * @secure
+     */
+    getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
+}
 export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
     readonly config: JwtClientConfig<HandleError>;
     alphaTools: AlphaTools<HandleError>;