@orbis-systems/orbis-api-clients 0.6.2 → 0.6.4

package/dist/insight/index.d.ts

@@ -242,9 +242,15 @@ export interface InsightArticleBody {
     type: string;
 }
 export interface InsightArticleByIDRequest {
-    /** (REQUIRE) */
+    /**
+     * (REQUIRE)
+     * @example 15035
+     */
     ID?: number;
-    /** (REQUIRE) */
+    /**
+     * (REQUIRE)
+     * @example "eng"
+     */
     language?: string;
 }
 export interface InsightArticleFeaturedImage {
@@ -264,7 +270,7 @@ export interface InsightArticleFeaturedImageInfo {
 }
 export interface InsightArticlesRequest {
     /** @example 10 */
-    count: number;
+    count?: number;
     /** @example "eng" */
     language: string;
     /** @example 1609459200 */
@@ -353,17 +359,17 @@ export interface InsightCalculateEstimatedReturnsResponse {
     total_value: number;
 }
 export interface InsightCalculateMatrixParamsRequest {
-    expiry_date: InsightDate;
+    expiry_date?: InsightDate;
     /** @example 10 */
-    max_intervals: number;
+    max_intervals?: number;
     /** @example "c" */
     option_type?: InsightCalculateMatrixParamsRequestOptionTypeEnum;
     /** @example 160 */
-    stock_price_max: number;
+    stock_price_max?: number;
     /** @example 140 */
-    stock_price_min: number;
+    stock_price_min?: number;
     /** @example 155 */
-    strike_value: number;
+    strike_value?: number;
     /** @example "AAPL" */
     ticker: string;
 }
@@ -372,13 +378,13 @@ export interface InsightCalculateMatrixResponse {
     ticker_data: InsightTickerData;
 }
 export interface InsightCalculateParamsRequest {
-    expiry_date: InsightDate;
+    expiry_date?: InsightDate;
     /** @example "c" */
     option_type?: InsightCalculateParamsRequestOptionTypeEnum;
     /** @example 150.25 */
-    stock_price: number;
+    stock_price?: number;
     /** @example 155 */
-    strike_value: number;
+    strike_value?: number;
     /** @example "AAPL" */
     ticker: string;
 }
@@ -432,7 +438,7 @@ export interface InsightCombainedProfileResponse {
     /** @example 36.403 */
     fund_ownership_percent: number;
     /** @example "EQUITY" */
-    fund_type: string;
+    fund_type: InsightCombainedProfileResponseFundTypeEnum;
     /** @example 0.392 */
     insider_ownership_percent: number;
     /** @example 39.768 */
@@ -564,9 +570,9 @@ export interface InsightCreateFeaturedArticlesRequest {
     /** @example 1 */
     source_id: number;
     /** @example ["AAPL","GOOGL"] */
-    symbols: string[];
+    symbols?: string[];
     /** @example ["News","Update"] */
-    tags: string[];
+    tags?: string[];
     /**
      * @maxLength 1000
      * @example "This is a teaser for the breaking news"
@@ -591,16 +597,16 @@ export interface InsightCreateHeatmapPresetRequest {
 export interface InsightCreateOrUpdateFixedIncomePresetRequest {
     id?: string;
     preset?: InsightGetFixedIncomeEntriesRequest;
-    preset_color?: string;
+    preset_color: string;
     preset_description?: string;
-    preset_name?: string;
+    preset_name: string;
 }
 export interface InsightCreateOrUpdateScreenerPresetRequest {
     id?: string;
     preset?: InsightStockScreenerRequest;
-    preset_color?: string;
+    preset_color: string;
     preset_description?: string;
-    preset_name?: string;
+    preset_name: string;
 }
 export interface InsightCreateRegionRequest {
     regions: InsightRegion[];
@@ -799,7 +805,7 @@ export interface InsightFeaturedArticle {
     updated: string;
 }
 export interface InsightFilterCustomIndexesRequest {
-    paging?: InsightPaging;
+    paging: InsightPaging;
     symbols?: string[];
 }
 export interface InsightFilteredCustomIndexResponse {
@@ -946,12 +952,14 @@ export interface InsightFundScreenerQuote {
 export interface InsightFundScreenerRequest {
     assets?: string[];
     categories?: string[];
-    fund_type?: string;
-    inverse?: string;
-    leverage?: string;
+    /** @example "ETF" */
+    fund_type: InsightFundScreenerRequestFundTypeEnum;
+    /** @example "ANY" */
+    inverse: InsightFundScreenerRequestInverseEnum;
+    /** @example "ANY" */
+    leverage: InsightFundScreenerRequestLeverageEnum;
     market_cap?: InsightLessAndMore;
-    paging?: InsightPaging;
-    quote_access_type?: string;
+    paging: InsightPaging;
     sectors?: InsightSectorFilter[];
     sponsors?: string[];
 }
@@ -967,11 +975,12 @@ export interface InsightFundSectorScreenerRequest {
     dividend_percent?: InsightLessAndMore;
     exposure?: InsightLessAndMore;
     holdings?: string[];
-    inverse?: string;
-    leverage?: string;
+    /** @example "ANY" */
+    inverse: InsightFundSectorScreenerRequestInverseEnum;
+    /** @example "ANY" */
+    leverage: InsightFundSectorScreenerRequestLeverageEnum;
     order?: InsightOrdering;
-    paging?: InsightPaging;
-    quote_access_type?: string;
+    paging: InsightPaging;
     sector_code?: string;
     sponsors?: string[];
 }
@@ -1118,10 +1127,13 @@ export interface InsightGetFixedIncomeHistoricalData {
     yield_to_worst: number;
 }
 export interface InsightGetFixedIncomeHistoricalRequest {
-    end?: string;
-    frequency?: string;
-    instrument_id?: string;
-    start?: string;
+    /** @example "2023-01-31" */
+    end: string;
+    /** @example "1min" */
+    frequency: string;
+    instrument_id: string;
+    /** @example "2023-01-01" */
+    start: string;
 }
 export interface InsightGetFixedIncomeHistoricalResponse {
     data: InsightGetFixedIncomeHistoricalData[];
@@ -1179,17 +1191,25 @@ export interface InsightGetFundsForHoldingResponse {
     data: InsightFundForHoldingWithQuote[];
 }
 export interface InsightGetIndustriesPerformanceQuoteFilter {
-    /** ALL OR US(NYSE/Nasdaq/Amex) */
+    /**
+     * ALL OR US(NYSE/Nasdaq/Amex)
+     * @example "ALL"
+     */
     exchanges?: string;
     limit?: number;
-    /** last_price, price_change, volume */
+    /**
+     * last_price, price_change, volume
+     * @example "last_price"
+     */
     order?: string;
     price?: InsightLessAndMore;
 }
 export interface InsightGetIndustriesPerformanceRequest {
-    quote_access_type?: string;
     quote_filters?: InsightGetIndustriesPerformanceQuoteFilter;
-    /** price-weighted, market-weighted */
+    /**
+     * price-weighted, market-weighted
+     * @example "price-weighted"
+     */
     ranking_type?: string;
 }
 export interface InsightGetIndustriesPerformanceResponse {
@@ -1202,7 +1222,7 @@ export interface InsightGetMarketDatesRequest {
     /** @example "2023-12-31" */
     end_date: string;
     /** @example ["NYSE","NASDAQ"] */
-    markets: string[];
+    markets?: string[];
     paging: InsightPaging;
     /** @example "2023-01-01" */
     start_date: string;
@@ -1222,7 +1242,7 @@ export interface InsightGetMarketHoursResponse {
 export interface InsightGetOwnershipsByIDRequest {
     /** @example "123e4567-e89b-12d3-a456-426614174000" */
     owner_id: string;
-    paging?: InsightPaging;
+    paging: InsightPaging;
 }
 export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
     count: number;
@@ -2441,7 +2461,7 @@ export interface InsightGetTopSymbolsV1Request {
     exchange?: string[];
     market_cap?: InsightLessAndMore;
     order?: InsightOrdering;
-    paging?: InsightPaging;
+    paging: InsightPaging;
     price?: InsightLessAndMore;
     volume?: InsightLessAndMore;
 }
@@ -2915,7 +2935,8 @@ export interface InsightMover {
     ticker: string;
 }
 export interface InsightMultipleCryptoLogosRequest {
-    symbols?: string[];
+    /** @example ["BTC","ETH"] */
+    symbols: string[];
 }
 export interface InsightMultipleSymbolLogosRequest {
     /** @example ["AAPL","GOOGL","MSFT"] */
@@ -2968,7 +2989,7 @@ export interface InsightNewsFilterRequest {
     /** @example "John Doe" */
     author?: string;
     /** @example ["Finance","Technology"] */
-    channels: string[];
+    channels?: string[];
     /** @example "2023-12-31" */
     end_date?: string;
     /** @example true */
@@ -2979,9 +3000,9 @@ export interface InsightNewsFilterRequest {
     /** @example "2023-01-01" */
     start_date?: string;
     /** @example ["AAPL","GOOGL"] */
-    symbols: string[];
+    symbols?: string[];
     /** @example ["Earnings","Market"] */
-    tags: string[];
+    tags?: string[];
 }
 export interface InsightNewsImage {
     size: string;
@@ -3052,7 +3073,7 @@ export interface InsightNewsfeed {
 }
 export interface InsightNewsfeedRequest {
     /** @example 10 */
-    count: number;
+    count?: number;
     /** @example "eng" */
     language: string;
     /** @example 1609459200 */
@@ -3127,7 +3148,7 @@ export interface InsightPagination {
 export interface InsightPaging {
     /**
      * @min 1
-     * @max 100
+     * @max 50
      * @example 10
      */
     limit: number;
@@ -3244,7 +3265,7 @@ export interface InsightQuoteHistoryRequest {
     /** Use ONLY one of the next filters: TimeRange OR Period */
     filter: InsightQuoteHistoryRequestFilter;
     order?: InsightOrdering;
-    paging?: InsightPaging;
+    paging: InsightPaging;
 }
 export interface InsightQuoteHistoryRequestFilter {
     period?: InsightPeriodFilter;
@@ -3274,7 +3295,6 @@ export interface InsightRecentIPOListRequest {
     load_quotes?: boolean;
     order?: InsightOrdering;
     paging: InsightPaging;
-    quote_access_type?: string;
     /** @example "20y" */
     time: string;
 }
@@ -3491,7 +3511,7 @@ export interface InsightStockScreenerResponse {
     count: number;
     details: InsightStockScreenerQuote[];
 }
-export interface InsightStockScreenerV2Request {
+export interface InsightStockScreenerV1Request {
     average_volume_30d?: InsightLessAndMore;
     dividend_ex_date?: InsightBeforeAndAfter;
     dividend_pay_date?: InsightBeforeAndAfter;
@@ -3500,10 +3520,10 @@ export interface InsightStockScreenerV2Request {
     gap?: InsightLessAndMore;
     industry?: InsightIncludeExclude;
     market_cap?: InsightLessAndMore;
-    pagination?: InsightPagination;
+    order?: InsightOrdering;
+    paging: InsightPaging;
     pe_ratio?: InsightLessAndMore;
     price?: InsightLessAndMore;
-    sorts?: InsightOrdering[];
     /** @example "ADR" */
     stock_type?: string;
     volume?: InsightLessAndMore;
@@ -3760,12 +3780,35 @@ export interface InsightUnderwriteResponse {
     title: string;
 }
 export interface InsightUpdateCustomIndexRequest {
+    /**
+     * @maxLength 1000
+     * @example "description"
+     */
     description?: string;
+    /**
+     * @maxItems 1000
+     * @example ["equity1","equity2"]
+     */
     equities?: string[];
+    /**
+     * @maxItems 1000
+     * @example ["etf1","etf2"]
+     */
     etfs?: string[];
-    id?: string;
-    name?: string;
-    private_name?: string;
+    /** @example "123e4567-e89b-12d3-a456-426614174000" */
+    id: string;
+    /**
+     * @minLength 1
+     * @maxLength 1000
+     * @example "name"
+     */
+    name: string;
+    /**
+     * @minLength 1
+     * @maxLength 1000
+     * @example "private_name"
+     */
+    private_name: string;
 }
 export interface InsightUpdateFeaturedArticlesRequest {
     /** @example "123e4567-e89b-12d3-a456-426614174000" */
@@ -3775,9 +3818,9 @@ export interface InsightUpdateFeaturedArticlesRequest {
     /** @example 1 */
     source_id: number;
     /** @example ["AAPL","GOOGL"] */
-    symbols: string[];
+    symbols?: string[];
     /** @example ["News","Update"] */
-    tags: string[];
+    tags?: string[];
     /**
      * @maxLength 1000
      * @example "This is an updated teaser for the news"
@@ -3884,6 +3927,12 @@ export enum InsightCalculateParamsRequestOptionTypeEnum {
     C = "c",
     P = "p"
 }
+/** @example "EQUITY" */
+export enum InsightCombainedProfileResponseFundTypeEnum {
+    EQUITY = "EQUITY",
+    FUND = "FUND",
+    INDEX = "INDEX"
+}
 /** @example "normal" */
 export enum InsightCryptoLogoConvertedRequestConversionEnum {
     Original = "original",
@@ -3895,6 +3944,38 @@ export enum InsightCryptoLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** @example "ETF" */
+export enum InsightFundScreenerRequestFundTypeEnum {
+    ANY = "ANY",
+    ETF = "ETF",
+    MF = "MF"
+}
+/** @example "ANY" */
+export enum InsightFundScreenerRequestInverseEnum {
+    ANY = "ANY",
+    SHORT = "SHORT",
+    LONG = "LONG"
+}
+/** @example "ANY" */
+export enum InsightFundScreenerRequestLeverageEnum {
+    ANY = "ANY",
+    LEVERAGE_I = "LEVERAGE_I",
+    LEVERAGE_II = "LEVERAGE_II",
+    LEVERAGE_III = "LEVERAGE_III"
+}
+/** @example "ANY" */
+export enum InsightFundSectorScreenerRequestInverseEnum {
+    ANY = "ANY",
+    SHORT = "SHORT",
+    LONG = "LONG"
+}
+/** @example "ANY" */
+export enum InsightFundSectorScreenerRequestLeverageEnum {
+    ANY = "ANY",
+    LEVERAGE_I = "LEVERAGE_I",
+    LEVERAGE_II = "LEVERAGE_II",
+    LEVERAGE_III = "LEVERAGE_III"
+}
 /** @example "LEVERAGE_I" */
 export enum InsightGetFundsForHoldingRequestLeverageEnum {
     ANY = "ANY",
@@ -3976,6 +4057,19 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** EQUITY|ETF|CRYPTO */
+export enum InsightTopStocksParamsStockTypeEnum {
+    EQUITY = "EQUITY",
+    ETF = "ETF",
+    CRYPTO = "CRYPTO"
+}
+/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
+export enum InsightGetCombinedProfileParamsSymbolTypeEnum {
+    ANY = "ANY",
+    FUND = "FUND",
+    EQUITY = "EQUITY",
+    INDEX = "INDEX"
+}
 /** Level of detail on updated stocks */
 export enum InsightTiprankGeneralStockUpdatesParamsDetailsEnum {
     None = "none",
@@ -4039,8 +4133,8 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
     getCombinedProfile(query: {
         /** Company symbol */
         symbol: string;
-        /** Desired symbol type - [ANY,FUND,EQUITY] */
-        symbol_type?: string;
+        /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
+        symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombainedProfileResponse, HandleError>>;
     /**
      * @description sort input array of symbols by type
@@ -4498,7 +4592,7 @@ export interface InsightStockScreenerRequestV2 {
     gap?: InsightLessAndMoreV2;
     industry?: InsightIncludeExcludeV2;
     market_cap?: InsightLessAndMoreV2;
-    pagination?: InsightPaginationV2;
+    pagination: InsightPaginationV2;
     pe_ratio?: InsightLessAndMoreV2;
     price?: InsightLessAndMoreV2;
     sorts?: InsightOrderingV2[];
@@ -5066,7 +5160,7 @@ export class Public<HandleError extends boolean = boolean> {
      * @tags Public
      * @name GetPublicFundamentalsBySymbolData
      * @summary get fundamentals by symbol data
-     * @request GET:/public/fundamentals/:symbol
+     * @request GET:/public/fundamentals/{symbol}
      * @secure
      */
     getPublicFundamentalsBySymbolData(symbol: string, query: {
@@ -5092,7 +5186,7 @@ export class Public<HandleError extends boolean = boolean> {
      * @tags Public
      * @name PublicQuoteProfile
      * @summary Public quote profile
-     * @request GET:/public/quote-profile/:symbol
+     * @request GET:/public/quote-profile/{symbol}
      * @secure
      */
     publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
@@ -5101,7 +5195,7 @@ export class Public<HandleError extends boolean = boolean> {
      * @tags Public
      * @name GetPublicRatiosBySymbolData
      * @summary get ratios by symbol data
-     * @request GET:/public/ratios/:symbol
+     * @request GET:/public/ratios/{symbol}
      * @secure
      */
     getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
@@ -5147,7 +5241,7 @@ export class Public<HandleError extends boolean = boolean> {
      */
     topStocks(query: {
         /** EQUITY|ETF|CRYPTO */
-        stock_type: string;
+        stock_type: InsightTopStocksParamsStockTypeEnum;
         /** how many records to return. Max value is 50 */
         limit: number;
         /** how many records to skip */
@@ -5234,7 +5328,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
      * @request POST:/stock-screener
      * @secure
      */
-    stockScreener(filter: InsightStockScreenerV2Request, headers?: {
+    stockScreener(filter: InsightStockScreenerV1Request, headers?: {
         /** Authorization */
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;