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

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 {
@@ -4238,6 +4239,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 +4757,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 +4884,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 +4980,58 @@ export class StockScreener<HandleError extends boolean = boolean> {
      */
     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>);
+    /**
+     * @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 PreIpoCompanies<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5156,6 +5168,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
@@ -5502,7 +5518,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
@@ -5535,27 +5556,27 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
      */
     ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
 }
-export class Ownerships<HandleError extends boolean = boolean> {
+export class AlphaTools<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
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetMomentumRatioGraph
+     * @summary get seasonlity data
+     * @request POST:/rst
      * @secure
      */
-    getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+    getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
     /**
-     * @description get ownerships by symbol data
-     * @tags Ownerships
-     * @name GetOwnershipsBySymbolData
-     * @summary get ownerships by symbol data
-     * @request POST:/symbol-ownerships
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetSeasonality
+     * @summary get seasonlity data
+     * @request POST:/seasonality
      * @secure
      */
-    getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+    getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
 }
 export class TipRank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -5923,6 +5944,19 @@ 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>);
@@ -6049,41 +6083,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>);
@@ -6142,6 +6141,28 @@ export class Passport<HandleError extends boolean = boolean> {
      */
     passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], 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 interface InsightBeforeAndAfterV2 {
     after?: string;
     before?: string;