@orbis-systems/orbis-api-clients 0.7.14 → 0.7.16

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 */
@@ -2632,6 +2604,137 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
     page_size?: number;
     data?: AesMidasUserMultiConditionResultResponse[] | null;
 }
+export class DataSource<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description All parameters are optional
+     * @tags DataSource
+     * @name PostDataSourceList
+     * @summary Query all DataSources in the whole system with optional filters - All users
+     * @request POST:/api/datasource/data-source-list
+     * @secure
+     */
+    postDataSourceList(data: AesMidasQueryPostBody, query?: {
+        /** Datasource name */
+        name?: string;
+        /** entitlement name */
+        entitlement?: string;
+        /**
+         * 0 or 1
+         * @format int32
+         */
+        inuse?: number;
+        /** category */
+        category?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
+    /**
+     * @tags DataSource
+     * @name GetDataSource
+     * @summary Query a specific DataSource by unique DataSource Name
+     * @request GET:/api/datasource/data-source
+     * @secure
+     */
+    getDataSource(query: {
+        name: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
+    /**
+     * @description Create a new DataSource with/without an existing Entitlement
+     * @tags DataSource
+     * @name PostDataSource
+     * @summary Create a new DataSource
+     * @request POST:/api/datasource/data-source
+     * @secure
+     */
+    postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
+    /**
+     * @description If modification is Entitlement related, server will unsign old entitlement in firms and users
+     * @tags DataSource
+     * @name PutDataSource
+     * @summary Update an existing DataSource
+     * @request PUT:/api/datasource/data-source
+     * @secure
+     */
+    putDataSource(query: {
+        name: string;
+    }, data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
+     * @tags DataSource
+     * @name DeleteDataSource
+     * @summary Delete an existing DataSource
+     * @request DELETE:/api/datasource/data-source
+     * @secure
+     */
+    deleteDataSource(query: {
+        name: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags DataSource
+     * @name GetDataSourceBitMapping
+     * @request GET:/api/datasource/data-source-bit-mapping
+     * @secure
+     */
+    getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags DataSource
+     * @name GetDataSourceToConfigBitMapping
+     * @summary Get All DataSource name to entitlement field Bit Mappings - All users - available in Microservice
+     * @request GET:/api/datasource/data-source-to-config-bit-mapping
+     * @secure
+     */
+    getDataSourceToConfigBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags DataSource
+     * @name GetDataSourceTallyCount
+     * @summary For ViewTrade admin to generate data source tally report - Super admin
+     * @request GET:/api/datasource/data-source-tally-count
+     * @secure
+     */
+    getDataSourceTallyCount(query?: {
+        data_source?: string;
+        firm_id?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
+    /**
+     * @tags DataSource
+     * @name PostDataSourceTallyReport
+     * @summary For ViewTrade admin to generate data source tally report
+     * @request POST:/api/datasource/data-source-tally-report
+     * @secure
+     */
+    postDataSourceTallyReport(query: {
+        data_source: string;
+        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>);
@@ -2875,109 +2978,6 @@ export class Entitlement<HandleError extends boolean = boolean> {
         entitlement: string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
 }
-export class DataSource<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description All parameters are optional
-     * @tags DataSource
-     * @name PostDataSourceList
-     * @summary Query all DataSources in the whole system with optional filters - All users
-     * @request POST:/api/datasource/data-source-list
-     * @secure
-     */
-    postDataSourceList(data: AesMidasQueryPostBody, query?: {
-        /** Datasource name */
-        name?: string;
-        /** entitlement name */
-        entitlement?: string;
-        /**
-         * 0 or 1
-         * @format int32
-         */
-        inuse?: number;
-        /** category */
-        category?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
-    /**
-     * @tags DataSource
-     * @name GetDataSource
-     * @summary Query a specific DataSource by unique DataSource Name
-     * @request GET:/api/datasource/data-source
-     * @secure
-     */
-    getDataSource(query: {
-        name: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
-    /**
-     * @description Create a new DataSource with/without an existing Entitlement
-     * @tags DataSource
-     * @name PostDataSource
-     * @summary Create a new DataSource
-     * @request POST:/api/datasource/data-source
-     * @secure
-     */
-    postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
-    /**
-     * @description If modification is Entitlement related, server will unsign old entitlement in firms and users
-     * @tags DataSource
-     * @name PutDataSource
-     * @summary Update an existing DataSource
-     * @request PUT:/api/datasource/data-source
-     * @secure
-     */
-    putDataSource(query: {
-        name: string;
-    }, data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
-     * @tags DataSource
-     * @name DeleteDataSource
-     * @summary Delete an existing DataSource
-     * @request DELETE:/api/datasource/data-source
-     * @secure
-     */
-    deleteDataSource(query: {
-        name: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags DataSource
-     * @name GetDataSourceBitMapping
-     * @request GET:/api/datasource/data-source-bit-mapping
-     * @secure
-     */
-    getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags DataSource
-     * @name GetDataSourceToConfigBitMapping
-     * @summary Get All DataSource name to entitlement field Bit Mappings - All users - available in Microservice
-     * @request GET:/api/datasource/data-source-to-config-bit-mapping
-     * @secure
-     */
-    getDataSourceToConfigBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags DataSource
-     * @name GetDataSourceTallyCount
-     * @summary For ViewTrade admin to generate data source tally report - Super admin
-     * @request GET:/api/datasource/data-source-tally-count
-     * @secure
-     */
-    getDataSourceTallyCount(query?: {
-        data_source?: string;
-        firm_id?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
-    /**
-     * @tags DataSource
-     * @name PostDataSourceTallyReport
-     * @summary For ViewTrade admin to generate data source tally report
-     * @request POST:/api/datasource/data-source-tally-report
-     * @secure
-     */
-    postDataSourceTallyReport(query: {
-        data_source: string;
-        firm_id: string;
-    }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
-}
 export class File<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3112,6 +3112,17 @@ export class Firm<HandleError extends boolean = boolean> {
     putFirmDefaultData(query: {
         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
+     */
+    getApplyFirmDataToUsers(query: {
+        firm_id: string;
+        data_source: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
 export class FundWebQuote<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -3221,35 +3232,6 @@ export class Log<HandleError extends boolean = boolean> {
         target_user?: string;
     }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
 }
-export class Permission<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Permission
-     * @name PostPermission
-     * @request POST:/api/permission/permission
-     * @secure
-     */
-    postPermission(data: AesMidasPermission, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-    /**
-     * @tags Permission
-     * @name GetPermission
-     * @request GET:/api/permission/permission
-     * @secure
-     */
-    getPermission(query: {
-        user_name: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
-    /**
-     * @tags Permission
-     * @name DeletePermission
-     * @request DELETE:/api/permission/permission
-     * @secure
-     */
-    deletePermission(query: {
-        user_name: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
-}
 export class Quote<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3317,6 +3299,29 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetOpraSnapshot
+     * @summary Query OPRA Snapshot - All users - available in Microservice
+     * @request GET:/api/quote/opra-snapshot
+     * @secure
+     */
+    getOpraSnapshot(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<AesMidasSnapshot[], HandleError>>;
     /**
      * @tags Quote
      * @name GetLevel1
@@ -4092,12 +4097,12 @@ export class Quote<HandleError extends boolean = boolean> {
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1Update[], HandleError>>;
     /**
      * @tags Quote
-     * @name GetPloygonFmv
+     * @name GetPolygonFmv
      * @summary Query polygon FMV data - All users - available in Microservice
-     * @request GET:/api/quote/ploygon/fmv
+     * @request GET:/api/quote/polygon/fmv
      * @secure
      */
-    getPloygonFmv(query: {
+    getPolygonFmv(query: {
         /** Allow multiple symbols, separated by ',' */
         symbols: string;
         /**
@@ -4158,6 +4163,35 @@ export class Quote<HandleError extends boolean = boolean> {
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonTop[], HandleError>>;
 }
+export class Permission<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Permission
+     * @name PostPermission
+     * @request POST:/api/permission/permission
+     * @secure
+     */
+    postPermission(data: AesMidasPermission, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+    /**
+     * @tags Permission
+     * @name GetPermission
+     * @request GET:/api/permission/permission
+     * @secure
+     */
+    getPermission(query: {
+        user_name: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
+    /**
+     * @tags Permission
+     * @name DeletePermission
+     * @request DELETE:/api/permission/permission
+     * @secure
+     */
+    deletePermission(query: {
+        user_name: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
+}
 export class QuotesReformat<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);