@orbis-systems/orbis-api-clients 0.8.2 → 0.8.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +281 -261
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +6196 -6218
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +1130 -1130
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +80 -80
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +4034 -4034
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +1092 -981
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +1 -1
package/dist/aesmidas/index.d.ts
CHANGED
|
@@ -78,6 +78,34 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
78
78
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
79
|
protected renewTokens(): Promise<AuthData>;
|
|
80
80
|
}
|
|
81
|
+
export class BackgroundService<HandleError extends boolean = boolean> {
|
|
82
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
83
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
84
|
+
/**
|
|
85
|
+
* @tags BackgroundService
|
|
86
|
+
* @name PostStart
|
|
87
|
+
* @summary Start the background service to sync UMA firms/users
|
|
88
|
+
* @request POST:/api/background-service/start
|
|
89
|
+
* @secure
|
|
90
|
+
*/
|
|
91
|
+
postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
92
|
+
/**
|
|
93
|
+
* @tags BackgroundService
|
|
94
|
+
* @name PostStop
|
|
95
|
+
* @summary Stop the background service to sync UMA firms/users
|
|
96
|
+
* @request POST:/api/background-service/stop
|
|
97
|
+
* @secure
|
|
98
|
+
*/
|
|
99
|
+
postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
100
|
+
/**
|
|
101
|
+
* @tags BackgroundService
|
|
102
|
+
* @name GetStatus
|
|
103
|
+
* @summary Check the status of the background service
|
|
104
|
+
* @request GET:/api/background-service/status
|
|
105
|
+
* @secure
|
|
106
|
+
*/
|
|
107
|
+
getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
108
|
+
}
|
|
81
109
|
export interface AesMidasActionLog {
|
|
82
110
|
id?: string | null;
|
|
83
111
|
/** @format date-time */
|
|
@@ -2803,6 +2831,109 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
|
|
|
2803
2831
|
page_size?: number;
|
|
2804
2832
|
data?: AesMidasUserMultiConditionResultResponse[] | null;
|
|
2805
2833
|
}
|
|
2834
|
+
export class DataSource<HandleError extends boolean = boolean> {
|
|
2835
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2836
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2837
|
+
/**
|
|
2838
|
+
* @description All parameters are optional
|
|
2839
|
+
* @tags DataSource
|
|
2840
|
+
* @name PostDataSourceList
|
|
2841
|
+
* @summary Query all DataSources in the whole system with optional filters - All users
|
|
2842
|
+
* @request POST:/api/datasource/data-source-list
|
|
2843
|
+
* @secure
|
|
2844
|
+
*/
|
|
2845
|
+
postDataSourceList(data: AesMidasQueryPostBody, query?: {
|
|
2846
|
+
/** Datasource name */
|
|
2847
|
+
name?: string;
|
|
2848
|
+
/** entitlement name */
|
|
2849
|
+
entitlement?: string;
|
|
2850
|
+
/**
|
|
2851
|
+
* 0 or 1
|
|
2852
|
+
* @format int32
|
|
2853
|
+
*/
|
|
2854
|
+
inuse?: number;
|
|
2855
|
+
/** category */
|
|
2856
|
+
category?: string;
|
|
2857
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
|
|
2858
|
+
/**
|
|
2859
|
+
* @tags DataSource
|
|
2860
|
+
* @name GetDataSource
|
|
2861
|
+
* @summary Query a specific DataSource by unique DataSource Name
|
|
2862
|
+
* @request GET:/api/datasource/data-source
|
|
2863
|
+
* @secure
|
|
2864
|
+
*/
|
|
2865
|
+
getDataSource(query: {
|
|
2866
|
+
name: string;
|
|
2867
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2868
|
+
/**
|
|
2869
|
+
* @description Create a new DataSource with/without an existing Entitlement
|
|
2870
|
+
* @tags DataSource
|
|
2871
|
+
* @name PostDataSource
|
|
2872
|
+
* @summary Create a new DataSource
|
|
2873
|
+
* @request POST:/api/datasource/data-source
|
|
2874
|
+
* @secure
|
|
2875
|
+
*/
|
|
2876
|
+
postDataSource(data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSource, HandleError>>;
|
|
2877
|
+
/**
|
|
2878
|
+
* @description If modification is Entitlement related, server will unsign old entitlement in firms and users
|
|
2879
|
+
* @tags DataSource
|
|
2880
|
+
* @name PutDataSource
|
|
2881
|
+
* @summary Update an existing DataSource
|
|
2882
|
+
* @request PUT:/api/datasource/data-source
|
|
2883
|
+
* @secure
|
|
2884
|
+
*/
|
|
2885
|
+
putDataSource(query: {
|
|
2886
|
+
name: string;
|
|
2887
|
+
}, data: AesMidasDataSource, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2888
|
+
/**
|
|
2889
|
+
* @description !Caution! It will remove all related data setting and unsign all related entitlement in firms and users
|
|
2890
|
+
* @tags DataSource
|
|
2891
|
+
* @name DeleteDataSource
|
|
2892
|
+
* @summary Delete an existing DataSource
|
|
2893
|
+
* @request DELETE:/api/datasource/data-source
|
|
2894
|
+
* @secure
|
|
2895
|
+
*/
|
|
2896
|
+
deleteDataSource(query: {
|
|
2897
|
+
name: string;
|
|
2898
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2899
|
+
/**
|
|
2900
|
+
* @tags DataSource
|
|
2901
|
+
* @name GetDataSourceBitMapping
|
|
2902
|
+
* @request GET:/api/datasource/data-source-bit-mapping
|
|
2903
|
+
* @secure
|
|
2904
|
+
*/
|
|
2905
|
+
getDataSourceBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2906
|
+
/**
|
|
2907
|
+
* @tags DataSource
|
|
2908
|
+
* @name GetDataSourceToConfigBitMapping
|
|
2909
|
+
* @summary Get All DataSource name to entitlement field Bit Mappings - All users - available in Microservice
|
|
2910
|
+
* @request GET:/api/datasource/data-source-to-config-bit-mapping
|
|
2911
|
+
* @secure
|
|
2912
|
+
*/
|
|
2913
|
+
getDataSourceToConfigBitMapping(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2914
|
+
/**
|
|
2915
|
+
* @tags DataSource
|
|
2916
|
+
* @name GetDataSourceTallyCount
|
|
2917
|
+
* @summary For ViewTrade admin to generate data source tally report - Super admin
|
|
2918
|
+
* @request GET:/api/datasource/data-source-tally-count
|
|
2919
|
+
* @secure
|
|
2920
|
+
*/
|
|
2921
|
+
getDataSourceTallyCount(query?: {
|
|
2922
|
+
data_source?: string;
|
|
2923
|
+
firm_id?: string;
|
|
2924
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
|
|
2925
|
+
/**
|
|
2926
|
+
* @tags DataSource
|
|
2927
|
+
* @name PostDataSourceTallyReport
|
|
2928
|
+
* @summary For ViewTrade admin to generate data source tally report
|
|
2929
|
+
* @request POST:/api/datasource/data-source-tally-report
|
|
2930
|
+
* @secure
|
|
2931
|
+
*/
|
|
2932
|
+
postDataSourceTallyReport(query: {
|
|
2933
|
+
data_source: string;
|
|
2934
|
+
firm_id: string;
|
|
2935
|
+
}, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
|
|
2936
|
+
}
|
|
2806
2937
|
export class Entitlement<HandleError extends boolean = boolean> {
|
|
2807
2938
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2808
2939
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3046,158 +3177,194 @@ export class Entitlement<HandleError extends boolean = boolean> {
|
|
|
3046
3177
|
entitlement: string;
|
|
3047
3178
|
}, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
|
|
3048
3179
|
}
|
|
3049
|
-
export class
|
|
3180
|
+
export class File<HandleError extends boolean = boolean> {
|
|
3050
3181
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3051
3182
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3052
3183
|
/**
|
|
3053
|
-
* @
|
|
3054
|
-
* @
|
|
3055
|
-
* @
|
|
3056
|
-
* @
|
|
3057
|
-
* @request POST:/api/datasource/data-source-list
|
|
3184
|
+
* @tags File
|
|
3185
|
+
* @name PostUpload
|
|
3186
|
+
* @summary upload file
|
|
3187
|
+
* @request POST:/api/file/upload
|
|
3058
3188
|
* @secure
|
|
3059
3189
|
*/
|
|
3060
|
-
|
|
3061
|
-
/** Datasource name */
|
|
3062
|
-
name?: string;
|
|
3063
|
-
/** entitlement name */
|
|
3064
|
-
entitlement?: string;
|
|
3065
|
-
/**
|
|
3066
|
-
* 0 or 1
|
|
3067
|
-
* @format int32
|
|
3068
|
-
*/
|
|
3069
|
-
inuse?: number;
|
|
3070
|
-
/** category */
|
|
3071
|
-
category?: string;
|
|
3072
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceResponsewithPagination, HandleError>>;
|
|
3190
|
+
postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
|
|
3073
3191
|
/**
|
|
3074
|
-
* @tags
|
|
3075
|
-
* @name
|
|
3076
|
-
* @summary
|
|
3077
|
-
* @request GET:/api/
|
|
3192
|
+
* @tags File
|
|
3193
|
+
* @name GetDownload
|
|
3194
|
+
* @summary download file by file id
|
|
3195
|
+
* @request GET:/api/file/download
|
|
3078
3196
|
* @secure
|
|
3079
3197
|
*/
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3198
|
+
getDownload(query: {
|
|
3199
|
+
file_id: string;
|
|
3200
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
|
|
3201
|
+
}
|
|
3202
|
+
export class Firm<HandleError extends boolean = boolean> {
|
|
3203
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3204
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3083
3205
|
/**
|
|
3084
|
-
* @
|
|
3085
|
-
* @
|
|
3086
|
-
* @
|
|
3087
|
-
* @
|
|
3088
|
-
* @request POST:/api/datasource/data-source
|
|
3206
|
+
* @tags Firm
|
|
3207
|
+
* @name PostFirmList
|
|
3208
|
+
* @summary Query all Firms in the system
|
|
3209
|
+
* @request POST:/api/firm/firm-list
|
|
3089
3210
|
* @secure
|
|
3090
3211
|
*/
|
|
3091
|
-
|
|
3212
|
+
postFirmList(data: AesMidasQueryPostBody, query?: {
|
|
3213
|
+
/** firm_id, optional */
|
|
3214
|
+
firm_id?: string;
|
|
3215
|
+
/** firm name, fuzzy search, optional */
|
|
3216
|
+
name?: string;
|
|
3217
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
|
|
3092
3218
|
/**
|
|
3093
|
-
* @
|
|
3094
|
-
* @
|
|
3095
|
-
* @name
|
|
3096
|
-
* @
|
|
3097
|
-
* @request PUT:/api/datasource/data-source
|
|
3219
|
+
* @tags Firm
|
|
3220
|
+
* @name GetFirm
|
|
3221
|
+
* @summary Query a specific Firm by firmid(short name)
|
|
3222
|
+
* @request GET:/api/firm/firm
|
|
3098
3223
|
* @secure
|
|
3099
3224
|
*/
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
},
|
|
3225
|
+
getFirm(query: {
|
|
3226
|
+
firm_id: string;
|
|
3227
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
3103
3228
|
/**
|
|
3104
|
-
* @
|
|
3105
|
-
* @
|
|
3106
|
-
* @
|
|
3107
|
-
* @
|
|
3108
|
-
* @request DELETE:/api/datasource/data-source
|
|
3229
|
+
* @tags Firm
|
|
3230
|
+
* @name PostFirm
|
|
3231
|
+
* @summary Create a new Firm
|
|
3232
|
+
* @request POST:/api/firm/firm
|
|
3109
3233
|
* @secure
|
|
3110
3234
|
*/
|
|
3111
|
-
|
|
3112
|
-
name: string;
|
|
3113
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3235
|
+
postFirm(data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
3114
3236
|
/**
|
|
3115
|
-
* @
|
|
3116
|
-
* @
|
|
3117
|
-
* @
|
|
3237
|
+
* @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
|
|
3238
|
+
* @tags Firm
|
|
3239
|
+
* @name PutFirm
|
|
3240
|
+
* @summary Update an existing Firm setting
|
|
3241
|
+
* @request PUT:/api/firm/firm
|
|
3118
3242
|
* @secure
|
|
3119
3243
|
*/
|
|
3120
|
-
|
|
3244
|
+
putFirm(query: {
|
|
3245
|
+
firm_id: string;
|
|
3246
|
+
}, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3121
3247
|
/**
|
|
3122
|
-
* @
|
|
3123
|
-
* @
|
|
3124
|
-
* @
|
|
3125
|
-
* @
|
|
3248
|
+
* @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
|
|
3249
|
+
* @tags Firm
|
|
3250
|
+
* @name GetFirmDataAccess
|
|
3251
|
+
* @summary Get which data sources that a firm can access
|
|
3252
|
+
* @request GET:/api/firm/firm-data-access
|
|
3126
3253
|
* @secure
|
|
3127
3254
|
*/
|
|
3128
|
-
|
|
3255
|
+
getFirmDataAccess(query: {
|
|
3256
|
+
firm_id: string;
|
|
3257
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
3129
3258
|
/**
|
|
3130
|
-
* @tags
|
|
3131
|
-
* @name
|
|
3132
|
-
* @summary
|
|
3133
|
-
* @request
|
|
3259
|
+
* @tags Firm
|
|
3260
|
+
* @name PostUmaFirmList
|
|
3261
|
+
* @summary Get all firms from UMA - Super admin
|
|
3262
|
+
* @request POST:/api/firm/uma-firm-list
|
|
3134
3263
|
* @secure
|
|
3135
3264
|
*/
|
|
3136
|
-
|
|
3137
|
-
data_source?: string;
|
|
3138
|
-
firm_id?: string;
|
|
3139
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyCount[], HandleError>>;
|
|
3265
|
+
postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
|
|
3140
3266
|
/**
|
|
3141
|
-
* @tags
|
|
3142
|
-
* @name
|
|
3143
|
-
* @summary
|
|
3144
|
-
* @request
|
|
3267
|
+
* @tags Firm
|
|
3268
|
+
* @name GetSystemFirmDefaultData
|
|
3269
|
+
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
|
|
3270
|
+
* @request GET:/api/firm/system-firm-default-data
|
|
3145
3271
|
* @secure
|
|
3146
3272
|
*/
|
|
3147
|
-
|
|
3148
|
-
|
|
3273
|
+
getSystemFirmDefaultData(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
3274
|
+
/**
|
|
3275
|
+
* @tags Firm
|
|
3276
|
+
* @name PutSystemFirmDefaultData
|
|
3277
|
+
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
|
|
3278
|
+
* @request PUT:/api/firm/system-firm-default-data
|
|
3279
|
+
* @secure
|
|
3280
|
+
*/
|
|
3281
|
+
putSystemFirmDefaultData(data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3282
|
+
/**
|
|
3283
|
+
* @tags Firm
|
|
3284
|
+
* @name GetFirmDefaultData
|
|
3285
|
+
* @summary Query a specific Firm Default Data Setting by firmid(short name)
|
|
3286
|
+
* @request GET:/api/firm/firm-default-data
|
|
3287
|
+
* @secure
|
|
3288
|
+
*/
|
|
3289
|
+
getFirmDefaultData(query: {
|
|
3149
3290
|
firm_id: string;
|
|
3150
|
-
},
|
|
3151
|
-
}
|
|
3152
|
-
export class BackgroundService<HandleError extends boolean = boolean> {
|
|
3153
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3154
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3291
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
3155
3292
|
/**
|
|
3156
|
-
* @
|
|
3157
|
-
* @
|
|
3158
|
-
* @
|
|
3159
|
-
* @
|
|
3293
|
+
* @description New default data must within firm data access availability
|
|
3294
|
+
* @tags Firm
|
|
3295
|
+
* @name PostFirmDefaultData
|
|
3296
|
+
* @summary Create Firm Default Data setting for a specific firm
|
|
3297
|
+
* @request POST:/api/firm/firm-default-data
|
|
3160
3298
|
* @secure
|
|
3161
3299
|
*/
|
|
3162
|
-
|
|
3300
|
+
postFirmDefaultData(query: {
|
|
3301
|
+
firm_id: string;
|
|
3302
|
+
}, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3163
3303
|
/**
|
|
3164
|
-
* @
|
|
3165
|
-
* @
|
|
3166
|
-
* @
|
|
3167
|
-
* @
|
|
3304
|
+
* @description New default data must within firm data access availability
|
|
3305
|
+
* @tags Firm
|
|
3306
|
+
* @name PutFirmDefaultData
|
|
3307
|
+
* @summary Update an existing Firm Default Data setting
|
|
3308
|
+
* @request PUT:/api/firm/firm-default-data
|
|
3168
3309
|
* @secure
|
|
3169
3310
|
*/
|
|
3170
|
-
|
|
3311
|
+
putFirmDefaultData(query: {
|
|
3312
|
+
firm_id: string;
|
|
3313
|
+
}, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3171
3314
|
/**
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
|
|
3315
|
+
* @tags Firm
|
|
3316
|
+
* @name GetApplyFirmDataToUsers
|
|
3317
|
+
* @summary Apply firm data to all users in this firm - Firm manager, or super admin - available in Microservice
|
|
3318
|
+
Can apply data_source, quote_type, or quote_level
|
|
3319
|
+
* @request GET:/api/firm/apply-firm-data-to-users
|
|
3320
|
+
* @secure
|
|
3321
|
+
*/
|
|
3322
|
+
getApplyFirmDataToUsers(query: {
|
|
3323
|
+
firm_id: string;
|
|
3324
|
+
data_source?: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* @format int32
|
|
3327
|
+
* @default -1
|
|
3328
|
+
*/
|
|
3329
|
+
quote_type?: number;
|
|
3330
|
+
/**
|
|
3331
|
+
* @format int32
|
|
3332
|
+
* @default -1
|
|
3333
|
+
*/
|
|
3334
|
+
quote_level?: number;
|
|
3335
|
+
/** @default false */
|
|
3336
|
+
if_apply_to_default?: boolean;
|
|
3337
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3338
|
+
/**
|
|
3339
|
+
* @tags Firm
|
|
3340
|
+
* @name GetApplyFirmDefaultSettingToAllUsers
|
|
3341
|
+
* @summary Apply firm default data setting to all users in this firm - Firm manager, or super admin
|
|
3342
|
+
* @request GET:/api/firm/apply-firm-default-setting-to-all-users
|
|
3176
3343
|
* @secure
|
|
3177
3344
|
*/
|
|
3178
|
-
|
|
3345
|
+
getApplyFirmDefaultSettingToAllUsers(query: {
|
|
3346
|
+
firm_id: string;
|
|
3347
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3179
3348
|
}
|
|
3180
|
-
export class
|
|
3349
|
+
export class FundWebQuote<HandleError extends boolean = boolean> {
|
|
3181
3350
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3182
3351
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3183
3352
|
/**
|
|
3184
|
-
* @tags
|
|
3185
|
-
* @name
|
|
3186
|
-
* @
|
|
3187
|
-
* @request POST:/api/file/upload
|
|
3353
|
+
* @tags FundWebQuote
|
|
3354
|
+
* @name GetFund
|
|
3355
|
+
* @request GET:/api/fund/fund
|
|
3188
3356
|
* @secure
|
|
3189
3357
|
*/
|
|
3190
|
-
|
|
3358
|
+
getFund(query: {
|
|
3359
|
+
symbol: string;
|
|
3360
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
|
|
3191
3361
|
/**
|
|
3192
|
-
* @tags
|
|
3193
|
-
* @name
|
|
3194
|
-
* @
|
|
3195
|
-
* @request GET:/api/file/download
|
|
3362
|
+
* @tags FundWebQuote
|
|
3363
|
+
* @name GetFundList
|
|
3364
|
+
* @request GET:/api/fund/fund-list
|
|
3196
3365
|
* @secure
|
|
3197
3366
|
*/
|
|
3198
|
-
|
|
3199
|
-
file_id: string;
|
|
3200
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
|
|
3367
|
+
getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
|
|
3201
3368
|
}
|
|
3202
3369
|
export class Log<HandleError extends boolean = boolean> {
|
|
3203
3370
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4377,163 +4544,6 @@ Adds short-lived cache to avoid repeated network calls.
|
|
|
4377
4544
|
platform?: string;
|
|
4378
4545
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonTop[], HandleError>>;
|
|
4379
4546
|
}
|
|
4380
|
-
export class FundWebQuote<HandleError extends boolean = boolean> {
|
|
4381
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4382
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4383
|
-
/**
|
|
4384
|
-
* @tags FundWebQuote
|
|
4385
|
-
* @name GetFund
|
|
4386
|
-
* @request GET:/api/fund/fund
|
|
4387
|
-
* @secure
|
|
4388
|
-
*/
|
|
4389
|
-
getFund(query: {
|
|
4390
|
-
symbol: string;
|
|
4391
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
|
|
4392
|
-
/**
|
|
4393
|
-
* @tags FundWebQuote
|
|
4394
|
-
* @name GetFundList
|
|
4395
|
-
* @request GET:/api/fund/fund-list
|
|
4396
|
-
* @secure
|
|
4397
|
-
*/
|
|
4398
|
-
getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
|
|
4399
|
-
}
|
|
4400
|
-
export class Firm<HandleError extends boolean = boolean> {
|
|
4401
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4402
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4403
|
-
/**
|
|
4404
|
-
* @tags Firm
|
|
4405
|
-
* @name PostFirmList
|
|
4406
|
-
* @summary Query all Firms in the system
|
|
4407
|
-
* @request POST:/api/firm/firm-list
|
|
4408
|
-
* @secure
|
|
4409
|
-
*/
|
|
4410
|
-
postFirmList(data: AesMidasQueryPostBody, query?: {
|
|
4411
|
-
/** firm_id, optional */
|
|
4412
|
-
firm_id?: string;
|
|
4413
|
-
/** firm name, fuzzy search, optional */
|
|
4414
|
-
name?: string;
|
|
4415
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmResponsewithPagination, HandleError>>;
|
|
4416
|
-
/**
|
|
4417
|
-
* @tags Firm
|
|
4418
|
-
* @name GetFirm
|
|
4419
|
-
* @summary Query a specific Firm by firmid(short name)
|
|
4420
|
-
* @request GET:/api/firm/firm
|
|
4421
|
-
* @secure
|
|
4422
|
-
*/
|
|
4423
|
-
getFirm(query: {
|
|
4424
|
-
firm_id: string;
|
|
4425
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
4426
|
-
/**
|
|
4427
|
-
* @tags Firm
|
|
4428
|
-
* @name PostFirm
|
|
4429
|
-
* @summary Create a new Firm
|
|
4430
|
-
* @request POST:/api/firm/firm
|
|
4431
|
-
* @secure
|
|
4432
|
-
*/
|
|
4433
|
-
postFirm(data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
4434
|
-
/**
|
|
4435
|
-
* @description !Caution! If remove any previous data source related settings, it will de-active relevant FirmEntitlement and unsign relevant UserEntitlements.
|
|
4436
|
-
* @tags Firm
|
|
4437
|
-
* @name PutFirm
|
|
4438
|
-
* @summary Update an existing Firm setting
|
|
4439
|
-
* @request PUT:/api/firm/firm
|
|
4440
|
-
* @secure
|
|
4441
|
-
*/
|
|
4442
|
-
putFirm(query: {
|
|
4443
|
-
firm_id: string;
|
|
4444
|
-
}, data: AesMidasFirm, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4445
|
-
/**
|
|
4446
|
-
* @description Note: Return a Firm Entity, which has data sources that this firm can access combining FirmEntitlements information. Not the original Firm settings.
|
|
4447
|
-
* @tags Firm
|
|
4448
|
-
* @name GetFirmDataAccess
|
|
4449
|
-
* @summary Get which data sources that a firm can access
|
|
4450
|
-
* @request GET:/api/firm/firm-data-access
|
|
4451
|
-
* @secure
|
|
4452
|
-
*/
|
|
4453
|
-
getFirmDataAccess(query: {
|
|
4454
|
-
firm_id: string;
|
|
4455
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirm, HandleError>>;
|
|
4456
|
-
/**
|
|
4457
|
-
* @tags Firm
|
|
4458
|
-
* @name PostUmaFirmList
|
|
4459
|
-
* @summary Get all firms from UMA - Super admin
|
|
4460
|
-
* @request POST:/api/firm/uma-firm-list
|
|
4461
|
-
* @secure
|
|
4462
|
-
*/
|
|
4463
|
-
postUmaFirmList(data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasUMAFirmResponsewithPagination, HandleError>>;
|
|
4464
|
-
/**
|
|
4465
|
-
* @tags Firm
|
|
4466
|
-
* @name GetSystemFirmDefaultData
|
|
4467
|
-
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
|
|
4468
|
-
* @request GET:/api/firm/system-firm-default-data
|
|
4469
|
-
* @secure
|
|
4470
|
-
*/
|
|
4471
|
-
getSystemFirmDefaultData(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
4472
|
-
/**
|
|
4473
|
-
* @tags Firm
|
|
4474
|
-
* @name PutSystemFirmDefaultData
|
|
4475
|
-
* @summary Query system Firm Default Data Setting, which will be assigned to firm if not specified otherwise
|
|
4476
|
-
* @request PUT:/api/firm/system-firm-default-data
|
|
4477
|
-
* @secure
|
|
4478
|
-
*/
|
|
4479
|
-
putSystemFirmDefaultData(data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4480
|
-
/**
|
|
4481
|
-
* @tags Firm
|
|
4482
|
-
* @name GetFirmDefaultData
|
|
4483
|
-
* @summary Query a specific Firm Default Data Setting by firmid(short name)
|
|
4484
|
-
* @request GET:/api/firm/firm-default-data
|
|
4485
|
-
* @secure
|
|
4486
|
-
*/
|
|
4487
|
-
getFirmDefaultData(query: {
|
|
4488
|
-
firm_id: string;
|
|
4489
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmDefaultDataSetting, HandleError>>;
|
|
4490
|
-
/**
|
|
4491
|
-
* @description New default data must within firm data access availability
|
|
4492
|
-
* @tags Firm
|
|
4493
|
-
* @name PostFirmDefaultData
|
|
4494
|
-
* @summary Create Firm Default Data setting for a specific firm
|
|
4495
|
-
* @request POST:/api/firm/firm-default-data
|
|
4496
|
-
* @secure
|
|
4497
|
-
*/
|
|
4498
|
-
postFirmDefaultData(query: {
|
|
4499
|
-
firm_id: string;
|
|
4500
|
-
}, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4501
|
-
/**
|
|
4502
|
-
* @description New default data must within firm data access availability
|
|
4503
|
-
* @tags Firm
|
|
4504
|
-
* @name PutFirmDefaultData
|
|
4505
|
-
* @summary Update an existing Firm Default Data setting
|
|
4506
|
-
* @request PUT:/api/firm/firm-default-data
|
|
4507
|
-
* @secure
|
|
4508
|
-
*/
|
|
4509
|
-
putFirmDefaultData(query: {
|
|
4510
|
-
firm_id: string;
|
|
4511
|
-
}, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4512
|
-
/**
|
|
4513
|
-
* @tags Firm
|
|
4514
|
-
* @name GetApplyFirmDataToUsers
|
|
4515
|
-
* @summary Apply firm data to all users in this firm - Firm manager, or super admin - available in Microservice
|
|
4516
|
-
Can apply data_source, quote_type, or quote_level
|
|
4517
|
-
* @request GET:/api/firm/apply-firm-data-to-users
|
|
4518
|
-
* @secure
|
|
4519
|
-
*/
|
|
4520
|
-
getApplyFirmDataToUsers(query: {
|
|
4521
|
-
firm_id: string;
|
|
4522
|
-
data_source?: string;
|
|
4523
|
-
/**
|
|
4524
|
-
* @format int32
|
|
4525
|
-
* @default -1
|
|
4526
|
-
*/
|
|
4527
|
-
quote_type?: number;
|
|
4528
|
-
/**
|
|
4529
|
-
* @format int32
|
|
4530
|
-
* @default -1
|
|
4531
|
-
*/
|
|
4532
|
-
quote_level?: number;
|
|
4533
|
-
/** @default false */
|
|
4534
|
-
if_apply_to_default?: boolean;
|
|
4535
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4536
|
-
}
|
|
4537
4547
|
export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
4538
4548
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4539
4549
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4630,6 +4640,11 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
|
4630
4640
|
* @default false
|
|
4631
4641
|
*/
|
|
4632
4642
|
includeMF?: boolean;
|
|
4643
|
+
/**
|
|
4644
|
+
* filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
|
|
4645
|
+
* @default false
|
|
4646
|
+
*/
|
|
4647
|
+
excludeNotFound?: boolean;
|
|
4633
4648
|
/** @default "" */
|
|
4634
4649
|
platform?: string;
|
|
4635
4650
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -4659,6 +4674,11 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
|
|
|
4659
4674
|
* @default false
|
|
4660
4675
|
*/
|
|
4661
4676
|
includeMF?: boolean;
|
|
4677
|
+
/**
|
|
4678
|
+
* filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
|
|
4679
|
+
* @default false
|
|
4680
|
+
*/
|
|
4681
|
+
excludeNotFound?: boolean;
|
|
4662
4682
|
/** @default "" */
|
|
4663
4683
|
platform?: string;
|
|
4664
4684
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|