@orbis-systems/orbis-api-clients 0.8.10 → 1.1.0

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 +833 -794
  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 +3385 -9823
  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/index.d.ts +41 -21
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.esm.js +1 -1
  16. package/dist/index.esm.js.map +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/index.js.map +1 -1
  19. package/dist/insight/index.d.ts +1613 -1294
  20. package/dist/insight/index.d.ts.map +1 -1
  21. package/dist/insight/index.esm.js +1 -1
  22. package/dist/insight/index.esm.js.map +1 -1
  23. package/dist/insight/index.js +1 -1
  24. package/dist/insight/index.js.map +1 -1
  25. package/dist/middleware/index.d.ts +273 -220
  26. package/dist/middleware/index.d.ts.map +1 -1
  27. package/dist/middleware/index.esm.js +1 -1
  28. package/dist/middleware/index.esm.js.map +1 -1
  29. package/dist/middleware/index.js +1 -1
  30. package/dist/middleware/index.js.map +1 -1
  31. package/dist/orbis/index.d.ts +4076 -4021
  32. package/dist/orbis/index.d.ts.map +1 -1
  33. package/dist/orbis/index.esm.js +1 -1
  34. package/dist/orbis/index.esm.js.map +1 -1
  35. package/dist/orbis/index.js +1 -1
  36. package/dist/orbis/index.js.map +1 -1
  37. package/dist/uma/index.d.ts +958 -879
  38. package/dist/uma/index.d.ts.map +1 -1
  39. package/dist/uma/index.esm.js +1 -1
  40. package/dist/uma/index.esm.js.map +1 -1
  41. package/dist/uma/index.js +1 -1
  42. package/dist/uma/index.js.map +1 -1
  43. package/package.json +157 -155
@@ -1,8 +1,23 @@
1
1
  import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
2
- interface BaseClientConfig<HandleError extends boolean = boolean> {
2
+ enum CaseFormat {
3
+ Camel = "camel",
4
+ Snake = "snake",
5
+ Original = "original"
6
+ }
7
+ type CamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${Lowercase<T>}${Capitalize<CamelCase<U>>}` : S extends Uppercase<S> ? Lowercase<S> : S;
8
+ type SnakeCase<S extends string> = S extends `${infer T}${infer U}` ? T extends Uppercase<T> ? T extends Lowercase<T> ? `${T}${SnakeCase<U>}` : `_${Lowercase<T>}${SnakeCase<U>}` : `${T}${SnakeCase<U>}` : S;
9
+ type CamelCaseKeys<T> = T extends Array<infer U> ? Array<CamelCaseKeys<U>> : T extends object ? {
10
+ [K in keyof T as CamelCase<K & string>]: CamelCaseKeys<T[K]>;
11
+ } : T;
12
+ type SnakeCaseKeys<T> = T extends Array<infer U> ? Array<SnakeCaseKeys<U>> : T extends object ? {
13
+ [K in keyof T as SnakeCase<K & string>]: SnakeCaseKeys<T[K]>;
14
+ } : T;
15
+ type TransformData<T, F extends CaseFormat | undefined> = CaseFormat.Original | undefined extends F ? T : F extends CaseFormat.Camel ? CamelCaseKeys<T> : F extends CaseFormat.Snake ? SnakeCaseKeys<T> : T;
16
+ interface BaseClientConfig<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
3
17
  debug?: boolean;
4
18
  baseUrl: string;
5
19
  handleError?: HandleError;
20
+ caseFormat?: Format;
6
21
  storage?: Storage;
7
22
  defaultSecure?: boolean;
8
23
  authDataStorageKey?: string;
@@ -25,43 +40,46 @@ type ResponseStatus = {
25
40
  status: HttpStatusCode | -1;
26
41
  statusText: string;
27
42
  };
28
- type SuccessClientResponse<Data = unknown> = ResponseStatus & {
43
+ type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus & {
29
44
  success: true;
30
45
  data: Data;
46
+ rawData: RawData;
31
47
  };
32
48
  type ErrorClientResponse = ResponseStatus & {
33
49
  success: false;
34
50
  data?: any;
51
+ rawData?: any;
35
52
  error: unknown;
36
53
  };
37
- type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
38
- declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
39
- protected readonly config: BaseClientConfig<HandleError>;
54
+ type ClientResponse<Data = unknown, HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> = HandleError extends true ? SuccessClientResponse<TransformData<Data, Format>, Data> | ErrorClientResponse : SuccessClientResponse<TransformData<Data, Format>, Data>;
55
+ declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
56
+ protected readonly config: BaseClientConfig<HandleError, Format>;
40
57
  protected readonly axiosInstance: AxiosInstance;
41
58
  protected readonly storage: Storage;
42
- constructor(config: BaseClientConfig<HandleError>);
59
+ constructor(config: BaseClientConfig<HandleError, Format>);
60
+ protected transformData<T>(data: any): TransformData<T, Format>;
43
61
  protected stringifyFormItem(formItem: unknown): string;
44
62
  protected createFormData(input: Record<string, unknown>): FormData;
45
- request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
46
- get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
47
- delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
48
- head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
49
- options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
50
- post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
51
- put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
52
- patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
63
+ request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
64
+ get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
65
+ delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
66
+ head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
67
+ options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
68
+ post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
69
+ put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
70
+ patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
53
71
  getAxios(): AxiosInstance;
54
72
  setAuthData(data: AuthData | null): void;
55
73
  getAuthData(): AuthData | null;
56
- getConfig(): BaseClientConfig<HandleError>;
74
+ getConfig(): BaseClientConfig<HandleError, Format>;
57
75
  protected abstract prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
58
76
  }
59
- declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
77
+ declare abstract class BaseApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, ApiClient extends BaseClient<HandleError, Format, unknown> = BaseClient<HandleError, Format>> {
60
78
  protected readonly apiClient: ApiClient;
61
79
  constructor(apiClient: ApiClient);
62
80
  getApiClient(): ApiClient;
63
81
  }
64
- interface JwtClientConfig<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError> {
82
+ interface JwtClientConfig<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError, Format> {
65
83
  authSchema?: string;
66
84
  autoRenewToken?: boolean;
67
85
  onRenewTokens?: () => Promise<AuthData>;
@@ -70,10 +88,10 @@ interface JwtAuthData {
70
88
  accessToken: string;
71
89
  refreshToken?: string;
72
90
  }
73
- declare class JwtClient<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, AuthData> {
74
- protected readonly config: JwtClientConfig<HandleError, AuthData>;
75
- constructor(config: JwtClientConfig<HandleError, AuthData>);
76
- getConfig(): JwtClientConfig<HandleError>;
91
+ declare class JwtClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, Format, AuthData> {
92
+ protected readonly config: JwtClientConfig<HandleError, Format, AuthData>;
93
+ constructor(config: JwtClientConfig<HandleError, Format, AuthData>);
94
+ getConfig(): JwtClientConfig<HandleError, Format, AuthData>;
77
95
  setRenewTokensCallback(renewTokensCallback: () => Promise<AuthData>): void;
78
96
  protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
79
97
  protected renewTokens(): Promise<AuthData>;
@@ -263,6 +281,13 @@ export interface MiddlewareRebalanceRecommendationDto {
263
281
  lastPrice: number;
264
282
  cashOnAccount: number;
265
283
  }
284
+ export interface MiddlewareBankingNotificationDto {
285
+ /** @example "Hello, this is a plain text message" */
286
+ text?: string;
287
+ /** @example "<h1>Hello</h1><p>This is an HTML message</p>" */
288
+ html?: string;
289
+ attachments?: File[];
290
+ }
266
291
  /**
267
292
  * Default to `equity` if not provided
268
293
  * @default "equity"
@@ -299,55 +324,35 @@ export enum MiddlewareRebalanceRecommendationDtoTransactionEnum {
299
324
  BUY = "BUY",
300
325
  SELL = "SELL"
301
326
  }
302
- export class AvatarApi<HandleError extends boolean = boolean> {
303
- protected readonly apiClient: JwtClient<HandleError>;
304
- constructor(apiClient: JwtClient<HandleError>);
305
- /**
306
- * @tags AvatarApi
307
- * @name GetUserAvatar
308
- * @request GET:/api/v1/avatars/users/{userId}
309
- * @secure
310
- */
311
- getUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
312
- /**
313
- * @tags AvatarApi
314
- * @name UploadUserAvatar
315
- * @request POST:/api/v1/avatars/users/{userId}
316
- * @secure
317
- */
318
- uploadUserAvatar(userId: number, data: MiddlewareAvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
319
- /**
320
- * @tags AvatarApi
321
- * @name DeleteUserAvatar
322
- * @request DELETE:/api/v1/avatars/users/{userId}
323
- * @secure
324
- */
325
- deleteUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
326
- /**
327
- * @tags AvatarApi
328
- * @name GetAccountAvatar
329
- * @request GET:/api/v1/avatars/accounts/{accountId}
330
- * @secure
331
- */
332
- getAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
327
+ export enum MiddlewareNotifyBankingParamsBankingTypeEnum {
328
+ Deposit = "deposit",
329
+ Withdrawal = "withdrawal"
330
+ }
331
+ export enum MiddlewareNotifyBankingParamsEnum {
332
+ Deposit = "deposit",
333
+ Withdrawal = "withdrawal"
334
+ }
335
+ export class AttributeApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
336
+ protected readonly apiClient: JwtClient<HandleError, Format>;
337
+ constructor(apiClient: JwtClient<HandleError, Format>);
333
338
  /**
334
- * @tags AvatarApi
335
- * @name UploadAccountAvatar
336
- * @request POST:/api/v1/avatars/accounts/{accountId}
339
+ * @tags AttributeApi
340
+ * @name GetAttributeValues
341
+ * @request GET:/api/v1/attributes
337
342
  * @secure
338
343
  */
339
- uploadAccountAvatar(accountId: number, data: MiddlewareAvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
344
+ getAttributeValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string | number | boolean>, HandleError, Format>>;
340
345
  /**
341
- * @tags AvatarApi
342
- * @name DeleteAccountAvatar
343
- * @request DELETE:/api/v1/avatars/accounts/{accountId}
346
+ * @tags AttributeApi
347
+ * @name GetPublicAttributeValue
348
+ * @request GET:/api/v1/attributes/{attributePublicId}
344
349
  * @secure
345
350
  */
346
- deleteAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
351
+ getPublicAttributeValue(attributePublicId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<string | number | boolean, HandleError, Format>>;
347
352
  }
348
- export class AuthenticationApi<HandleError extends boolean = boolean> {
349
- protected readonly apiClient: JwtClient<HandleError>;
350
- constructor(apiClient: JwtClient<HandleError>);
353
+ export class AuthenticationApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
354
+ protected readonly apiClient: JwtClient<HandleError, Format>;
355
+ constructor(apiClient: JwtClient<HandleError, Format>);
351
356
  /**
352
357
  * @tags AuthenticationApi
353
358
  * @name Authenticate
@@ -355,16 +360,16 @@ export class AuthenticationApi<HandleError extends boolean = boolean> {
355
360
  */
356
361
  authenticate(headers: {
357
362
  /** Application environment (for different firms) */
358
- "Application-Env"?: string;
363
+ 'Application-Env'?: string;
359
364
  /** Firm's id from UMA */
360
- "Firm-Id": string;
365
+ 'Firm-Id': string;
361
366
  /** Custom watchmen API for token validation. Defaults to token issuer claim if not provided */
362
- "Watchmen-Api"?: string;
367
+ 'Watchmen-Api'?: string;
363
368
  /** Watchmen authorization token (it's `sessionId` from Watchmen's `login` endpoint) */
364
- "Watchmen-Token": string;
369
+ 'Watchmen-Token': string;
365
370
  /** Name of the application using middleware */
366
- "Application-Name": string;
367
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareUserTokensDto, HandleError>>;
371
+ 'Application-Name': string;
372
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareUserTokensDto, HandleError, Format>>;
368
373
  /**
369
374
  * @description Must use `refreshToken` instead of `accessToken` in `Authorization` header
370
375
  * @tags AuthenticationApi
@@ -372,260 +377,299 @@ export class AuthenticationApi<HandleError extends boolean = boolean> {
372
377
  * @request POST:/api/v1/refresh
373
378
  * @secure
374
379
  */
375
- refresh(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareUserTokensDto, HandleError>>;
380
+ refresh(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareUserTokensDto, HandleError, Format>>;
376
381
  /**
377
382
  * @tags AuthenticationApi
378
383
  * @name Invalidate
379
384
  * @request POST:/api/v1/invalidate
380
385
  * @secure
381
386
  */
382
- invalidate(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
383
- }
384
- export class AttributeApi<HandleError extends boolean = boolean> {
385
- protected readonly apiClient: JwtClient<HandleError>;
386
- constructor(apiClient: JwtClient<HandleError>);
387
- /**
388
- * @tags AttributeApi
389
- * @name GetAttributeValues
390
- * @request GET:/api/v1/attributes
391
- * @secure
392
- */
393
- getAttributeValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string | number | boolean>, HandleError>>;
394
- /**
395
- * @tags AttributeApi
396
- * @name GetPublicAttributeValue
397
- * @request GET:/api/v1/attributes/{attributePublicId}
398
- * @secure
399
- */
400
- getPublicAttributeValue(attributePublicId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<string | number | boolean, HandleError>>;
401
- }
402
- export class MessageApi<HandleError extends boolean = boolean> {
403
- protected readonly apiClient: JwtClient<HandleError>;
404
- constructor(apiClient: JwtClient<HandleError>);
405
- /**
406
- * @tags MessageApi
407
- * @name GetMessages
408
- * @request GET:/api/v1/messages
409
- * @secure
410
- */
411
- getMessages(query?: {
412
- /** Get messages in preferred language. If not provided or there is no translation for the chosen language, default one will be used. */
413
- languageCode?: string;
414
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareMessageDto[], HandleError>>;
415
- /**
416
- * @tags MessageApi
417
- * @name MarkAllAsSeen
418
- * @request PATCH:/api/v1/messages/mark-as-seen
419
- * @secure
420
- */
421
- markAllAsSeen(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
422
- /**
423
- * @tags MessageApi
424
- * @name MarkSingleAsSeen
425
- * @request PATCH:/api/v1/messages/mark-as-seen/{messageId}
426
- * @secure
427
- */
428
- markSingleAsSeen(messageId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
387
+ invalidate(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
429
388
  }
430
- export class WatchlistApi<HandleError extends boolean = boolean> {
431
- protected readonly apiClient: JwtClient<HandleError>;
432
- constructor(apiClient: JwtClient<HandleError>);
389
+ export class AvatarApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
390
+ protected readonly apiClient: JwtClient<HandleError, Format>;
391
+ constructor(apiClient: JwtClient<HandleError, Format>);
433
392
  /**
434
- * @tags WatchlistApi
435
- * @name GetAllWatchlists
436
- * @request GET:/api/v1/watchlists
437
- * @secure
438
- */
439
- getAllWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto[], HandleError>>;
440
- /**
441
- * @tags WatchlistApi
442
- * @name CreateWatchlist
443
- * @request POST:/api/v1/watchlists
444
- * @secure
445
- */
446
- createWatchlist(data: MiddlewarePersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
447
- /**
448
- * @tags WatchlistApi
449
- * @name GetWatchlist
450
- * @request GET:/api/v1/watchlists/{watchlistId}
451
- * @secure
452
- */
453
- getWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
454
- /**
455
- * @tags WatchlistApi
456
- * @name UpdateWatchlist
457
- * @request PUT:/api/v1/watchlists/{watchlistId}
458
- * @secure
459
- */
460
- updateWatchlist(watchlistId: number, data: MiddlewarePersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
461
- /**
462
- * @tags WatchlistApi
463
- * @name DeleteWatchlist
464
- * @request DELETE:/api/v1/watchlists/{watchlistId}
393
+ * @tags AvatarApi
394
+ * @name GetUserAvatar
395
+ * @request GET:/api/v1/avatars/users/{userId}
465
396
  * @secure
466
397
  */
467
- deleteWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
398
+ getUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Blob, HandleError, Format>>;
468
399
  /**
469
- * @tags WatchlistApi
470
- * @name AddWatchlistEntries
471
- * @request POST:/api/v1/watchlists/{watchlistId}/entries
400
+ * @tags AvatarApi
401
+ * @name UploadUserAvatar
402
+ * @request POST:/api/v1/avatars/users/{userId}
472
403
  * @secure
473
404
  */
474
- addWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
405
+ uploadUserAvatar(userId: number, data: MiddlewareAvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
475
406
  /**
476
- * @tags WatchlistApi
477
- * @name RemoveWatchlistEntries
478
- * @request DELETE:/api/v1/watchlists/{watchlistId}/entries
407
+ * @tags AvatarApi
408
+ * @name DeleteUserAvatar
409
+ * @request DELETE:/api/v1/avatars/users/{userId}
479
410
  * @secure
480
411
  */
481
- removeWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
412
+ deleteUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
482
413
  /**
483
- * @tags WatchlistApi
484
- * @name UpdateWatchlistEntries
485
- * @request PUT:/api/v1/watchlists/{watchlistId}/entries
414
+ * @tags AvatarApi
415
+ * @name GetAccountAvatar
416
+ * @request GET:/api/v1/avatars/accounts/{accountId}
486
417
  * @secure
487
418
  */
488
- updateWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError>>;
419
+ getAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Blob, HandleError, Format>>;
489
420
  /**
490
- * @tags WatchlistApi
491
- * @name UpdateWatchlistOrders
492
- * @request POST:/api/v1/watchlists/orders
421
+ * @tags AvatarApi
422
+ * @name UploadAccountAvatar
423
+ * @request POST:/api/v1/avatars/accounts/{accountId}
493
424
  * @secure
494
425
  */
495
- updateWatchlistOrders(data: MiddlewareWatchlistOrdersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
426
+ uploadAccountAvatar(accountId: number, data: MiddlewareAvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
496
427
  /**
497
- * @tags WatchlistApi
498
- * @name ImportWatchmenWatchlists
499
- * @request POST:/api/v1/watchlists/import
428
+ * @tags AvatarApi
429
+ * @name DeleteAccountAvatar
430
+ * @request DELETE:/api/v1/avatars/accounts/{accountId}
500
431
  * @secure
501
432
  */
502
- importWatchmenWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
433
+ deleteAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
503
434
  }
504
- export class ChartApi<HandleError extends boolean = boolean> {
505
- protected readonly apiClient: JwtClient<HandleError>;
506
- constructor(apiClient: JwtClient<HandleError>);
435
+ export class ChartApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
436
+ protected readonly apiClient: JwtClient<HandleError, Format>;
437
+ constructor(apiClient: JwtClient<HandleError, Format>);
507
438
  /**
508
439
  * @tags ChartApi
509
440
  * @name GetChartLayouts
510
441
  * @request GET:/api/v1/charts/layouts
511
442
  * @secure
512
443
  */
513
- getChartLayouts(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDto[], HandleError>>;
444
+ getChartLayouts(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDto[], HandleError, Format>>;
514
445
  /**
515
446
  * @tags ChartApi
516
447
  * @name UpdateChartLayout
517
448
  * @request PUT:/api/v1/charts/layouts
518
449
  * @secure
519
450
  */
520
- updateChartLayout(data: MiddlewareChartLayoutDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDetailsDto, HandleError>>;
451
+ updateChartLayout(data: MiddlewareChartLayoutDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDetailsDto, HandleError, Format>>;
521
452
  /**
522
453
  * @tags ChartApi
523
454
  * @name GetChartLayoutDetails
524
455
  * @request GET:/api/v1/charts/layouts/{chartId}
525
456
  * @secure
526
457
  */
527
- getChartLayoutDetails(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDetailsDto, HandleError>>;
458
+ getChartLayoutDetails(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartLayoutDetailsDto, HandleError, Format>>;
528
459
  /**
529
460
  * @tags ChartApi
530
461
  * @name DeleteChartLayout
531
462
  * @request DELETE:/api/v1/charts/layouts/{chartId}
532
463
  * @secure
533
464
  */
534
- deleteChartLayout(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
465
+ deleteChartLayout(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
535
466
  /**
536
467
  * @tags ChartApi
537
468
  * @name GetIndicatorTemplates
538
469
  * @request GET:/api/v1/charts/indicator-templates
539
470
  * @secure
540
471
  */
541
- getIndicatorTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartDataDto[], HandleError>>;
472
+ getIndicatorTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartDataDto[], HandleError, Format>>;
542
473
  /**
543
474
  * @tags ChartApi
544
475
  * @name UpdateIndicatorTemplate
545
476
  * @request PUT:/api/v1/charts/indicator-templates
546
477
  * @secure
547
478
  */
548
- updateIndicatorTemplate(data: MiddlewareChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError>>;
479
+ updateIndicatorTemplate(data: MiddlewareChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError, Format>>;
549
480
  /**
550
481
  * @tags ChartApi
551
482
  * @name GetIndicatorTemplateDetails
552
483
  * @request GET:/api/v1/charts/indicator-templates/{templateName}
553
484
  * @secure
554
485
  */
555
- getIndicatorTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError>>;
486
+ getIndicatorTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError, Format>>;
556
487
  /**
557
488
  * @tags ChartApi
558
489
  * @name DeleteIndicatorTemplate
559
490
  * @request DELETE:/api/v1/charts/indicator-templates/{templateName}
560
491
  * @secure
561
492
  */
562
- deleteIndicatorTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
493
+ deleteIndicatorTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
563
494
  /**
564
495
  * @tags ChartApi
565
496
  * @name GetChartTemplates
566
497
  * @request GET:/api/v1/charts/templates
567
498
  * @secure
568
499
  */
569
- getChartTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartDataDto[], HandleError>>;
500
+ getChartTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartDataDto[], HandleError, Format>>;
570
501
  /**
571
502
  * @tags ChartApi
572
503
  * @name UpdateChartTemplate
573
504
  * @request PUT:/api/v1/charts/templates
574
505
  * @secure
575
506
  */
576
- updateChartTemplate(data: MiddlewareChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError>>;
507
+ updateChartTemplate(data: MiddlewareChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError, Format>>;
577
508
  /**
578
509
  * @tags ChartApi
579
510
  * @name GetChartTemplateDetails
580
511
  * @request GET:/api/v1/charts/templates/{templateName}
581
512
  * @secure
582
513
  */
583
- getChartTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError>>;
514
+ getChartTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareChartTemplateDto, HandleError, Format>>;
584
515
  /**
585
516
  * @tags ChartApi
586
517
  * @name DeleteChartTemplate
587
518
  * @request DELETE:/api/v1/charts/templates/{templateName}
588
519
  * @secure
589
520
  */
590
- deleteChartTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
521
+ deleteChartTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
591
522
  }
592
- export class VersioningApi<HandleError extends boolean = boolean> {
593
- protected readonly apiClient: JwtClient<HandleError>;
594
- constructor(apiClient: JwtClient<HandleError>);
523
+ export class LlmApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
524
+ protected readonly apiClient: JwtClient<HandleError, Format>;
525
+ constructor(apiClient: JwtClient<HandleError, Format>);
595
526
  /**
596
- * @tags VersioningApi
597
- * @name GetAppVersion
598
- * @request GET:/api/versioning/{appId}
527
+ * @tags LlmApi
528
+ * @name Chat
529
+ * @request POST:/api/v1/llm/chat
530
+ * @secure
599
531
  */
600
- getAppVersion(appId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareAppVersionDto, HandleError>>;
532
+ chat(config?: RequestConfig<HandleError>): Promise<ClientResponse<object, HandleError, Format>>;
533
+ }
534
+ export class MessageApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
535
+ protected readonly apiClient: JwtClient<HandleError, Format>;
536
+ constructor(apiClient: JwtClient<HandleError, Format>);
601
537
  /**
602
- * @tags VersioningApi
603
- * @name UpdateAppVersion
604
- * @request POST:/api/versioning/{appId}
538
+ * @tags MessageApi
539
+ * @name GetMessages
540
+ * @request GET:/api/v1/messages
541
+ * @secure
605
542
  */
606
- updateAppVersion(appId: string, data: MiddlewareAppVersionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
543
+ getMessages(query?: {
544
+ /** Get messages in preferred language. If not provided or there is no translation for the chosen language, default one will be used. */
545
+ languageCode?: string;
546
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareMessageDto[], HandleError, Format>>;
547
+ /**
548
+ * @tags MessageApi
549
+ * @name MarkAllAsSeen
550
+ * @request PATCH:/api/v1/messages/mark-as-seen
551
+ * @secure
552
+ */
553
+ markAllAsSeen(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
554
+ /**
555
+ * @tags MessageApi
556
+ * @name MarkSingleAsSeen
557
+ * @request PATCH:/api/v1/messages/mark-as-seen/{messageId}
558
+ * @secure
559
+ */
560
+ markSingleAsSeen(messageId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
607
561
  }
608
- export class PreferenceApi<HandleError extends boolean = boolean> {
609
- protected readonly apiClient: JwtClient<HandleError>;
610
- constructor(apiClient: JwtClient<HandleError>);
562
+ export class PreferenceApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
563
+ protected readonly apiClient: JwtClient<HandleError, Format>;
564
+ constructor(apiClient: JwtClient<HandleError, Format>);
611
565
  /**
612
566
  * @tags PreferenceApi
613
567
  * @name GetPreferences
614
568
  * @request GET:/api/v1/preferences
615
569
  * @secure
616
570
  */
617
- getPreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
571
+ getPreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError, Format>>;
618
572
  /**
619
573
  * @tags PreferenceApi
620
574
  * @name SavePreferences
621
575
  * @request POST:/api/v1/preferences
622
576
  * @secure
623
577
  */
624
- savePreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
578
+ savePreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError, Format>>;
625
579
  }
626
- export class WatchmenApi<HandleError extends boolean = boolean> {
627
- protected readonly apiClient: JwtClient<HandleError>;
628
- constructor(apiClient: JwtClient<HandleError>);
580
+ export class VersioningApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
581
+ protected readonly apiClient: JwtClient<HandleError, Format>;
582
+ constructor(apiClient: JwtClient<HandleError, Format>);
583
+ /**
584
+ * @tags VersioningApi
585
+ * @name GetAppVersion
586
+ * @request GET:/api/versioning/{appId}
587
+ */
588
+ getAppVersion(appId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareAppVersionDto, HandleError, Format>>;
589
+ /**
590
+ * @tags VersioningApi
591
+ * @name UpdateAppVersion
592
+ * @request POST:/api/versioning/{appId}
593
+ */
594
+ updateAppVersion(appId: string, data: MiddlewareAppVersionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
595
+ }
596
+ export class WatchlistApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
597
+ protected readonly apiClient: JwtClient<HandleError, Format>;
598
+ constructor(apiClient: JwtClient<HandleError, Format>);
599
+ /**
600
+ * @tags WatchlistApi
601
+ * @name GetAllWatchlists
602
+ * @request GET:/api/v1/watchlists
603
+ * @secure
604
+ */
605
+ getAllWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto[], HandleError, Format>>;
606
+ /**
607
+ * @tags WatchlistApi
608
+ * @name CreateWatchlist
609
+ * @request POST:/api/v1/watchlists
610
+ * @secure
611
+ */
612
+ createWatchlist(data: MiddlewarePersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
613
+ /**
614
+ * @tags WatchlistApi
615
+ * @name GetWatchlist
616
+ * @request GET:/api/v1/watchlists/{watchlistId}
617
+ * @secure
618
+ */
619
+ getWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
620
+ /**
621
+ * @tags WatchlistApi
622
+ * @name UpdateWatchlist
623
+ * @request PUT:/api/v1/watchlists/{watchlistId}
624
+ * @secure
625
+ */
626
+ updateWatchlist(watchlistId: number, data: MiddlewarePersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
627
+ /**
628
+ * @tags WatchlistApi
629
+ * @name DeleteWatchlist
630
+ * @request DELETE:/api/v1/watchlists/{watchlistId}
631
+ * @secure
632
+ */
633
+ deleteWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
634
+ /**
635
+ * @tags WatchlistApi
636
+ * @name AddWatchlistEntries
637
+ * @request POST:/api/v1/watchlists/{watchlistId}/entries
638
+ * @secure
639
+ */
640
+ addWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
641
+ /**
642
+ * @tags WatchlistApi
643
+ * @name RemoveWatchlistEntries
644
+ * @request DELETE:/api/v1/watchlists/{watchlistId}/entries
645
+ * @secure
646
+ */
647
+ removeWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
648
+ /**
649
+ * @tags WatchlistApi
650
+ * @name UpdateWatchlistEntries
651
+ * @request PUT:/api/v1/watchlists/{watchlistId}/entries
652
+ * @secure
653
+ */
654
+ updateWatchlistEntries(watchlistId: number, data: MiddlewareWatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareWatchlistDto, HandleError, Format>>;
655
+ /**
656
+ * @tags WatchlistApi
657
+ * @name UpdateWatchlistOrders
658
+ * @request POST:/api/v1/watchlists/orders
659
+ * @secure
660
+ */
661
+ updateWatchlistOrders(data: MiddlewareWatchlistOrdersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
662
+ /**
663
+ * @tags WatchlistApi
664
+ * @name ImportWatchmenWatchlists
665
+ * @request POST:/api/v1/watchlists/import
666
+ * @secure
667
+ */
668
+ importWatchmenWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
669
+ }
670
+ export class WatchmenApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
671
+ protected readonly apiClient: JwtClient<HandleError, Format>;
672
+ constructor(apiClient: JwtClient<HandleError, Format>);
629
673
  /**
630
674
  * @tags WatchmenApi
631
675
  * @name GetModelRebalanceRecommendations
@@ -633,20 +677,29 @@ export class WatchmenApi<HandleError extends boolean = boolean> {
633
677
  * @request POST:/api/v1/watchmen/rebalance-recommendations
634
678
  * @secure
635
679
  */
636
- getModelRebalanceRecommendations(data: MiddlewareRebalanceDataDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareRebalanceRecommendationDto[], HandleError>>;
637
- }
638
- export class MiddlewareApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
639
- readonly config: JwtClientConfig<HandleError>;
640
- attribute: AttributeApi<HandleError>;
641
- authentication: AuthenticationApi<HandleError>;
642
- avatar: AvatarApi<HandleError>;
643
- chart: ChartApi<HandleError>;
644
- message: MessageApi<HandleError>;
645
- preference: PreferenceApi<HandleError>;
646
- versioning: VersioningApi<HandleError>;
647
- watchlist: WatchlistApi<HandleError>;
648
- watchmen: WatchmenApi<HandleError>;
649
- constructor(config: JwtClientConfig<HandleError>);
680
+ getModelRebalanceRecommendations(data: MiddlewareRebalanceDataDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MiddlewareRebalanceRecommendationDto[], HandleError, Format>>;
681
+ /**
682
+ * @tags WatchmenApi
683
+ * @name NotifyBanking
684
+ * @summary Send a banking notification email (deposit/withdrawal)
685
+ * @request POST:/api/v1/watchmen/banking-notification/{bankingType}
686
+ * @secure
687
+ */
688
+ notifyBanking(bankingType: MiddlewareNotifyBankingParamsEnum, data: MiddlewareBankingNotificationDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
689
+ }
690
+ export class MiddlewareApi<HandleError extends boolean = false, Format extends CaseFormat = CaseFormat.Original> extends BaseApi<HandleError, Format, JwtClient<HandleError, Format>> {
691
+ readonly config: JwtClientConfig<HandleError, Format>;
692
+ attribute: AttributeApi<HandleError, Format>;
693
+ authentication: AuthenticationApi<HandleError, Format>;
694
+ avatar: AvatarApi<HandleError, Format>;
695
+ chart: ChartApi<HandleError, Format>;
696
+ llmApi: LlmApi<HandleError, Format>;
697
+ message: MessageApi<HandleError, Format>;
698
+ preference: PreferenceApi<HandleError, Format>;
699
+ versioning: VersioningApi<HandleError, Format>;
700
+ watchlist: WatchlistApi<HandleError, Format>;
701
+ watchmen: WatchmenApi<HandleError, Format>;
702
+ constructor(config: JwtClientConfig<HandleError, Format>);
650
703
  }
651
704
 
652
705
  //# sourceMappingURL=index.d.ts.map