@orbis-systems/orbis-api-clients 0.1.6 → 0.1.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/index.d.ts +89 -87
- package/dist/index.d.ts.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/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -243,38 +243,6 @@ export class AttributeApi<HandleError extends boolean = boolean> {
|
|
|
243
243
|
*/
|
|
244
244
|
getPublicAttributeValue(attributePublicId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<string | number | boolean, HandleError>>;
|
|
245
245
|
}
|
|
246
|
-
export class AuthenticationApi<HandleError extends boolean = boolean> {
|
|
247
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
248
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
249
|
-
/**
|
|
250
|
-
* @tags AuthenticationApi
|
|
251
|
-
* @name Authenticate
|
|
252
|
-
* @request POST:/api/v1/authenticate
|
|
253
|
-
*/
|
|
254
|
-
authenticate(headers: {
|
|
255
|
-
/** Firm's id from UMA */
|
|
256
|
-
'Firm-Id': string;
|
|
257
|
-
/** Watchmen authorization token (it's `sessionId` from Watchmen's `login` endpoint) */
|
|
258
|
-
'Watchmen-Token': string;
|
|
259
|
-
/** Name of the application using middleware */
|
|
260
|
-
'Application-Name': string;
|
|
261
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
262
|
-
/**
|
|
263
|
-
* @description Must use `refreshToken` instead of `accessToken` in `Authorization` header
|
|
264
|
-
* @tags AuthenticationApi
|
|
265
|
-
* @name Refresh
|
|
266
|
-
* @request POST:/api/v1/refresh
|
|
267
|
-
* @secure
|
|
268
|
-
*/
|
|
269
|
-
refresh(config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
270
|
-
/**
|
|
271
|
-
* @tags AuthenticationApi
|
|
272
|
-
* @name Invalidate
|
|
273
|
-
* @request POST:/api/v1/invalidate
|
|
274
|
-
* @secure
|
|
275
|
-
*/
|
|
276
|
-
invalidate(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
277
|
-
}
|
|
278
246
|
export class AvatarApi<HandleError extends boolean = boolean> {
|
|
279
247
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
280
248
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -321,6 +289,61 @@ export class AvatarApi<HandleError extends boolean = boolean> {
|
|
|
321
289
|
*/
|
|
322
290
|
deleteAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
323
291
|
}
|
|
292
|
+
export class AuthenticationApi<HandleError extends boolean = boolean> {
|
|
293
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
294
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
295
|
+
/**
|
|
296
|
+
* @tags AuthenticationApi
|
|
297
|
+
* @name Authenticate
|
|
298
|
+
* @request POST:/api/v1/authenticate
|
|
299
|
+
*/
|
|
300
|
+
authenticate(headers: {
|
|
301
|
+
/** Application environment (for different firms) */
|
|
302
|
+
'Application-Env'?: string;
|
|
303
|
+
/** Firm's id from UMA */
|
|
304
|
+
'Firm-Id': string;
|
|
305
|
+
/** Watchmen authorization token (it's `sessionId` from Watchmen's `login` endpoint) */
|
|
306
|
+
'Watchmen-Token': string;
|
|
307
|
+
/** Name of the application using middleware */
|
|
308
|
+
'Application-Name': string;
|
|
309
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
310
|
+
/**
|
|
311
|
+
* @description Must use `refreshToken` instead of `accessToken` in `Authorization` header
|
|
312
|
+
* @tags AuthenticationApi
|
|
313
|
+
* @name Refresh
|
|
314
|
+
* @request POST:/api/v1/refresh
|
|
315
|
+
* @secure
|
|
316
|
+
*/
|
|
317
|
+
refresh(config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
318
|
+
/**
|
|
319
|
+
* @tags AuthenticationApi
|
|
320
|
+
* @name Invalidate
|
|
321
|
+
* @request POST:/api/v1/invalidate
|
|
322
|
+
* @secure
|
|
323
|
+
*/
|
|
324
|
+
invalidate(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
325
|
+
}
|
|
326
|
+
export class MessageApi<HandleError extends boolean = boolean> {
|
|
327
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
328
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
329
|
+
/**
|
|
330
|
+
* @tags MessageApi
|
|
331
|
+
* @name GetMessages
|
|
332
|
+
* @request GET:/api/v1/messages
|
|
333
|
+
* @secure
|
|
334
|
+
*/
|
|
335
|
+
getMessages(query?: {
|
|
336
|
+
/** Get messages in preferred language. If not provided or there is no translation for the chosen language, default one will be used. */
|
|
337
|
+
languageCode?: string;
|
|
338
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<MessageDto[], HandleError>>;
|
|
339
|
+
/**
|
|
340
|
+
* @tags MessageApi
|
|
341
|
+
* @name MarkAsSeen
|
|
342
|
+
* @request PATCH:/api/v1/messages/mark-as-seen
|
|
343
|
+
* @secure
|
|
344
|
+
*/
|
|
345
|
+
markAsSeen(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
346
|
+
}
|
|
324
347
|
export class ChartApi<HandleError extends boolean = boolean> {
|
|
325
348
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
326
349
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -409,61 +432,6 @@ export class ChartApi<HandleError extends boolean = boolean> {
|
|
|
409
432
|
*/
|
|
410
433
|
deleteChartTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
411
434
|
}
|
|
412
|
-
export class MessageApi<HandleError extends boolean = boolean> {
|
|
413
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
414
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
415
|
-
/**
|
|
416
|
-
* @tags MessageApi
|
|
417
|
-
* @name GetMessages
|
|
418
|
-
* @request GET:/api/v1/messages
|
|
419
|
-
* @secure
|
|
420
|
-
*/
|
|
421
|
-
getMessages(query?: {
|
|
422
|
-
/** Get messages in preferred language. If not provided or there is no translation for the chosen language, default one will be used. */
|
|
423
|
-
languageCode?: string;
|
|
424
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<MessageDto[], HandleError>>;
|
|
425
|
-
/**
|
|
426
|
-
* @tags MessageApi
|
|
427
|
-
* @name MarkAsSeen
|
|
428
|
-
* @request PATCH:/api/v1/messages/mark-as-seen
|
|
429
|
-
* @secure
|
|
430
|
-
*/
|
|
431
|
-
markAsSeen(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
432
|
-
}
|
|
433
|
-
export class PreferenceApi<HandleError extends boolean = boolean> {
|
|
434
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
435
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
436
|
-
/**
|
|
437
|
-
* @tags PreferenceApi
|
|
438
|
-
* @name GetPreferences
|
|
439
|
-
* @request GET:/api/v1/preferences
|
|
440
|
-
* @secure
|
|
441
|
-
*/
|
|
442
|
-
getPreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
443
|
-
/**
|
|
444
|
-
* @tags PreferenceApi
|
|
445
|
-
* @name SavePreferences
|
|
446
|
-
* @request POST:/api/v1/preferences
|
|
447
|
-
* @secure
|
|
448
|
-
*/
|
|
449
|
-
savePreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
450
|
-
}
|
|
451
|
-
export class VersioningApi<HandleError extends boolean = boolean> {
|
|
452
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
453
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
454
|
-
/**
|
|
455
|
-
* @tags VersioningApi
|
|
456
|
-
* @name GetAppVersion
|
|
457
|
-
* @request GET:/api/versioning/{appId}
|
|
458
|
-
*/
|
|
459
|
-
getAppVersion(appId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<AppVersionDto, HandleError>>;
|
|
460
|
-
/**
|
|
461
|
-
* @tags VersioningApi
|
|
462
|
-
* @name UpdateAppVersion
|
|
463
|
-
* @request POST:/api/versioning/{appId}
|
|
464
|
-
*/
|
|
465
|
-
updateAppVersion(appId: string, data: AppVersionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
466
|
-
}
|
|
467
435
|
export class WatchlistApi<HandleError extends boolean = boolean> {
|
|
468
436
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
469
437
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -538,6 +506,40 @@ export class WatchlistApi<HandleError extends boolean = boolean> {
|
|
|
538
506
|
*/
|
|
539
507
|
importWatchmenWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
540
508
|
}
|
|
509
|
+
export class PreferenceApi<HandleError extends boolean = boolean> {
|
|
510
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
511
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
512
|
+
/**
|
|
513
|
+
* @tags PreferenceApi
|
|
514
|
+
* @name GetPreferences
|
|
515
|
+
* @request GET:/api/v1/preferences
|
|
516
|
+
* @secure
|
|
517
|
+
*/
|
|
518
|
+
getPreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
519
|
+
/**
|
|
520
|
+
* @tags PreferenceApi
|
|
521
|
+
* @name SavePreferences
|
|
522
|
+
* @request POST:/api/v1/preferences
|
|
523
|
+
* @secure
|
|
524
|
+
*/
|
|
525
|
+
savePreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
526
|
+
}
|
|
527
|
+
export class VersioningApi<HandleError extends boolean = boolean> {
|
|
528
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
529
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
530
|
+
/**
|
|
531
|
+
* @tags VersioningApi
|
|
532
|
+
* @name GetAppVersion
|
|
533
|
+
* @request GET:/api/versioning/{appId}
|
|
534
|
+
*/
|
|
535
|
+
getAppVersion(appId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<AppVersionDto, HandleError>>;
|
|
536
|
+
/**
|
|
537
|
+
* @tags VersioningApi
|
|
538
|
+
* @name UpdateAppVersion
|
|
539
|
+
* @request POST:/api/versioning/{appId}
|
|
540
|
+
*/
|
|
541
|
+
updateAppVersion(appId: string, data: AppVersionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
542
|
+
}
|
|
541
543
|
export class MiddlewareApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
542
544
|
attribute: AttributeApi<HandleError>;
|
|
543
545
|
authentication: AuthenticationApi<HandleError>;
|