@orbis-systems/orbis-api-clients 0.2.3 → 0.2.4

package/dist/index.d.ts

@@ -374,6 +374,44 @@ export interface InsightClassificationResponse {
     id: number;
     name: string;
 }
+export interface InsightCombainedProfileResponse {
+    address: string;
+    asset: string;
+    category: string;
+    city: string;
+    company_name: string;
+    country: string;
+    country_code: string;
+    earning_release: InsightEarningRelease;
+    email: string;
+    employees_number: number;
+    /** Index fields */
+    exchange: string;
+    exchange_name: string;
+    /** Fund fields */
+    expense_ratio: number;
+    fax: string;
+    fund_ownership_percent: number;
+    fund_type: string;
+    insider_ownership_percent: number;
+    institutional_ownership_percent: number;
+    inverse: boolean;
+    legal_company_name: string;
+    leverage: number;
+    logo: InsightSymbolLogosResponse;
+    long_description: string;
+    market_cap: number;
+    mic: string;
+    phone: string;
+    postal_code: string;
+    province: string;
+    sector: InsightSymbolIndustries;
+    short_company_name: string;
+    short_description: string;
+    structure: string;
+    symbol: string;
+    website: string;
+}
 export interface InsightCompaniesReview {
     average_return: number;
     company: string;
@@ -660,6 +698,15 @@ export interface InsightFixedIncome {
     type: string;
     updated_at: string;
 }
+export interface InsightFixedIncomePreset {
+    created_at: string;
+    id: string;
+    preset: Record<string, any>;
+    preset_color: string;
+    preset_description: string;
+    preset_name: string;
+    updated_at: string;
+}
 export interface InsightFundFilterAsset {
     asset_id?: string;
     asset_name?: string;
@@ -686,6 +733,28 @@ export interface InsightFundForHoldingWithQuote {
     symbol: string;
     volume: number;
 }
+export interface InsightFundScreenerQuote {
+    asset: string;
+    category: string;
+    dividend_amount: number;
+    dividend_ex_date: string;
+    dividend_pay_date: string;
+    dividend_percent: number;
+    expense_ratio: number;
+    fund_type: string;
+    inverse: boolean;
+    last_price: number;
+    leverage: number;
+    market_cap: number;
+    name: string;
+    price_change: number;
+    price_change_percent: number;
+    sectors: InsightSectorBreakdown[];
+    sponsor: string;
+    symbol: string;
+    /** Fill from quote when available */
+    volume: number;
+}
 export interface InsightFundScreenerRequest {
     assets?: string[];
     categories?: string[];
@@ -700,7 +769,7 @@ export interface InsightFundScreenerRequest {
 }
 export interface InsightFundScreenerResponse {
     count: number;
-    details: InsightFundSreenerQuote[];
+    details: InsightFundScreenerQuote[];
 }
 export interface InsightFundSector {
     sector_id: string;
@@ -718,28 +787,6 @@ export interface InsightFundSectorScreenerRequest {
     sector_code?: string;
     sponsors?: string[];
 }
-export interface InsightFundSreenerQuote {
-    asset: string;
-    category: string;
-    dividend_amount: number;
-    dividend_ex_date: string;
-    dividend_pay_date: string;
-    dividend_percent: number;
-    expense_ratio: number;
-    fund_type: string;
-    inverse: boolean;
-    last_price: number;
-    leverage: number;
-    market_cap: number;
-    name: string;
-    price_change: number;
-    price_change_percent: number;
-    sectors: InsightSectorBreakdown[];
-    sponsor: string;
-    symbol: string;
-    /** Fill from quote when available */
-    volume: number;
-}
 export interface InsightFutureIPO {
     currency: string;
     market: string;
@@ -902,6 +949,12 @@ export interface InsightGetIndustriesPerformanceRequest {
     /** price-weighted, market-weighted */
     ranking_type?: string;
 }
+export interface InsightGetIndustriesPerformanceResponse {
+    best_performing_quotes: InsightStockScreenerQuote[];
+    industries: InsightIndustryGroup[];
+    sectors: InsightSector[];
+    worst_performing_quotes: InsightStockScreenerQuote[];
+}
 export interface InsightGetMarketDatesRequest {
     end_date?: string;
     markets?: string[];
@@ -945,6 +998,11 @@ export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
     paging?: InsightPaging;
     symbols?: string[];
 }
+export interface InsightGetScreenerPresetsResponse {
+    count: number;
+    default_presets: InsightScreenerPreset[];
+    details: InsightScreenerPreset[];
+}
 export interface InsightGetSymbolFundamentalsRequest {
     mode?: string;
     symbol?: string;
@@ -1161,6 +1219,15 @@ export interface InsightIncludeExclude {
     exclude?: string[];
     include?: string[];
 }
+export interface InsightIndustryGroup {
+    industry_group_code: string;
+    industry_group_market_cap: number;
+    industry_group_market_cap_1day: number;
+    industry_group_market_cap_1month: number;
+    industry_group_market_cap_1week: number;
+    industry_group_market_cap_2week: number;
+    industry_group_name: string;
+}
 export interface InsightInsidersBestPerformingExpertDistribution {
     buy: number;
     hold: number;
@@ -1512,6 +1579,16 @@ export interface InsightNewsImage {
     size: string;
     url: string;
 }
+export interface InsightNewsPreview {
+    created: string;
+    id: string;
+    image: InsightNewsImage[];
+    is_body_empty: boolean;
+    is_press_release: boolean;
+    teaser: string;
+    title: string;
+    updated: string;
+}
 export interface InsightNewsRequest {
     id?: string;
 }
@@ -1757,6 +1834,9 @@ export interface InsightRecentIPOListRequest {
     quote_access_type?: string;
     time?: string;
 }
+export interface InsightRecentNewsPreviewsResponse {
+    news: InsightNewsPreview[];
+}
 export interface InsightRegion {
     id: string;
     name: string;
@@ -1780,6 +1860,15 @@ export interface InsightRewriteFieldValueRequest {
     new_value?: any;
     symbol?: string;
 }
+export interface InsightScreenerPreset {
+    created_at: string;
+    id: string;
+    preset: Record<string, any>;
+    preset_color: string;
+    preset_description: string;
+    preset_name: string;
+    updated_at: string;
+}
 export interface InsightSearchArticleRequest {
     /** (REQUIRE) */
     language?: string;
@@ -1809,6 +1898,16 @@ export interface InsightSeasonalityRequest {
     years?: number;
 }
 export type InsightSeasonalityResponse = Record<string, InsightSeasonalityEntry>;
+export interface InsightSector {
+    industry_groups: InsightIndustryGroup[];
+    sector_code: string;
+    sector_market_cap: number;
+    sector_market_cap_1day: number;
+    sector_market_cap_1month: number;
+    sector_market_cap_1week: number;
+    sector_market_cap_2week: number;
+    sector_name: string;
+}
 export interface InsightSectorBreakdown {
     breakdown: string;
     code: string;
@@ -2382,7 +2481,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
         symbol: string;
         /** Desired symbol type - [ANY,FUND,EQUITY] */
         symbol_type?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCompanyProfileResponse, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombainedProfileResponse, HandleError>>;
     /**
      * @description sort input array of symbols by type
      * @tags CompanyProfile
@@ -2447,9 +2546,9 @@ export class CustomLists<HandleError extends boolean = boolean> {
      */
     getCustomList(id: string, query: {
         /** sort direction - asc or desc */
-        order_direction: number;
+        order_direction: string;
         /** sort field  - volume, symbol(alphabetical), market_cap, dividend_percent */
-        order_field: number;
+        order_field: string;
         /** how many equities records to return. Max value is 50 */
         limit: number;
         /** how many equities records to skip */
@@ -2562,6 +2661,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      * @name FixedIncomeHistorical
      * @summary Get historical fixed income
      * @request POST:/fixed-income/historical
+     * @secure
      */
     fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
     /**
@@ -2577,7 +2677,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
         limit: number;
         /** how many records to skip */
         offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
     /**
      * @description update fixed-income preset
      * @tags FixedIncome
@@ -2586,7 +2686,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      * @request PUT:/fixed-income/presets
      * @secure
      */
-    updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncomePreset, HandleError>>;
     /**
      * @description create fixed-income preset
      * @tags FixedIncome
@@ -2595,7 +2695,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      * @request POST:/fixed-income/presets
      * @secure
      */
-    createOrFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    createOrFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncomePreset, HandleError>>;
     /**
      * @description remove fixed-income preset
      * @tags FixedIncome
@@ -2615,11 +2715,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
      */
     getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
 }
-export interface InsightStockMarketHeatmapEntryV2 {
-    price_change_percent: number;
-    symbol: string;
-    title: string;
-}
 export interface InsightBeforeAndAfterV2 {
     after?: string;
     before?: string;
@@ -2766,11 +2861,6 @@ export interface InsightPagingV2 {
     limit: number;
     offset: number;
 }
-export interface InsightStockMarketHeatmapResponseV2 {
-    details: InsightStockMarketHeatmapEntryV2[];
-    max_change: number;
-    min_change: number;
-}
 export interface InsightStockScreenerQuoteV2 {
     average_volume_30d: number;
     company_name: string;
@@ -2809,9 +2899,12 @@ export interface InsightStockScreenerRequestV2 {
     stock_type?: string;
     volume?: InsightLessAndMoreV2;
 }
-export interface InsightStockScreenerResponseV2 {
-    count: number;
-    details: InsightStockScreenerQuoteV2[];
+export interface InsightStockScreenerV2ResponseV2 {
+    current_page: number;
+    data: InsightStockScreenerQuoteV2[];
+    page_count: number;
+    status: number;
+    total_records: number;
 }
 /** @default "asc" */
 export enum InsightOrderingV2DirectionEnumV2 {
@@ -2886,12 +2979,12 @@ export class Funds<HandleError extends boolean = boolean> {
     /**
      * @description get fund screener filters
      * @tags Funds
-     * @name GetSreenerFilters
+     * @name GetScreenerFilters
      * @summary get fund screener filters
      * @request GET:/funds/screener/filters
      * @secure
      */
-    getSreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
+    getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
     /**
      * @description filter funds by params
      * @tags Funds
@@ -3056,7 +3149,7 @@ export class Logos<HandleError extends boolean = boolean> {
     logosSocialSymbolLogos(query: {
         /** Company symbol */
         symbol: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse[], HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
     /**
      * @description Returns logos for company symbol
      * @tags Logos
@@ -3104,6 +3197,7 @@ export class News<HandleError extends boolean = boolean> {
      * @name NewsAvailableAuthors
      * @summary Get available authors in DB (for filters)
      * @request POST:/news/authors
+     * @secure
      */
     newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
     /**
@@ -3112,6 +3206,7 @@ export class News<HandleError extends boolean = boolean> {
      * @name NewsAvailableChannels
      * @summary Get available channels in DB (for filters)
      * @request POST:/news/channels
+     * @secure
      */
     newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
     /**
@@ -3120,6 +3215,7 @@ export class News<HandleError extends boolean = boolean> {
      * @name NewsFiltered
      * @summary Get filtered news
      * @request POST:/news/filter
+     * @secure
      */
     newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
     /**
@@ -3128,14 +3224,36 @@ export class News<HandleError extends boolean = boolean> {
      * @name NewsById
      * @summary Get news by id
      * @request POST:/news/id
+     * @secure
      */
     newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
+    /**
+     * @description Returns news previews
+     * @tags News
+     * @name NewsPreviewsFiltered
+     * @summary Get news previews
+     * @request GET:/news/previews
+     * @secure
+     */
+    newsPreviewsFiltered(query: {
+        /** Start date */
+        start_date?: string;
+        /** End date */
+        end_date?: string;
+        /** Symbol */
+        symbol?: string;
+        /** how many records to return. Max value is 50 */
+        limit: number;
+        /** how many records to skip */
+        offset: number;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
     /**
      * @description Returns available stocks in DB
      * @tags News
      * @name NewsAvailableStocks
      * @summary Get available stocks in DB (for filters)
      * @request GET:/news/symbols
+     * @secure
      */
     newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
     /**
@@ -3144,6 +3262,7 @@ export class News<HandleError extends boolean = boolean> {
      * @name NewsAvailableTags
      * @summary Get available tags in DB (for filters)
      * @request POST:/news/tags
+     * @secure
      */
     newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
 }
@@ -3342,6 +3461,22 @@ export class Public<HandleError extends boolean = boolean> {
         /** 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
@@ -3437,7 +3572,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
      * @request POST:/industries-performance
      * @secure
      */
-    industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
     /**
      * @description filter stocks by params
      * @tags StockScreener
@@ -3463,7 +3598,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
         limit: number;
         /** how many records to skip */
         offset: number;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
     /**
      * @description update screener preset
      * @tags StockScreener
@@ -3472,7 +3607,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
      * @request PUT:/stock-screener/presets
      * @secure
      */
-    updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
     /**
      * @description create screener preset
      * @tags StockScreener
@@ -3481,7 +3616,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
      * @request POST:/stock-screener/presets
      * @secure
      */
-    createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
     /**
      * @description remove screener preset
      * @tags StockScreener
@@ -3499,7 +3634,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
      * @request POST:/stock-screener/top
      * @secure
      */
-    getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
+    getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
 }
 export class StockScreenerV2<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -3512,7 +3647,7 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
      * @request POST:/stock-screener
      * @secure
      */
-    stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
+    stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerV2ResponseV2, HandleError>>;
     /**
      * @description get top symbols
      * @tags StockScreener
@@ -3521,7 +3656,7 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
      * @request POST:/stock-screener/top
      * @secure
      */
-    getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponseV2, HandleError>>;
+    getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerV2ResponseV2, HandleError>>;
 }
 export class TipRank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;