@orbis-systems/orbis-api-clients 0.7.19 → 0.7.20

package/dist/aesmidas/index.d.ts

@@ -77,34 +77,6 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
     setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
     protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
 }
-export class BackgroundService<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags BackgroundService
-     * @name PostStart
-     * @summary Start the background service to sync UMA firms/users
-     * @request POST:/api/background-service/start
-     * @secure
-     */
-    postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags BackgroundService
-     * @name PostStop
-     * @summary Stop the background service to sync UMA firms/users
-     * @request POST:/api/background-service/stop
-     * @secure
-     */
-    postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags BackgroundService
-     * @name GetStatus
-     * @summary Check the status of the background service
-     * @request GET:/api/background-service/status
-     * @secure
-     */
-    getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-}
 export interface AesMidasActionLog {
     id?: string | null;
     /** @format date-time */
@@ -991,6 +963,14 @@ export interface AesMidasFundWebQuote {
     one_year_change_percent?: number;
     cusip?: string | null;
 }
+export interface AesMidasHistoricalBondChartApex {
+    /** @format date-time */
+    timestamp?: string;
+    /** @format double */
+    price?: number;
+    /** @format double */
+    yield_to_worst?: number;
+}
 export interface AesMidasICEEOD {
     symbol?: string | null;
     /** @format double */
@@ -1593,6 +1573,16 @@ export interface AesMidasNightSession {
     low_px?: number | null;
     /** @format double */
     closing_px?: number | null;
+    /** @format double */
+    yest_close_px?: number | null;
+    trade_region?: string | null;
+    /** @format int32 */
+    condition?: number | null;
+    /** @format double */
+    pre_last_px?: number | null;
+    pre_activity_timestamp?: string | null;
+    /** @format int32 */
+    column?: number | null;
     not_found?: boolean;
     source?: string | null;
 }
@@ -1739,7 +1729,7 @@ export interface AesMidasOptionL1 {
     quote_time?: string | null;
     underlying?: string | null;
     root_symbol?: string | null;
-    /** @format int32 */
+    /** @format double */
     strike?: number;
     /** @format int32 */
     prime_share?: number;
@@ -1773,15 +1763,61 @@ export interface AesMidasPermission {
 export interface AesMidasPolygonFMV {
     symbol?: string | null;
     /** @format double */
-    fmv?: number;
+    last_price?: number;
     update_time?: string | null;
     primary_exchange?: string | null;
-    mic?: string | null;
+    exchange?: string | null;
     currency?: string | null;
-    country_code?: string | null;
-    comp_name?: string | null;
+    country?: string | null;
+    company_name?: string | null;
     status?: string | null;
     info_time?: string | null;
+    /** @format double */
+    change?: number | null;
+    /** @format double */
+    change_percent?: number | null;
+    /** @format int64 */
+    volume?: number | null;
+    /** @format int64 */
+    market_cap?: number | null;
+    dividend_ex_date?: string | null;
+    dividend_payment_date?: string | null;
+    /** @format double */
+    price_earning_ratio?: number | null;
+    /** @format double */
+    yesterday_close?: number | null;
+    /** @format int64 */
+    average_volume30?: number | null;
+    /** @format double */
+    day_high?: number | null;
+    /** @format double */
+    day_low?: number | null;
+    /** @format double */
+    high52week?: number | null;
+    /** @format double */
+    low52week?: number | null;
+    /** @format double */
+    opening_price?: number | null;
+    /** @format double */
+    closing_price?: number | null;
+    /** @format double */
+    dividend_amount?: number | null;
+    /** @format double */
+    dividend_yield?: number | null;
+    /** @format double */
+    week_change?: number | null;
+    /** @format double */
+    week_change_percent?: number | null;
+    /** @format double */
+    month_change?: number | null;
+    /** @format double */
+    month_change_percent?: number | null;
+    /** @format double */
+    year_change?: number | null;
+    /** @format double */
+    year_change_percent?: number | null;
+    /** @format double */
+    earnings_per_share?: number | null;
     not_found?: boolean;
 }
 export interface AesMidasPolygonMinuteChart {
@@ -2203,12 +2239,12 @@ export interface AesMidasUMAB2BUser {
     /** @format int32 */
     id?: number;
     /** @format int32 */
-    initiator_id?: number;
+    initiator_id?: number | null;
     first_name?: string | null;
     last_name?: string | null;
     locale?: AesMidasUMALocale;
     /** @format int32 */
-    locale_id?: number;
+    locale_id?: number | null;
     mfa_enabled?: boolean;
     phone?: string | null;
     phone_verified?: boolean;
@@ -2216,9 +2252,10 @@ export interface AesMidasUMAB2BUser {
     should_reset_password?: boolean;
     updated_at?: string | null;
     username?: string | null;
+    status?: string | null;
+    firms?: AesMidasUMAUserFirm[] | null;
     big_avatar_url?: string | null;
     branches?: AesMidasUMABranch[] | null;
-    firms?: AesMidasUMAUserFirm[] | null;
     has_access_to_all_firm_branches?: boolean;
     microservices?: AesMidasUMAUserMicroservice[] | null;
     mode?: string | null;
@@ -2228,7 +2265,6 @@ export interface AesMidasUMAB2BUser {
     roles?: AesMidasUMARole[] | null;
     small_avatar_url?: string | null;
     theme?: string | null;
-    status?: string | null;
 }
 export interface AesMidasUMAB2BUserResponsewithPagination {
     /** @format int32 */
@@ -2250,12 +2286,12 @@ export interface AesMidasUMAB2CUser {
     /** @format int32 */
     id?: number;
     /** @format int32 */
-    initiator_id?: number;
+    initiator_id?: number | null;
     first_name?: string | null;
     last_name?: string | null;
     locale?: AesMidasUMALocale;
     /** @format int32 */
-    locale_id?: number;
+    locale_id?: number | null;
     mfa_enabled?: boolean;
     phone?: string | null;
     phone_verified?: boolean;
@@ -2263,12 +2299,12 @@ export interface AesMidasUMAB2CUser {
     should_reset_password?: boolean;
     updated_at?: string | null;
     username?: string | null;
-    branches?: AesMidasUMABranch[] | null;
+    status?: string | null;
     firms?: AesMidasUMAUserFirm[] | null;
+    branches?: AesMidasUMABranch[] | null;
     microservices?: AesMidasUMAUserMicroservice[] | null;
     permissions?: AesMidasUMAPermission[] | null;
     roles?: AesMidasUMARole[] | null;
-    status?: string | null;
 }
 export interface AesMidasUMAB2CUserResponsewithPagination {
     /** @format int32 */
@@ -2357,7 +2393,7 @@ export interface AesMidasUMAPermission {
     metadata?: AesMidasUMAMetadata;
     microservice?: AesMidasUMAUserMicroservice;
     /** @format int32 */
-    microservice_id?: number;
+    microservice_id?: number | null;
     permission?: string | null;
     updated_at?: string | null;
 }
@@ -2365,12 +2401,12 @@ export interface AesMidasUMARole {
     created_at?: string | null;
     firm?: AesMidasUMAFirmBasic;
     /** @format int32 */
-    firm_id?: number;
+    firm_id?: number | null;
     /** @format int32 */
     id?: number;
     microservice?: AesMidasUMAUserMicroservice;
     /** @format int32 */
-    microservice_id?: number;
+    microservice_id?: number | null;
     name?: string | null;
     permissions?: AesMidasUMAPermission[] | null;
     type?: AesMidasUMARoleType;
@@ -2632,6 +2668,34 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
     page_size?: number;
     data?: AesMidasUserMultiConditionResultResponse[] | null;
 }
+export class BackgroundService<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags BackgroundService
+     * @name PostStart
+     * @summary Start the background service to sync UMA firms/users
+     * @request POST:/api/background-service/start
+     * @secure
+     */
+    postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags BackgroundService
+     * @name PostStop
+     * @summary Stop the background service to sync UMA firms/users
+     * @request POST:/api/background-service/stop
+     * @secure
+     */
+    postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags BackgroundService
+     * @name GetStatus
+     * @summary Check the status of the background service
+     * @request GET:/api/background-service/status
+     * @secure
+     */
+    getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+}
 export class DataSource<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3113,15 +3177,28 @@ export class Firm<HandleError extends boolean = boolean> {
         firm_id: string;
     }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
-     * @tags Firm
-     * @name GetApplyFirmDataToUsers
-     * @summary Apply one firm data to all users in this firm - Firm manager, or super admin - available in Microservice
-     * @request GET:/api/firm/apply-firm-data-to-users
-     * @secure
-     */
+ * @tags Firm
+ * @name GetApplyFirmDataToUsers
+ * @summary Apply firm data to all users in this firm - Firm manager, or super admin - available in Microservice
+Can apply data_source, quote_type, or quote_level
+ * @request GET:/api/firm/apply-firm-data-to-users
+ * @secure
+ */
     getApplyFirmDataToUsers(query: {
         firm_id: string;
-        data_source: string;
+        data_source?: string;
+        /**
+         * @format int32
+         * @default -1
+         */
+        quote_type?: number;
+        /**
+         * @format int32
+         * @default -1
+         */
+        quote_level?: number;
+        /** @default false */
+        if_apply_to_default?: boolean;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
 export class FundWebQuote<HandleError extends boolean = boolean> {
@@ -3231,6 +3308,30 @@ export class Log<HandleError extends boolean = boolean> {
          */
         target_user?: string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
+    /**
+     * @tags Log
+     * @name GetDataQueryLogByUsername
+     * @summary Query data query logs by username and date range
+     * @request GET:/api/log/data-query-log-by-username
+     * @secure
+     */
+    getDataQueryLogByUsername(query: {
+        username: string;
+        'start_date(UTC)': string;
+        'end_date(UTC)': string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
+    /**
+     * @tags Log
+     * @name GetActionLogByUsername
+     * @summary Query action logs by username and date range
+     * @request GET:/api/log/action-log-by-username
+     * @secure
+     */
+    getActionLogByUsername(query: {
+        username: string;
+        'start_date(UTC)': string;
+        'end_date(UTC)': string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
 }
 export class Permission<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -3397,6 +3498,29 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetNightSessionRegionQuotesOnbbo
+     * @summary Query ONBBO Region Quotes(Level2) from Tick data - All users - available in Microservice
+     * @request GET:/api/quote/night-session/region-quotes/onbbo
+     * @secure
+     */
+    getNightSessionRegionQuotesOnbbo(query: {
+        /** Allow one symbol */
+        symbol: string;
+        /**
+         * Optional. Default is false. If true, response will be camel case
+         * @default false
+         */
+        response_camel_case?: boolean;
+        /**
+         * Optional. Must input if enterprise user query on behave of their clients
+         * @default ""
+         */
+        user_name?: string;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
     /**
      * @tags Quote
      * @name GetTimeSale
@@ -3420,6 +3544,29 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetNightSessionTimeSaleOnbbo
+     * @summary Query ONBBO TimeSale from Tick data - All users - available in Microservice
+     * @request GET:/api/quote/night-session/time-sale/onbbo
+     * @secure
+     */
+    getNightSessionTimeSaleOnbbo(query: {
+        /** Allow one symbol */
+        symbol: string;
+        /**
+         * Optional. Default is false. If true, response will be camel case
+         * @default false
+         */
+        response_camel_case?: boolean;
+        /**
+         * Optional. Must input if enterprise user query on behave of their clients
+         * @default ""
+         */
+        user_name?: string;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
     /**
      * @tags Quote
      * @name GetLastTrade
@@ -3443,6 +3590,29 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetNightSessionLastTradeOnbbo
+     * @summary Query ONBBO Last Trade(Level 2 data) - All users - available in Microservice
+     * @request GET:/api/quote/night-session/last-trade/onbbo
+     * @secure
+     */
+    getNightSessionLastTradeOnbbo(query: {
+        /** Allow multiple symbols query, seperated by ',' */
+        symbols: string;
+        /**
+         * Optional. Default is false. If true, response will be camel case
+         * @default false
+         */
+        response_camel_case?: boolean;
+        /**
+         * Optional. Must input if enterprise user query on behave of their clients
+         * @default ""
+         */
+        user_name?: string;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
     /**
      * @tags Quote
      * @name GetIntradayChart
@@ -3806,6 +3976,30 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondPagedResult, HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetBondsChart
+     * @summary Query Bonds historical chart data - All users - available in Microservice
+     * @request GET:/api/quote/bonds-chart
+     * @secure
+     */
+    getBondsChart(query: {
+        /** ISIN, only allow one symbol at a time */
+        isin: string;
+        /** Frequency of price observations. Supported frequencies and ranges are: 1day: EOD close prices - Maximum supported time range: 365 days. 15min: 15 minute interval prices - Maximum supported time range: 15 days. 1min: 1 minute tick prices.The number of price updates per day will differ based on the liquidity profile of the underlying bond(some bonds will only have a few updates throughout the day). The maximum update frequency is 2 updates per minute.In this case, we will aggregate by taking the later timestamp - Maximum supported time range: 1 day. */
+        frequency: string;
+        /** Filter data equal to or after this time in YYYY-MM-DD format. */
+        start: string;
+        /** Filter data equal to or before this time in YYYY-MM-DD format. */
+        end: string;
+        /**
+         * if response with camel case
+         * @default false
+         */
+        response_camel_case?: boolean;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasHistoricalBondChartApex[], HandleError>>;
     /**
      * @tags Quote
      * @name GetMutualFunds
@@ -4134,11 +4328,6 @@ export class Quote<HandleError extends boolean = boolean> {
     getPolygonFmv(query: {
         /** Allow multiple symbols, separated by ',' */
         symbols: string;
-        /**
-         * Optional. Default is false. If true, response will be camel case
-         * @default false
-         */
-        response_camel_case?: boolean;
         /**
          * Optional. Must input if enterprise user query on behave of their clients
          * @default ""
@@ -4281,6 +4470,8 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
          * @default false
          */
         loadQuotes?: boolean;
+        /** include countries. For example, if only want to display US symbols, please send 'US' in this parameter */
+        includeCountries?: string;
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
@@ -4522,7 +4713,7 @@ export class User<HandleError extends boolean = boolean> {
      * @request POST:/api/user/register-uma-b2c-user
      * @secure
      */
-    postRegisterUmaB2CUser(data: AesMidasUMAB2BUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    postRegisterUmaB2CUser(data: AesMidasUMAB2CUser, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
      * @tags User
      * @name PostUmaB2BUserList
@@ -4555,7 +4746,7 @@ export class User<HandleError extends boolean = boolean> {
      */
     postUsersByMultipleConditions(data: AesMidasQueryPostBody, query?: {
         /**
-         * firm id
+         * firm id, support multiple firms separated by ',', optional
          * @default ""
          */
         firm?: string;
@@ -4713,6 +4904,20 @@ export class WebSocket<HandleError extends boolean = boolean> {
      */
     getWssub(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
+export class WebSocketEvent<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+ * @tags WebSocketEvent
+ * @name GetWsevent
+ * @summary WebSocket endpoint for Redis event-based subscription mode
+Supports Polygon FMV subscriptions with optimized batch processing
+Uses optimized approach with Redis Keyspace Notifications for real-time updates
+ * @request GET:/wsevent
+ * @secure
+ */
+    getWsevent(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+}
 export class WsStream<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4737,6 +4942,7 @@ export class AesMidasApi<HandleError extends boolean = false> extends BaseApi<Ha
     quotesReformat: QuotesReformat<HandleError>;
     user: User<HandleError>;
     webSocket: WebSocket<HandleError>;
+    webSocketEvent: WebSocketEvent<HandleError>;
     wsStream: WsStream<HandleError>;
     constructor(config: JwtClientConfig<HandleError>);
 }