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

package/dist/insight/index.d.ts

@@ -637,22 +637,8 @@ export interface InsightCreateOrUpdateFundScreenerPresetRequest {
     preset_description?: string;
     preset_name: string;
 }
-export interface InsightCreateOrUpdateMarketDateRequest {
-    /** @example "16:00" */
-    close_time: string;
-    /** @example false */
-    holiday?: boolean;
-    /** @example "U" */
-    market_code: string;
-    /** @example "2023-01-01" */
-    open_date: string;
-    /** @example "09:30" */
-    open_time: string;
-    /** @example "America/New_York" */
-    timezone: string;
-}
 export interface InsightCreateOrUpdateMarketRequest {
-    /** @example "US" */
+    /** @example "USA" */
     country_code: string;
     /** @example "USD" */
     currency_code: string;
@@ -662,17 +648,21 @@ export interface InsightCreateOrUpdateMarketRequest {
     market_name: string;
     /** @example true */
     primary_market?: boolean;
+    /** @example "America/New_York" */
+    timezone: string;
 }
 export interface InsightCreateOrUpdateMarketScheduleRequest {
-    friday?: InsightMarketSchedule;
     /** @example "U" */
     market_code: string;
-    monday?: InsightMarketSchedule;
-    saturday?: InsightMarketSchedule;
-    sunday?: InsightMarketSchedule;
-    thursday?: InsightMarketSchedule;
-    tuesday?: InsightMarketSchedule;
-    wednesday?: InsightMarketSchedule;
+    schedule?: {
+        friday?: InsightMarketScheduleEntry[];
+        monday?: InsightMarketScheduleEntry[];
+        saturday?: InsightMarketScheduleEntry[];
+        sunday?: InsightMarketScheduleEntry[];
+        thursday?: InsightMarketScheduleEntry[];
+        tuesday?: InsightMarketScheduleEntry[];
+        wednesday?: InsightMarketScheduleEntry[];
+    };
 }
 export interface InsightCreateOrUpdateScreenerPresetRequest {
     id?: string;
@@ -1298,30 +1288,21 @@ export interface InsightGetMarketDatesResponse {
 }
 export interface InsightGetMarketHoursResponse {
     close_time: string;
+    market: InsightMarket;
     next_market_day: InsightMarketDate;
     open_right_now: boolean;
     open_time: string;
     open_today: boolean;
-    schedule: InsightGetMarketScheduleResponse;
-    time_zone: string;
+    schedule: InsightWeeklyMarketSchedule;
+    timezone: string;
 }
 export interface InsightGetMarketScheduleResponse {
-    /** @example "2023-01-01T00:00:00Z" */
-    created_at: string;
-    friday: InsightMarketSchedule;
     market: InsightMarket;
-    monday: InsightMarketSchedule;
-    saturday: InsightMarketSchedule;
-    sunday: InsightMarketSchedule;
-    thursday: InsightMarketSchedule;
-    tuesday: InsightMarketSchedule;
-    /** @example "2023-01-01T00:00:00Z" */
-    updated_at: string;
-    wednesday: InsightMarketSchedule;
+    schedule: InsightWeeklyMarketSchedule;
 }
 export interface InsightGetMarketsResponse {
     count: number;
-    data: InsightMarket[];
+    data: InsightMarketWithSchedule[];
 }
 export interface InsightGetOwnershipsByIDRequest {
     /** @example "123e4567-e89b-12d3-a456-426614174000" */
@@ -3193,6 +3174,8 @@ export interface InsightMarket {
     market_name: string;
     /** @example true */
     primary_market: boolean;
+    /** @example "America/New_York" */
+    timezone: string;
     /** @example "2023-01-01T00:00:00Z" */
     updated_at: string;
 }
@@ -3202,23 +3185,37 @@ export interface InsightMarketCapBreakdown {
 }
 export interface InsightMarketDate {
     close_time: string;
-    country_code: string;
-    currency_code: string;
     holiday: boolean;
     market_code: string;
-    market_name: string;
+    name: string;
     open_date: string;
     open_time: string;
-    primary_market: boolean;
     timezone: string;
 }
-export interface InsightMarketSchedule {
+export interface InsightMarketDates {
+    /** @example "16:00" */
+    close_time: string;
+    /** @example false */
+    holiday: boolean;
+    /** @example "U" */
+    market_code: string;
+    /** @example "name" */
+    name: string;
+    /** @example "2023-01-01" */
+    open_date: string;
+    /** @example "09:30" */
+    open_time: string;
+}
+export interface InsightMarketScheduleEntry {
     /** @example "16:00" */
     close_time: string;
     /** @example "09:30" */
     open_time: string;
-    /** @example "America/New_York" */
-    timezone: string;
+}
+export interface InsightMarketWithSchedule {
+    market: InsightMarket;
+    open_right_now: boolean;
+    schedule: InsightWeeklyMarketSchedule;
 }
 export interface InsightMatrixData {
     date: InsightDate;
@@ -3873,6 +3870,11 @@ export interface InsightSearchArticleRequest {
     /** @example "all" */
     type: InsightArticleSearchType;
 }
+export interface InsightSearchLocodeDataResponse {
+    countries: InsightCountryEntry[];
+    currencies: InsightCurrencyEntry[];
+    timezones: InsightTimezoneEntry[];
+}
 export interface InsightSeasonalityEntry {
     april: InsightTickerSeasonality;
     august: InsightTickerSeasonality;
@@ -4377,6 +4379,19 @@ export interface InsightValuation {
     price_to_sales_ratio: number;
     trailing_price_to_earnings_ratio: number;
 }
+export interface InsightWeeklyMarketSchedule {
+    /** @example "2023-01-01T00:00:00Z" */
+    created_at: string;
+    friday: InsightMarketScheduleEntry[];
+    monday: InsightMarketScheduleEntry[];
+    saturday: InsightMarketScheduleEntry[];
+    sunday: InsightMarketScheduleEntry[];
+    thursday: InsightMarketScheduleEntry[];
+    tuesday: InsightMarketScheduleEntry[];
+    /** @example "2023-01-01T00:00:00Z" */
+    updated_at: string;
+    wednesday: InsightMarketScheduleEntry[];
+}
 export interface InsightYearlyData {
     benchmark_average: number;
     date: number;
@@ -4396,6 +4411,22 @@ export interface InsightYearlyPerformance {
     performance: number;
     year: number;
 }
+export interface InsightCountryEntry {
+    a2code: string;
+    a3code: string;
+    country: string;
+}
+export interface InsightCurrencyEntry {
+    code: string;
+    country: string;
+    currency: string;
+}
+export interface InsightTimezoneEntry {
+    label: string;
+    name: string;
+    tz_code: string;
+    utc: string;
+}
 export interface InsightEquityDataResponse {
     ask_px: number;
     ask_sz: number;
@@ -4598,6 +4629,11 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+/** filter by active status */
+export enum InsightGetPreIpoCompaniesParamsIsActiveEnum {
+    True = "true",
+    False = "false"
+}
 /** sort field */
 export enum InsightGetPreIpoCompaniesParamsOrderFieldEnum {
     Id = "id",
@@ -4691,6 +4727,12 @@ export enum InsightGetPreIpoCompanySpvsParamsFieldEnum {
     Valuation = "valuation",
     MinCommitmentAmount = "min_commitment_amount"
 }
+/** Search field */
+export enum InsightSearchLocodeDataParamsFieldEnum {
+    CountryName = "country.name",
+    CurrencyCountry = "currency.country",
+    TimezoneLabel = "timezone.label"
+}
 /** EQUITY|ETF|CRYPTO */
 export enum InsightTopStocksParamsStockTypeEnum {
     EQUITY = "EQUITY",
@@ -5407,6 +5449,19 @@ 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>);
@@ -5446,19 +5501,6 @@ 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>);
@@ -5509,6 +5551,18 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
         name?: string;
         /** search by categories */
         categories?: string;
+        /** search by listing type */
+        listing_type?: string;
+        /** filter by active status */
+        is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
+        /** filter by minimum last valuation */
+        min_last_valuation?: number;
+        /** filter by maximum last valuation */
+        max_last_valuation?: number;
+        /** filter by minimum total funding */
+        min_total_funding?: number;
+        /** filter by maximum total funding */
+        max_total_funding?: number;
         /** how many records to return. Max value is 50 */
         limit: number;
         /** how many records to skip */
@@ -5886,7 +5940,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @request POST:/market-dates
      * @secure
      */
-    createOrUpdateMarketDate(market: InsightCreateOrUpdateMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate, HandleError>>;
+    createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
     /**
      * @description Remove market date
      * @tags MarketDates
@@ -5905,6 +5959,20 @@ export class MarketDates<HandleError extends boolean = boolean> {
      * @secure
      */
     getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
+    /**
+     * @description Search locode data by search string and field
+     * @tags MarketDates
+     * @name SearchLocodeData
+     * @summary Search locode data
+     * @request GET:/market-dates/locode
+     * @secure
+     */
+    searchLocodeData(query?: {
+        /** Search string */
+        search?: string;
+        /** Search field */
+        field?: InsightSearchLocodeDataParamsFieldEnum;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
     /**
      * @description Get markets
      * @tags MarketDates
@@ -6139,50 +6207,6 @@ 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>);
@@ -6241,6 +6265,85 @@ 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 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 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 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>);
@@ -6607,41 +6710,6 @@ export class TipRank<HandleError extends boolean = boolean> {
         Authorization?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], 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 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 Public<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);