@orbis-systems/orbis-api-clients 1.3.1 → 1.4.0

package/dist/insight/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
+import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponseHeaders, HttpStatusCode } from "axios";
 enum CaseFormat {
     Camel = "camel",
     Snake = "snake",
@@ -44,12 +44,14 @@ type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus &
     success: true;
     data: Data;
     rawData: RawData;
+    headers: AxiosResponseHeaders;
 };
 type ErrorClientResponse = ResponseStatus & {
     success: false;
     data?: any;
     rawData?: any;
     error: unknown;
+    headers?: AxiosResponseHeaders;
 };
 type ClientResponse<Data = unknown, HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> = HandleError extends true ? SuccessClientResponse<TransformData<Data, Format>, Data> | ErrorClientResponse : SuccessClientResponse<TransformData<Data, Format>, Data>;
 declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
@@ -101,6 +103,39 @@ export enum InsightTrendingType {
     TrendingTypeBestRated = "best-rated",
     TrendingTypeWorstRated = "worst-rated"
 }
+export enum InsightTiprankNewsOrderBy {
+    TiprankNewsOrderByDate = "date",
+    TiprankNewsOrderByLastUpdateDate = "last_update_date"
+}
+export enum InsightTiprankNewsLang {
+    TiprankNewsLangEN = "en",
+    TiprankNewsLangHE = "he",
+    TiprankNewsLangES = "es",
+    TiprankNewsLangJP = "jp"
+}
+export enum InsightTiprankNewsCountry {
+    TiprankNewsCountryUS = "US",
+    TiprankNewsCountryCanada = "Canada",
+    TiprankNewsCountryUK = "UK",
+    TiprankNewsCountryGlobal = "Global",
+    TiprankNewsCountryGermany = "Germany",
+    TiprankNewsCountrySpain = "Spain",
+    TiprankNewsCountryFrance = "France",
+    TiprankNewsCountryItaly = "Italy",
+    TiprankNewsCountryIsrael = "Israel",
+    TiprankNewsCountryAustralia = "Australia",
+    TiprankNewsCountrySingapore = "Singapore",
+    TiprankNewsCountryEuroZone = "EuroZone",
+    TiprankNewsCountryJapan = "Japan",
+    TiprankNewsCountryHongKong = "HongKong"
+}
+export enum InsightTiprankNewsCategory {
+    TiprankNewsCategoryNews = "news",
+    TiprankNewsCategoryArticle = "article",
+    /** spelled as in TipRank API */
+    TiprankNewsCategoryCompanyAnnouncements = "company-announcments",
+    TiprankNewsCategoryTheFly = "the-fly"
+}
 export enum InsightPeriodType {
     PeriodDay = "day",
     PeriodWeek = "week",
@@ -848,10 +883,18 @@ export interface InsightEarningReleasesRequest {
     exchanges?: string[];
     /** @example true */
     load_quotes?: boolean;
+    /** in millions */
+    market_cap?: InsightLessAndMore;
+    /** Allowed fields: symbol, market_cap, exchange, quarter, time, date */
+    order?: InsightOrdering;
     /** Paging is required if LoadQuotes is true */
     paging?: InsightPaging;
+    /** @example "confirmed" */
+    status?: InsightEarningReleasesRequestStatusEnum;
     /** @example ["AAPL","GOOGL"] */
     symbols?: string[];
+    /** @example ["Before Market Open","After Market Close"] */
+    time?: string[];
 }
 export interface InsightEarningReleasesResponse {
     /** @example 10 */
@@ -1191,6 +1234,7 @@ export interface InsightFundScreenerRequest {
     leverage?: InsightFundScreenerRequestLeverageEnum;
     market_cap?: InsightLessAndMore;
     paging: InsightPaging;
+    search?: InsightSearch;
     sectors?: InsightSectorFilter[];
     sponsors?: string[];
 }
@@ -4126,6 +4170,12 @@ export interface InsightScreenerPreset {
     preset_name: string;
     updated_at: string;
 }
+export interface InsightSearch {
+    /** @example "name" */
+    field: string;
+    /** @example "technology" */
+    query: string;
+}
 export interface InsightSearchArticleRequest {
     /** @example "eng" */
     language: string;
@@ -4442,6 +4492,70 @@ export interface InsightTimeRangeFilter {
      */
     start_time: number;
 }
+export interface InsightTiprankNewsArticle {
+    author: InsightTiprankNewsAuthor;
+    category: InsightTiprankNewsTopic;
+    content: string;
+    date: string;
+    description: string;
+    id: string;
+    image: InsightTiprankNewsImage;
+    last_modified: string;
+    link: string;
+    modified: boolean;
+    slug: string;
+    source: string;
+    story_highlights: string;
+    thumbnail: InsightTiprankNewsImage;
+    tickers: string[];
+    title: string;
+    topics: InsightTiprankNewsTopic[];
+}
+export interface InsightTiprankNewsArticlesResponse {
+    data: InsightTiprankNewsArticle[];
+    disclaimer: string;
+}
+export interface InsightTiprankNewsAuthor {
+    bio: string;
+    image: InsightTiprankNewsImage;
+    linkedin: string;
+    name: string;
+    slug: string;
+    source: string;
+    topics: any[];
+    type: string;
+}
+export interface InsightTiprankNewsImage {
+    height: number;
+    src: string;
+    width: number;
+}
+export interface InsightTiprankNewsRequest {
+    /** Posts by categories 		Enums(news, article, company-announcments, the-fly)	(OPTIONAL) */
+    categories?: InsightTiprankNewsCategory[];
+    /** Posts by specific countries 		Enums(US, Canada, UK, Global, Germany, Spain, France, Italy, Israel, Australia, Singapore, EuroZone, Japan, HongKong)	(OPTIONAL) */
+    countries?: InsightTiprankNewsCountry[];
+    /** Exclude links from the post	(OPTIONAL) */
+    exclude_links?: boolean;
+    /** Posts by post ids	(OPTIONAL) */
+    ids?: string[];
+    /** Include additional content for each post	(OPTIONAL) */
+    include_content?: boolean;
+    /** The language of the content 		Enums(en, he, es, jp)	(OPTIONAL) */
+    lang?: InsightTiprankNewsLang;
+    /** Number of posts to pull	(OPTIONAL) */
+    num?: number;
+    /** Field used to sort results in descending order 		Enums(date, last_update_date)	(OPTIONAL) */
+    order_by?: InsightTiprankNewsOrderBy;
+    /** Posts by post slugs	(OPTIONAL) */
+    slugs?: string[];
+    /** Posts by ticker symbols	(OPTIONAL) */
+    tickers?: string[];
+}
+export interface InsightTiprankNewsTopic {
+    slug: string;
+    title: string;
+}
 export interface InsightTiprankQuote {
     ask_px: number;
     ask_sz: number;
@@ -4781,6 +4895,11 @@ export enum InsightCryptoLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** @example "confirmed" */
+export enum InsightEarningReleasesRequestStatusEnum {
+    Estimated = "estimated",
+    Confirmed = "confirmed"
+}
 /** @example "ETF" */
 export enum InsightFundScreenerRequestFundTypeEnum {
     ANY = "ANY",
@@ -5290,6 +5409,8 @@ export class Earnings<HandleError extends boolean = boolean, Format extends Case
          * @example ""NYSE,NAS""
          */
         exchanges?: string[];
+        /** Filter by status - estimated/confirmed */
+        status?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError, Format>>;
     /**
      * @description get earnings release dates for symbols
@@ -5675,7 +5796,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
         category?: string;
         /** Asset class id */
         asset_class?: string;
-        /** Leverage ratios to filter by */
+        /** Leverage ratios to filter by; whole numbers (e.g. 0,1,2) match the leverage category, decimal values (e.g. 1.5) match the exact leverage ratio */
         leverage_ratios?: number[];
         /** Whether to include inverse ETFs */
         inverse?: boolean;
@@ -5725,7 +5846,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
         category?: string;
         /** Asset class id */
         asset_class?: string;
-        /** Leverage ratios to filter by */
+        /** Leverage ratios to filter by; whole numbers (e.g. 0,1,2) match the leverage category, decimal values (e.g. 1.5) match the exact leverage ratio */
         leverage_ratios?: number[];
         /** Whether to include inverse ETFs */
         inverse?: boolean;
@@ -7198,6 +7319,15 @@ export class TipRank<HandleError extends boolean = boolean, Format extends CaseF
      * @secure
      */
     tiprankLiveFeed(filter: InsightLiveFeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError, Format>>;
+    /**
+     * @description Returns the latest market-moving news about publicly traded companies and their stocks.
+     * @tags TipRank
+     * @name TiprankNews
+     * @summary Get tiprank News
+     * @request POST:/tipranks/news
+     * @secure
+     */
+    tiprankNews(filter: InsightTiprankNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTiprankNewsArticlesResponse, HandleError, Format>>;
     /**
      * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
      * @tags TipRank
@@ -7348,6 +7478,7 @@ export class UsageTracking<HandleError extends boolean = boolean, Format extends
      * @name GetUsageData
      * @summary get insight usage data
      * @request POST:/tracking/usage
+     * @deprecated
      * @secure
      */
     getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError, Format>>;