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

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 */
@@ -1770,6 +1742,39 @@ export interface AesMidasPermission {
     level1: boolean;
     level2: boolean;
 }
+export interface AesMidasPolygonFMV {
+    symbol?: string | null;
+    /** @format double */
+    fmv?: number;
+    update_time?: string | null;
+    primary_exchange?: string | null;
+    mic?: string | null;
+    currency?: string | null;
+    country_code?: string | null;
+    comp_name?: string | null;
+    status?: string | null;
+    info_time?: string | null;
+    not_found?: boolean;
+}
+export interface AesMidasPolygonMinuteChart {
+    symbol?: string | null;
+    time?: string | null;
+    /** @format double */
+    open?: number;
+    /** @format double */
+    high?: number;
+    /** @format double */
+    low?: number;
+    /** @format double */
+    close?: number;
+    /** @format int64 */
+    volume?: number;
+}
+export interface AesMidasPolygonTop {
+    level?: string | null;
+    type?: string | null;
+    symbols?: string | null;
+}
 export interface AesMidasQueryLog {
     id?: string | null;
     /** @format date-time */
@@ -2599,6 +2604,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>);
@@ -2702,6 +2735,28 @@ export class DataSource<HandleError extends boolean = boolean> {
         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>);
+    /**
+     * @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>);
@@ -2945,141 +3000,6 @@ 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>>;
-}
 export class FundWebQuote<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3217,6 +3137,130 @@ export class Permission<HandleError extends boolean = boolean> {
         user_name: string;
     }, 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 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 Quote<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -3284,6 +3328,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
@@ -4057,6 +4124,73 @@ export class Quote<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1Update[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetPolygonFmv
+     * @summary Query polygon FMV data - All users - available in Microservice
+     * @request GET:/api/quote/polygon/fmv
+     * @secure
+     */
+    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 ""
+         */
+        user_name?: string;
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonFMV[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetPolygonMinuteChart
+     * @summary Query Polygon Minute Chart - All users - available in Microservice
+     * @request GET:/api/quote/polygon/minute-chart
+     * @secure
+     */
+    getPolygonMinuteChart(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<AesMidasPolygonMinuteChart[], HandleError>>;
+    /**
+     * @tags Quote
+     * @name GetPolygonTop
+     * @summary Query Polygon Top list - All users - available in Microservice
+     * @request GET:/api/quote/polygon/top
+     * @secure
+     */
+    getPolygonTop(query?: {
+        /**
+         * 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<AesMidasPolygonTop[], HandleError>>;
 }
 export class QuotesReformat<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;