@orbis-systems/orbis-api-clients 0.8.7 → 0.8.8

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 (37) hide show
  1. package/dist/aesmidas/index.d.ts +78 -65
  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 +5362 -5362
  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 +1319 -1319
  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 +104 -104
  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 +3862 -3862
  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 +602 -602
  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/package.json +2 -1
@@ -78,34 +78,6 @@ 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
- }
109
81
  export interface AesMidasActionLog {
110
82
  id?: string | null;
111
83
  /** @format date-time */
@@ -2154,6 +2126,7 @@ export interface AesMidasSignAgreement {
2154
2126
  }
2155
2127
  export interface AesMidasSnapshot {
2156
2128
  symbol?: string | null;
2129
+ company_name?: string | null;
2157
2130
  issue_market?: string | null;
2158
2131
  /** @format double */
2159
2132
  yest_close_px?: number;
@@ -2831,6 +2804,34 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
2831
2804
  page_size?: number;
2832
2805
  data?: AesMidasUserMultiConditionResultResponse[] | null;
2833
2806
  }
2807
+ export class BackgroundService<HandleError extends boolean = boolean> {
2808
+ protected readonly apiClient: JwtClient<HandleError>;
2809
+ constructor(apiClient: JwtClient<HandleError>);
2810
+ /**
2811
+ * @tags BackgroundService
2812
+ * @name PostStart
2813
+ * @summary Start the background service to sync UMA firms/users
2814
+ * @request POST:/api/background-service/start
2815
+ * @secure
2816
+ */
2817
+ postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2818
+ /**
2819
+ * @tags BackgroundService
2820
+ * @name PostStop
2821
+ * @summary Stop the background service to sync UMA firms/users
2822
+ * @request POST:/api/background-service/stop
2823
+ * @secure
2824
+ */
2825
+ postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2826
+ /**
2827
+ * @tags BackgroundService
2828
+ * @name GetStatus
2829
+ * @summary Check the status of the background service
2830
+ * @request GET:/api/background-service/status
2831
+ * @secure
2832
+ */
2833
+ getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2834
+ }
2834
2835
  export class DataSource<HandleError extends boolean = boolean> {
2835
2836
  protected readonly apiClient: JwtClient<HandleError>;
2836
2837
  constructor(apiClient: JwtClient<HandleError>);
@@ -3312,13 +3313,13 @@ export class Firm<HandleError extends boolean = boolean> {
3312
3313
  firm_id: string;
3313
3314
  }, data: AesMidasFirmDefaultDataSetting, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3314
3315
  /**
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
- */
3316
+ * @tags Firm
3317
+ * @name GetApplyFirmDataToUsers
3318
+ * @summary Apply firm data to all users in this firm - Firm manager, or super admin - available in Microservice
3319
+ Can apply data_source, quote_type, or quote_level
3320
+ * @request GET:/api/firm/apply-firm-data-to-users
3321
+ * @secure
3322
+ */
3322
3323
  getApplyFirmDataToUsers(query: {
3323
3324
  firm_id: string;
3324
3325
  data_source?: string;
@@ -3386,8 +3387,8 @@ export class Log<HandleError extends boolean = boolean> {
3386
3387
  */
3387
3388
  postDataQueryLogByAction(query: {
3388
3389
  action: string;
3389
- 'start_date(UTC)': string;
3390
- 'end_date(UTC)': string;
3390
+ "start_date(UTC)": string;
3391
+ "end_date(UTC)": string;
3391
3392
  }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
3392
3393
  /**
3393
3394
  * @tags Log
@@ -3398,8 +3399,8 @@ export class Log<HandleError extends boolean = boolean> {
3398
3399
  */
3399
3400
  postDataQueryLogByDataSource(query: {
3400
3401
  data_source: string;
3401
- 'start_date(UTC)': string;
3402
- 'end_date(UTC)': string;
3402
+ "start_date(UTC)": string;
3403
+ "end_date(UTC)": string;
3403
3404
  }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogReportResponsewithPagination, HandleError>>;
3404
3405
  /**
3405
3406
  * @tags Log
@@ -3409,8 +3410,8 @@ export class Log<HandleError extends boolean = boolean> {
3409
3410
  * @secure
3410
3411
  */
3411
3412
  getSnapshotCount(query: {
3412
- 'start_date(UTC)': string;
3413
- 'end_date(UTC)': string;
3413
+ "start_date(UTC)": string;
3414
+ "end_date(UTC)": string;
3414
3415
  market_hour_only?: boolean;
3415
3416
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshotCount[], HandleError>>;
3416
3417
  /**
@@ -3421,8 +3422,8 @@ export class Log<HandleError extends boolean = boolean> {
3421
3422
  * @secure
3422
3423
  */
3423
3424
  postSnapshotReport(query: {
3424
- 'start_date(UTC)': string;
3425
- 'end_date(UTC)': string;
3425
+ "start_date(UTC)": string;
3426
+ "end_date(UTC)": string;
3426
3427
  firm_id: string;
3427
3428
  exchange: string;
3428
3429
  market_hour_only?: boolean;
@@ -3445,8 +3446,8 @@ export class Log<HandleError extends boolean = boolean> {
3445
3446
  postModificationLogByAction(query: {
3446
3447
  /** To get available actions list, please call api/Log/modification-action-list. */
3447
3448
  action: string;
3448
- 'start_date(UTC)': string;
3449
- 'end_date(UTC)': string;
3449
+ "start_date(UTC)": string;
3450
+ "end_date(UTC)": string;
3450
3451
  /**
3451
3452
  * optional
3452
3453
  * @default ""
@@ -3462,8 +3463,8 @@ export class Log<HandleError extends boolean = boolean> {
3462
3463
  */
3463
3464
  getDataQueryLogByUsername(query: {
3464
3465
  username: string;
3465
- 'start_date(UTC)': string;
3466
- 'end_date(UTC)': string;
3466
+ "start_date(UTC)": string;
3467
+ "end_date(UTC)": string;
3467
3468
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasQueryLogResponsewithPagination, HandleError>>;
3468
3469
  /**
3469
3470
  * @tags Log
@@ -3474,8 +3475,8 @@ export class Log<HandleError extends boolean = boolean> {
3474
3475
  */
3475
3476
  getActionLogByUsername(query: {
3476
3477
  username: string;
3477
- 'start_date(UTC)': string;
3478
- 'end_date(UTC)': string;
3478
+ "start_date(UTC)": string;
3479
+ "end_date(UTC)": string;
3479
3480
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasActionLogResponsewithPagination, HandleError>>;
3480
3481
  }
3481
3482
  export class Permission<HandleError extends boolean = boolean> {
@@ -4451,14 +4452,14 @@ export class Quote<HandleError extends boolean = boolean> {
4451
4452
  platform?: string;
4452
4453
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasNightSessionMarketHoliday[], HandleError>>;
4453
4454
  /**
4454
- * @tags Quote
4455
- * @name GetUsMasterFile
4456
- * @summary Get US End of Day master file - All users - available in Microservice
4457
- Streams upstream response directly to the client to reduce latency and memory usage.
4458
- Adds short-lived cache to avoid repeated network calls.
4459
- * @request GET:/api/quote/us-master-file
4460
- * @secure
4461
- */
4455
+ * @tags Quote
4456
+ * @name GetUsMasterFile
4457
+ * @summary Get US End of Day master file - All users - available in Microservice
4458
+ Streams upstream response directly to the client to reduce latency and memory usage.
4459
+ Adds short-lived cache to avoid repeated network calls.
4460
+ * @request GET:/api/quote/us-master-file
4461
+ * @secure
4462
+ */
4462
4463
  getUsMasterFile(query?: {
4463
4464
  /**
4464
4465
  * Optional. Must input if enterprise user query on behalf of their clients
@@ -5010,6 +5011,18 @@ export class User<HandleError extends boolean = boolean> {
5010
5011
  putUserDataConfig(query: {
5011
5012
  user_id: string;
5012
5013
  }, data: AesMidasUserDataConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5014
+ /**
5015
+ * @description Pass target_firm_id to move, or omit/empty to unlink.
5016
+ * @tags User
5017
+ * @name PutUserFirm
5018
+ * @summary Move a UMA user to a different firm or unlink from current firm
5019
+ * @request PUT:/api/user/user-firm
5020
+ * @secure
5021
+ */
5022
+ putUserFirm(query: {
5023
+ user_id: string;
5024
+ target_firm_id?: string;
5025
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5013
5026
  /**
5014
5027
  * @tags User
5015
5028
  * @name GetUserDataConfigById
@@ -5091,14 +5104,14 @@ export class WebSocketEvent<HandleError extends boolean = boolean> {
5091
5104
  protected readonly apiClient: JwtClient<HandleError>;
5092
5105
  constructor(apiClient: JwtClient<HandleError>);
5093
5106
  /**
5094
- * @tags WebSocketEvent
5095
- * @name GetWsevent
5096
- * @summary WebSocket endpoint for Redis event-based subscription mode
5097
- Supports Polygon FMV subscriptions with optimized batch processing
5098
- Uses optimized approach with Redis Keyspace Notifications for real-time updates
5099
- * @request GET:/wsevent
5100
- * @secure
5101
- */
5107
+ * @tags WebSocketEvent
5108
+ * @name GetWsevent
5109
+ * @summary WebSocket endpoint for Redis event-based subscription mode
5110
+ Supports Polygon FMV subscriptions with optimized batch processing
5111
+ Uses optimized approach with Redis Keyspace Notifications for real-time updates
5112
+ * @request GET:/wsevent
5113
+ * @secure
5114
+ */
5102
5115
  getWsevent(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5103
5116
  }
5104
5117
  export class WsStream<HandleError extends boolean = boolean> {