@orbis-systems/orbis-api-clients 0.8.7 → 0.8.9

package/dist/aesmidas/index.d.ts

@@ -78,34 +78,6 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
     protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
     protected renewTokens(): Promise<AuthData>;
 }
-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 */
@@ -315,6 +287,7 @@ export interface AesMidasBondReformat {
     isin?: string | null;
     cusip?: string | null;
     company_name?: string | null;
+    issue_market?: string | null;
     exchange?: string | null;
     market_description?: string | null;
     country?: string | null;
@@ -1427,6 +1400,7 @@ export interface AesMidasLevel1Reformat {
     isin?: string | null;
     cusip?: string | null;
     company_name?: string | null;
+    issue_market?: string | null;
     exchange?: string | null;
     market_description?: string | null;
     country?: string | null;
@@ -2154,6 +2128,7 @@ export interface AesMidasSignAgreement {
 }
 export interface AesMidasSnapshot {
     symbol?: string | null;
+    company_name?: string | null;
     issue_market?: string | null;
     /** @format double */
     yest_close_px?: number;
@@ -2934,6 +2909,34 @@ export class DataSource<HandleError extends boolean = boolean> {
         firm_id: string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
 }
+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 Entitlement<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3312,13 +3315,13 @@ 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 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
- */
+   * @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;
@@ -3386,8 +3389,8 @@ export class Log<HandleError extends boolean = boolean> {
      */
     postDataQueryLogByAction(query: {
         action: string;
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
     /**
      * @tags Log
@@ -3398,8 +3401,8 @@ export class Log<HandleError extends boolean = boolean> {
      */
     postDataQueryLogByDataSource(query: {
         data_source: string;
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
     /**
      * @tags Log
@@ -3409,8 +3412,8 @@ export class Log<HandleError extends boolean = boolean> {
      * @secure
      */
     getSnapshotCount(query: {
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
         market_hour_only?: boolean;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
     /**
@@ -3421,8 +3424,8 @@ export class Log<HandleError extends boolean = boolean> {
      * @secure
      */
     postSnapshotReport(query: {
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
         firm_id: string;
         exchange: string;
         market_hour_only?: boolean;
@@ -3445,8 +3448,8 @@ export class Log<HandleError extends boolean = boolean> {
     postModificationLogByAction(query: {
         /** To get available actions list, please call api/Log/modification-action-list. */
         action: string;
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
         /**
          * optional
          * @default ""
@@ -3462,8 +3465,8 @@ export class Log<HandleError extends boolean = boolean> {
      */
     getDataQueryLogByUsername(query: {
         username: string;
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
     /**
      * @tags Log
@@ -3474,8 +3477,8 @@ export class Log<HandleError extends boolean = boolean> {
      */
     getActionLogByUsername(query: {
         username: string;
-        'start_date(UTC)': string;
-        'end_date(UTC)': string;
+        "start_date(UTC)": string;
+        "end_date(UTC)": string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
 }
 export class Permission<HandleError extends boolean = boolean> {
@@ -4451,14 +4454,14 @@ export class Quote<HandleError extends boolean = boolean> {
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasNightSessionMarketHoliday[], HandleError>>;
     /**
- * @tags Quote
- * @name GetUsMasterFile
- * @summary Get US End of Day master file - All users - available in Microservice
-Streams upstream response directly to the client to reduce latency and memory usage.
-Adds short-lived cache to avoid repeated network calls.
- * @request GET:/api/quote/us-master-file
- * @secure
- */
+   * @tags Quote
+   * @name GetUsMasterFile
+   * @summary Get US End of Day master file - All users - available in Microservice
+  Streams upstream response directly to the client to reduce latency and memory usage.
+  Adds short-lived cache to avoid repeated network calls.
+   * @request GET:/api/quote/us-master-file
+   * @secure
+   */
     getUsMasterFile(query?: {
         /**
          * Optional. Must input if enterprise user query on behalf of their clients
@@ -4682,6 +4685,19 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags QuotesReformat
+     * @name GetEquitySnapshot
+     * @summary Query NBBO Snapshot - All users
+     * @request GET:/api/quotes/equity/snapshot
+     * @secure
+     */
+    getEquitySnapshot(query: {
+        /** Allow multiple symbols query, seperated by ',' */
+        symbols: string;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
     /**
      * @tags QuotesReformat
      * @name GetOption
@@ -5010,6 +5026,18 @@ export class User<HandleError extends boolean = boolean> {
     putUserDataConfig(query: {
         user_id: string;
     }, data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Pass target_firm_id to move, or omit/empty to unlink.
+     * @tags User
+     * @name PutUserFirm
+     * @summary Move a UMA user to a different firm or unlink from current firm
+     * @request PUT:/api/user/user-firm
+     * @secure
+     */
+    putUserFirm(query: {
+        user_id: string;
+        target_firm_id?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
      * @tags User
      * @name GetUserDataConfigById
@@ -5091,14 +5119,14 @@ 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
- */
+   * @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> {