@orbis-systems/orbis-api-clients 0.7.3 → 0.7.5

package/dist/insight/index.d.ts

@@ -2572,6 +2572,7 @@ export interface InsightHedgeFundsResponse {
     total_num_hedge_funds: number;
 }
 export interface InsightHelpRequestWithSymbol {
+    paging?: InsightPaging;
     symbol?: string;
 }
 export interface InsightHistoricalIPO {
@@ -3250,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;
@@ -3328,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;
@@ -4238,6 +4242,17 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** search by research type */
+export enum InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum {
+    INTERVIEW = "INTERVIEW",
+    MARKET = "MARKET",
+    COMPANY = "COMPANY"
+}
+/** search by relation */
+export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
+    SUBJECT = "SUBJECT",
+    CONNECTED = "CONNECTED"
+}
 /** sort direction */
 export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
     ASC = "ASC",
@@ -4745,6 +4760,19 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      */
     getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
 }
+export class Fundamentals<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get fundamentals by symbol data
+     * @tags Fundamentals
+     * @name GetFundamentalsBySymbolData
+     * @summary get fundamentals by symbol data
+     * @request POST:/fundamentals
+     * @secure
+     */
+    getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
+}
 export class Funds<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4859,71 +4887,6 @@ export class Funds<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
 }
-export class Fundamentals<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get fundamentals by symbol data
-     * @tags Fundamentals
-     * @name GetFundamentalsBySymbolData
-     * @summary get fundamentals by symbol data
-     * @request POST:/fundamentals
-     * @secure
-     */
-    getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
-}
-export class Quotes<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Get single historical quote
-     * @tags Quotes
-     * @name GitHistoricalQuote
-     * @summary Get single historical quote
-     * @request GET:/historical/quote
-     * @secure
-     */
-    gitHistoricalQuote(query: {
-        /** Symbol */
-        symbol: string;
-        /** Date */
-        date: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
-    /**
-     * @description get quote history by symbol
-     * @tags Quotes
-     * @name GitQuoteHistory
-     * @summary Get quote history
-     * @request POST:/quote-history
-     * @secure
-     */
-    gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
-    /**
-     * @description Returns a list of quotes equity info for specified symbols.
-     * @tags Quotes
-     * @name GetQuotesEquityData
-     * @summary Get Quotes Equity data
-     * @request GET:/quotes/equity
-     * @secure
-     */
-    getQuotesEquityData(query: {
-        /** Comma separated symbols */
-        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 StockScreener<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5020,6 +4983,99 @@ export class StockScreener<HandleError extends boolean = boolean> {
      */
     getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, 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>);
+    /**
+     * @description get recent ipos info
+     * @tags Ipos
+     * @name PostRecent
+     * @summary get recent ipos info
+     * @request POST:/ipos/recent
+     * @secure
+     */
+    postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
+    /**
+     * @description get upcoming ipos info
+     * @tags Ipos
+     * @name GetUpcoming
+     * @summary get upcoming ipos info
+     * @request GET:/ipos/upcoming
+     * @secure
+     */
+    getUpcoming(query: {
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
+    /**
+     * @description get ipo info by symbol
+     * @tags Ipos
+     * @name GetIpos
+     * @summary get ipo info by symbol
+     * @request GET:/ipos/{symbol}
+     * @secure
+     */
+    getIpos(symbol: string, query?: {
+        /** load quotes */
+        load_quotes?: boolean;
+        /** statuses */
+        statuses?: string[];
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
+}
+export class Quotes<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Get single historical quote
+     * @tags Quotes
+     * @name GitHistoricalQuote
+     * @summary Get single historical quote
+     * @request GET:/historical/quote
+     * @secure
+     */
+    gitHistoricalQuote(query: {
+        /** Symbol */
+        symbol: string;
+        /** Date */
+        date: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
+    /**
+     * @description get quote history by symbol
+     * @tags Quotes
+     * @name GitQuoteHistory
+     * @summary Get quote history
+     * @request POST:/quote-history
+     * @secure
+     */
+    gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
+    /**
+     * @description Returns a list of quotes equity info for specified symbols.
+     * @tags Quotes
+     * @name GetQuotesEquityData
+     * @summary Get Quotes Equity data
+     * @request GET:/quotes/equity
+     * @secure
+     */
+    getQuotesEquityData(query: {
+        /** Comma separated symbols */
+        symbols: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
+}
 export class PreIpoCompanies<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5156,6 +5212,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
         limit: number;
         /** how many records to skip */
         offset: number;
+        /** search by research type */
+        research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
+        /** search by relation */
+        relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
     /**
      * @description get pre ipo company research document by id
@@ -5206,47 +5266,6 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
      */
     getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
 }
-export class Ipos<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get recent ipos info
-     * @tags Ipos
-     * @name PostRecent
-     * @summary get recent ipos info
-     * @request POST:/ipos/recent
-     * @secure
-     */
-    postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
-    /**
-     * @description get upcoming ipos info
-     * @tags Ipos
-     * @name GetUpcoming
-     * @summary get upcoming ipos info
-     * @request GET:/ipos/upcoming
-     * @secure
-     */
-    getUpcoming(query: {
-        /** how many records to return. Max value is 50 */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
-    /**
-     * @description get ipo info by symbol
-     * @tags Ipos
-     * @name GetIpos
-     * @summary get ipo info by symbol
-     * @request GET:/ipos/{symbol}
-     * @secure
-     */
-    getIpos(symbol: string, query?: {
-        /** load quotes */
-        load_quotes?: boolean;
-        /** statuses */
-        statuses?: string[];
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
-}
 export class Logos<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5502,7 +5521,12 @@ export class News<HandleError extends boolean = boolean> {
      * @request GET:/news/symbols
      * @secure
      */
-    newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
+    newsAvailableStocks(query?: {
+        /** Limit */
+        limit?: number;
+        /** Offset */
+        offset?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
     /**
      * @description Returns available tags in DB
      * @tags News
@@ -5923,6 +5947,41 @@ export class TipRank<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
 }
+export class AlphaTools<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetMomentumRatioGraph
+     * @summary get seasonlity data
+     * @request POST:/rst
+     * @secure
+     */
+    getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
+    /**
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetSeasonality
+     * @summary get seasonlity data
+     * @request POST:/seasonality
+     * @secure
+     */
+    getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, 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>);
@@ -6049,41 +6108,6 @@ export class Public<HandleError extends boolean = boolean> {
         offset: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, 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 AlphaTools<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get seasonlity data with comparison to benchmark
-     * @tags AlphaTools
-     * @name GetMomentumRatioGraph
-     * @summary get seasonlity data
-     * @request POST:/rst
-     * @secure
-     */
-    getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
-    /**
-     * @description get seasonlity data with comparison to benchmark
-     * @tags AlphaTools
-     * @name GetSeasonality
-     * @summary get seasonlity data
-     * @request POST:/seasonality
-     * @secure
-     */
-    getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
-}
 export class Passport<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);