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

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.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +180 -180
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +117 -117
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +204 -136
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +52 -52
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +885 -885
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +140 -135
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +149 -149
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -2604,34 +2604,6 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
2604
2604
  page_size?: number;
2605
2605
  data?: AesMidasUserMultiConditionResultResponse[] | null;
2606
2606
  }
2607
- export class BackgroundService<HandleError extends boolean = boolean> {
2608
- protected readonly apiClient: JwtClient<HandleError>;
2609
- constructor(apiClient: JwtClient<HandleError>);
2610
- /**
2611
- * @tags BackgroundService
2612
- * @name PostStart
2613
- * @summary Start the background service to sync UMA firms/users
2614
- * @request POST:/api/background-service/start
2615
- * @secure
2616
- */
2617
- postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2618
- /**
2619
- * @tags BackgroundService
2620
- * @name PostStop
2621
- * @summary Stop the background service to sync UMA firms/users
2622
- * @request POST:/api/background-service/stop
2623
- * @secure
2624
- */
2625
- postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2626
- /**
2627
- * @tags BackgroundService
2628
- * @name GetStatus
2629
- * @summary Check the status of the background service
2630
- * @request GET:/api/background-service/status
2631
- * @secure
2632
- */
2633
- getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2634
- }
2635
2607
  export class DataSource<HandleError extends boolean = boolean> {
2636
2608
  protected readonly apiClient: JwtClient<HandleError>;
2637
2609
  constructor(apiClient: JwtClient<HandleError>);
@@ -2735,27 +2707,33 @@ export class DataSource<HandleError extends boolean = boolean> {
2735
2707
  firm_id: string;
2736
2708
  }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2737
2709
  }
2738
- export class File<HandleError extends boolean = boolean> {
2710
+ export class BackgroundService<HandleError extends boolean = boolean> {
2739
2711
  protected readonly apiClient: JwtClient<HandleError>;
2740
2712
  constructor(apiClient: JwtClient<HandleError>);
2741
2713
  /**
2742
- * @tags File
2743
- * @name PostUpload
2744
- * @summary upload file
2745
- * @request POST:/api/file/upload
2714
+ * @tags BackgroundService
2715
+ * @name PostStart
2716
+ * @summary Start the background service to sync UMA firms/users
2717
+ * @request POST:/api/background-service/start
2746
2718
  * @secure
2747
2719
  */
2748
- postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
2720
+ postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2749
2721
  /**
2750
- * @tags File
2751
- * @name GetDownload
2752
- * @summary download file by file id
2753
- * @request GET:/api/file/download
2722
+ * @tags BackgroundService
2723
+ * @name PostStop
2724
+ * @summary Stop the background service to sync UMA firms/users
2725
+ * @request POST:/api/background-service/stop
2754
2726
  * @secure
2755
2727
  */
2756
- getDownload(query: {
2757
- file_id: string;
2758
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
2728
+ postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2729
+ /**
2730
+ * @tags BackgroundService
2731
+ * @name GetStatus
2732
+ * @summary Check the status of the background service
2733
+ * @request GET:/api/background-service/status
2734
+ * @secure
2735
+ */
2736
+ getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2759
2737
  }
2760
2738
  export class Entitlement<HandleError extends boolean = boolean> {
2761
2739
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3000,142 +2978,27 @@ export class Entitlement<HandleError extends boolean = boolean> {
3000
2978
  entitlement: string;
3001
2979
  }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFirmEntitlementHistoryResponsewithPagination, HandleError>>;
3002
2980
  }
3003
- export class FundWebQuote<HandleError extends boolean = boolean> {
3004
- protected readonly apiClient: JwtClient<HandleError>;
3005
- constructor(apiClient: JwtClient<HandleError>);
3006
- /**
3007
- * @tags FundWebQuote
3008
- * @name GetFund
3009
- * @request GET:/api/fund/fund
3010
- * @secure
3011
- */
3012
- getFund(query: {
3013
- symbol: string;
3014
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
3015
- /**
3016
- * @tags FundWebQuote
3017
- * @name GetFundList
3018
- * @request GET:/api/fund/fund-list
3019
- * @secure
3020
- */
3021
- getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
3022
- }
3023
- export class Log<HandleError extends boolean = boolean> {
3024
- protected readonly apiClient: JwtClient<HandleError>;
3025
- constructor(apiClient: JwtClient<HandleError>);
3026
- /**
3027
- * @tags Log
3028
- * @name GetDataQueryActionList
3029
- * @summary Query all data query action list in the system
3030
- * @request GET:/api/log/data-query-action-list
3031
- * @secure
3032
- */
3033
- getDataQueryActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3034
- /**
3035
- * @tags Log
3036
- * @name PostDataQueryLogByAction
3037
- * @summary Query data query logs by a specific query and date range
3038
- * @request POST:/api/log/data-query-log-by-action
3039
- * @secure
3040
- */
3041
- postDataQueryLogByAction(query: {
3042
- action: string;
3043
- 'start_date(UTC)': string;
3044
- 'end_date(UTC)': string;
3045
- }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
3046
- /**
3047
- * @tags Log
3048
- * @name PostDataQueryLogByDataSource
3049
- * @summary Query data query logs by a specific data source and date range and return for report
3050
- * @request POST:/api/log/data-query-log-by-data-source
3051
- * @secure
3052
- */
3053
- postDataQueryLogByDataSource(query: {
3054
- data_source: string;
3055
- 'start_date(UTC)': string;
3056
- 'end_date(UTC)': string;
3057
- }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
3058
- /**
3059
- * @tags Log
3060
- * @name GetSnapshotCount
3061
- * @summary Query snapshot report counts - Super admin
3062
- * @request GET:/api/log/snapshot-count
3063
- * @secure
3064
- */
3065
- getSnapshotCount(query: {
3066
- 'start_date(UTC)': string;
3067
- 'end_date(UTC)': string;
3068
- market_hour_only?: boolean;
3069
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
3070
- /**
3071
- * @tags Log
3072
- * @name PostSnapshotReport
3073
- * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin
3074
- * @request POST:/api/log/snapshot-report
3075
- * @secure
3076
- */
3077
- postSnapshotReport(query: {
3078
- 'start_date(UTC)': string;
3079
- 'end_date(UTC)': string;
3080
- firm_id: string;
3081
- exchange: string;
3082
- market_hour_only?: boolean;
3083
- }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
3084
- /**
3085
- * @tags Log
3086
- * @name GetModificationActionList
3087
- * @summary Query all modification actions list in the system
3088
- * @request GET:/api/log/modification-action-list
3089
- * @secure
3090
- */
3091
- getModificationActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3092
- /**
3093
- * @tags Log
3094
- * @name PostModificationLogByAction
3095
- * @summary Query login/out and modification actions logs by a specific action and date range
3096
- * @request POST:/api/log/modification-log-by-action
3097
- * @secure
3098
- */
3099
- postModificationLogByAction(query: {
3100
- /** To get available actions list, please call api/Log/modification-action-list. */
3101
- action: string;
3102
- 'start_date(UTC)': string;
3103
- 'end_date(UTC)': string;
3104
- /**
3105
- * optional
3106
- * @default ""
3107
- */
3108
- target_user?: string;
3109
- }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
3110
- }
3111
- export class Permission<HandleError extends boolean = boolean> {
2981
+ export class File<HandleError extends boolean = boolean> {
3112
2982
  protected readonly apiClient: JwtClient<HandleError>;
3113
2983
  constructor(apiClient: JwtClient<HandleError>);
3114
2984
  /**
3115
- * @tags Permission
3116
- * @name PostPermission
3117
- * @request POST:/api/permission/permission
3118
- * @secure
3119
- */
3120
- postPermission(data: AesMidasPermission, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3121
- /**
3122
- * @tags Permission
3123
- * @name GetPermission
3124
- * @request GET:/api/permission/permission
2985
+ * @tags File
2986
+ * @name PostUpload
2987
+ * @summary upload file
2988
+ * @request POST:/api/file/upload
3125
2989
  * @secure
3126
2990
  */
3127
- getPermission(query: {
3128
- user_name: string;
3129
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
2991
+ postUpload(data: AesMidasEntitlementFile, config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
3130
2992
  /**
3131
- * @tags Permission
3132
- * @name DeletePermission
3133
- * @request DELETE:/api/permission/permission
2993
+ * @tags File
2994
+ * @name GetDownload
2995
+ * @summary download file by file id
2996
+ * @request GET:/api/file/download
3134
2997
  * @secure
3135
2998
  */
3136
- deletePermission(query: {
3137
- user_name: string;
3138
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2999
+ getDownload(query: {
3000
+ file_id: string;
3001
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasEntitlementFile, HandleError>>;
3139
3002
  }
3140
3003
  export class Firm<HandleError extends boolean = boolean> {
3141
3004
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3261,6 +3124,114 @@ export class Firm<HandleError extends boolean = boolean> {
3261
3124
  data_source: string;
3262
3125
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3263
3126
  }
3127
+ export class FundWebQuote<HandleError extends boolean = boolean> {
3128
+ protected readonly apiClient: JwtClient<HandleError>;
3129
+ constructor(apiClient: JwtClient<HandleError>);
3130
+ /**
3131
+ * @tags FundWebQuote
3132
+ * @name GetFund
3133
+ * @request GET:/api/fund/fund
3134
+ * @secure
3135
+ */
3136
+ getFund(query: {
3137
+ symbol: string;
3138
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote, HandleError>>;
3139
+ /**
3140
+ * @tags FundWebQuote
3141
+ * @name GetFundList
3142
+ * @request GET:/api/fund/fund-list
3143
+ * @secure
3144
+ */
3145
+ getFundList(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFundWebQuote[], HandleError>>;
3146
+ }
3147
+ export class Log<HandleError extends boolean = boolean> {
3148
+ protected readonly apiClient: JwtClient<HandleError>;
3149
+ constructor(apiClient: JwtClient<HandleError>);
3150
+ /**
3151
+ * @tags Log
3152
+ * @name GetDataQueryActionList
3153
+ * @summary Query all data query action list in the system
3154
+ * @request GET:/api/log/data-query-action-list
3155
+ * @secure
3156
+ */
3157
+ getDataQueryActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3158
+ /**
3159
+ * @tags Log
3160
+ * @name PostDataQueryLogByAction
3161
+ * @summary Query data query logs by a specific query and date range
3162
+ * @request POST:/api/log/data-query-log-by-action
3163
+ * @secure
3164
+ */
3165
+ postDataQueryLogByAction(query: {
3166
+ action: string;
3167
+ 'start_date(UTC)': string;
3168
+ 'end_date(UTC)': string;
3169
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
3170
+ /**
3171
+ * @tags Log
3172
+ * @name PostDataQueryLogByDataSource
3173
+ * @summary Query data query logs by a specific data source and date range and return for report
3174
+ * @request POST:/api/log/data-query-log-by-data-source
3175
+ * @secure
3176
+ */
3177
+ postDataQueryLogByDataSource(query: {
3178
+ data_source: string;
3179
+ 'start_date(UTC)': string;
3180
+ 'end_date(UTC)': string;
3181
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
3182
+ /**
3183
+ * @tags Log
3184
+ * @name GetSnapshotCount
3185
+ * @summary Query snapshot report counts - Super admin
3186
+ * @request GET:/api/log/snapshot-count
3187
+ * @secure
3188
+ */
3189
+ getSnapshotCount(query: {
3190
+ 'start_date(UTC)': string;
3191
+ 'end_date(UTC)': string;
3192
+ market_hour_only?: boolean;
3193
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
3194
+ /**
3195
+ * @tags Log
3196
+ * @name PostSnapshotReport
3197
+ * @summary Query snapshot report for a specific firm and a sepcific exchange with Pagination and Sort - Super admin
3198
+ * @request POST:/api/log/snapshot-report
3199
+ * @secure
3200
+ */
3201
+ postSnapshotReport(query: {
3202
+ 'start_date(UTC)': string;
3203
+ 'end_date(UTC)': string;
3204
+ firm_id: string;
3205
+ exchange: string;
3206
+ market_hour_only?: boolean;
3207
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotReportResponsewithPagination, HandleError>>;
3208
+ /**
3209
+ * @tags Log
3210
+ * @name GetModificationActionList
3211
+ * @summary Query all modification actions list in the system
3212
+ * @request GET:/api/log/modification-action-list
3213
+ * @secure
3214
+ */
3215
+ getModificationActionList(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3216
+ /**
3217
+ * @tags Log
3218
+ * @name PostModificationLogByAction
3219
+ * @summary Query login/out and modification actions logs by a specific action and date range
3220
+ * @request POST:/api/log/modification-log-by-action
3221
+ * @secure
3222
+ */
3223
+ postModificationLogByAction(query: {
3224
+ /** To get available actions list, please call api/Log/modification-action-list. */
3225
+ action: string;
3226
+ 'start_date(UTC)': string;
3227
+ 'end_date(UTC)': string;
3228
+ /**
3229
+ * optional
3230
+ * @default ""
3231
+ */
3232
+ target_user?: string;
3233
+ }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
3234
+ }
3264
3235
  export class Quote<HandleError extends boolean = boolean> {
3265
3236
  protected readonly apiClient: JwtClient<HandleError>;
3266
3237
  constructor(apiClient: JwtClient<HandleError>);
@@ -4192,6 +4163,35 @@ export class Quote<HandleError extends boolean = boolean> {
4192
4163
  platform?: string;
4193
4164
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonTop[], HandleError>>;
4194
4165
  }
4166
+ export class Permission<HandleError extends boolean = boolean> {
4167
+ protected readonly apiClient: JwtClient<HandleError>;
4168
+ constructor(apiClient: JwtClient<HandleError>);
4169
+ /**
4170
+ * @tags Permission
4171
+ * @name PostPermission
4172
+ * @request POST:/api/permission/permission
4173
+ * @secure
4174
+ */
4175
+ postPermission(data: AesMidasPermission, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4176
+ /**
4177
+ * @tags Permission
4178
+ * @name GetPermission
4179
+ * @request GET:/api/permission/permission
4180
+ * @secure
4181
+ */
4182
+ getPermission(query: {
4183
+ user_name: string;
4184
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPermission, HandleError>>;
4185
+ /**
4186
+ * @tags Permission
4187
+ * @name DeletePermission
4188
+ * @request DELETE:/api/permission/permission
4189
+ * @secure
4190
+ */
4191
+ deletePermission(query: {
4192
+ user_name: string;
4193
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4194
+ }
4195
4195
  export class QuotesReformat<HandleError extends boolean = boolean> {
4196
4196
  protected readonly apiClient: JwtClient<HandleError>;
4197
4197
  constructor(apiClient: JwtClient<HandleError>);
@@ -4693,6 +4693,17 @@ export class User<HandleError extends boolean = boolean> {
4693
4693
  */
4694
4694
  getTest(config?: RequestConfig<HandleError>): Promise<ClientResponse<string, HandleError>>;
4695
4695
  }
4696
+ export class WsStream<HandleError extends boolean = boolean> {
4697
+ protected readonly apiClient: JwtClient<HandleError>;
4698
+ constructor(apiClient: JwtClient<HandleError>);
4699
+ /**
4700
+ * @tags WsStream
4701
+ * @name GetStream
4702
+ * @request GET:/stream
4703
+ * @secure
4704
+ */
4705
+ getStream(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4706
+ }
4696
4707
  export class WebSocket<HandleError extends boolean = boolean> {
4697
4708
  protected readonly apiClient: JwtClient<HandleError>;
4698
4709
  constructor(apiClient: JwtClient<HandleError>);
@@ -4713,17 +4724,6 @@ export class WebSocket<HandleError extends boolean = boolean> {
4713
4724
  */
4714
4725
  getWssub(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4715
4726
  }
4716
- export class WsStream<HandleError extends boolean = boolean> {
4717
- protected readonly apiClient: JwtClient<HandleError>;
4718
- constructor(apiClient: JwtClient<HandleError>);
4719
- /**
4720
- * @tags WsStream
4721
- * @name GetStream
4722
- * @request GET:/stream
4723
- * @secure
4724
- */
4725
- getStream(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4726
- }
4727
4727
  export class AesMidasApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4728
4728
  readonly config: JwtClientConfig<HandleError>;
4729
4729
  dataSource: DataSource<HandleError>;