@orbis-systems/orbis-api-clients 0.7.17 → 0.7.19

package/dist/insight/index.d.ts

@@ -757,7 +757,8 @@ export interface InsightEarningReleasesRequest {
     exchanges?: string[];
     /** @example true */
     load_quotes?: boolean;
-    paging: InsightPaging;
+    /** Paging is required if LoadQuotes is true */
+    paging?: InsightPaging;
     /** @example ["AAPL","GOOGL"] */
     symbols?: string[];
 }
@@ -3828,6 +3829,11 @@ export interface InsightRemoveMarketDateRequest {
     market_code: string;
     /** @example "2023-01-01" */
     open_date: string;
+    /**
+     * Optional: if provided, only the entry with this open_time will be removed
+     * @example "09:30"
+     */
+    open_time?: string;
 }
 export interface InsightRemoveRewrittenFieldValueRequest {
     /** @example "Removed" */
@@ -4147,6 +4153,7 @@ export interface InsightTagShortInfo {
 }
 export interface InsightTickerData {
     historic_volatility: number;
+    risk_free_rate: number;
     ticker: string;
 }
 export interface InsightTickerSeasonality {
@@ -5153,6 +5160,26 @@ export class Earnings<HandleError extends boolean = boolean> {
      * @secure
      */
     getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
+    /**
+     * @description get earnings releases count per day
+     * @tags Earnings
+     * @name GetEarningsReleasesCountPerDay
+     * @summary get earnings releases count per day
+     * @request GET:/earnings-releases
+     * @secure
+     */
+    getEarningsReleasesCountPerDay(query?: {
+        /**
+         * Start date in format YYYY-MM-DD
+         * @example ""2024-01-01""
+         */
+        start_date?: string;
+        /**
+         * End date in format YYYY-MM-DD
+         * @example ""2024-01-31""
+         */
+        end_date?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
 }
 export class FixedIncome<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -5449,19 +5476,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>);
@@ -5501,6 +5515,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>);
@@ -5949,7 +5976,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @request DELETE:/market-dates
      * @secure
      */
-    removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
      * @description Get market dates history
      * @tags MarketDates
@@ -5999,7 +6026,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @request GET:/market-dates/markets/{market}
      * @secure
      */
-    getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
+    getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
     /**
      * @description Remove market
      * @tags MarketDates
@@ -6009,6 +6036,18 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @secure
      */
     removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Get market schedules
+     * @tags MarketDates
+     * @name GetMarketSchedules
+     * @summary Get market schedules
+     * @request GET:/market-dates/schedule
+     * @secure
+     */
+    getMarketSchedules(query?: {
+        /** Market codes, comma separated */
+        market?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
     /**
      * @description CreateOrUpdateMarketSchedule market schedule
      * @tags MarketDates
@@ -6036,18 +6075,6 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @secure
      */
     removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description Get market schedules
-     * @tags MarketDates
-     * @name GetMarketSchedules
-     * @summary Get market schedules
-     * @request GET:/market-dates/schedules
-     * @secure
-     */
-    getMarketSchedules(query?: {
-        /** Market codes, comma separated */
-        market?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
     /**
      * @description Get todays market hours
      * @tags MarketDates
@@ -6207,6 +6234,50 @@ export class News<HandleError extends boolean = boolean> {
      */
     newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
 }
+export class OptionGreeks<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Returns calculated matrix
+     * @tags OptionGreeks
+     * @name OgCalculateMatrix
+     * @summary Calculate matrix
+     * @request POST:/og/calculate-matrix
+     * @secure
+     */
+    ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
+    /**
+     * @description Returns calculated params
+     * @tags OptionGreeks
+     * @name OgCalculateParams
+     * @summary Calculate params
+     * @request POST:/og/calculate-params
+     * @secure
+     */
+    ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, 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>);
@@ -6265,49 +6336,134 @@ 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 Public<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 Calculate estimated returns for selected symbols. Uses split adjusted prices
+     * @tags Public
+     * @name CalculateEstimatedReturns
+     * @summary Calculate Estimated Returns
+     * @request GET:/public/estimated-returns
      * @secure
      */
-    getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
+    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 get ownerships by symbol data
-     * @tags Ownerships
-     * @name GetOwnershipsBySymbolData
-     * @summary get ownerships by symbol data
-     * @request POST:/symbol-ownerships
+     * @description Returns an expert forecast
+     * @tags Public
+     * @name ExpertForecast
+     * @summary Expert forecast
+     * @request GET:/public/expert-forecast
      * @secure
      */
-    getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
-}
-export class OptionGreeks<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
+    expertForecast(query: {
+        /** Comma separated symbols */
+        symbols: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
     /**
-     * @description Returns calculated matrix
-     * @tags OptionGreeks
-     * @name OgCalculateMatrix
-     * @summary Calculate matrix
-     * @request POST:/og/calculate-matrix
+     * @description get fundamentals by symbol data
+     * @tags Public
+     * @name GetPublicFundamentalsBySymbolData
+     * @summary get fundamentals by symbol data
+     * @request GET:/public/fundamentals/{symbol}
      * @secure
      */
-    ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
+    getPublicFundamentalsBySymbolData(symbol: string, query: {
+        /** Annual or quarterly */
+        mode: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
     /**
-     * @description Returns calculated params
-     * @tags OptionGreeks
-     * @name OgCalculateParams
-     * @summary Calculate params
-     * @request POST:/og/calculate-params
+     * @description Daily price history
+     * @tags Public
+     * @name DailyPriceHistory
+     * @summary Daily price history
+     * @request GET:/public/price-history/daily
      * @secure
      */
-    ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
+    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 AlphaTools<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -6331,19 +6487,6 @@ export class AlphaTools<HandleError extends boolean = boolean> {
      */
     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 TipRank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -6710,134 +6853,18 @@ export class TipRank<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
 }
-export class Public<HandleError extends boolean = boolean> {
+export class UsageTracking<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
+     * @description get usage date per branch for a period
+     * @tags UsageTracking
+     * @name GetUsageData
+     * @summary get insight usage data
+     * @request POST:/tracking/usage
      * @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>>;
+    getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
 }
 export interface InsightBeforeAndAfterV2 {
     after?: string;