@orbis-systems/orbis-api-clients 0.8.1 → 0.8.2

package/dist/insight/index.d.ts

@@ -1221,7 +1221,11 @@ export interface InsightGetFundDetailsResponse {
     long_description: string;
     market_caps: InsightMarketCapBreakdown[];
     maturities: InsightMaturityBreakdown[];
+    month_end_nav: number;
+    month_end_nav_date: string;
     phone: string;
+    primary_benchmark: string;
+    primary_index_beta_y1: number;
     sectors: InsightSectorBreakdown[];
     structure: string;
     symbol: string;
@@ -2831,6 +2835,7 @@ export interface InsightHedgeFundsResponse {
 }
 export interface InsightHelpRequestWithSymbol {
     paging?: InsightPaging;
+    search_query?: string;
     symbol?: string;
 }
 export interface InsightHistoricalIPO {
@@ -3363,6 +3368,8 @@ export interface InsightNewsFilterRequest {
     symbols?: string[];
     /** @example ["Earnings","Market"] */
     tags?: string[];
+    /** @example true */
+    with_images_only?: boolean;
 }
 export interface InsightNewsImage {
     size: string;
@@ -5527,19 +5534,6 @@ 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 Quotes<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5579,6 +5573,19 @@ 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>);
@@ -6274,6 +6281,8 @@ export class News<HandleError extends boolean = boolean> {
         limit?: number;
         /** Offset */
         offset?: number;
+        /** search query */
+        search_query?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
     /**
      * @description Returns available tags in DB
@@ -6329,6 +6338,228 @@ export class Ownerships<HandleError extends boolean = boolean> {
      */
     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>);
+    /**
+     * @description Returns article by id
+     * @tags Passport
+     * @name PassportArticleById
+     * @summary Get article by id
+     * @request POST:/passport/article-by-id
+     * @secure
+     */
+    passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
+    /**
+     * @description Returns articles
+     * @tags Passport
+     * @name PassportArticles
+     * @summary Get articles
+     * @request POST:/passport/articles
+     * @secure
+     */
+    passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
+    /**
+     * @description Returns author profile
+     * @tags Passport
+     * @name PassportAuthorProfile
+     * @summary Get author profile
+     * @request POST:/passport/author-profile
+     * @secure
+     */
+    passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
+    /**
+     * @description Returns most popular tags
+     * @tags Passport
+     * @name PassportMostPopularTags
+     * @summary Get most popular tags
+     * @request POST:/passport/most-popular-tags
+     * @secure
+     */
+    passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
+    /**
+     * @description Returns news feed
+     * @tags Passport
+     * @name PassportNewsFeed
+     * @summary Get news feed
+     * @request POST:/passport/newsfeed
+     * @secure
+     */
+    passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
+    /**
+     * @description Returns article by parameters
+     * @tags Passport
+     * @name PassportSearchArticle
+     * @summary Search article by parameters
+     * @request POST:/passport/search-article
+     * @secure
+     */
+    passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
+}
+export class Public<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
+     * @tags Public
+     * @name CalculateEstimatedReturns
+     * @summary Calculate Estimated Returns
+     * @request GET:/public/estimated-returns
+     * @secure
+     */
+    calculateEstimatedReturns(query: {
+        /** Single symbol */
+        symbol: string;
+        /**
+         * Non-zero amount
+         * @format float64
+         */
+        amount: number;
+        /** Start date for calculations */
+        start_date: string;
+        /** End date for calculations */
+        end_date: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
+    /**
+     * @description Returns an expert forecast
+     * @tags Public
+     * @name ExpertForecast
+     * @summary Expert forecast
+     * @request GET:/public/expert-forecast
+     * @secure
+     */
+    expertForecast(query: {
+        /** Comma separated symbols */
+        symbols: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
+    /**
+     * @description get fundamentals by symbol data
+     * @tags Public
+     * @name GetPublicFundamentalsBySymbolData
+     * @summary get fundamentals by symbol data
+     * @request GET:/public/fundamentals/{symbol}
+     * @secure
+     */
+    getPublicFundamentalsBySymbolData(symbol: string, query: {
+        /** Annual or quarterly */
+        mode: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
+    /**
+     * @description Daily price history
+     * @tags Public
+     * @name DailyPriceHistory
+     * @summary Daily price history
+     * @request GET:/public/price-history/daily
+     * @secure
+     */
+    dailyPriceHistory(query: {
+        /** Single symbol */
+        symbol: string;
+        /** Target date */
+        date: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
+    /**
+     * @description Public quote profile
+     * @tags Public
+     * @name PublicQuoteProfile
+     * @summary Public quote profile
+     * @request GET:/public/quote-profile/{symbol}
+     * @secure
+     */
+    publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
+    /**
+     * @description get ratios by symbol data
+     * @tags Public
+     * @name GetPublicRatiosBySymbolData
+     * @summary get ratios by symbol data
+     * @request GET:/public/ratios/{symbol}
+     * @secure
+     */
+    getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
+    /**
+     * @description find a symbol by name or description
+     * @tags Public
+     * @name QuoteFundamentalsSearch
+     * @summary find a symbol by name or description
+     * @request GET:/public/symbol-search
+     * @secure
+     */
+    quoteFundamentalsSearch(query: {
+        /** Search query */
+        search_query: string;
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
+    /**
+     * @description Get top gainers
+     * @tags Public
+     * @name TopGainers
+     * @summary Top Gainers
+     * @request GET:/public/top-gainers
+     * @secure
+     */
+    topGainers(query: {
+        /** sort direction - asc or desc */
+        order_direction?: string;
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
+    /**
+     * @description Get top stocks
+     * @tags Public
+     * @name TopStocks
+     * @summary Top Stocks
+     * @request GET:/public/top-stocks
+     * @secure
+     */
+    topStocks(query: {
+        /** EQUITY|ETF|CRYPTO */
+        stock_type: InsightTopStocksParamsStockTypeEnum;
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        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 TipRank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -6695,228 +6926,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 Passport<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Returns article by id
-     * @tags Passport
-     * @name PassportArticleById
-     * @summary Get article by id
-     * @request POST:/passport/article-by-id
-     * @secure
-     */
-    passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
-    /**
-     * @description Returns articles
-     * @tags Passport
-     * @name PassportArticles
-     * @summary Get articles
-     * @request POST:/passport/articles
-     * @secure
-     */
-    passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
-    /**
-     * @description Returns author profile
-     * @tags Passport
-     * @name PassportAuthorProfile
-     * @summary Get author profile
-     * @request POST:/passport/author-profile
-     * @secure
-     */
-    passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
-    /**
-     * @description Returns most popular tags
-     * @tags Passport
-     * @name PassportMostPopularTags
-     * @summary Get most popular tags
-     * @request POST:/passport/most-popular-tags
-     * @secure
-     */
-    passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
-    /**
-     * @description Returns news feed
-     * @tags Passport
-     * @name PassportNewsFeed
-     * @summary Get news feed
-     * @request POST:/passport/newsfeed
-     * @secure
-     */
-    passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
-    /**
-     * @description Returns article by parameters
-     * @tags Passport
-     * @name PassportSearchArticle
-     * @summary Search article by parameters
-     * @request POST:/passport/search-article
-     * @secure
-     */
-    passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], 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 Public<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
-     * @tags Public
-     * @name CalculateEstimatedReturns
-     * @summary Calculate Estimated Returns
-     * @request GET:/public/estimated-returns
-     * @secure
-     */
-    calculateEstimatedReturns(query: {
-        /** Single symbol */
-        symbol: string;
-        /**
-         * Non-zero amount
-         * @format float64
-         */
-        amount: number;
-        /** Start date for calculations */
-        start_date: string;
-        /** End date for calculations */
-        end_date: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
-    /**
-     * @description Returns an expert forecast
-     * @tags Public
-     * @name ExpertForecast
-     * @summary Expert forecast
-     * @request GET:/public/expert-forecast
-     * @secure
-     */
-    expertForecast(query: {
-        /** Comma separated symbols */
-        symbols: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
-    /**
-     * @description get fundamentals by symbol data
-     * @tags Public
-     * @name GetPublicFundamentalsBySymbolData
-     * @summary get fundamentals by symbol data
-     * @request GET:/public/fundamentals/{symbol}
-     * @secure
-     */
-    getPublicFundamentalsBySymbolData(symbol: string, query: {
-        /** Annual or quarterly */
-        mode: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
-    /**
-     * @description Daily price history
-     * @tags Public
-     * @name DailyPriceHistory
-     * @summary Daily price history
-     * @request GET:/public/price-history/daily
-     * @secure
-     */
-    dailyPriceHistory(query: {
-        /** Single symbol */
-        symbol: string;
-        /** Target date */
-        date: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
-    /**
-     * @description Public quote profile
-     * @tags Public
-     * @name PublicQuoteProfile
-     * @summary Public quote profile
-     * @request GET:/public/quote-profile/{symbol}
-     * @secure
-     */
-    publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
-    /**
-     * @description get ratios by symbol data
-     * @tags Public
-     * @name GetPublicRatiosBySymbolData
-     * @summary get ratios by symbol data
-     * @request GET:/public/ratios/{symbol}
-     * @secure
-     */
-    getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
-    /**
-     * @description find a symbol by name or description
-     * @tags Public
-     * @name QuoteFundamentalsSearch
-     * @summary find a symbol by name or description
-     * @request GET:/public/symbol-search
-     * @secure
-     */
-    quoteFundamentalsSearch(query: {
-        /** Search query */
-        search_query: string;
-        /** how many records to return. Max value is 50 */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
-    /**
-     * @description Get top gainers
-     * @tags Public
-     * @name TopGainers
-     * @summary Top Gainers
-     * @request GET:/public/top-gainers
-     * @secure
-     */
-    topGainers(query: {
-        /** sort direction - asc or desc */
-        order_direction?: string;
-        /** how many records to return. Max value is 50 */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
-    /**
-     * @description Get top stocks
-     * @tags Public
-     * @name TopStocks
-     * @summary Top Stocks
-     * @request GET:/public/top-stocks
-     * @secure
-     */
-    topStocks(query: {
-        /** EQUITY|ETF|CRYPTO */
-        stock_type: InsightTopStocksParamsStockTypeEnum;
-        /** how many records to return. Max value is 50 */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
-}
 export interface InsightBeforeAndAfterV2 {
     after?: string;
     before?: string;