@orbis-systems/orbis-api-clients 0.8.1 → 0.8.6

package/dist/aesmidas/index.d.ts

@@ -78,6 +78,34 @@ 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 */
@@ -1731,6 +1759,16 @@ export interface AesMidasOptionChain {
     ask_sz_fr?: number | null;
     /** @format double */
     volume_fr?: number | null;
+    /** @format double */
+    open_px?: number | null;
+    /** @format double */
+    high_px?: number | null;
+    /** @format double */
+    low_px?: number | null;
+    /** @format double */
+    yest_close_px?: number | null;
+    /** @format double */
+    close_px?: number | null;
 }
 export interface AesMidasOptionChainDates {
     dates_dictionary?: Record<string, string | null>;
@@ -2140,6 +2178,22 @@ export interface AesMidasSnapshot {
     volume_fr?: number | null;
     /** @format double */
     trade_sz_fr?: number | null;
+    /** @format double */
+    ask_px?: number;
+    /** @format int32 */
+    ask_sz?: number | null;
+    /** @format double */
+    bid_px?: number;
+    /** @format int32 */
+    bid_sz?: number | null;
+    /** @format double */
+    change?: number;
+    /** @format double */
+    change_percent?: number;
+    /** @format double */
+    bid_sz_fr?: number | null;
+    /** @format double */
+    ask_sz_fr?: number | null;
 }
 export interface AesMidasSnapshotCount {
     firm_id?: string | null;
@@ -2880,193 +2934,6 @@ 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 Firm<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Firm
-     * @name PostFirmList
-     * @summary Query all Firms in the system
-     * @request POST:/api/firm/firm-list
-     * @secure
-     */
-    postFirmList(data: AesMidasQueryPostBody, query?: {
-        /** firm_id, optional */
-        firm_id?: string;
-        /** firm name, fuzzy search, optional */
-        name?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
-    /**
-     * @tags Firm
-     * @name GetFirm
-     * @summary Query a specific Firm by firmid(short name)
-     * @request GET:/api/firm/firm
-     * @secure
-     */
-    getFirm(query: {
-        firm_id: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
-    /**
-     * @tags Firm
-     * @name PostFirm
-     * @summary Create a new Firm
-     * @request POST:/api/firm/firm
-     * @secure
-     */
-    postFirm(data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
-    /**
-     * @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
-     * @tags Firm
-     * @name PutFirm
-     * @summary Update an existing Firm setting
-     * @request PUT:/api/firm/firm
-     * @secure
-     */
-    putFirm(query: {
-        firm_id: string;
-    }, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
-     * @tags Firm
-     * @name GetFirmDataAccess
-     * @summary Get which data sources that a firm can access
-     * @request GET:/api/firm/firm-data-access
-     * @secure
-     */
-    getFirmDataAccess(query: {
-        firm_id: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
-    /**
-     * @tags Firm
-     * @name PostUmaFirmList
-     * @summary Get all firms from UMA - Super admin
-     * @request POST:/api/firm/uma-firm-list
-     * @secure
-     */
-    postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
-    /**
-     * @tags Firm
-     * @name GetSystemFirmDefaultData
-     * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
-     * @request GET:/api/firm/system-firm-default-data
-     * @secure
-     */
-    getSystemFirmDefaultData(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
-    /**
-     * @tags Firm
-     * @name PutSystemFirmDefaultData
-     * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
-     * @request PUT:/api/firm/system-firm-default-data
-     * @secure
-     */
-    putSystemFirmDefaultData(data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags Firm
-     * @name GetFirmDefaultData
-     * @summary Query a specific Firm Default Data Setting by firmid(short name)
-     * @request GET:/api/firm/firm-default-data
-     * @secure
-     */
-    getFirmDefaultData(query: {
-        firm_id: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
-    /**
-     * @description New default data must within firm data access availability
-     * @tags Firm
-     * @name PostFirmDefaultData
-     * @summary Create Firm Default Data setting for a specific firm
-     * @request POST:/api/firm/firm-default-data
-     * @secure
-     */
-    postFirmDefaultData(query: {
-        firm_id: string;
-    }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description New default data must within firm data access availability
-     * @tags Firm
-     * @name PutFirmDefaultData
-     * @summary Update an existing Firm Default Data setting
-     * @request PUT:/api/firm/firm-default-data
-     * @secure
-     */
-    putFirmDefaultData(query: {
-        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
- */
-    getApplyFirmDataToUsers(query: {
-        firm_id: 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 File<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags File
-     * @name PostUpload
-     * @summary upload file
-     * @request POST:/api/file/upload
-     * @secure
-     */
-    postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
-    /**
-     * @tags File
-     * @name GetDownload
-     * @summary download file by file id
-     * @request GET:/api/file/download
-     * @secure
-     */
-    getDownload(query: {
-        file_id: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
-}
 export class Entitlement<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3310,6 +3177,185 @@ export class Entitlement<HandleError extends boolean = boolean> {
         entitlement: string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
 }
+export class File<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags File
+     * @name PostUpload
+     * @summary upload file
+     * @request POST:/api/file/upload
+     * @secure
+     */
+    postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
+    /**
+     * @tags File
+     * @name GetDownload
+     * @summary download file by file id
+     * @request GET:/api/file/download
+     * @secure
+     */
+    getDownload(query: {
+        file_id: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
+}
+export class Firm<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Firm
+     * @name PostFirmList
+     * @summary Query all Firms in the system
+     * @request POST:/api/firm/firm-list
+     * @secure
+     */
+    postFirmList(data: AesMidasQueryPostBody, query?: {
+        /** firm_id, optional */
+        firm_id?: string;
+        /** firm name, fuzzy search, optional */
+        name?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
+    /**
+     * @tags Firm
+     * @name GetFirm
+     * @summary Query a specific Firm by firmid(short name)
+     * @request GET:/api/firm/firm
+     * @secure
+     */
+    getFirm(query: {
+        firm_id: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
+    /**
+     * @tags Firm
+     * @name PostFirm
+     * @summary Create a new Firm
+     * @request POST:/api/firm/firm
+     * @secure
+     */
+    postFirm(data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
+    /**
+     * @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
+     * @tags Firm
+     * @name PutFirm
+     * @summary Update an existing Firm setting
+     * @request PUT:/api/firm/firm
+     * @secure
+     */
+    putFirm(query: {
+        firm_id: string;
+    }, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
+     * @tags Firm
+     * @name GetFirmDataAccess
+     * @summary Get which data sources that a firm can access
+     * @request GET:/api/firm/firm-data-access
+     * @secure
+     */
+    getFirmDataAccess(query: {
+        firm_id: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
+    /**
+     * @tags Firm
+     * @name PostUmaFirmList
+     * @summary Get all firms from UMA - Super admin
+     * @request POST:/api/firm/uma-firm-list
+     * @secure
+     */
+    postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
+    /**
+     * @tags Firm
+     * @name GetSystemFirmDefaultData
+     * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
+     * @request GET:/api/firm/system-firm-default-data
+     * @secure
+     */
+    getSystemFirmDefaultData(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
+    /**
+     * @tags Firm
+     * @name PutSystemFirmDefaultData
+     * @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
+     * @request PUT:/api/firm/system-firm-default-data
+     * @secure
+     */
+    putSystemFirmDefaultData(data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags Firm
+     * @name GetFirmDefaultData
+     * @summary Query a specific Firm Default Data Setting by firmid(short name)
+     * @request GET:/api/firm/firm-default-data
+     * @secure
+     */
+    getFirmDefaultData(query: {
+        firm_id: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
+    /**
+     * @description New default data must within firm data access availability
+     * @tags Firm
+     * @name PostFirmDefaultData
+     * @summary Create Firm Default Data setting for a specific firm
+     * @request POST:/api/firm/firm-default-data
+     * @secure
+     */
+    postFirmDefaultData(query: {
+        firm_id: string;
+    }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description New default data must within firm data access availability
+     * @tags Firm
+     * @name PutFirmDefaultData
+     * @summary Update an existing Firm Default Data setting
+     * @request PUT:/api/firm/firm-default-data
+     * @secure
+     */
+    putFirmDefaultData(query: {
+        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
+ */
+    getApplyFirmDataToUsers(query: {
+        firm_id: 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> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags FundWebQuote
+     * @name GetFund
+     * @request GET:/api/fund/fund
+     * @secure
+     */
+    getFund(query: {
+        symbol: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
+    /**
+     * @tags FundWebQuote
+     * @name GetFundList
+     * @request GET:/api/fund/fund-list
+     * @secure
+     */
+    getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
+}
 export class Log<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -4812,26 +4858,6 @@ export class UmaTest<HandleError extends boolean = boolean> {
      */
     getB2CUserListToLocal(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
-export class FundWebQuote<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags FundWebQuote
-     * @name GetFund
-     * @request GET:/api/fund/fund
-     * @secure
-     */
-    getFund(query: {
-        symbol: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
-    /**
-     * @tags FundWebQuote
-     * @name GetFundList
-     * @request GET:/api/fund/fund-list
-     * @secure
-     */
-    getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
-}
 export class User<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);