@orbis-systems/orbis-api-clients 0.6.6 → 0.6.7

package/dist/insight/index.d.ts

@@ -4188,6 +4188,45 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
     Date = "date",
     Rank = "rank"
 }
+export class CompanyProfile<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get company profile, industries classification and closest earning release
+     * @tags CompanyProfile
+     * @name GetCompanyProfile
+     * @summary get company profile
+     * @request GET:/company-profile
+     * @secure
+     */
+    getCompanyProfile(query: {
+        /** Company symbol */
+        symbol: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
+    /**
+     * @description get combined profile, equities and funds
+     * @tags CompanyProfile
+     * @name GetCombinedProfile
+     * @summary get company profile
+     * @request GET:/quote-profile
+     * @secure
+     */
+    getCombinedProfile(query: {
+        /** Company symbol */
+        symbol: string;
+        /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
+        symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
+    /**
+     * @description sort input array of symbols by type
+     * @tags CompanyProfile
+     * @name GetSymbolsPerSymbolType
+     * @summary sort input array of symbols by type
+     * @request POST:/symbols-per-type
+     * @secure
+     */
+    getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
+}
 export class WorldMarkets<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4370,45 +4409,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
         id: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
-export class CompanyProfile<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description get company profile, industries classification and closest earning release
-     * @tags CompanyProfile
-     * @name GetCompanyProfile
-     * @summary get company profile
-     * @request GET:/company-profile
-     * @secure
-     */
-    getCompanyProfile(query: {
-        /** Company symbol */
-        symbol: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
-    /**
-     * @description get combined profile, equities and funds
-     * @tags CompanyProfile
-     * @name GetCombinedProfile
-     * @summary get company profile
-     * @request GET:/quote-profile
-     * @secure
-     */
-    getCombinedProfile(query: {
-        /** Company symbol */
-        symbol: string;
-        /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
-        symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
-    /**
-     * @description sort input array of symbols by type
-     * @tags CompanyProfile
-     * @name GetSymbolsPerSymbolType
-     * @summary sort input array of symbols by type
-     * @request POST:/symbols-per-type
-     * @secure
-     */
-    getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
-}
 export class CustomLists<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4581,6 +4581,19 @@ export class Earnings<HandleError extends boolean = boolean> {
      */
     getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, 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 FixedIncome<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4653,19 +4666,6 @@ 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>);
@@ -5005,33 +5005,6 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
      */
     getPreIpoCompanyResearchDocuments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, 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>>;
-}
 export class Logos<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5273,6 +5246,33 @@ export class News<HandleError extends boolean = boolean> {
      */
     newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], 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>>;
+}
 export class MarketDates<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5320,131 +5320,27 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
      */
     ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
 }
-export class Public<HandleError extends boolean = boolean> {
+export class AlphaTools<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 */
-        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
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetMomentumRatioGraph
+     * @summary get seasonlity data
+     * @request POST:/rst
      * @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>>;
+    getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
     /**
-     * @description Get top stocks
-     * @tags Public
-     * @name TopStocks
-     * @summary Top Stocks
-     * @request GET:/public/top-stocks
+     * @description get seasonlity data with comparison to benchmark
+     * @tags AlphaTools
+     * @name GetSeasonality
+     * @summary get seasonlity data
+     * @request POST:/seasonality
      * @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>>;
+    getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
 }
 export class TipRank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -5812,40 +5708,166 @@ export class TipRank<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
 }
-export class AlphaTools<HandleError extends boolean = boolean> {
+export class UsageTracking<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
+     * @description get usage date per branch for a period
+     * @tags UsageTracking
+     * @name GetUsageData
+     * @summary get insight usage data
+     * @request POST:/tracking/usage
      * @secure
      */
-    getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
+    getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
+}
+export class Ownerships<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description get seasonlity data with comparison to benchmark
-     * @tags AlphaTools
-     * @name GetSeasonality
-     * @summary get seasonlity data
-     * @request POST:/seasonality
+     * @description get ownerships by id datadata
+     * @tags Ownerships
+     * @name GetOwnershipsByIdData
+     * @summary get ownerships by id data
+     * @request POST:/ownerships
      * @secure
      */
-    getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
+    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 UsageTracking<HandleError extends boolean = boolean> {
+export class Public<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
+     * @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
      */
-    getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
+    calculateEstimatedReturns(query: {
+        /** Single symbol */
+        symbol: string;
+        /** Non-zero amount */
+        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 Passport<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -5905,28 +5927,6 @@ 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;