@orbis-systems/orbis-api-clients 0.7.8 → 0.7.9

package/dist/insight/index.d.ts

@@ -765,6 +765,7 @@ export interface InsightExtendedFundData {
     closing_price: number;
     expense_ratio: number;
     factsheet_url: string;
+    fund_net_assets: number;
     fund_type: string;
     inverse: boolean;
     last_price: number;
@@ -3254,6 +3255,7 @@ export interface InsightPreIPOCompany {
     num_shares_outstanding: number;
     reference_price: number;
     reference_price_date: string;
+    symbol: string;
     total_funding: number;
     total_funding_rounds: number;
     twelve_month_trailing_revenue: number;
@@ -4553,90 +4555,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
      */
     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>);
-    /**
-     * @description get custom lists
-     * @tags Custom Lists
-     * @name GetCustomLists
-     * @summary get custom lists
-     * @request GET:/custom-lists
-     * @secure
-     */
-    getCustomLists(query: {
-        /** how many records to return. Max value is 50 */
-        limit: number;
-        /** how many records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
-    /**
-     * @description update custom list
-     * @tags Custom Lists
-     * @name UpdateCustomList
-     * @summary update custom list
-     * @request PUT:/custom-lists
-     * @secure
-     */
-    updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
-    /**
-     * @description create custom list
-     * @tags Custom Lists
-     * @name CreateCustomList
-     * @summary create custom list
-     * @request POST:/custom-lists
-     * @secure
-     */
-    createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
-    /**
-     * @description remove custom list
-     * @tags Custom Lists
-     * @name RemoveCustomList
-     * @summary remove custom list
-     * @request DELETE:/custom-lists
-     * @secure
-     */
-    removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description filter custom lists
-     * @tags Custom Lists
-     * @name FilterCustomLists
-     * @summary filter custom lists
-     * @request POST:/custom-lists/filter
-     * @secure
-     */
-    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
-    /**
-     * @description get custom list with quotes
-     * @tags Custom Lists
-     * @name GetCustomListWithQuotes
-     * @summary get custom list with quotes
-     * @request GET:/custom-lists/{id-or-slug}
-     * @secure
-     */
-    getCustomListWithQuotes(idOrSlug: string, query: {
-        /** sort direction - asc or desc */
-        order_direction: string;
-        /** sort field  - volume, symbol(alphabetical), market_cap, dividend_percent */
-        order_field: string;
-        /** how many equities records to return. Max value is 50 */
-        limit: number;
-        /** how many equities records to skip */
-        offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
-    /**
-     * @description filter custom list
-     * @tags Custom Lists
-     * @name FilterCustomList
-     * @summary filter custom list
-     * @request GET:/custom-lists/{id-or-slug}/filter
-     * @secure
-     */
-    filterCustomList(idOrSlug: string, query?: {
-        /** symbols to check inclusion */
-        symbols?: string[];
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
-}
 export class Dashboard<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4797,6 +4715,90 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      */
     getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
 }
+export class CustomLists<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description get custom lists
+     * @tags Custom Lists
+     * @name GetCustomLists
+     * @summary get custom lists
+     * @request GET:/custom-lists
+     * @secure
+     */
+    getCustomLists(query: {
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
+    /**
+     * @description update custom list
+     * @tags Custom Lists
+     * @name UpdateCustomList
+     * @summary update custom list
+     * @request PUT:/custom-lists
+     * @secure
+     */
+    updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
+    /**
+     * @description create custom list
+     * @tags Custom Lists
+     * @name CreateCustomList
+     * @summary create custom list
+     * @request POST:/custom-lists
+     * @secure
+     */
+    createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
+    /**
+     * @description remove custom list
+     * @tags Custom Lists
+     * @name RemoveCustomList
+     * @summary remove custom list
+     * @request DELETE:/custom-lists
+     * @secure
+     */
+    removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description filter custom lists
+     * @tags Custom Lists
+     * @name FilterCustomLists
+     * @summary filter custom lists
+     * @request POST:/custom-lists/filter
+     * @secure
+     */
+    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
+    /**
+     * @description get custom list with quotes
+     * @tags Custom Lists
+     * @name GetCustomListWithQuotes
+     * @summary get custom list with quotes
+     * @request GET:/custom-lists/{id-or-slug}
+     * @secure
+     */
+    getCustomListWithQuotes(idOrSlug: string, query: {
+        /** sort direction - asc or desc */
+        order_direction: string;
+        /** sort field  - volume, symbol(alphabetical), market_cap, dividend_percent */
+        order_field: string;
+        /** how many equities records to return. Max value is 50 */
+        limit: number;
+        /** how many equities records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
+    /**
+     * @description filter custom list
+     * @tags Custom Lists
+     * @name FilterCustomList
+     * @summary filter custom list
+     * @request GET:/custom-lists/{id-or-slug}/filter
+     * @secure
+     */
+    filterCustomList(idOrSlug: string, query?: {
+        /** symbols to check inclusion */
+        symbols?: string[];
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
+}
 export class Fundamentals<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -5083,7 +5085,16 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
      * @request GET:/ipos/market-data/ohlc/{symbol}
      * @secure
      */
-    monarkOghlcDataForSymbol(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
+    monarkOghlcDataForSymbol(symbol: string, query?: {
+        /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
+        from?: string;
+        /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
+        to?: string;
+        /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
+        interval?: string;
+        /** Limit the number of OHLC data points returned. Default is 100. */
+        limit?: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
         close?: number;
         high?: number;
         low?: number;
@@ -5627,27 +5638,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>;
@@ -6028,86 +6039,6 @@ export class UsageTracking<HandleError extends boolean = boolean> {
      */
     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>);
-    /**
-     * @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>);
@@ -6234,6 +6165,86 @@ export class Public<HandleError extends boolean = boolean> {
         offset: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, 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>);
+    /**
+     * @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 interface InsightBeforeAndAfterV2 {
     after?: string;
     before?: string;