@orbis-systems/orbis-api-clients 0.1.0 → 0.1.1
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 +2115 -215
- 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
|
@@ -78,20 +78,25 @@ export interface ValidationError {
|
|
|
78
78
|
meta?: Record<string, string | number>;
|
|
79
79
|
}
|
|
80
80
|
export interface ValidationExceptionDto {
|
|
81
|
+
/** @default [] */
|
|
81
82
|
errors: ValidationError[];
|
|
82
83
|
id: string;
|
|
83
84
|
message: string;
|
|
85
|
+
/** @format date-time */
|
|
84
86
|
timestamp: string;
|
|
85
87
|
}
|
|
86
88
|
export interface ExceptionDto {
|
|
87
89
|
id: string;
|
|
88
90
|
message: string;
|
|
91
|
+
/** @format date-time */
|
|
89
92
|
timestamp: string;
|
|
90
93
|
}
|
|
91
94
|
export interface AvatarUploadDto {
|
|
95
|
+
/** @format binary */
|
|
92
96
|
image: File;
|
|
93
97
|
}
|
|
94
98
|
export interface UserTokensDto {
|
|
99
|
+
/** Deprecated. Use `accessToken` instead */
|
|
95
100
|
apiToken: string;
|
|
96
101
|
accessToken: string;
|
|
97
102
|
refreshToken: string;
|
|
@@ -99,20 +104,27 @@ export interface UserTokensDto {
|
|
|
99
104
|
}
|
|
100
105
|
export interface MessageDto {
|
|
101
106
|
id: number;
|
|
107
|
+
/** @maxLength 64 */
|
|
102
108
|
title: string;
|
|
109
|
+
/** @maxLength 512 */
|
|
103
110
|
content: string;
|
|
111
|
+
/** @default false */
|
|
104
112
|
isRtl: boolean;
|
|
105
113
|
}
|
|
106
114
|
export interface ChartLayoutDto {
|
|
107
115
|
id: number;
|
|
116
|
+
/** @maxLength 16 */
|
|
108
117
|
symbol: string;
|
|
118
|
+
/** @maxLength 8 */
|
|
109
119
|
resolution: string;
|
|
110
120
|
timestamp: object;
|
|
111
121
|
name: string;
|
|
112
122
|
}
|
|
113
123
|
export interface ChartLayoutDetailsDto {
|
|
114
124
|
id: number;
|
|
125
|
+
/** @maxLength 16 */
|
|
115
126
|
symbol: string;
|
|
127
|
+
/** @maxLength 8 */
|
|
116
128
|
resolution: string;
|
|
117
129
|
timestamp: object;
|
|
118
130
|
name: string;
|
|
@@ -126,25 +138,59 @@ export interface ChartTemplateDto {
|
|
|
126
138
|
content: string;
|
|
127
139
|
}
|
|
128
140
|
export interface WatchlistEntryDto {
|
|
129
|
-
|
|
141
|
+
/**
|
|
142
|
+
* Default to `equity` if not provided
|
|
143
|
+
* @default "equity"
|
|
144
|
+
*/
|
|
145
|
+
type?: WatchlistEntryDtoTypeEnum;
|
|
130
146
|
symbol: string;
|
|
131
147
|
}
|
|
132
148
|
export interface WatchlistDto {
|
|
133
149
|
id: number;
|
|
150
|
+
/**
|
|
151
|
+
* Setting this to `true` would automatically mark other watchlists of the same user to not default
|
|
152
|
+
* @default false
|
|
153
|
+
*/
|
|
134
154
|
isDefault: boolean;
|
|
155
|
+
/** @maxLength 64 */
|
|
135
156
|
name: string;
|
|
157
|
+
/**
|
|
158
|
+
* @maxLength 256
|
|
159
|
+
* @default ""
|
|
160
|
+
*/
|
|
136
161
|
description: string;
|
|
162
|
+
/**
|
|
163
|
+
* @maxLength 10
|
|
164
|
+
* @default ""
|
|
165
|
+
*/
|
|
137
166
|
color: string;
|
|
167
|
+
/** @default null */
|
|
138
168
|
order: number | null;
|
|
169
|
+
/** @default [] */
|
|
139
170
|
entries: WatchlistEntryDto[];
|
|
140
171
|
}
|
|
141
172
|
export interface PersistWatchlistDto {
|
|
142
173
|
id: number;
|
|
174
|
+
/**
|
|
175
|
+
* Setting this to `true` would automatically mark other watchlists of the same user to not default
|
|
176
|
+
* @default false
|
|
177
|
+
*/
|
|
143
178
|
isDefault?: boolean;
|
|
179
|
+
/** @maxLength 64 */
|
|
144
180
|
name: string;
|
|
181
|
+
/**
|
|
182
|
+
* @maxLength 256
|
|
183
|
+
* @default ""
|
|
184
|
+
*/
|
|
145
185
|
description?: string;
|
|
186
|
+
/**
|
|
187
|
+
* @maxLength 10
|
|
188
|
+
* @default ""
|
|
189
|
+
*/
|
|
146
190
|
color?: string;
|
|
191
|
+
/** @default null */
|
|
147
192
|
order?: number | null;
|
|
193
|
+
/** @default [] */
|
|
148
194
|
entries?: WatchlistEntryDto[];
|
|
149
195
|
}
|
|
150
196
|
export interface WatchlistEntriesDto {
|
|
@@ -159,85 +205,330 @@ export interface WatchlistOrdersDto {
|
|
|
159
205
|
}
|
|
160
206
|
export interface AppVersionDto {
|
|
161
207
|
token: string;
|
|
208
|
+
/**
|
|
209
|
+
* @maxLength 32
|
|
210
|
+
* @default ""
|
|
211
|
+
*/
|
|
162
212
|
versionNumber: string;
|
|
163
213
|
}
|
|
214
|
+
/**
|
|
215
|
+
* Default to `equity` if not provided
|
|
216
|
+
* @default "equity"
|
|
217
|
+
*/
|
|
218
|
+
export enum WatchlistEntryDtoTypeEnum {
|
|
219
|
+
Equity = "equity",
|
|
220
|
+
Option = "option",
|
|
221
|
+
Crypto = "crypto",
|
|
222
|
+
Bond = "bond",
|
|
223
|
+
MutualFund = "mutualFund"
|
|
224
|
+
}
|
|
164
225
|
export class AttributeApi<HandleError extends boolean = boolean> {
|
|
165
226
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
166
227
|
constructor(apiClient: JwtClient<HandleError>);
|
|
167
|
-
|
|
168
|
-
|
|
228
|
+
/**
|
|
229
|
+
* @tags AttributeApi
|
|
230
|
+
* @name GetAttributeValues
|
|
231
|
+
* @request GET:/api/v1/attributes
|
|
232
|
+
* @secure
|
|
233
|
+
*/
|
|
234
|
+
getAttributeValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string | number | boolean>, HandleError>>;
|
|
235
|
+
/**
|
|
236
|
+
* @tags AttributeApi
|
|
237
|
+
* @name GetPublicAttributeValue
|
|
238
|
+
* @request GET:/api/v1/attributes/{attributePublicId}
|
|
239
|
+
* @secure
|
|
240
|
+
*/
|
|
241
|
+
getPublicAttributeValue(attributePublicId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<string | number | boolean, HandleError>>;
|
|
169
242
|
}
|
|
170
243
|
export class AuthenticationApi<HandleError extends boolean = boolean> {
|
|
171
244
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
172
245
|
constructor(apiClient: JwtClient<HandleError>);
|
|
246
|
+
/**
|
|
247
|
+
* @tags AuthenticationApi
|
|
248
|
+
* @name Authenticate
|
|
249
|
+
* @request POST:/api/v1/authenticate
|
|
250
|
+
*/
|
|
173
251
|
authenticate(headers: {
|
|
252
|
+
/** Firm's id from UMA */
|
|
174
253
|
'Firm-Id': string;
|
|
254
|
+
/** Watchmen authorization token (it's `sessionId` from Watchmen's `login` endpoint) */
|
|
175
255
|
'Watchmen-Token': string;
|
|
256
|
+
/** Name of the application using middleware */
|
|
176
257
|
'Application-Name': string;
|
|
177
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
178
|
-
|
|
179
|
-
|
|
258
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
259
|
+
/**
|
|
260
|
+
* @description Must use `refreshToken` instead of `accessToken` in `Authorization` header
|
|
261
|
+
* @tags AuthenticationApi
|
|
262
|
+
* @name Refresh
|
|
263
|
+
* @request POST:/api/v1/refresh
|
|
264
|
+
* @secure
|
|
265
|
+
*/
|
|
266
|
+
refresh(config?: RequestConfig<HandleError>): Promise<ClientResponse<UserTokensDto, HandleError>>;
|
|
267
|
+
/**
|
|
268
|
+
* @tags AuthenticationApi
|
|
269
|
+
* @name Invalidate
|
|
270
|
+
* @request POST:/api/v1/invalidate
|
|
271
|
+
* @secure
|
|
272
|
+
*/
|
|
273
|
+
invalidate(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
180
274
|
}
|
|
181
275
|
export class AvatarApi<HandleError extends boolean = boolean> {
|
|
182
276
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
183
277
|
constructor(apiClient: JwtClient<HandleError>);
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
278
|
+
/**
|
|
279
|
+
* @tags AvatarApi
|
|
280
|
+
* @name GetUserAvatar
|
|
281
|
+
* @request GET:/api/v1/avatars/users/{userId}
|
|
282
|
+
* @secure
|
|
283
|
+
*/
|
|
284
|
+
getUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
|
|
285
|
+
/**
|
|
286
|
+
* @tags AvatarApi
|
|
287
|
+
* @name UploadUserAvatar
|
|
288
|
+
* @request POST:/api/v1/avatars/users/{userId}
|
|
289
|
+
* @secure
|
|
290
|
+
*/
|
|
291
|
+
uploadUserAvatar(userId: number, data: AvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
292
|
+
/**
|
|
293
|
+
* @tags AvatarApi
|
|
294
|
+
* @name DeleteUserAvatar
|
|
295
|
+
* @request DELETE:/api/v1/avatars/users/{userId}
|
|
296
|
+
* @secure
|
|
297
|
+
*/
|
|
298
|
+
deleteUserAvatar(userId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
299
|
+
/**
|
|
300
|
+
* @tags AvatarApi
|
|
301
|
+
* @name GetAccountAvatar
|
|
302
|
+
* @request GET:/api/v1/avatars/accounts/{accountId}
|
|
303
|
+
* @secure
|
|
304
|
+
*/
|
|
305
|
+
getAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
|
|
306
|
+
/**
|
|
307
|
+
* @tags AvatarApi
|
|
308
|
+
* @name UploadAccountAvatar
|
|
309
|
+
* @request POST:/api/v1/avatars/accounts/{accountId}
|
|
310
|
+
* @secure
|
|
311
|
+
*/
|
|
312
|
+
uploadAccountAvatar(accountId: number, data: AvatarUploadDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
313
|
+
/**
|
|
314
|
+
* @tags AvatarApi
|
|
315
|
+
* @name DeleteAccountAvatar
|
|
316
|
+
* @request DELETE:/api/v1/avatars/accounts/{accountId}
|
|
317
|
+
* @secure
|
|
318
|
+
*/
|
|
319
|
+
deleteAccountAvatar(accountId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
190
320
|
}
|
|
191
321
|
export class ChartApi<HandleError extends boolean = boolean> {
|
|
192
322
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
193
323
|
constructor(apiClient: JwtClient<HandleError>);
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
324
|
+
/**
|
|
325
|
+
* @tags ChartApi
|
|
326
|
+
* @name GetChartLayouts
|
|
327
|
+
* @request GET:/api/v1/charts/layouts
|
|
328
|
+
* @secure
|
|
329
|
+
*/
|
|
330
|
+
getChartLayouts(config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartLayoutDto[], HandleError>>;
|
|
331
|
+
/**
|
|
332
|
+
* @tags ChartApi
|
|
333
|
+
* @name UpdateChartLayout
|
|
334
|
+
* @request PUT:/api/v1/charts/layouts
|
|
335
|
+
* @secure
|
|
336
|
+
*/
|
|
337
|
+
updateChartLayout(data: ChartLayoutDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartLayoutDetailsDto, HandleError>>;
|
|
338
|
+
/**
|
|
339
|
+
* @tags ChartApi
|
|
340
|
+
* @name GetChartLayoutDetails
|
|
341
|
+
* @request GET:/api/v1/charts/layouts/{chartId}
|
|
342
|
+
* @secure
|
|
343
|
+
*/
|
|
344
|
+
getChartLayoutDetails(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartLayoutDetailsDto, HandleError>>;
|
|
345
|
+
/**
|
|
346
|
+
* @tags ChartApi
|
|
347
|
+
* @name DeleteChartLayout
|
|
348
|
+
* @request DELETE:/api/v1/charts/layouts/{chartId}
|
|
349
|
+
* @secure
|
|
350
|
+
*/
|
|
351
|
+
deleteChartLayout(chartId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
352
|
+
/**
|
|
353
|
+
* @tags ChartApi
|
|
354
|
+
* @name GetIndicatorTemplates
|
|
355
|
+
* @request GET:/api/v1/charts/indicator-templates
|
|
356
|
+
* @secure
|
|
357
|
+
*/
|
|
358
|
+
getIndicatorTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartDataDto[], HandleError>>;
|
|
359
|
+
/**
|
|
360
|
+
* @tags ChartApi
|
|
361
|
+
* @name UpdateIndicatorTemplate
|
|
362
|
+
* @request PUT:/api/v1/charts/indicator-templates
|
|
363
|
+
* @secure
|
|
364
|
+
*/
|
|
365
|
+
updateIndicatorTemplate(data: ChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartTemplateDto, HandleError>>;
|
|
366
|
+
/**
|
|
367
|
+
* @tags ChartApi
|
|
368
|
+
* @name GetIndicatorTemplateDetails
|
|
369
|
+
* @request GET:/api/v1/charts/indicator-templates/{templateName}
|
|
370
|
+
* @secure
|
|
371
|
+
*/
|
|
372
|
+
getIndicatorTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartTemplateDto, HandleError>>;
|
|
373
|
+
/**
|
|
374
|
+
* @tags ChartApi
|
|
375
|
+
* @name DeleteIndicatorTemplate
|
|
376
|
+
* @request DELETE:/api/v1/charts/indicator-templates/{templateName}
|
|
377
|
+
* @secure
|
|
378
|
+
*/
|
|
379
|
+
deleteIndicatorTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
380
|
+
/**
|
|
381
|
+
* @tags ChartApi
|
|
382
|
+
* @name GetChartTemplates
|
|
383
|
+
* @request GET:/api/v1/charts/templates
|
|
384
|
+
* @secure
|
|
385
|
+
*/
|
|
386
|
+
getChartTemplates(config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartDataDto[], HandleError>>;
|
|
387
|
+
/**
|
|
388
|
+
* @tags ChartApi
|
|
389
|
+
* @name UpdateChartTemplate
|
|
390
|
+
* @request PUT:/api/v1/charts/templates
|
|
391
|
+
* @secure
|
|
392
|
+
*/
|
|
393
|
+
updateChartTemplate(data: ChartTemplateDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartTemplateDto, HandleError>>;
|
|
394
|
+
/**
|
|
395
|
+
* @tags ChartApi
|
|
396
|
+
* @name GetChartTemplateDetails
|
|
397
|
+
* @request GET:/api/v1/charts/templates/{templateName}
|
|
398
|
+
* @secure
|
|
399
|
+
*/
|
|
400
|
+
getChartTemplateDetails(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<ChartTemplateDto, HandleError>>;
|
|
401
|
+
/**
|
|
402
|
+
* @tags ChartApi
|
|
403
|
+
* @name DeleteChartTemplate
|
|
404
|
+
* @request DELETE:/api/v1/charts/templates/{templateName}
|
|
405
|
+
* @secure
|
|
406
|
+
*/
|
|
407
|
+
deleteChartTemplate(templateName: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
206
408
|
}
|
|
207
409
|
export class MessageApi<HandleError extends boolean = boolean> {
|
|
208
410
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
209
411
|
constructor(apiClient: JwtClient<HandleError>);
|
|
412
|
+
/**
|
|
413
|
+
* @tags MessageApi
|
|
414
|
+
* @name GetMessages
|
|
415
|
+
* @request GET:/api/v1/messages
|
|
416
|
+
* @secure
|
|
417
|
+
*/
|
|
210
418
|
getMessages(query?: {
|
|
419
|
+
/** Get messages in preferred language. If not provided or there is no translation for the chosen language, default one will be used. */
|
|
211
420
|
languageCode?: string;
|
|
212
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
421
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<MessageDto[], HandleError>>;
|
|
213
422
|
}
|
|
214
423
|
export class PreferenceApi<HandleError extends boolean = boolean> {
|
|
215
424
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
216
425
|
constructor(apiClient: JwtClient<HandleError>);
|
|
217
|
-
|
|
218
|
-
|
|
426
|
+
/**
|
|
427
|
+
* @tags PreferenceApi
|
|
428
|
+
* @name GetPreferences
|
|
429
|
+
* @request GET:/api/v1/preferences
|
|
430
|
+
* @secure
|
|
431
|
+
*/
|
|
432
|
+
getPreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
433
|
+
/**
|
|
434
|
+
* @tags PreferenceApi
|
|
435
|
+
* @name SavePreferences
|
|
436
|
+
* @request POST:/api/v1/preferences
|
|
437
|
+
* @secure
|
|
438
|
+
*/
|
|
439
|
+
savePreferences(config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
219
440
|
}
|
|
220
441
|
export class VersioningApi<HandleError extends boolean = boolean> {
|
|
221
442
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
222
443
|
constructor(apiClient: JwtClient<HandleError>);
|
|
223
|
-
|
|
224
|
-
|
|
444
|
+
/**
|
|
445
|
+
* @tags VersioningApi
|
|
446
|
+
* @name GetAppVersion
|
|
447
|
+
* @request GET:/api/versioning/{appId}
|
|
448
|
+
*/
|
|
449
|
+
getAppVersion(appId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<AppVersionDto, HandleError>>;
|
|
450
|
+
/**
|
|
451
|
+
* @tags VersioningApi
|
|
452
|
+
* @name UpdateAppVersion
|
|
453
|
+
* @request POST:/api/versioning/{appId}
|
|
454
|
+
*/
|
|
455
|
+
updateAppVersion(appId: string, data: AppVersionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
225
456
|
}
|
|
226
457
|
export class WatchlistApi<HandleError extends boolean = boolean> {
|
|
227
458
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
228
459
|
constructor(apiClient: JwtClient<HandleError>);
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
460
|
+
/**
|
|
461
|
+
* @tags WatchlistApi
|
|
462
|
+
* @name GetAllWatchlists
|
|
463
|
+
* @request GET:/api/v1/watchlists
|
|
464
|
+
* @secure
|
|
465
|
+
*/
|
|
466
|
+
getAllWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto[], HandleError>>;
|
|
467
|
+
/**
|
|
468
|
+
* @tags WatchlistApi
|
|
469
|
+
* @name CreateWatchlist
|
|
470
|
+
* @request POST:/api/v1/watchlists
|
|
471
|
+
* @secure
|
|
472
|
+
*/
|
|
473
|
+
createWatchlist(data: PersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
474
|
+
/**
|
|
475
|
+
* @tags WatchlistApi
|
|
476
|
+
* @name GetWatchlist
|
|
477
|
+
* @request GET:/api/v1/watchlists/{watchlistId}
|
|
478
|
+
* @secure
|
|
479
|
+
*/
|
|
480
|
+
getWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
481
|
+
/**
|
|
482
|
+
* @tags WatchlistApi
|
|
483
|
+
* @name UpdateWatchlist
|
|
484
|
+
* @request PUT:/api/v1/watchlists/{watchlistId}
|
|
485
|
+
* @secure
|
|
486
|
+
*/
|
|
487
|
+
updateWatchlist(watchlistId: number, data: PersistWatchlistDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
488
|
+
/**
|
|
489
|
+
* @tags WatchlistApi
|
|
490
|
+
* @name DeleteWatchlist
|
|
491
|
+
* @request DELETE:/api/v1/watchlists/{watchlistId}
|
|
492
|
+
* @secure
|
|
493
|
+
*/
|
|
494
|
+
deleteWatchlist(watchlistId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
495
|
+
/**
|
|
496
|
+
* @tags WatchlistApi
|
|
497
|
+
* @name AddWatchlistEntries
|
|
498
|
+
* @request POST:/api/v1/watchlists/{watchlistId}/entries
|
|
499
|
+
* @secure
|
|
500
|
+
*/
|
|
501
|
+
addWatchlistEntries(watchlistId: number, data: WatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
502
|
+
/**
|
|
503
|
+
* @tags WatchlistApi
|
|
504
|
+
* @name RemoveWatchlistEntries
|
|
505
|
+
* @request DELETE:/api/v1/watchlists/{watchlistId}/entries
|
|
506
|
+
* @secure
|
|
507
|
+
*/
|
|
508
|
+
removeWatchlistEntries(watchlistId: number, data: WatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
509
|
+
/**
|
|
510
|
+
* @tags WatchlistApi
|
|
511
|
+
* @name UpdateWatchlistEntries
|
|
512
|
+
* @request PUT:/api/v1/watchlists/{watchlistId}/entries
|
|
513
|
+
* @secure
|
|
514
|
+
*/
|
|
515
|
+
updateWatchlistEntries(watchlistId: number, data: WatchlistEntriesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchlistDto, HandleError>>;
|
|
516
|
+
/**
|
|
517
|
+
* @tags WatchlistApi
|
|
518
|
+
* @name UpdateWatchlistOrders
|
|
519
|
+
* @request POST:/api/v1/watchlists/orders
|
|
520
|
+
* @secure
|
|
521
|
+
*/
|
|
522
|
+
updateWatchlistOrders(data: WatchlistOrdersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
523
|
+
/**
|
|
524
|
+
* @tags WatchlistApi
|
|
525
|
+
* @name ImportWatchmenWatchlists
|
|
526
|
+
* @request POST:/api/v1/watchlists/import
|
|
527
|
+
* @secure
|
|
528
|
+
*/
|
|
529
|
+
importWatchmenWatchlists(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
530
|
+
}
|
|
531
|
+
export class MiddlewareApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
241
532
|
attribute: AttributeApi<HandleError>;
|
|
242
533
|
authentication: AuthenticationApi<HandleError>;
|
|
243
534
|
avatar: AvatarApi<HandleError>;
|
|
@@ -261,12 +552,12 @@ declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClie
|
|
|
261
552
|
protected readonly config: OrbisClientConfig<HandleError>;
|
|
262
553
|
request<Data = unknown, Body = unknown>(config: RequestConfig<Body>): Promise<OrbisClientResponse<Data, HandleError>>;
|
|
263
554
|
}
|
|
264
|
-
export class OrbisApi<HandleError extends boolean =
|
|
555
|
+
export class OrbisApi<HandleError extends boolean = false> extends BaseApi<HandleError, OrbisClient<HandleError>> {
|
|
265
556
|
constructor(config: OrbisClientConfig<HandleError>);
|
|
266
|
-
login(username: string, password: string): Promise<
|
|
557
|
+
login(username: string, password: string): Promise<ClientResponse<{
|
|
267
558
|
sessionId: string;
|
|
268
559
|
}, HandleError>>;
|
|
269
|
-
sso(token: string, platform: string): Promise<
|
|
560
|
+
sso(token: string, platform: string): Promise<ClientResponse<{
|
|
270
561
|
sessionId: string;
|
|
271
562
|
}, HandleError>>;
|
|
272
563
|
logout(): Promise<void>;
|
|
@@ -349,11 +640,14 @@ export interface B2BusersettingsB2BUserSettingsChangeSerializer {
|
|
|
349
640
|
}
|
|
350
641
|
export interface B2BusersettingsB2BUserSettingsSerializer {
|
|
351
642
|
do_not_ask_mfa_again: boolean;
|
|
643
|
+
/** @example "test@gmail.com" */
|
|
352
644
|
email: string;
|
|
353
645
|
first_name: string;
|
|
354
646
|
last_name: string;
|
|
647
|
+
/** @example true */
|
|
355
648
|
mfa_enabled: boolean;
|
|
356
649
|
mode: string;
|
|
650
|
+
/** @example "+1231231234" */
|
|
357
651
|
phone: string;
|
|
358
652
|
theme: string;
|
|
359
653
|
}
|
|
@@ -378,6 +672,7 @@ export interface B2CauthRegisterResultSerializer {
|
|
|
378
672
|
}
|
|
379
673
|
export interface B2CauthRegisterSerializer {
|
|
380
674
|
register: B2CauthRegisterResultSerializer;
|
|
675
|
+
/** @example 201 */
|
|
381
676
|
status: number;
|
|
382
677
|
}
|
|
383
678
|
export interface B2CusersB2CUserSerializer {
|
|
@@ -417,6 +712,7 @@ export enum CommontypesAuthUserType {
|
|
|
417
712
|
}
|
|
418
713
|
export interface CommontypesPaginationDto {
|
|
419
714
|
page?: number;
|
|
715
|
+
/** @max 100 */
|
|
420
716
|
size?: number;
|
|
421
717
|
}
|
|
422
718
|
export enum CommontypesResetPasswordType {
|
|
@@ -454,7 +750,9 @@ export interface FirmsGetFirmsListSerializer {
|
|
|
454
750
|
total_records: number;
|
|
455
751
|
}
|
|
456
752
|
export interface HttperrorsError {
|
|
753
|
+
/** @example ["'sms'"," 'email'"] */
|
|
457
754
|
available_options?: MfaOption[];
|
|
755
|
+
/** @example 400 */
|
|
458
756
|
code?: HttperrorsErrorCode;
|
|
459
757
|
description?: string;
|
|
460
758
|
field?: string;
|
|
@@ -527,8 +825,11 @@ export interface IdentityprovidersIdentityProviderResponseSerializer {
|
|
|
527
825
|
status: number;
|
|
528
826
|
}
|
|
529
827
|
export interface LocalesLocaleSerializer {
|
|
828
|
+
/** @example 1 */
|
|
530
829
|
id: number;
|
|
830
|
+
/** @example "fr" */
|
|
531
831
|
locale: string;
|
|
832
|
+
/** @example "French" */
|
|
532
833
|
name: string;
|
|
533
834
|
}
|
|
534
835
|
export enum MfaOption {
|
|
@@ -660,7 +961,9 @@ export interface TypesAPIKeys {
|
|
|
660
961
|
updated_at?: string;
|
|
661
962
|
}
|
|
662
963
|
export interface TypesAPIKeysB2BLoginDto {
|
|
964
|
+
/** @maxLength 255 */
|
|
663
965
|
api_key: string;
|
|
966
|
+
/** @maxLength 255 */
|
|
664
967
|
api_secret: string;
|
|
665
968
|
}
|
|
666
969
|
export interface TypesActionLogEntityFilterDto {
|
|
@@ -684,23 +987,33 @@ export interface TypesAdminB2BUserSerializer {
|
|
|
684
987
|
allow_feedback: boolean;
|
|
685
988
|
big_avatar_url: string;
|
|
686
989
|
branches: TypesBranchSerializer[];
|
|
990
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
687
991
|
created_at: string;
|
|
992
|
+
/** @example true */
|
|
688
993
|
do_not_ask_mfa_again: boolean;
|
|
994
|
+
/** @example "test@email.com" */
|
|
689
995
|
email: string;
|
|
996
|
+
/** @example true */
|
|
690
997
|
email_verified: boolean;
|
|
691
998
|
firms: TypesFirmAccessSerializer[];
|
|
999
|
+
/** @example "Mike" */
|
|
692
1000
|
first_name: string;
|
|
693
1001
|
has_access_to_all_firm_branches: boolean;
|
|
1002
|
+
/** @example 1 */
|
|
694
1003
|
id: number;
|
|
695
1004
|
initiator_id: number;
|
|
1005
|
+
/** @example "Jenkins" */
|
|
696
1006
|
last_name: string;
|
|
697
1007
|
locale: TypesLocaleSerializer;
|
|
698
1008
|
locale_id: number;
|
|
1009
|
+
/** @example true */
|
|
699
1010
|
mfa_enabled: boolean;
|
|
700
1011
|
microservices: TypesMicroserviceSerializer[];
|
|
701
1012
|
mode: string;
|
|
702
1013
|
permissions: TypesPermissionSerializer[];
|
|
1014
|
+
/** @example "+123478844" */
|
|
703
1015
|
phone: string;
|
|
1016
|
+
/** @example true */
|
|
704
1017
|
phone_verified: boolean;
|
|
705
1018
|
primary_firm_id: number;
|
|
706
1019
|
rep_code: string;
|
|
@@ -708,6 +1021,7 @@ export interface TypesAdminB2BUserSerializer {
|
|
|
708
1021
|
should_reset_password: boolean;
|
|
709
1022
|
small_avatar_url: string;
|
|
710
1023
|
theme: string;
|
|
1024
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
711
1025
|
updated_at: string;
|
|
712
1026
|
username: string;
|
|
713
1027
|
}
|
|
@@ -717,28 +1031,39 @@ export interface TypesAdminB2CUserSerializer {
|
|
|
717
1031
|
blocked_at: string;
|
|
718
1032
|
blocking_reason: string;
|
|
719
1033
|
branches: TypesBranchSerializer[];
|
|
1034
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
720
1035
|
created_at: string;
|
|
1036
|
+
/** @example true */
|
|
721
1037
|
do_not_ask_mfa_again: boolean;
|
|
1038
|
+
/** @example "test@email.com" */
|
|
722
1039
|
email: string;
|
|
1040
|
+
/** @example true */
|
|
723
1041
|
email_verified: boolean;
|
|
724
1042
|
firms: TypesFirmAccessSerializer[];
|
|
1043
|
+
/** @example "Mike" */
|
|
725
1044
|
first_name: string;
|
|
1045
|
+
/** @example 1 */
|
|
726
1046
|
id: number;
|
|
727
1047
|
initiator_id: number;
|
|
728
1048
|
is_blocked: boolean;
|
|
1049
|
+
/** @example "Jenkins" */
|
|
729
1050
|
last_name: string;
|
|
730
1051
|
locale: TypesLocaleSerializer;
|
|
731
1052
|
locale_id: number;
|
|
1053
|
+
/** @example true */
|
|
732
1054
|
mfa_enabled: boolean;
|
|
733
1055
|
microservices: TypesMicroserviceSerializer[];
|
|
734
1056
|
permissions: TypesPermissionSerializer[];
|
|
1057
|
+
/** @example "+123478844" */
|
|
735
1058
|
phone: string;
|
|
1059
|
+
/** @example true */
|
|
736
1060
|
phone_verified: boolean;
|
|
737
1061
|
primary_firm_id: number;
|
|
738
1062
|
rep_code: string;
|
|
739
1063
|
roles: TypesRoleSerializer[];
|
|
740
1064
|
should_reset_password: boolean;
|
|
741
1065
|
small_avatar_url: string;
|
|
1066
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
742
1067
|
updated_at: string;
|
|
743
1068
|
username: string;
|
|
744
1069
|
}
|
|
@@ -746,27 +1071,38 @@ export interface TypesAdminUserSerializer {
|
|
|
746
1071
|
allow_feedback: boolean;
|
|
747
1072
|
big_avatar_url: string;
|
|
748
1073
|
branches: TypesBranchSerializer[];
|
|
1074
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
749
1075
|
created_at: string;
|
|
1076
|
+
/** @example true */
|
|
750
1077
|
do_not_ask_mfa_again: boolean;
|
|
1078
|
+
/** @example "test@email.com" */
|
|
751
1079
|
email: string;
|
|
1080
|
+
/** @example true */
|
|
752
1081
|
email_verified: boolean;
|
|
753
1082
|
firms: TypesFirmAccessSerializer[];
|
|
1083
|
+
/** @example "Mike" */
|
|
754
1084
|
first_name: string;
|
|
1085
|
+
/** @example 1 */
|
|
755
1086
|
id: number;
|
|
756
1087
|
initiator_id: number;
|
|
1088
|
+
/** @example "Jenkins" */
|
|
757
1089
|
last_name: string;
|
|
758
1090
|
locale: TypesLocaleSerializer;
|
|
759
1091
|
locale_id: number;
|
|
1092
|
+
/** @example true */
|
|
760
1093
|
mfa_enabled: boolean;
|
|
761
1094
|
microservices: TypesMicroserviceSerializer[];
|
|
762
1095
|
permissions: TypesPermissionSerializer[];
|
|
1096
|
+
/** @example "+123478844" */
|
|
763
1097
|
phone: string;
|
|
1098
|
+
/** @example true */
|
|
764
1099
|
phone_verified: boolean;
|
|
765
1100
|
primary_firm_id: number;
|
|
766
1101
|
rep_code: string;
|
|
767
1102
|
roles: TypesRoleSerializer[];
|
|
768
1103
|
should_reset_password: boolean;
|
|
769
1104
|
small_avatar_url: string;
|
|
1105
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
770
1106
|
updated_at: string;
|
|
771
1107
|
username: string;
|
|
772
1108
|
}
|
|
@@ -792,7 +1128,7 @@ export interface TypesAuthFormDto {
|
|
|
792
1128
|
logo_path?: string;
|
|
793
1129
|
redirect_url: string;
|
|
794
1130
|
reset_password_link_template?: string;
|
|
795
|
-
reset_password_type:
|
|
1131
|
+
reset_password_type: TypesAuthFormDtoResetPasswordTypeEnum;
|
|
796
1132
|
slug: string;
|
|
797
1133
|
}
|
|
798
1134
|
export interface TypesAuthFormSerializer {
|
|
@@ -807,7 +1143,7 @@ export interface TypesAuthFormSerializer {
|
|
|
807
1143
|
logo_path: string;
|
|
808
1144
|
redirect_url: string;
|
|
809
1145
|
reset_password_link_template: string;
|
|
810
|
-
reset_password_type:
|
|
1146
|
+
reset_password_type: TypesAuthFormSerializerResetPasswordTypeEnum;
|
|
811
1147
|
slug: string;
|
|
812
1148
|
updated_at: string;
|
|
813
1149
|
}
|
|
@@ -836,14 +1172,18 @@ export interface TypesAvatarSettingsSerializer {
|
|
|
836
1172
|
}
|
|
837
1173
|
export interface TypesB2BResetPasswordDto {
|
|
838
1174
|
captcha_response?: string;
|
|
1175
|
+
/** @maxLength 255 */
|
|
839
1176
|
code: string;
|
|
1177
|
+
/** @maxLength 255 */
|
|
840
1178
|
contact: string;
|
|
1179
|
+
/** @maxLength 100 */
|
|
841
1180
|
new_password: string;
|
|
842
1181
|
old_password?: string;
|
|
843
1182
|
}
|
|
844
1183
|
export interface TypesB2BSendContactChangeCodeDto {
|
|
1184
|
+
/** @maxLength 255 */
|
|
845
1185
|
contact: string;
|
|
846
|
-
type:
|
|
1186
|
+
type: TypesB2BSendContactChangeCodeDtoTypeEnum;
|
|
847
1187
|
}
|
|
848
1188
|
export interface TypesB2BUploadAvatarSerializer {
|
|
849
1189
|
big_avatar_path: string;
|
|
@@ -853,26 +1193,37 @@ export interface TypesB2BUserSerializer {
|
|
|
853
1193
|
admin_of_firm_ids: number[];
|
|
854
1194
|
allow_feedback: boolean;
|
|
855
1195
|
big_avatar_url: string;
|
|
1196
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
856
1197
|
created_at: string;
|
|
1198
|
+
/** @example true */
|
|
857
1199
|
do_not_ask_mfa_again: boolean;
|
|
1200
|
+
/** @example "test@email.com" */
|
|
858
1201
|
email: string;
|
|
1202
|
+
/** @example true */
|
|
859
1203
|
email_verified: boolean;
|
|
1204
|
+
/** @example "Mike" */
|
|
860
1205
|
first_name: string;
|
|
1206
|
+
/** @example 1 */
|
|
861
1207
|
id: number;
|
|
862
1208
|
initiator_id: number;
|
|
863
1209
|
is_chief_admin: boolean;
|
|
1210
|
+
/** @example "Jenkins" */
|
|
864
1211
|
last_name: string;
|
|
865
1212
|
locale: TypesLocaleSerializer;
|
|
866
1213
|
locale_id: number;
|
|
1214
|
+
/** @example true */
|
|
867
1215
|
mfa_enabled: boolean;
|
|
868
1216
|
microservices: TypesMicroserviceAccessSerializer[];
|
|
869
1217
|
mode: string;
|
|
1218
|
+
/** @example "+123478844" */
|
|
870
1219
|
phone: string;
|
|
1220
|
+
/** @example true */
|
|
871
1221
|
phone_verified: boolean;
|
|
872
1222
|
rep_code: string;
|
|
873
1223
|
should_reset_password: boolean;
|
|
874
1224
|
small_avatar_url: string;
|
|
875
1225
|
theme: string;
|
|
1226
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
876
1227
|
updated_at: string;
|
|
877
1228
|
username: string;
|
|
878
1229
|
}
|
|
@@ -889,16 +1240,19 @@ export interface TypesB2CResetPasswordDto {
|
|
|
889
1240
|
auth_form_slug: string;
|
|
890
1241
|
captcha_response?: string;
|
|
891
1242
|
code: string;
|
|
1243
|
+
/** @maxLength 255 */
|
|
892
1244
|
contact?: string;
|
|
1245
|
+
/** @maxLength 100 */
|
|
893
1246
|
new_password: string;
|
|
894
|
-
reset_type:
|
|
1247
|
+
reset_type: TypesB2CResetPasswordDtoResetTypeEnum;
|
|
895
1248
|
}
|
|
896
1249
|
export interface TypesB2CSendContactChangeCodeDto {
|
|
1250
|
+
/** @maxLength 255 */
|
|
897
1251
|
contact: string;
|
|
898
|
-
type:
|
|
1252
|
+
type: TypesB2CSendContactChangeCodeDtoTypeEnum;
|
|
899
1253
|
}
|
|
900
1254
|
export interface TypesB2CSendVerificationCodeDto {
|
|
901
|
-
code_type:
|
|
1255
|
+
code_type: TypesB2CSendVerificationCodeDtoCodeTypeEnum;
|
|
902
1256
|
contact: string;
|
|
903
1257
|
}
|
|
904
1258
|
export interface TypesB2CUserSettingsSerializer {
|
|
@@ -911,43 +1265,75 @@ export interface TypesB2CUserSettingsSerializer {
|
|
|
911
1265
|
phone_verified: boolean;
|
|
912
1266
|
}
|
|
913
1267
|
export interface TypesBasicB2BLoginDto {
|
|
1268
|
+
/** @maxLength 255 */
|
|
914
1269
|
device_id: string;
|
|
1270
|
+
/**
|
|
1271
|
+
* @maxLength 255
|
|
1272
|
+
* @example "test@gmail.com"
|
|
1273
|
+
*/
|
|
915
1274
|
email: string;
|
|
916
1275
|
mfa_codes?: TypesMfaCodesDto;
|
|
1276
|
+
/**
|
|
1277
|
+
* @maxLength 100
|
|
1278
|
+
* @example "TeStPaSS"
|
|
1279
|
+
*/
|
|
917
1280
|
password: string;
|
|
1281
|
+
/** @example true */
|
|
918
1282
|
remember_me?: boolean;
|
|
919
1283
|
}
|
|
920
1284
|
export interface TypesBasicB2CLoginDto {
|
|
921
1285
|
auth_form_slug?: string;
|
|
922
1286
|
client_platform_slug?: string;
|
|
1287
|
+
/** @maxLength 255 */
|
|
923
1288
|
device_id: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* @maxLength 255
|
|
1291
|
+
* @example "test@gmail.com"
|
|
1292
|
+
*/
|
|
924
1293
|
login: string;
|
|
925
1294
|
mfa_codes?: TypesMfaCodesDto;
|
|
1295
|
+
/**
|
|
1296
|
+
* @maxLength 100
|
|
1297
|
+
* @example "TeStPaSS"
|
|
1298
|
+
*/
|
|
926
1299
|
password: string;
|
|
1300
|
+
/** @example true */
|
|
927
1301
|
remember_me?: boolean;
|
|
928
1302
|
send_redirect?: boolean;
|
|
929
1303
|
}
|
|
930
1304
|
export interface TypesBranchAdminSerializer {
|
|
931
1305
|
branch_admins_count: number;
|
|
1306
|
+
/** @example "1000" */
|
|
932
1307
|
code: string;
|
|
1308
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
933
1309
|
created_at: string;
|
|
934
1310
|
firm: TypesFirmSerializer;
|
|
1311
|
+
/** @example 1 */
|
|
935
1312
|
firm_id: number;
|
|
1313
|
+
/** @example 1 */
|
|
936
1314
|
id: number;
|
|
1315
|
+
/** @example "New York" */
|
|
937
1316
|
name: string;
|
|
938
1317
|
retail_available_mfa_options: string[];
|
|
939
1318
|
retail_email_verification_required: boolean;
|
|
940
1319
|
retail_login_enabled: boolean;
|
|
941
1320
|
retail_mfa_enabling_required: boolean;
|
|
942
1321
|
retail_phone_verification_required: boolean;
|
|
1322
|
+
/** @example "new-york" */
|
|
943
1323
|
slug: string;
|
|
1324
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
944
1325
|
updated_at: string;
|
|
945
1326
|
}
|
|
946
1327
|
export interface TypesBranchSerializer {
|
|
1328
|
+
/** @example "1000" */
|
|
947
1329
|
code: string;
|
|
1330
|
+
/** @example 1 */
|
|
948
1331
|
firm_id: number;
|
|
1332
|
+
/** @example 1 */
|
|
949
1333
|
id: number;
|
|
1334
|
+
/** @example "New York" */
|
|
950
1335
|
name: string;
|
|
1336
|
+
/** @example "new-york" */
|
|
951
1337
|
slug: string;
|
|
952
1338
|
}
|
|
953
1339
|
export interface TypesCountrySerializer {
|
|
@@ -961,6 +1347,7 @@ export interface TypesCreateAPIKeysDto {
|
|
|
961
1347
|
branches?: number[];
|
|
962
1348
|
firms?: TypesFirmInfo[];
|
|
963
1349
|
mfa_codes?: TypesMfaCodesDto;
|
|
1350
|
+
/** @maxLength 255 */
|
|
964
1351
|
name: string;
|
|
965
1352
|
permissions?: number[];
|
|
966
1353
|
roles?: number[];
|
|
@@ -969,37 +1356,72 @@ export interface TypesCreateB2BUserDto {
|
|
|
969
1356
|
add_default_domain_permissions?: boolean;
|
|
970
1357
|
allow_feedback?: boolean;
|
|
971
1358
|
branches?: number[];
|
|
1359
|
+
/**
|
|
1360
|
+
* @maxLength 255
|
|
1361
|
+
* @example "test@gmail.com"
|
|
1362
|
+
*/
|
|
972
1363
|
email?: string;
|
|
1364
|
+
/** @minItems 1 */
|
|
973
1365
|
firms: TypesFirmInfo[];
|
|
1366
|
+
/** @maxLength 255 */
|
|
974
1367
|
first_name: string;
|
|
975
1368
|
has_access_to_all_firm_branches?: boolean;
|
|
1369
|
+
/** @maxLength 255 */
|
|
976
1370
|
last_name: string;
|
|
1371
|
+
/** @example "TeStPaSS" */
|
|
977
1372
|
password: string;
|
|
978
1373
|
permissions?: number[];
|
|
1374
|
+
/**
|
|
1375
|
+
* @maxLength 255
|
|
1376
|
+
* @example "+1231231234"
|
|
1377
|
+
*/
|
|
979
1378
|
phone?: string;
|
|
980
1379
|
primary_firm_id?: number;
|
|
1380
|
+
/** @minItems 1 */
|
|
981
1381
|
roles: number[];
|
|
982
1382
|
should_reset_password?: boolean;
|
|
1383
|
+
/** @maxLength 255 */
|
|
983
1384
|
username?: string;
|
|
984
1385
|
}
|
|
985
1386
|
export interface TypesCreateB2CUserDto {
|
|
986
1387
|
allow_feedback?: boolean;
|
|
987
1388
|
blocking_reason?: string;
|
|
1389
|
+
/** @minItems 1 */
|
|
988
1390
|
branches: number[];
|
|
1391
|
+
/**
|
|
1392
|
+
* @maxLength 255
|
|
1393
|
+
* @example "test@gmail.com"
|
|
1394
|
+
*/
|
|
989
1395
|
email?: string;
|
|
1396
|
+
/** @min 1 */
|
|
990
1397
|
firm_id: number;
|
|
1398
|
+
/** @maxLength 255 */
|
|
991
1399
|
first_name: string;
|
|
992
1400
|
is_blocked?: boolean;
|
|
1401
|
+
/** @maxLength 255 */
|
|
993
1402
|
last_name: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* @maxLength 100
|
|
1405
|
+
* @example "TeStPaSS"
|
|
1406
|
+
*/
|
|
994
1407
|
password: string;
|
|
995
1408
|
permissions?: number[];
|
|
1409
|
+
/**
|
|
1410
|
+
* @maxLength 255
|
|
1411
|
+
* @example "+1231231234"
|
|
1412
|
+
*/
|
|
996
1413
|
phone?: string;
|
|
1414
|
+
/** @minItems 1 */
|
|
997
1415
|
roles: number[];
|
|
1416
|
+
/** @maxLength 255 */
|
|
998
1417
|
username?: string;
|
|
999
1418
|
}
|
|
1000
1419
|
export interface TypesCreateBranchDto {
|
|
1420
|
+
/** @maxLength 255 */
|
|
1001
1421
|
code?: string;
|
|
1422
|
+
/** @min 1 */
|
|
1002
1423
|
firm_id: number;
|
|
1424
|
+
/** @maxLength 255 */
|
|
1003
1425
|
name: string;
|
|
1004
1426
|
retail_available_auth_app_options?: CommontypesAuthAppType[];
|
|
1005
1427
|
retail_email_verification_required?: boolean;
|
|
@@ -1007,94 +1429,142 @@ export interface TypesCreateBranchDto {
|
|
|
1007
1429
|
retail_mfa_enabling_required?: boolean;
|
|
1008
1430
|
retail_phone_verification_required?: boolean;
|
|
1009
1431
|
settings?: TypesTenantSettingDto[];
|
|
1432
|
+
/** @maxLength 255 */
|
|
1010
1433
|
slug: string;
|
|
1011
1434
|
}
|
|
1012
1435
|
export interface TypesCreateEndpointDto {
|
|
1013
1436
|
is_active?: boolean;
|
|
1014
1437
|
is_public?: boolean;
|
|
1015
1438
|
metadata?: TypesEndpointMetadataDto;
|
|
1016
|
-
method:
|
|
1439
|
+
method: TypesCreateEndpointDtoMethodEnum;
|
|
1440
|
+
/** @min 1 */
|
|
1017
1441
|
microservice_id: number;
|
|
1018
1442
|
required_permissions?: number[];
|
|
1443
|
+
/** @maxLength 255 */
|
|
1019
1444
|
route: string;
|
|
1020
|
-
type?:
|
|
1445
|
+
type?: TypesCreateEndpointDtoTypeEnum;
|
|
1021
1446
|
}
|
|
1022
1447
|
export interface TypesCreateFirmDto {
|
|
1023
1448
|
allow_b2c_email_notifications?: boolean;
|
|
1024
1449
|
firm_tags?: number[];
|
|
1025
1450
|
mailgun_creds?: TypesFirmMailgunCredsDto;
|
|
1451
|
+
/** @maxLength 255 */
|
|
1026
1452
|
name: string;
|
|
1453
|
+
/** @maxLength 255 */
|
|
1027
1454
|
slug: string;
|
|
1028
1455
|
twilio_creds?: TypesFirmTwilioCredsDto;
|
|
1029
1456
|
}
|
|
1030
1457
|
export interface TypesCreateIdentityProviderDto {
|
|
1458
|
+
/** @maxLength 1000 */
|
|
1031
1459
|
auth_url: string;
|
|
1460
|
+
/** @maxLength 255 */
|
|
1032
1461
|
client_id: string;
|
|
1462
|
+
/** @maxLength 255 */
|
|
1033
1463
|
client_secret: string;
|
|
1464
|
+
/** @maxLength 1000 */
|
|
1034
1465
|
company_domain: string;
|
|
1466
|
+
/** @min 1 */
|
|
1035
1467
|
firm_id: number;
|
|
1468
|
+
/** @min 1 */
|
|
1036
1469
|
priority: number;
|
|
1470
|
+
/** @maxLength 1000 */
|
|
1037
1471
|
redirect_url?: string;
|
|
1038
|
-
type:
|
|
1472
|
+
type: TypesCreateIdentityProviderDtoTypeEnum;
|
|
1039
1473
|
}
|
|
1040
1474
|
export interface TypesCreateMicroserviceDto {
|
|
1041
1475
|
domains?: TypesMicroserviceDomainDto[];
|
|
1042
1476
|
is_active?: boolean;
|
|
1043
1477
|
is_visible_on_admin_sidebar?: boolean;
|
|
1478
|
+
/** @maxLength 1000 */
|
|
1044
1479
|
logo_url?: string;
|
|
1480
|
+
/** @maxLength 255 */
|
|
1045
1481
|
name: string;
|
|
1482
|
+
/** @maxLength 255 */
|
|
1046
1483
|
slug: string;
|
|
1047
1484
|
}
|
|
1048
1485
|
export interface TypesCreatePermissionDto {
|
|
1049
|
-
assignment_group:
|
|
1486
|
+
assignment_group: TypesCreatePermissionDtoAssignmentGroupEnum;
|
|
1050
1487
|
metadata?: PgmodelsPermissionMetadata;
|
|
1051
1488
|
microservice_id?: number;
|
|
1489
|
+
/** @maxLength 1000 */
|
|
1052
1490
|
permission: string;
|
|
1053
1491
|
}
|
|
1054
1492
|
export interface TypesCreateRoleDto {
|
|
1055
|
-
assignment_group?:
|
|
1493
|
+
assignment_group?: TypesCreateRoleDtoAssignmentGroupEnum;
|
|
1494
|
+
/** @min 0 */
|
|
1056
1495
|
firm_id?: number;
|
|
1057
1496
|
microservice_id: number;
|
|
1497
|
+
/** @maxLength 255 */
|
|
1058
1498
|
name: string;
|
|
1499
|
+
/** @minItems 1 */
|
|
1059
1500
|
permissions: number[];
|
|
1060
1501
|
permissions_can_assign_role?: number[];
|
|
1502
|
+
/** @min 1 */
|
|
1061
1503
|
type_id: number;
|
|
1062
1504
|
}
|
|
1063
1505
|
export interface TypesCreateRoleTypeDto {
|
|
1506
|
+
/** @maxLength 255 */
|
|
1064
1507
|
color: string;
|
|
1508
|
+
/** @maxLength 255 */
|
|
1065
1509
|
type: string;
|
|
1066
1510
|
}
|
|
1067
1511
|
export interface TypesCreateSecretNoteDto {
|
|
1512
|
+
/** @maxLength 255 */
|
|
1068
1513
|
email: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* supported suffixes are h, m, s, ms. Min 15 mins, max 7 days
|
|
1516
|
+
* @example "48h"
|
|
1517
|
+
*/
|
|
1069
1518
|
expires_in: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* @min 1
|
|
1521
|
+
* @max 5
|
|
1522
|
+
*/
|
|
1070
1523
|
max_view_count: number;
|
|
1071
1524
|
name?: string;
|
|
1072
1525
|
note_params: Record<string, string>;
|
|
1073
|
-
type:
|
|
1526
|
+
type: TypesCreateSecretNoteDtoTypeEnum;
|
|
1074
1527
|
}
|
|
1075
1528
|
export interface TypesCreateTagDto {
|
|
1076
1529
|
name: string;
|
|
1077
1530
|
}
|
|
1078
1531
|
export interface TypesCreateWatchmenInstanceDto {
|
|
1532
|
+
/**
|
|
1533
|
+
* @minLength 1
|
|
1534
|
+
* @maxLength 255
|
|
1535
|
+
*/
|
|
1079
1536
|
name: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* @minLength 1
|
|
1539
|
+
* @maxLength 255
|
|
1540
|
+
*/
|
|
1080
1541
|
slug: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* @minLength 1
|
|
1544
|
+
* @maxLength 1000
|
|
1545
|
+
*/
|
|
1081
1546
|
url: string;
|
|
1082
1547
|
}
|
|
1083
1548
|
export interface TypesCreateYubicoOTPDto {
|
|
1549
|
+
/** @maxLength 255 */
|
|
1084
1550
|
name: string;
|
|
1085
1551
|
otp: string;
|
|
1086
1552
|
}
|
|
1087
1553
|
export interface TypesDeleteAPIKeysDto {
|
|
1554
|
+
/** @minItems 1 */
|
|
1088
1555
|
ids: number[];
|
|
1089
1556
|
mfa_codes?: TypesMfaCodesDto;
|
|
1090
1557
|
}
|
|
1091
1558
|
export interface TypesDeleteByIDsDtoInt {
|
|
1559
|
+
/** @minItems 1 */
|
|
1092
1560
|
ids: number[];
|
|
1093
1561
|
}
|
|
1094
1562
|
export interface TypesDeleteByIDsDtoInt64 {
|
|
1563
|
+
/** @minItems 1 */
|
|
1095
1564
|
ids: number[];
|
|
1096
1565
|
}
|
|
1097
1566
|
export interface TypesDeleteSessionsDto {
|
|
1567
|
+
/** @minItems 1 */
|
|
1098
1568
|
pair_ids: string[];
|
|
1099
1569
|
}
|
|
1100
1570
|
export interface TypesEndpointMetadataDto {
|
|
@@ -1102,7 +1572,7 @@ export interface TypesEndpointMetadataDto {
|
|
|
1102
1572
|
skip_email_verification_check?: boolean;
|
|
1103
1573
|
skip_mfa_enabled_check?: boolean;
|
|
1104
1574
|
skip_phone_verification_check?: boolean;
|
|
1105
|
-
user_type?:
|
|
1575
|
+
user_type?: TypesEndpointMetadataDtoUserTypeEnum;
|
|
1106
1576
|
}
|
|
1107
1577
|
export interface TypesEndpointMetadataSerializer {
|
|
1108
1578
|
admin_ui_permission_key: string;
|
|
@@ -1117,7 +1587,7 @@ export interface TypesEndpointSerializer {
|
|
|
1117
1587
|
is_active: boolean;
|
|
1118
1588
|
is_public: boolean;
|
|
1119
1589
|
metadata: TypesEndpointMetadataSerializer;
|
|
1120
|
-
method:
|
|
1590
|
+
method: TypesEndpointSerializerMethodEnum;
|
|
1121
1591
|
microservice: TypesMicroserviceSerializer;
|
|
1122
1592
|
microservice_id: number;
|
|
1123
1593
|
required_permissions: TypesPermissionSerializer[];
|
|
@@ -1130,7 +1600,12 @@ export interface TypesFinishOAuthLoginDto {
|
|
|
1130
1600
|
state: string;
|
|
1131
1601
|
}
|
|
1132
1602
|
export interface TypesFinishTOTPRegistrationDto {
|
|
1603
|
+
/**
|
|
1604
|
+
* @minLength 6
|
|
1605
|
+
* @maxLength 8
|
|
1606
|
+
*/
|
|
1133
1607
|
code: string;
|
|
1608
|
+
/** @maxLength 255 */
|
|
1134
1609
|
name: string;
|
|
1135
1610
|
}
|
|
1136
1611
|
export interface TypesFirmAccessSerializer {
|
|
@@ -1138,24 +1613,34 @@ export interface TypesFirmAccessSerializer {
|
|
|
1138
1613
|
allow_b2c_email_notifications: boolean;
|
|
1139
1614
|
branches: TypesBranchSerializer[];
|
|
1140
1615
|
branches_count: number;
|
|
1616
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1141
1617
|
created_at: string;
|
|
1142
1618
|
have_access_to_all_firm_branches: boolean;
|
|
1619
|
+
/** @example 1 */
|
|
1143
1620
|
id: number;
|
|
1144
1621
|
last_status_change_at: string;
|
|
1622
|
+
/** @example "ViewTrade" */
|
|
1145
1623
|
name: string;
|
|
1624
|
+
/** @example "viewtrade" */
|
|
1146
1625
|
slug: string;
|
|
1147
1626
|
status: string;
|
|
1148
1627
|
tags: TypesTagSerializer[];
|
|
1628
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1149
1629
|
updated_at: string;
|
|
1150
1630
|
}
|
|
1151
1631
|
export interface TypesFirmInfo {
|
|
1632
|
+
/** @min 1 */
|
|
1152
1633
|
firm_id: number;
|
|
1153
1634
|
have_access_to_all_firm_branches?: boolean;
|
|
1154
1635
|
}
|
|
1155
1636
|
export interface TypesFirmMailgunCredsDto {
|
|
1637
|
+
/** @maxLength 255 */
|
|
1156
1638
|
domain?: string;
|
|
1639
|
+
/** @maxLength 255 */
|
|
1157
1640
|
from_address?: string;
|
|
1641
|
+
/** @maxLength 255 */
|
|
1158
1642
|
from_name?: string;
|
|
1643
|
+
/** @maxLength 255 */
|
|
1159
1644
|
private_api_key?: string;
|
|
1160
1645
|
}
|
|
1161
1646
|
export interface TypesFirmSerializer {
|
|
@@ -1163,19 +1648,28 @@ export interface TypesFirmSerializer {
|
|
|
1163
1648
|
allow_b2c_email_notifications: boolean;
|
|
1164
1649
|
branches: TypesBranchSerializer[];
|
|
1165
1650
|
branches_count: number;
|
|
1651
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1166
1652
|
created_at: string;
|
|
1653
|
+
/** @example 1 */
|
|
1167
1654
|
id: number;
|
|
1168
1655
|
last_status_change_at: string;
|
|
1656
|
+
/** @example "ViewTrade" */
|
|
1169
1657
|
name: string;
|
|
1658
|
+
/** @example "viewtrade" */
|
|
1170
1659
|
slug: string;
|
|
1171
1660
|
status: string;
|
|
1172
1661
|
tags: TypesTagSerializer[];
|
|
1662
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1173
1663
|
updated_at: string;
|
|
1174
1664
|
}
|
|
1175
1665
|
export interface TypesFirmTwilioCredsDto {
|
|
1666
|
+
/** @maxLength 255 */
|
|
1176
1667
|
account_sid?: string;
|
|
1668
|
+
/** @maxLength 255 */
|
|
1177
1669
|
auth_token?: string;
|
|
1670
|
+
/** @maxLength 255 */
|
|
1178
1671
|
phone_number?: string;
|
|
1672
|
+
/** @maxLength 255 */
|
|
1179
1673
|
subaccount_sid?: string;
|
|
1180
1674
|
}
|
|
1181
1675
|
export interface TypesFirmWithCredsSerializer {
|
|
@@ -1183,15 +1677,20 @@ export interface TypesFirmWithCredsSerializer {
|
|
|
1183
1677
|
allow_b2c_email_notifications: boolean;
|
|
1184
1678
|
branches: TypesBranchSerializer[];
|
|
1185
1679
|
branches_count: number;
|
|
1680
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1186
1681
|
created_at: string;
|
|
1682
|
+
/** @example 1 */
|
|
1187
1683
|
id: number;
|
|
1188
1684
|
last_status_change_at: string;
|
|
1189
1685
|
mailgun_creds: TypesFirmMailgunCredsDto;
|
|
1686
|
+
/** @example "ViewTrade" */
|
|
1190
1687
|
name: string;
|
|
1688
|
+
/** @example "viewtrade" */
|
|
1191
1689
|
slug: string;
|
|
1192
1690
|
status: string;
|
|
1193
1691
|
tags: TypesTagSerializer[];
|
|
1194
1692
|
twilio_creds: TypesFirmTwilioCredsDto;
|
|
1693
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1195
1694
|
updated_at: string;
|
|
1196
1695
|
}
|
|
1197
1696
|
export interface TypesGeneratedWatchmenTokenInfoSerializer {
|
|
@@ -1252,7 +1751,7 @@ export interface TypesGetB2CUsersListFiltersDto {
|
|
|
1252
1751
|
permission_names?: string[];
|
|
1253
1752
|
phone_verified?: boolean;
|
|
1254
1753
|
role_ids?: number[];
|
|
1255
|
-
show_only?:
|
|
1754
|
+
show_only?: TypesGetB2CUsersListFiltersDtoShowOnlyEnum;
|
|
1256
1755
|
}
|
|
1257
1756
|
export interface TypesGetBranchesListDto {
|
|
1258
1757
|
count_branch_admins?: boolean;
|
|
@@ -1291,7 +1790,7 @@ export interface TypesGetFirmsListDto {
|
|
|
1291
1790
|
}
|
|
1292
1791
|
export interface TypesGetFirmsListFiltersDto {
|
|
1293
1792
|
ids?: number[];
|
|
1294
|
-
statuses?:
|
|
1793
|
+
statuses?: TypesGetFirmsListFiltersDtoStatusesEnum;
|
|
1295
1794
|
tag_ids?: number[];
|
|
1296
1795
|
}
|
|
1297
1796
|
export interface TypesGetIdentityProvidersListDto {
|
|
@@ -1303,7 +1802,7 @@ export interface TypesGetIdentityProvidersListDto {
|
|
|
1303
1802
|
export interface TypesGetIdentityProvidersListFiltersDto {
|
|
1304
1803
|
firm_ids?: number[];
|
|
1305
1804
|
ids?: number[];
|
|
1306
|
-
types?:
|
|
1805
|
+
types?: TypesGetIdentityProvidersListFiltersDtoTypesEnum[];
|
|
1307
1806
|
}
|
|
1308
1807
|
export interface TypesGetMicroservicesListDto {
|
|
1309
1808
|
filters?: TypesGetMicroservicesListFiltersDto;
|
|
@@ -1354,6 +1853,7 @@ export interface TypesGetRolesListFiltersDto {
|
|
|
1354
1853
|
type_ids?: number[];
|
|
1355
1854
|
}
|
|
1356
1855
|
export interface TypesGetSecretNoteDto {
|
|
1856
|
+
/** @maxLength 255 */
|
|
1357
1857
|
email: string;
|
|
1358
1858
|
email_code: string;
|
|
1359
1859
|
id: string;
|
|
@@ -1364,6 +1864,7 @@ export interface TypesGetTagsDto {
|
|
|
1364
1864
|
sorts?: CommontypesSortDto[];
|
|
1365
1865
|
}
|
|
1366
1866
|
export interface TypesGetTotpQRDto {
|
|
1867
|
+
/** @min 6 */
|
|
1367
1868
|
digits: number;
|
|
1368
1869
|
name?: string;
|
|
1369
1870
|
}
|
|
@@ -1382,7 +1883,7 @@ export interface TypesGetUsersListFiltersDto {
|
|
|
1382
1883
|
permission_names?: string[];
|
|
1383
1884
|
phone_verified?: boolean;
|
|
1384
1885
|
role_ids?: number[];
|
|
1385
|
-
show_only?:
|
|
1886
|
+
show_only?: TypesGetUsersListFiltersDtoShowOnlyEnum;
|
|
1386
1887
|
}
|
|
1387
1888
|
export interface TypesGetWatchmenInstancesDto {
|
|
1388
1889
|
pagination: CommontypesPaginationDto;
|
|
@@ -1390,8 +1891,9 @@ export interface TypesGetWatchmenInstancesDto {
|
|
|
1390
1891
|
sorts?: CommontypesSortDto[];
|
|
1391
1892
|
}
|
|
1392
1893
|
export interface TypesGetWebAuthnLoginChallengeDto {
|
|
1894
|
+
/** @maxLength 255 */
|
|
1393
1895
|
email: string;
|
|
1394
|
-
user_type?:
|
|
1896
|
+
user_type?: TypesGetWebAuthnLoginChallengeDtoUserTypeEnum;
|
|
1395
1897
|
}
|
|
1396
1898
|
export interface TypesIdentityProviderSerializer {
|
|
1397
1899
|
auth_url: string;
|
|
@@ -1403,7 +1905,7 @@ export interface TypesIdentityProviderSerializer {
|
|
|
1403
1905
|
id: number;
|
|
1404
1906
|
priority: number;
|
|
1405
1907
|
redirect_url: string;
|
|
1406
|
-
type:
|
|
1908
|
+
type: TypesIdentityProviderSerializerTypeEnum;
|
|
1407
1909
|
updated_at: string;
|
|
1408
1910
|
}
|
|
1409
1911
|
export interface TypesImageDimensionsSerializer {
|
|
@@ -1424,22 +1926,29 @@ export interface TypesInitOAuthLoginSerializer {
|
|
|
1424
1926
|
state: string;
|
|
1425
1927
|
}
|
|
1426
1928
|
export interface TypesLinkWatchmenUserToUmaDto {
|
|
1929
|
+
/** @min 1 */
|
|
1427
1930
|
uma_user_id: number;
|
|
1428
|
-
uma_user_type:
|
|
1931
|
+
uma_user_type: TypesLinkWatchmenUserToUmaDtoUmaUserTypeEnum;
|
|
1429
1932
|
watchmen_instance_slug: string;
|
|
1933
|
+
/** @min 1 */
|
|
1430
1934
|
watchmen_user_id: number;
|
|
1431
1935
|
watchmen_username?: string;
|
|
1432
1936
|
}
|
|
1433
1937
|
export interface TypesLocaleSerializer {
|
|
1938
|
+
/** @example 1 */
|
|
1434
1939
|
id: number;
|
|
1940
|
+
/** @example "en" */
|
|
1435
1941
|
locale: string;
|
|
1942
|
+
/** @example "English" */
|
|
1436
1943
|
name: string;
|
|
1437
1944
|
}
|
|
1438
1945
|
export interface TypesLogoutDto {
|
|
1439
1946
|
refresh_token: string;
|
|
1440
1947
|
}
|
|
1441
1948
|
export interface TypesMfaCodesDto {
|
|
1949
|
+
/** @example "12345" */
|
|
1442
1950
|
email?: string;
|
|
1951
|
+
/** @example "12345" */
|
|
1443
1952
|
phone?: string;
|
|
1444
1953
|
totp?: string;
|
|
1445
1954
|
yubico_otp?: string;
|
|
@@ -1447,6 +1956,7 @@ export interface TypesMfaCodesDto {
|
|
|
1447
1956
|
}
|
|
1448
1957
|
export interface TypesMicroserviceAccessSerializer {
|
|
1449
1958
|
entities: Record<string, Record<string, boolean>>;
|
|
1959
|
+
/** @example 1 */
|
|
1450
1960
|
id: number;
|
|
1451
1961
|
is_active: boolean;
|
|
1452
1962
|
is_visible_on_admin_sidebar: boolean;
|
|
@@ -1455,18 +1965,31 @@ export interface TypesMicroserviceAccessSerializer {
|
|
|
1455
1965
|
slug: string;
|
|
1456
1966
|
}
|
|
1457
1967
|
export interface TypesMicroserviceDomainDto {
|
|
1968
|
+
/**
|
|
1969
|
+
* @maxLength 255
|
|
1970
|
+
* @example "internal.com"
|
|
1971
|
+
*/
|
|
1458
1972
|
internal_domain: string;
|
|
1973
|
+
/** @maxLength 255 */
|
|
1459
1974
|
internal_protocol: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* @maxLength 255
|
|
1977
|
+
* @example "/insights-api"
|
|
1978
|
+
*/
|
|
1460
1979
|
public_path_prefix: string;
|
|
1461
1980
|
}
|
|
1462
1981
|
export interface TypesMicroserviceDomainSerializer {
|
|
1982
|
+
/** @example "internal.com" */
|
|
1463
1983
|
internal_domain: string;
|
|
1984
|
+
/** @example "https" */
|
|
1464
1985
|
internal_protocol: string;
|
|
1986
|
+
/** @example "public.com" */
|
|
1465
1987
|
public_path_prefix: string;
|
|
1466
1988
|
}
|
|
1467
1989
|
export interface TypesMicroserviceSerializer {
|
|
1468
1990
|
created_at: string;
|
|
1469
1991
|
domains: TypesMicroserviceDomainSerializer[];
|
|
1992
|
+
/** @example 1 */
|
|
1470
1993
|
id: number;
|
|
1471
1994
|
is_active: boolean;
|
|
1472
1995
|
is_visible_on_admin_sidebar: boolean;
|
|
@@ -1477,7 +2000,12 @@ export interface TypesMicroserviceSerializer {
|
|
|
1477
2000
|
updated_at: string;
|
|
1478
2001
|
}
|
|
1479
2002
|
export interface TypesOptionalPaginationDto {
|
|
2003
|
+
/** @min 0 */
|
|
1480
2004
|
page?: number;
|
|
2005
|
+
/**
|
|
2006
|
+
* @min 0
|
|
2007
|
+
* @max 100
|
|
2008
|
+
*/
|
|
1481
2009
|
size?: number;
|
|
1482
2010
|
}
|
|
1483
2011
|
export interface TypesPermissionMetadataSerializer {
|
|
@@ -1485,8 +2013,9 @@ export interface TypesPermissionMetadataSerializer {
|
|
|
1485
2013
|
is_microservice_global: boolean;
|
|
1486
2014
|
}
|
|
1487
2015
|
export interface TypesPermissionSerializer {
|
|
1488
|
-
assignment_group:
|
|
2016
|
+
assignment_group: TypesPermissionSerializerAssignmentGroupEnum;
|
|
1489
2017
|
created_at: string;
|
|
2018
|
+
/** @example 1 */
|
|
1490
2019
|
id: number;
|
|
1491
2020
|
metadata: TypesPermissionMetadataSerializer;
|
|
1492
2021
|
microservice: TypesMicroserviceSerializer;
|
|
@@ -1497,7 +2026,7 @@ export interface TypesPermissionSerializer {
|
|
|
1497
2026
|
export interface TypesPublicSettingsSerializer {
|
|
1498
2027
|
auth_apps_limits: TypesAuthAppsLimitsSerializer;
|
|
1499
2028
|
avatar: TypesAvatarSettingsSerializer;
|
|
1500
|
-
b2c_mfa_options:
|
|
2029
|
+
b2c_mfa_options: CommontypesAuthAppType[];
|
|
1501
2030
|
reset_password: TypesResetPasswordSettingsSerializer;
|
|
1502
2031
|
totp: TypesTOTPSerializer;
|
|
1503
2032
|
verification: TypesVerificationSettingsSerializer;
|
|
@@ -1507,19 +2036,41 @@ export interface TypesRefreshDto {
|
|
|
1507
2036
|
}
|
|
1508
2037
|
export interface TypesRegisterDto {
|
|
1509
2038
|
captcha_response?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* @maxLength 255
|
|
2041
|
+
* @example "test@gmail.com"
|
|
2042
|
+
*/
|
|
1510
2043
|
email?: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* @maxLength 255
|
|
2046
|
+
* @example "Mike"
|
|
2047
|
+
*/
|
|
1511
2048
|
first_name: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* @maxLength 255
|
|
2051
|
+
* @example "Jenkins"
|
|
2052
|
+
*/
|
|
1512
2053
|
last_name: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* @maxLength 100
|
|
2056
|
+
* @example "TeStPaSS"
|
|
2057
|
+
*/
|
|
1513
2058
|
password: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* @maxLength 255
|
|
2061
|
+
* @example "+12312312312"
|
|
2062
|
+
*/
|
|
1514
2063
|
phone?: string;
|
|
2064
|
+
/** @maxLength 255 */
|
|
1515
2065
|
username?: string;
|
|
1516
2066
|
}
|
|
1517
2067
|
export interface TypesResetPasswordSettingsSerializer {
|
|
1518
2068
|
expires_in_minutes: number;
|
|
1519
2069
|
}
|
|
1520
2070
|
export interface TypesRevokeUserSessionsDto {
|
|
2071
|
+
/** @min 1 */
|
|
1521
2072
|
user_id: number;
|
|
1522
|
-
user_type:
|
|
2073
|
+
user_type: TypesRevokeUserSessionsDtoUserTypeEnum;
|
|
1523
2074
|
}
|
|
1524
2075
|
export interface TypesRoleSerializer {
|
|
1525
2076
|
assignment_group: PgmodelsPermissionAG;
|
|
@@ -1549,30 +2100,41 @@ export interface TypesSecretNoteSerializer {
|
|
|
1549
2100
|
id: string;
|
|
1550
2101
|
name: string;
|
|
1551
2102
|
note_params: Record<string, string>;
|
|
1552
|
-
type:
|
|
2103
|
+
type: TypesSecretNoteSerializerTypeEnum;
|
|
1553
2104
|
views_left: number;
|
|
1554
2105
|
}
|
|
1555
2106
|
export interface TypesSendB2BMfaCodeDto {
|
|
2107
|
+
/** @maxLength 255 */
|
|
1556
2108
|
device_id?: string;
|
|
2109
|
+
/**
|
|
2110
|
+
* @maxLength 255
|
|
2111
|
+
* @example "test@gmail.com"
|
|
2112
|
+
*/
|
|
1557
2113
|
email: string;
|
|
1558
|
-
type:
|
|
2114
|
+
type: TypesSendB2BMfaCodeDtoTypeEnum;
|
|
1559
2115
|
}
|
|
1560
2116
|
export interface TypesSendB2CMfaCodeDto {
|
|
2117
|
+
/** @maxLength 255 */
|
|
1561
2118
|
device_id?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* @maxLength 255
|
|
2121
|
+
* @example "test@gmail.com"
|
|
2122
|
+
*/
|
|
1562
2123
|
login: string;
|
|
1563
|
-
type:
|
|
2124
|
+
type: TypesSendB2CMfaCodeDtoTypeEnum;
|
|
1564
2125
|
}
|
|
1565
2126
|
export interface TypesSendB2CResetPasswordCodeDto {
|
|
1566
2127
|
auth_form_slug: string;
|
|
1567
|
-
code_type?:
|
|
2128
|
+
code_type?: TypesSendB2CResetPasswordCodeDtoCodeTypeEnum;
|
|
1568
2129
|
contact: string;
|
|
1569
|
-
reset_type:
|
|
2130
|
+
reset_type: TypesSendB2CResetPasswordCodeDtoResetTypeEnum;
|
|
1570
2131
|
}
|
|
1571
2132
|
export interface TypesSendResetPasswordCodeDto {
|
|
1572
2133
|
contact: string;
|
|
1573
|
-
type:
|
|
2134
|
+
type: TypesSendResetPasswordCodeDtoTypeEnum;
|
|
1574
2135
|
}
|
|
1575
2136
|
export interface TypesSendVerificationCodeForSecretNoteDto {
|
|
2137
|
+
/** @maxLength 255 */
|
|
1576
2138
|
email: string;
|
|
1577
2139
|
id: string;
|
|
1578
2140
|
}
|
|
@@ -1592,28 +2154,51 @@ export interface TypesSessionSerializer {
|
|
|
1592
2154
|
export interface TypesSetB2BUserSettingsDto {
|
|
1593
2155
|
captcha_response?: string;
|
|
1594
2156
|
do_not_ask_mfa_again?: boolean;
|
|
2157
|
+
/**
|
|
2158
|
+
* @maxLength 255
|
|
2159
|
+
* @example "test@gmail.com"
|
|
2160
|
+
*/
|
|
1595
2161
|
email: string;
|
|
1596
2162
|
email_change_code?: string;
|
|
2163
|
+
/** @maxLength 255 */
|
|
1597
2164
|
first_name: string;
|
|
2165
|
+
/** @maxLength 255 */
|
|
1598
2166
|
last_name: string;
|
|
2167
|
+
/** @example true */
|
|
1599
2168
|
mfa_enabled?: boolean;
|
|
2169
|
+
/** @maxLength 255 */
|
|
1600
2170
|
mode?: string;
|
|
2171
|
+
/** @maxLength 255 */
|
|
1601
2172
|
new_password?: string;
|
|
1602
2173
|
old_password?: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* @maxLength 255
|
|
2176
|
+
* @example "+1231231234"
|
|
2177
|
+
*/
|
|
1603
2178
|
phone?: string;
|
|
1604
2179
|
phone_change_code?: string;
|
|
2180
|
+
/** @maxLength 255 */
|
|
1605
2181
|
theme?: string;
|
|
1606
2182
|
}
|
|
1607
2183
|
export interface TypesSetB2CUserSettingsDto {
|
|
2184
|
+
/** @maxLength 255 */
|
|
1608
2185
|
email: string;
|
|
1609
2186
|
email_change_code?: string;
|
|
1610
2187
|
enable_email_mfa?: boolean;
|
|
1611
2188
|
enable_phone_mfa?: boolean;
|
|
2189
|
+
/** @maxLength 255 */
|
|
1612
2190
|
first_name?: string;
|
|
2191
|
+
/** @maxLength 255 */
|
|
1613
2192
|
last_name?: string;
|
|
2193
|
+
/** @example true */
|
|
1614
2194
|
mfa_enabled?: boolean;
|
|
2195
|
+
/** @maxLength 255 */
|
|
1615
2196
|
new_password?: string;
|
|
1616
2197
|
old_password?: string;
|
|
2198
|
+
/**
|
|
2199
|
+
* @maxLength 255
|
|
2200
|
+
* @example "+1231231234"
|
|
2201
|
+
*/
|
|
1617
2202
|
phone?: string;
|
|
1618
2203
|
phone_change_code?: string;
|
|
1619
2204
|
}
|
|
@@ -1634,7 +2219,7 @@ export interface TypesTagSerializer {
|
|
|
1634
2219
|
updated_at: string;
|
|
1635
2220
|
}
|
|
1636
2221
|
export interface TypesTenantSettingDto {
|
|
1637
|
-
label:
|
|
2222
|
+
label: TypesTenantSettingDtoLabelEnum;
|
|
1638
2223
|
value: string;
|
|
1639
2224
|
}
|
|
1640
2225
|
export enum TypesTenantSettingLabel {
|
|
@@ -1654,50 +2239,86 @@ export interface TypesUpdateAPIKeysDto {
|
|
|
1654
2239
|
branches?: number[];
|
|
1655
2240
|
firms?: TypesFirmInfo[];
|
|
1656
2241
|
mfa_codes?: TypesMfaCodesDto;
|
|
2242
|
+
/** @maxLength 255 */
|
|
1657
2243
|
name: string;
|
|
1658
2244
|
permissions?: number[];
|
|
1659
2245
|
roles?: number[];
|
|
1660
2246
|
updated_at: string;
|
|
1661
2247
|
}
|
|
1662
2248
|
export interface TypesUpdateAuthAppDto {
|
|
2249
|
+
/** @maxLength 255 */
|
|
1663
2250
|
name: string;
|
|
1664
|
-
status:
|
|
2251
|
+
status: TypesUpdateAuthAppDtoStatusEnum;
|
|
1665
2252
|
}
|
|
1666
2253
|
export interface TypesUpdateB2BUserDto {
|
|
1667
2254
|
allow_feedback?: boolean;
|
|
1668
2255
|
branches?: number[];
|
|
2256
|
+
/**
|
|
2257
|
+
* @maxLength 255
|
|
2258
|
+
* @example "test@gmail.com"
|
|
2259
|
+
*/
|
|
1669
2260
|
email?: string;
|
|
2261
|
+
/** @minItems 1 */
|
|
1670
2262
|
firms: TypesFirmInfo[];
|
|
2263
|
+
/** @maxLength 255 */
|
|
1671
2264
|
first_name: string;
|
|
1672
2265
|
has_access_to_all_firm_branches?: boolean;
|
|
2266
|
+
/** @maxLength 255 */
|
|
1673
2267
|
last_name: string;
|
|
2268
|
+
/** @example "TeStPaSS" */
|
|
1674
2269
|
password?: string;
|
|
1675
2270
|
permissions?: number[];
|
|
2271
|
+
/**
|
|
2272
|
+
* @maxLength 255
|
|
2273
|
+
* @example "+1231231234"
|
|
2274
|
+
*/
|
|
1676
2275
|
phone?: string;
|
|
1677
2276
|
primary_firm_id?: number;
|
|
2277
|
+
/** @minItems 1 */
|
|
1678
2278
|
roles: number[];
|
|
1679
2279
|
should_reset_password?: boolean;
|
|
1680
2280
|
updated_at: string;
|
|
2281
|
+
/** @maxLength 255 */
|
|
1681
2282
|
username?: string;
|
|
1682
2283
|
}
|
|
1683
2284
|
export interface TypesUpdateB2CUserDto {
|
|
1684
2285
|
allow_feedback?: boolean;
|
|
1685
2286
|
blocking_reason?: string;
|
|
2287
|
+
/** @minItems 1 */
|
|
1686
2288
|
branches: number[];
|
|
2289
|
+
/**
|
|
2290
|
+
* @maxLength 255
|
|
2291
|
+
* @example "test@gmail.com"
|
|
2292
|
+
*/
|
|
1687
2293
|
email?: string;
|
|
2294
|
+
/** @min 1 */
|
|
1688
2295
|
firm_id: number;
|
|
2296
|
+
/** @maxLength 255 */
|
|
1689
2297
|
first_name: string;
|
|
1690
2298
|
is_blocked?: boolean;
|
|
2299
|
+
/** @maxLength 255 */
|
|
1691
2300
|
last_name: string;
|
|
2301
|
+
/**
|
|
2302
|
+
* @maxLength 100
|
|
2303
|
+
* @example "TeStPaSS"
|
|
2304
|
+
*/
|
|
1692
2305
|
password?: string;
|
|
1693
2306
|
permissions?: number[];
|
|
2307
|
+
/**
|
|
2308
|
+
* @maxLength 255
|
|
2309
|
+
* @example "+1231231234"
|
|
2310
|
+
*/
|
|
1694
2311
|
phone?: string;
|
|
2312
|
+
/** @minItems 1 */
|
|
1695
2313
|
roles: number[];
|
|
1696
2314
|
updated_at: string;
|
|
2315
|
+
/** @maxLength 255 */
|
|
1697
2316
|
username?: string;
|
|
1698
2317
|
}
|
|
1699
2318
|
export interface TypesUpdateBranchDto {
|
|
2319
|
+
/** @maxLength 255 */
|
|
1700
2320
|
code?: string;
|
|
2321
|
+
/** @maxLength 255 */
|
|
1701
2322
|
name: string;
|
|
1702
2323
|
retail_available_auth_app_options?: CommontypesAuthAppType[];
|
|
1703
2324
|
retail_email_verification_required?: boolean;
|
|
@@ -1705,6 +2326,7 @@ export interface TypesUpdateBranchDto {
|
|
|
1705
2326
|
retail_mfa_enabling_required?: boolean;
|
|
1706
2327
|
retail_phone_verification_required?: boolean;
|
|
1707
2328
|
settings?: TypesTenantSettingDto[];
|
|
2329
|
+
/** @maxLength 255 */
|
|
1708
2330
|
slug: string;
|
|
1709
2331
|
updated_at: string;
|
|
1710
2332
|
}
|
|
@@ -1712,59 +2334,79 @@ export interface TypesUpdateEndpointDto {
|
|
|
1712
2334
|
is_active?: boolean;
|
|
1713
2335
|
is_public?: boolean;
|
|
1714
2336
|
metadata?: TypesEndpointMetadataDto;
|
|
1715
|
-
method:
|
|
2337
|
+
method: TypesUpdateEndpointDtoMethodEnum;
|
|
2338
|
+
/** @min 1 */
|
|
1716
2339
|
microservice_id: number;
|
|
1717
2340
|
required_permissions?: number[];
|
|
2341
|
+
/** @maxLength 255 */
|
|
1718
2342
|
route: string;
|
|
1719
|
-
type?:
|
|
2343
|
+
type?: TypesUpdateEndpointDtoTypeEnum;
|
|
1720
2344
|
updated_at: string;
|
|
1721
2345
|
}
|
|
1722
2346
|
export interface TypesUpdateFirmDto {
|
|
1723
2347
|
allow_b2c_email_notifications?: boolean;
|
|
1724
2348
|
firm_tags?: number[];
|
|
1725
2349
|
mailgun_creds?: TypesFirmMailgunCredsDto;
|
|
2350
|
+
/** @maxLength 255 */
|
|
1726
2351
|
name: string;
|
|
2352
|
+
/** @maxLength 255 */
|
|
1727
2353
|
slug: string;
|
|
1728
|
-
status:
|
|
2354
|
+
status: TypesUpdateFirmDtoStatusEnum;
|
|
1729
2355
|
twilio_creds?: TypesFirmTwilioCredsDto;
|
|
1730
2356
|
updated_at: string;
|
|
1731
2357
|
}
|
|
1732
2358
|
export interface TypesUpdateIdentityProviderDto {
|
|
2359
|
+
/** @maxLength 1000 */
|
|
1733
2360
|
auth_url: string;
|
|
2361
|
+
/** @maxLength 255 */
|
|
1734
2362
|
client_id: string;
|
|
2363
|
+
/** @maxLength 255 */
|
|
1735
2364
|
client_secret: string;
|
|
2365
|
+
/** @maxLength 1000 */
|
|
1736
2366
|
company_domain: string;
|
|
2367
|
+
/** @min 1 */
|
|
1737
2368
|
firm_id: number;
|
|
2369
|
+
/** @min 1 */
|
|
1738
2370
|
priority: number;
|
|
2371
|
+
/** @maxLength 1000 */
|
|
1739
2372
|
redirect_url?: string;
|
|
1740
|
-
type:
|
|
2373
|
+
type: TypesUpdateIdentityProviderDtoTypeEnum;
|
|
1741
2374
|
updated_at: string;
|
|
1742
2375
|
}
|
|
1743
2376
|
export interface TypesUpdateMicroserviceDto {
|
|
1744
2377
|
domains?: TypesMicroserviceDomainDto[];
|
|
1745
2378
|
is_active?: boolean;
|
|
1746
2379
|
is_visible_on_admin_sidebar?: boolean;
|
|
2380
|
+
/** @maxLength 1000 */
|
|
1747
2381
|
logo_url?: string;
|
|
2382
|
+
/** @maxLength 255 */
|
|
1748
2383
|
name: string;
|
|
2384
|
+
/** @maxLength 255 */
|
|
1749
2385
|
slug: string;
|
|
1750
2386
|
updated_at: string;
|
|
1751
2387
|
}
|
|
1752
2388
|
export interface TypesUpdatePermissionDto {
|
|
1753
|
-
assignment_group?:
|
|
2389
|
+
assignment_group?: TypesUpdatePermissionDtoAssignmentGroupEnum;
|
|
1754
2390
|
metadata?: PgmodelsPermissionMetadata;
|
|
1755
2391
|
microservice_id?: number;
|
|
2392
|
+
/** @maxLength 1000 */
|
|
1756
2393
|
permission: string;
|
|
1757
2394
|
updated_at: string;
|
|
1758
2395
|
}
|
|
1759
2396
|
export interface TypesUpdateRoleDto {
|
|
2397
|
+
/** @maxLength 255 */
|
|
1760
2398
|
name: string;
|
|
2399
|
+
/** @minItems 1 */
|
|
1761
2400
|
permissions: number[];
|
|
1762
2401
|
permissions_can_assign_role?: number[];
|
|
2402
|
+
/** @min 1 */
|
|
1763
2403
|
type_id: number;
|
|
1764
2404
|
updated_at: string;
|
|
1765
2405
|
}
|
|
1766
2406
|
export interface TypesUpdateRoleTypeDto {
|
|
2407
|
+
/** @maxLength 255 */
|
|
1767
2408
|
color: string;
|
|
2409
|
+
/** @maxLength 255 */
|
|
1768
2410
|
type: string;
|
|
1769
2411
|
updated_at: string;
|
|
1770
2412
|
}
|
|
@@ -1773,50 +2415,77 @@ export interface TypesUpdateTagDto {
|
|
|
1773
2415
|
updated_at: string;
|
|
1774
2416
|
}
|
|
1775
2417
|
export interface TypesUpdateWatchmenInstanceDto {
|
|
2418
|
+
/**
|
|
2419
|
+
* @minLength 1
|
|
2420
|
+
* @maxLength 255
|
|
2421
|
+
*/
|
|
1776
2422
|
name: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* @minLength 1
|
|
2425
|
+
* @maxLength 255
|
|
2426
|
+
*/
|
|
1777
2427
|
slug: string;
|
|
1778
2428
|
updated_at: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* @minLength 1
|
|
2431
|
+
* @maxLength 1000
|
|
2432
|
+
*/
|
|
1779
2433
|
url: string;
|
|
1780
2434
|
}
|
|
1781
2435
|
export interface TypesUpsertTablePresetDto {
|
|
1782
2436
|
presets?: object;
|
|
2437
|
+
/** @maxLength 255 */
|
|
1783
2438
|
table_name: string;
|
|
1784
2439
|
}
|
|
1785
2440
|
export interface TypesUpsertUserDto {
|
|
1786
2441
|
branches: number[];
|
|
2442
|
+
/** @example "test@gmail.com" */
|
|
1787
2443
|
email: string;
|
|
1788
2444
|
firms: number[];
|
|
1789
2445
|
first_name?: string;
|
|
1790
2446
|
initiator_id?: number;
|
|
1791
2447
|
last_name?: string;
|
|
1792
2448
|
permissions: number[];
|
|
2449
|
+
/** @example "+1231231234" */
|
|
1793
2450
|
phone?: string;
|
|
1794
2451
|
rep_code?: string;
|
|
1795
2452
|
roles: number[];
|
|
1796
|
-
type:
|
|
2453
|
+
type: TypesUpsertUserDtoTypeEnum;
|
|
1797
2454
|
}
|
|
1798
2455
|
export interface TypesUpsertUsersDto {
|
|
2456
|
+
/** @maxItems 100 */
|
|
1799
2457
|
users: TypesUpsertUserDto[];
|
|
1800
2458
|
}
|
|
1801
2459
|
export interface TypesUserSerializer {
|
|
1802
2460
|
allow_feedback: boolean;
|
|
1803
2461
|
big_avatar_url: string;
|
|
2462
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1804
2463
|
created_at: string;
|
|
2464
|
+
/** @example true */
|
|
1805
2465
|
do_not_ask_mfa_again: boolean;
|
|
2466
|
+
/** @example "test@email.com" */
|
|
1806
2467
|
email: string;
|
|
2468
|
+
/** @example true */
|
|
1807
2469
|
email_verified: boolean;
|
|
2470
|
+
/** @example "Mike" */
|
|
1808
2471
|
first_name: string;
|
|
2472
|
+
/** @example 1 */
|
|
1809
2473
|
id: number;
|
|
1810
2474
|
initiator_id: number;
|
|
2475
|
+
/** @example "Jenkins" */
|
|
1811
2476
|
last_name: string;
|
|
1812
2477
|
locale: TypesLocaleSerializer;
|
|
1813
2478
|
locale_id: number;
|
|
2479
|
+
/** @example true */
|
|
1814
2480
|
mfa_enabled: boolean;
|
|
2481
|
+
/** @example "+123478844" */
|
|
1815
2482
|
phone: string;
|
|
2483
|
+
/** @example true */
|
|
1816
2484
|
phone_verified: boolean;
|
|
1817
2485
|
rep_code: string;
|
|
1818
2486
|
should_reset_password: boolean;
|
|
1819
2487
|
small_avatar_url: string;
|
|
2488
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1820
2489
|
updated_at: string;
|
|
1821
2490
|
username: string;
|
|
1822
2491
|
}
|
|
@@ -1825,7 +2494,7 @@ export interface TypesVerificationSettingsSerializer {
|
|
|
1825
2494
|
}
|
|
1826
2495
|
export interface TypesVerifyContactDto {
|
|
1827
2496
|
code: string;
|
|
1828
|
-
code_type:
|
|
2497
|
+
code_type: TypesVerifyContactDtoCodeTypeEnum;
|
|
1829
2498
|
contact: string;
|
|
1830
2499
|
}
|
|
1831
2500
|
export interface TypesVerifyWatchmenAuthTokenDto {
|
|
@@ -1906,6 +2575,7 @@ export interface TypesWebAuthnPublicKeyCredentialCreationSerializer {
|
|
|
1906
2575
|
export interface TypesWebAuthnRegistrationSolutionDto {
|
|
1907
2576
|
client_extension_results?: object;
|
|
1908
2577
|
id?: string;
|
|
2578
|
+
/** @maxLength 255 */
|
|
1909
2579
|
name: string;
|
|
1910
2580
|
raw_id?: string;
|
|
1911
2581
|
response?: TypesWebAuthnAttestationResponse;
|
|
@@ -1960,301 +2630,1531 @@ export interface WatchmeninstancesWatchmenInstanceMutationSerializer {
|
|
|
1960
2630
|
status: number;
|
|
1961
2631
|
watchmen_instance: TypesWatchmenInstanceSerializer;
|
|
1962
2632
|
}
|
|
2633
|
+
export enum TypesAuthFormDtoResetPasswordTypeEnum {
|
|
2634
|
+
ByContactCode = "by_contact_code",
|
|
2635
|
+
ByEmailLink = "by_email_link"
|
|
2636
|
+
}
|
|
2637
|
+
export enum TypesAuthFormSerializerResetPasswordTypeEnum {
|
|
2638
|
+
ByContactCode = "by_contact_code",
|
|
2639
|
+
ByEmailLink = "by_email_link"
|
|
2640
|
+
}
|
|
2641
|
+
export enum TypesB2BSendContactChangeCodeDtoTypeEnum {
|
|
2642
|
+
Email = "email",
|
|
2643
|
+
Voice = "voice",
|
|
2644
|
+
Sms = "sms"
|
|
2645
|
+
}
|
|
2646
|
+
export enum TypesB2CResetPasswordDtoResetTypeEnum {
|
|
2647
|
+
ByContactCode = "by_contact_code",
|
|
2648
|
+
ByEmailLink = "by_email_link"
|
|
2649
|
+
}
|
|
2650
|
+
export enum TypesB2CSendContactChangeCodeDtoTypeEnum {
|
|
2651
|
+
Email = "email",
|
|
2652
|
+
Voice = "voice",
|
|
2653
|
+
Sms = "sms"
|
|
2654
|
+
}
|
|
2655
|
+
export enum TypesB2CSendVerificationCodeDtoCodeTypeEnum {
|
|
2656
|
+
Email = "email",
|
|
2657
|
+
Voice = "voice",
|
|
2658
|
+
Sms = "sms"
|
|
2659
|
+
}
|
|
2660
|
+
export enum TypesCreateEndpointDtoMethodEnum {
|
|
2661
|
+
POST = "POST",
|
|
2662
|
+
PUT = "PUT",
|
|
2663
|
+
DELETE = "DELETE",
|
|
2664
|
+
GET = "GET",
|
|
2665
|
+
PATCH = "PATCH",
|
|
2666
|
+
ALL = "ALL"
|
|
2667
|
+
}
|
|
2668
|
+
export enum TypesCreateEndpointDtoTypeEnum {
|
|
2669
|
+
Regular = "regular",
|
|
2670
|
+
DisplayOnly = "display_only"
|
|
2671
|
+
}
|
|
2672
|
+
export enum TypesCreateIdentityProviderDtoTypeEnum {
|
|
2673
|
+
Okta = "okta"
|
|
2674
|
+
}
|
|
2675
|
+
export enum TypesCreatePermissionDtoAssignmentGroupEnum {
|
|
2676
|
+
Regular = "regular",
|
|
2677
|
+
Superadmin = "superadmin",
|
|
2678
|
+
B2BOnly = "b2b_only"
|
|
2679
|
+
}
|
|
2680
|
+
export enum TypesCreateRoleDtoAssignmentGroupEnum {
|
|
2681
|
+
Regular = "regular",
|
|
2682
|
+
Superadmin = "superadmin",
|
|
2683
|
+
B2BOnly = "b2b_only"
|
|
2684
|
+
}
|
|
2685
|
+
export enum TypesCreateSecretNoteDtoTypeEnum {
|
|
2686
|
+
Password = "password"
|
|
2687
|
+
}
|
|
2688
|
+
export enum TypesEndpointMetadataDtoUserTypeEnum {
|
|
2689
|
+
B2B = "b2b",
|
|
2690
|
+
B2C = "b2c"
|
|
2691
|
+
}
|
|
2692
|
+
export enum TypesEndpointSerializerMethodEnum {
|
|
2693
|
+
POST = "POST",
|
|
2694
|
+
PUT = "PUT",
|
|
2695
|
+
DELETE = "DELETE",
|
|
2696
|
+
GET = "GET",
|
|
2697
|
+
PATCH = "PATCH",
|
|
2698
|
+
ALL = "ALL"
|
|
2699
|
+
}
|
|
2700
|
+
export enum TypesGetB2CUsersListFiltersDtoShowOnlyEnum {
|
|
2701
|
+
Admin = "admin",
|
|
2702
|
+
BranchAdmin = "branch_admin",
|
|
2703
|
+
Compliance = "compliance"
|
|
2704
|
+
}
|
|
2705
|
+
export enum TypesGetFirmsListFiltersDtoStatusesEnum {
|
|
2706
|
+
InProgress = "in_progress",
|
|
2707
|
+
Active = "active",
|
|
2708
|
+
Suspended = "suspended",
|
|
2709
|
+
Deleted = "deleted"
|
|
2710
|
+
}
|
|
2711
|
+
export enum TypesGetIdentityProvidersListFiltersDtoTypesEnum {
|
|
2712
|
+
Okta = "okta"
|
|
2713
|
+
}
|
|
2714
|
+
export enum TypesGetUsersListFiltersDtoShowOnlyEnum {
|
|
2715
|
+
Admin = "admin",
|
|
2716
|
+
BranchAdmin = "branch_admin",
|
|
2717
|
+
Compliance = "compliance"
|
|
2718
|
+
}
|
|
2719
|
+
export enum TypesGetWebAuthnLoginChallengeDtoUserTypeEnum {
|
|
2720
|
+
B2B = "b2b",
|
|
2721
|
+
B2C = "b2c"
|
|
2722
|
+
}
|
|
2723
|
+
export enum TypesIdentityProviderSerializerTypeEnum {
|
|
2724
|
+
Okta = "okta"
|
|
2725
|
+
}
|
|
2726
|
+
export enum TypesLinkWatchmenUserToUmaDtoUmaUserTypeEnum {
|
|
2727
|
+
B2B = "b2b",
|
|
2728
|
+
B2C = "b2c"
|
|
2729
|
+
}
|
|
2730
|
+
export enum TypesPermissionSerializerAssignmentGroupEnum {
|
|
2731
|
+
Regular = "regular",
|
|
2732
|
+
Chiefadmin = "chiefadmin",
|
|
2733
|
+
Superadmin = "superadmin"
|
|
2734
|
+
}
|
|
2735
|
+
export enum TypesRevokeUserSessionsDtoUserTypeEnum {
|
|
2736
|
+
B2B = "b2b",
|
|
2737
|
+
B2C = "b2c"
|
|
2738
|
+
}
|
|
2739
|
+
export enum TypesSecretNoteSerializerTypeEnum {
|
|
2740
|
+
Password = "password"
|
|
2741
|
+
}
|
|
2742
|
+
export enum TypesSendB2BMfaCodeDtoTypeEnum {
|
|
2743
|
+
Email = "email",
|
|
2744
|
+
Voice = "voice",
|
|
2745
|
+
Sms = "sms"
|
|
2746
|
+
}
|
|
2747
|
+
export enum TypesSendB2CMfaCodeDtoTypeEnum {
|
|
2748
|
+
Email = "email",
|
|
2749
|
+
Voice = "voice",
|
|
2750
|
+
Sms = "sms"
|
|
2751
|
+
}
|
|
2752
|
+
export enum TypesSendB2CResetPasswordCodeDtoCodeTypeEnum {
|
|
2753
|
+
Email = "email",
|
|
2754
|
+
Voice = "voice",
|
|
2755
|
+
Sms = "sms"
|
|
2756
|
+
}
|
|
2757
|
+
export enum TypesSendB2CResetPasswordCodeDtoResetTypeEnum {
|
|
2758
|
+
ByContactCode = "by_contact_code",
|
|
2759
|
+
ByEmailLink = "by_email_link"
|
|
2760
|
+
}
|
|
2761
|
+
export enum TypesSendResetPasswordCodeDtoTypeEnum {
|
|
2762
|
+
Email = "email",
|
|
2763
|
+
Voice = "voice",
|
|
2764
|
+
Sms = "sms"
|
|
2765
|
+
}
|
|
2766
|
+
export enum TypesTenantSettingDtoLabelEnum {
|
|
2767
|
+
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
2768
|
+
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
2769
|
+
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
2770
|
+
}
|
|
2771
|
+
export enum TypesUpdateAuthAppDtoStatusEnum {
|
|
2772
|
+
Active = "active",
|
|
2773
|
+
Disabled = "disabled"
|
|
2774
|
+
}
|
|
2775
|
+
export enum TypesUpdateEndpointDtoMethodEnum {
|
|
2776
|
+
POST = "POST",
|
|
2777
|
+
PUT = "PUT",
|
|
2778
|
+
DELETE = "DELETE",
|
|
2779
|
+
GET = "GET",
|
|
2780
|
+
PATCH = "PATCH",
|
|
2781
|
+
ALL = "ALL"
|
|
2782
|
+
}
|
|
2783
|
+
export enum TypesUpdateEndpointDtoTypeEnum {
|
|
2784
|
+
Regular = "regular",
|
|
2785
|
+
DisplayOnly = "display_only"
|
|
2786
|
+
}
|
|
2787
|
+
export enum TypesUpdateFirmDtoStatusEnum {
|
|
2788
|
+
InProgress = "in_progress",
|
|
2789
|
+
Active = "active",
|
|
2790
|
+
Suspended = "suspended",
|
|
2791
|
+
Deleted = "deleted"
|
|
2792
|
+
}
|
|
2793
|
+
export enum TypesUpdateIdentityProviderDtoTypeEnum {
|
|
2794
|
+
Okta = "okta"
|
|
2795
|
+
}
|
|
2796
|
+
export enum TypesUpdatePermissionDtoAssignmentGroupEnum {
|
|
2797
|
+
Regular = "regular",
|
|
2798
|
+
Superadmin = "superadmin",
|
|
2799
|
+
B2BOnly = "b2b_only"
|
|
2800
|
+
}
|
|
2801
|
+
export enum TypesUpsertUserDtoTypeEnum {
|
|
2802
|
+
B2B = "b2b",
|
|
2803
|
+
B2C = "b2c"
|
|
2804
|
+
}
|
|
2805
|
+
export enum TypesVerifyContactDtoCodeTypeEnum {
|
|
2806
|
+
Email = "email",
|
|
2807
|
+
Voice = "voice",
|
|
2808
|
+
Sms = "sms"
|
|
2809
|
+
}
|
|
1963
2810
|
export class ActionLogs<HandleError extends boolean = boolean> {
|
|
1964
2811
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1965
2812
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1966
|
-
|
|
2813
|
+
/**
|
|
2814
|
+
* @description Get Action logs list
|
|
2815
|
+
* @tags action_logs
|
|
2816
|
+
* @name GetActionLogs
|
|
2817
|
+
* @summary Get Action logs list
|
|
2818
|
+
* @request POST:/v1/action-logs/list
|
|
2819
|
+
* @secure
|
|
2820
|
+
*/
|
|
2821
|
+
getActionLogs(getActionLogsDto: TypesGetActionLogsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ActionlogsGetActionLogsSerializer, HandleError>>;
|
|
1967
2822
|
}
|
|
1968
2823
|
export class ApiKeys<HandleError extends boolean = boolean> {
|
|
1969
2824
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1970
2825
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
2826
|
+
/**
|
|
2827
|
+
* @description Delete API Key by id (would throw 404 error if API key not found or belongs to different user)
|
|
2828
|
+
* @tags api_keys
|
|
2829
|
+
* @name DeleteMany
|
|
2830
|
+
* @summary Delete API Key by id
|
|
2831
|
+
* @request DELETE:/v1/b2b/api-keys
|
|
2832
|
+
* @secure
|
|
2833
|
+
*/
|
|
2834
|
+
deleteMany(deleteAPIKeys: TypesDeleteAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2835
|
+
/**
|
|
2836
|
+
* @description Get APIKey by id
|
|
2837
|
+
* @tags api_keys
|
|
2838
|
+
* @name GetById
|
|
2839
|
+
* @summary Get APIKey by id
|
|
2840
|
+
* @request GET:/v1/b2b/api-keys/{id}
|
|
2841
|
+
* @secure
|
|
2842
|
+
*/
|
|
2843
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<ApikeysAPIKeysMutationSerializer, HandleError>>;
|
|
2844
|
+
/**
|
|
2845
|
+
* @description Create API Key & API Secret Pair. API Secret won't be accessible for read after that
|
|
2846
|
+
* @tags api_keys
|
|
2847
|
+
* @name Create
|
|
2848
|
+
* @summary Create API Key & API Secret Pair
|
|
2849
|
+
* @request POST:/v2/b2b/api-keys
|
|
2850
|
+
* @secure
|
|
2851
|
+
*/
|
|
2852
|
+
create(createApiKeys: TypesCreateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ApikeysAPIKeysMutationSerializer, HandleError>>;
|
|
2853
|
+
/**
|
|
2854
|
+
* @description Get API Keys info(would return API Keys without secrets)
|
|
2855
|
+
* @tags api_keys
|
|
2856
|
+
* @name Get
|
|
2857
|
+
* @summary Get API Keys info(would return API Keys without secrets)
|
|
2858
|
+
* @request POST:/v2/b2b/api-keys/list
|
|
2859
|
+
* @secure
|
|
2860
|
+
*/
|
|
2861
|
+
get(apiKeys: TypesGetAPIKeysListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ApikeysGetAPIKeysSerializer, HandleError>>;
|
|
2862
|
+
/**
|
|
2863
|
+
* @description Update API Key Record
|
|
2864
|
+
* @tags api_keys
|
|
2865
|
+
* @name Update
|
|
2866
|
+
* @summary Update API Key Record
|
|
2867
|
+
* @request PUT:/v2/b2b/api-keys/{id}
|
|
2868
|
+
* @secure
|
|
2869
|
+
*/
|
|
2870
|
+
update(id: number, apiKeys: TypesUpdateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<ApikeysAPIKeysMutationSerializer, HandleError>>;
|
|
1976
2871
|
}
|
|
1977
2872
|
export class AuthApps<HandleError extends boolean = boolean> {
|
|
1978
2873
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1979
2874
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
|
|
1988
|
-
|
|
2875
|
+
/**
|
|
2876
|
+
* @description Get auth apps
|
|
2877
|
+
* @tags auth_apps
|
|
2878
|
+
* @name Get
|
|
2879
|
+
* @summary Get auth apps
|
|
2880
|
+
* @request GET:/v1/auth-apps
|
|
2881
|
+
* @secure
|
|
2882
|
+
*/
|
|
2883
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthappsGetAuthAppsListSerializer, HandleError>>;
|
|
2884
|
+
/**
|
|
2885
|
+
* @description Delete auth apps
|
|
2886
|
+
* @tags auth_apps
|
|
2887
|
+
* @name DeleteMany
|
|
2888
|
+
* @summary Delete auth apps
|
|
2889
|
+
* @request DELETE:/v1/auth-apps
|
|
2890
|
+
* @secure
|
|
2891
|
+
*/
|
|
2892
|
+
deleteMany(deleteAuthAppsDto: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2893
|
+
/**
|
|
2894
|
+
* @description Get TOTP registration QR
|
|
2895
|
+
* @tags auth_apps
|
|
2896
|
+
* @name GetRegistrationQr
|
|
2897
|
+
* @summary Get TOTP registration QR
|
|
2898
|
+
* @request POST:/v1/auth-apps/totp/registration/qr
|
|
2899
|
+
* @secure
|
|
2900
|
+
*/
|
|
2901
|
+
getRegistrationQr(getTotpQRDto: TypesGetTotpQRDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
|
|
2902
|
+
/**
|
|
2903
|
+
* @description Finish TOTP registration
|
|
2904
|
+
* @tags auth_apps
|
|
2905
|
+
* @name FinishRegistration
|
|
2906
|
+
* @summary Finish TOTP registration
|
|
2907
|
+
* @request POST:/v1/auth-apps/totp/registration/response
|
|
2908
|
+
* @secure
|
|
2909
|
+
*/
|
|
2910
|
+
finishRegistration(finishTOTPRegistrationDto: TypesFinishTOTPRegistrationDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthappsFinishTOTPRegistrationResponseSerializer, HandleError>>;
|
|
2911
|
+
/**
|
|
2912
|
+
* @description Get WebAuthn login challenge
|
|
2913
|
+
* @tags auth_apps
|
|
2914
|
+
* @name GetLoginChallenge
|
|
2915
|
+
* @summary Get WebAuthn login challenge
|
|
2916
|
+
* @request POST:/v1/auth-apps/webauthn/login/request
|
|
2917
|
+
*/
|
|
2918
|
+
getLoginChallenge(getWebAuthnLoginChallengeDto: TypesGetWebAuthnLoginChallengeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesWebAuthnCredentialAssertionSerializer, HandleError>>;
|
|
2919
|
+
/**
|
|
2920
|
+
* @description Get WebAuthn register challenge
|
|
2921
|
+
* @tags auth_apps
|
|
2922
|
+
* @name GetRegisterChallenge
|
|
2923
|
+
* @summary Get WebAuthn register challenge
|
|
2924
|
+
* @request POST:/v1/auth-apps/webauthn/registration/request
|
|
2925
|
+
* @secure
|
|
2926
|
+
*/
|
|
2927
|
+
getRegisterChallenge(config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesWebAuthnCredentialCreationSerializer, HandleError>>;
|
|
2928
|
+
/**
|
|
2929
|
+
* @description Finish WebAuthn credential registration
|
|
2930
|
+
* @tags auth_apps
|
|
2931
|
+
* @name FinishCredentialRegistration
|
|
2932
|
+
* @summary Finish WebAuthn credential registration
|
|
2933
|
+
* @request POST:/v1/auth-apps/webauthn/registration/response
|
|
2934
|
+
* @secure
|
|
2935
|
+
*/
|
|
2936
|
+
finishCredentialRegistration(webAuthnRegistrationSolutionDto: TypesWebAuthnRegistrationSolutionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2937
|
+
/**
|
|
2938
|
+
* @description Register Yubico OTP Key
|
|
2939
|
+
* @tags auth_apps
|
|
2940
|
+
* @name Register
|
|
2941
|
+
* @summary Register Yubico OTP Key
|
|
2942
|
+
* @request POST:/v1/auth-apps/yubico/otp/registration
|
|
2943
|
+
* @secure
|
|
2944
|
+
*/
|
|
2945
|
+
register(yubicoOTPDto: TypesCreateYubicoOTPDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2946
|
+
/**
|
|
2947
|
+
* @description Update auth app
|
|
2948
|
+
* @tags auth_apps
|
|
2949
|
+
* @name Update
|
|
2950
|
+
* @summary Update auth app
|
|
2951
|
+
* @request PUT:/v1/auth-apps/{id}
|
|
2952
|
+
* @secure
|
|
2953
|
+
*/
|
|
2954
|
+
update(id: number, updateAuthAppDto: TypesUpdateAuthAppDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthappsAuthAppResponseSerializer, HandleError>>;
|
|
1989
2955
|
}
|
|
1990
2956
|
export class AuthForms<HandleError extends boolean = boolean> {
|
|
1991
2957
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1992
2958
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
2959
|
+
/**
|
|
2960
|
+
* @description Create Auth Form
|
|
2961
|
+
* @tags auth_forms
|
|
2962
|
+
* @name Create
|
|
2963
|
+
* @summary Create Auth Form
|
|
2964
|
+
* @request POST:/v1/auth-forms
|
|
2965
|
+
* @secure
|
|
2966
|
+
*/
|
|
2967
|
+
create(authFormDto: TypesAuthFormDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthformsAuthFormMutationSerializer, HandleError>>;
|
|
2968
|
+
/**
|
|
2969
|
+
* @description Delete Auth Forms by ids
|
|
2970
|
+
* @tags auth_forms
|
|
2971
|
+
* @name DeleteMany
|
|
2972
|
+
* @summary Delete Auth Forms by ids
|
|
2973
|
+
* @request DELETE:/v1/auth-forms
|
|
2974
|
+
* @secure
|
|
2975
|
+
*/
|
|
2976
|
+
deleteMany(deleteAuthFormsDto: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2977
|
+
/**
|
|
2978
|
+
* @description Get Auth Forms with pagination. Available sort fields are `id, branch_id, slug, created_at, updated_at`. Search is performed by slug field
|
|
2979
|
+
* @tags auth_forms
|
|
2980
|
+
* @name Get
|
|
2981
|
+
* @summary Get Auth Forms with pagination
|
|
2982
|
+
* @request POST:/v1/auth-forms/list
|
|
2983
|
+
* @secure
|
|
2984
|
+
*/
|
|
2985
|
+
get(getAuthFormListDto: TypesGetAuthFormsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthformsGetAuthFormsListSerializer, HandleError>>;
|
|
2986
|
+
/**
|
|
2987
|
+
* @description Get Auth Forms by slug
|
|
2988
|
+
* @tags auth_forms
|
|
2989
|
+
* @name GetBySlug
|
|
2990
|
+
* @summary Get Auth Forms by slug
|
|
2991
|
+
* @request GET:/v1/auth-forms/public/{slug}
|
|
2992
|
+
*/
|
|
2993
|
+
getBySlug(slug: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthformsAuthFormMutationSerializer, HandleError>>;
|
|
2994
|
+
/**
|
|
2995
|
+
* @description Get Auth Forms by id
|
|
2996
|
+
* @tags auth_forms
|
|
2997
|
+
* @name GetById
|
|
2998
|
+
* @summary Get Auth Forms by id
|
|
2999
|
+
* @request GET:/v1/auth-forms/{id}
|
|
3000
|
+
* @secure
|
|
3001
|
+
*/
|
|
3002
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthformsAuthFormMutationSerializer, HandleError>>;
|
|
3003
|
+
/**
|
|
3004
|
+
* @description Update Auth Form record
|
|
3005
|
+
* @tags auth_forms
|
|
3006
|
+
* @name Update
|
|
3007
|
+
* @summary Update Auth Form record
|
|
3008
|
+
* @request PUT:/v1/auth-forms/{id}
|
|
3009
|
+
* @secure
|
|
3010
|
+
*/
|
|
3011
|
+
update(id: number, authFormDto: TypesAuthFormDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<AuthformsAuthFormMutationSerializer, HandleError>>;
|
|
1999
3012
|
}
|
|
2000
3013
|
export class B2BAuth<HandleError extends boolean = boolean> {
|
|
2001
3014
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2002
3015
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2003
|
-
|
|
2004
|
-
|
|
3016
|
+
/**
|
|
3017
|
+
* @description Get current B2B user info by access token.
|
|
3018
|
+
* @tags b2b_auth
|
|
3019
|
+
* @name GetCurrent
|
|
3020
|
+
* @summary Get current B2B user info by access token
|
|
3021
|
+
* @request GET:/v1/auth/b2b/current
|
|
3022
|
+
* @secure
|
|
3023
|
+
*/
|
|
3024
|
+
getCurrent(config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BauthGetCurrentB2BUserSerializer, HandleError>>;
|
|
3025
|
+
/**
|
|
3026
|
+
* @description Login B2B user by API Keys
|
|
3027
|
+
* @tags b2b_auth
|
|
3028
|
+
* @name ApiKeysLogin
|
|
3029
|
+
* @summary Login B2B user by API Keys
|
|
3030
|
+
* @request POST:/v1/auth/b2b/login/api-keys
|
|
3031
|
+
*/
|
|
3032
|
+
apiKeysLogin(apiKeysLoginParams: TypesAPIKeysB2BLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BauthSimpleB2BLoginSerializer, HandleError>>;
|
|
3033
|
+
/**
|
|
3034
|
+
* @description Login B2B user by email/password.
|
|
3035
|
+
* @tags b2b_auth
|
|
3036
|
+
* @name BasicLogin
|
|
3037
|
+
* @summary Login B2B user by email/password
|
|
3038
|
+
* @request POST:/v1/auth/b2b/login/basic
|
|
3039
|
+
*/
|
|
2005
3040
|
basicLogin(basicLoginParams: TypesBasicB2BLoginDto, headers?: {
|
|
3041
|
+
/** Run endpoint in debug mode */
|
|
2006
3042
|
'Debug-Token'?: string;
|
|
2007
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2008
|
-
|
|
2009
|
-
|
|
3043
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BauthBasicB2BLoginSerializer, HandleError>>;
|
|
3044
|
+
/**
|
|
3045
|
+
* @description logout from B2B user session
|
|
3046
|
+
* @tags b2b_auth
|
|
3047
|
+
* @name Logout
|
|
3048
|
+
* @summary logout from B2B user session
|
|
3049
|
+
* @request DELETE:/v1/auth/b2b/logout
|
|
3050
|
+
*/
|
|
3051
|
+
logout(B2BLogoutParams: TypesLogoutDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3052
|
+
/**
|
|
3053
|
+
* @description Refresh B2B user token pair
|
|
3054
|
+
* @tags b2b_auth
|
|
3055
|
+
* @name RefreshTokens
|
|
3056
|
+
* @summary Refresh B2B user token pair
|
|
3057
|
+
* @request POST:/v1/auth/b2b/refresh
|
|
3058
|
+
*/
|
|
3059
|
+
refreshTokens(B2BRefreshParams: TypesRefreshDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BauthBasicB2BLoginSerializer, HandleError>>;
|
|
3060
|
+
/**
|
|
3061
|
+
* @description Reset B2B user password
|
|
3062
|
+
* @tags b2b_auth
|
|
3063
|
+
* @name ResetPassword
|
|
3064
|
+
* @summary Reset B2B user password
|
|
3065
|
+
* @request PUT:/v1/auth/b2b/reset-password
|
|
3066
|
+
*/
|
|
2010
3067
|
resetPassword(B2BResetPasswordParams: TypesB2BResetPasswordDto, headers?: {
|
|
3068
|
+
/** Run endpoint in debug mode */
|
|
2011
3069
|
'Debug-Token'?: string;
|
|
2012
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2013
|
-
|
|
2014
|
-
|
|
3070
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BauthSimpleB2BLoginSerializer, HandleError>>;
|
|
3071
|
+
/**
|
|
3072
|
+
* @description Send MFA code for B2B user
|
|
3073
|
+
* @tags b2b_auth
|
|
3074
|
+
* @name SendMfaCode
|
|
3075
|
+
* @summary Send MFA code for B2B user
|
|
3076
|
+
* @request PUT:/v1/auth/b2b/send-mfa-code
|
|
3077
|
+
*/
|
|
3078
|
+
sendMfaCode(SendB2BMfaCodeDto: TypesSendB2BMfaCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3079
|
+
/**
|
|
3080
|
+
* @description Send reset password code for B2B user
|
|
3081
|
+
* @tags b2b_auth
|
|
3082
|
+
* @name SendResetPasswordCode
|
|
3083
|
+
* @summary Send reset password code for B2B user
|
|
3084
|
+
* @request PUT:/v1/auth/b2b/send-reset-password-code
|
|
3085
|
+
*/
|
|
3086
|
+
sendResetPasswordCode(B2BSendResetPasswordCodeParams: TypesSendResetPasswordCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2015
3087
|
}
|
|
2016
3088
|
export class B2BUsers<HandleError extends boolean = boolean> {
|
|
2017
3089
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2018
3090
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
3091
|
+
/**
|
|
3092
|
+
* @description Delete B2B user by id
|
|
3093
|
+
* @tags b2b_users
|
|
3094
|
+
* @name DeleteMany
|
|
3095
|
+
* @summary Delete B2B user by id
|
|
3096
|
+
* @request DELETE:/v1/users/b2b
|
|
3097
|
+
* @secure
|
|
3098
|
+
*/
|
|
3099
|
+
deleteMany(deleteB2BUsers: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3100
|
+
/**
|
|
3101
|
+
* @description Get B2B User by id
|
|
3102
|
+
* @tags b2b_users
|
|
3103
|
+
* @name GetById
|
|
3104
|
+
* @summary Get B2B User by id
|
|
3105
|
+
* @request GET:/v1/users/b2b/{id}
|
|
3106
|
+
* @secure
|
|
3107
|
+
*/
|
|
3108
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BusersB2BUserSerializer, HandleError>>;
|
|
3109
|
+
/**
|
|
3110
|
+
* @description Create B2B User
|
|
3111
|
+
* @tags b2b_users
|
|
3112
|
+
* @name Create
|
|
3113
|
+
* @summary Create B2B User
|
|
3114
|
+
* @request POST:/v2/users/b2b
|
|
3115
|
+
* @secure
|
|
3116
|
+
*/
|
|
3117
|
+
create(createB2BUser: TypesCreateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BusersB2BUserSerializer, HandleError>>;
|
|
3118
|
+
/**
|
|
3119
|
+
* @description Get B2B users with pagination
|
|
3120
|
+
* @tags b2b_users
|
|
3121
|
+
* @name Get
|
|
3122
|
+
* @summary Get B2B users with pagination
|
|
3123
|
+
* @request POST:/v2/users/b2b/list
|
|
3124
|
+
* @secure
|
|
3125
|
+
*/
|
|
3126
|
+
get(getB2BUsers: TypesGetB2BUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserscommonGetUsersListSerializerTypesAdminB2BUserSerializer, HandleError>>;
|
|
3127
|
+
/**
|
|
3128
|
+
* @description Update B2B User
|
|
3129
|
+
* @tags b2b_users
|
|
3130
|
+
* @name Update
|
|
3131
|
+
* @summary Update B2B User
|
|
3132
|
+
* @request PUT:/v2/users/b2b/{id}
|
|
3133
|
+
* @secure
|
|
3134
|
+
*/
|
|
3135
|
+
update(id: number, createB2BUserNew: TypesUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BusersB2BUserSerializer, HandleError>>;
|
|
2024
3136
|
}
|
|
2025
3137
|
export class B2BUserSettings<HandleError extends boolean = boolean> {
|
|
2026
3138
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2027
3139
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3140
|
+
/**
|
|
3141
|
+
* @description Set B2B User Settings ReCAPTCHA code is required in following cases (if proper Debug-Token was not provided): 1. User changes email 2. User changes password 3. User changes/verifies phone number
|
|
3142
|
+
* @tags b2b_user_settings
|
|
3143
|
+
* @name SetUserSettings
|
|
3144
|
+
* @summary Set B2B User Settings
|
|
3145
|
+
* @request PUT:/v1/b2b/settings
|
|
3146
|
+
* @secure
|
|
3147
|
+
*/
|
|
2028
3148
|
setUserSettings(setB2BUserSettings: TypesSetB2BUserSettingsDto, headers?: {
|
|
3149
|
+
/** Run endpoint in debug mode */
|
|
2029
3150
|
'Debug-Token'?: string;
|
|
3151
|
+
/** Branch id, with which user should work */
|
|
2030
3152
|
BRANCH?: string;
|
|
2031
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3153
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BusersettingsB2BUserSettingsChangeSerializer, HandleError>>;
|
|
3154
|
+
/**
|
|
3155
|
+
* @description Upload avatar for B2B user
|
|
3156
|
+
* @tags b2b_user_settings
|
|
3157
|
+
* @name UploadAvatar
|
|
3158
|
+
* @summary Upload avatar for B2B user
|
|
3159
|
+
* @request PUT:/v1/b2b/settings/avatar
|
|
3160
|
+
* @secure
|
|
3161
|
+
*/
|
|
2032
3162
|
uploadAvatar(data: {
|
|
3163
|
+
/**
|
|
3164
|
+
* Avatar to upload
|
|
3165
|
+
* @format binary
|
|
3166
|
+
*/
|
|
2033
3167
|
avatar?: File;
|
|
3168
|
+
/** Should delete old avatar instead of uploading new one */
|
|
2034
3169
|
delete_avatar?: boolean;
|
|
2035
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3170
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2BusersettingsB2BUploadAvatarResponseSerializer, HandleError>>;
|
|
3171
|
+
/**
|
|
3172
|
+
* @description Send B2B user contact change code
|
|
3173
|
+
* @tags b2b_user_settings
|
|
3174
|
+
* @name SendContactChangeCode
|
|
3175
|
+
* @summary Send B2B user contact change code
|
|
3176
|
+
* @request POST:/v1/b2b/settings/codes
|
|
3177
|
+
* @secure
|
|
3178
|
+
*/
|
|
2036
3179
|
sendContactChangeCode(b2bSendContactChangeCodeDto: TypesB2BSendContactChangeCodeDto, headers?: {
|
|
3180
|
+
/** Branch id, with which user should work */
|
|
2037
3181
|
BRANCH?: string;
|
|
2038
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3182
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2039
3183
|
}
|
|
2040
3184
|
export class B2CAuth<HandleError extends boolean = boolean> {
|
|
2041
3185
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2042
3186
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2043
|
-
|
|
3187
|
+
/**
|
|
3188
|
+
* @description Get current B2C user info by access token.
|
|
3189
|
+
* @tags b2c_auth
|
|
3190
|
+
* @name GetCurrent
|
|
3191
|
+
* @summary Get current B2C user info by access token
|
|
3192
|
+
* @request GET:/v1/auth/b2c/current
|
|
3193
|
+
* @secure
|
|
3194
|
+
*/
|
|
3195
|
+
getCurrent(config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthGetCurrentB2CUserSerializer, HandleError>>;
|
|
3196
|
+
/**
|
|
3197
|
+
* @description Initialize Apple OAuth2 Login
|
|
3198
|
+
* @tags b2c_auth
|
|
3199
|
+
* @name InitAppleLogin
|
|
3200
|
+
* @summary Initialize Apple OAuth2 Login
|
|
3201
|
+
* @request POST:/v1/auth/b2c/login/apple
|
|
3202
|
+
*/
|
|
2044
3203
|
initAppleLogin(initOAuthLoginDto: TypesInitOAuthLoginDto, headers?: {
|
|
3204
|
+
/** Branch id/slug/code, with which user should work */
|
|
2045
3205
|
BRANCH?: string;
|
|
3206
|
+
/** Firm id/slug, with which user should work */
|
|
2046
3207
|
FIRM?: string;
|
|
2047
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2048
|
-
|
|
3208
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesB2CInitOAuthResponse, HandleError>>;
|
|
3209
|
+
/**
|
|
3210
|
+
* @description Finish Apple OAuth2 Login
|
|
3211
|
+
* @tags b2c_auth
|
|
3212
|
+
* @name FinishAppleLogin
|
|
3213
|
+
* @summary Finish Apple OAuth2 Login
|
|
3214
|
+
* @request POST:/v1/auth/b2c/login/apple/callback
|
|
3215
|
+
*/
|
|
3216
|
+
finishAppleLogin(finishOAuthLoginDto: TypesFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthB2CLoginResultSerializer, HandleError>>;
|
|
3217
|
+
/**
|
|
3218
|
+
* @description Login B2C user by email/password.
|
|
3219
|
+
* @tags b2c_auth
|
|
3220
|
+
* @name BasicLogin
|
|
3221
|
+
* @summary Login B2C user by email/password
|
|
3222
|
+
* @request POST:/v1/auth/b2c/login/basic
|
|
3223
|
+
*/
|
|
2049
3224
|
basicLogin(basicLoginParams: TypesBasicB2CLoginDto, headers?: {
|
|
3225
|
+
/** Branch id/slug/code, with which user should work */
|
|
2050
3226
|
BRANCH?: string;
|
|
3227
|
+
/** Firm id/slug, with which user should work */
|
|
2051
3228
|
FIRM?: string;
|
|
2052
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3229
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthB2CLoginResultSerializer, HandleError>>;
|
|
3230
|
+
/**
|
|
3231
|
+
* @description Initialize Google OAuth2 Login
|
|
3232
|
+
* @tags b2c_auth
|
|
3233
|
+
* @name InitGoogleLogin
|
|
3234
|
+
* @summary Initialize Google OAuth2 Login
|
|
3235
|
+
* @request POST:/v1/auth/b2c/login/google
|
|
3236
|
+
*/
|
|
2053
3237
|
initGoogleLogin(initOAuthLoginDto: TypesInitOAuthLoginDto, headers?: {
|
|
3238
|
+
/** Branch id/slug/code, with which user should work */
|
|
2054
3239
|
BRANCH?: string;
|
|
3240
|
+
/** Firm id/slug, with which user should work */
|
|
2055
3241
|
FIRM?: string;
|
|
2056
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2057
|
-
|
|
2058
|
-
|
|
3242
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesB2CInitOAuthResponse, HandleError>>;
|
|
3243
|
+
/**
|
|
3244
|
+
* @description Finish Google OAuth2 Login
|
|
3245
|
+
* @tags b2c_auth
|
|
3246
|
+
* @name FinishGoogleLogin
|
|
3247
|
+
* @summary Finish Google OAuth2 Login
|
|
3248
|
+
* @request POST:/v1/auth/b2c/login/google/callback
|
|
3249
|
+
*/
|
|
3250
|
+
finishGoogleLogin(finishOAuthLoginDto: TypesFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthB2CLoginResultSerializer, HandleError>>;
|
|
3251
|
+
/**
|
|
3252
|
+
* @description logout from B2C user session
|
|
3253
|
+
* @tags b2c_auth
|
|
3254
|
+
* @name Logout
|
|
3255
|
+
* @summary logout from B2C user session
|
|
3256
|
+
* @request DELETE:/v1/auth/b2c/logout
|
|
3257
|
+
*/
|
|
3258
|
+
logout(B2CLogoutParams: TypesLogoutDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3259
|
+
/**
|
|
3260
|
+
* @description Refresh B2C user token pair
|
|
3261
|
+
* @tags b2c_auth
|
|
3262
|
+
* @name RefreshTokens
|
|
3263
|
+
* @summary Refresh B2C user token pair
|
|
3264
|
+
* @request POST:/v1/auth/b2c/refresh
|
|
3265
|
+
*/
|
|
2059
3266
|
refreshTokens(b2cRefreshDto: TypesB2CRefreshDto, headers?: {
|
|
3267
|
+
/**
|
|
3268
|
+
* token
|
|
3269
|
+
* @default "refresh_token=xxx"
|
|
3270
|
+
*/
|
|
2060
3271
|
Cookie?: string;
|
|
2061
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3272
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthRefreshResultSerializer, HandleError>>;
|
|
3273
|
+
/**
|
|
3274
|
+
* @description Register new B2C user. This endpoint should be used for Web GUI only
|
|
3275
|
+
* @tags b2c_auth
|
|
3276
|
+
* @name Register
|
|
3277
|
+
* @summary Register new B2C user
|
|
3278
|
+
* @request POST:/v1/auth/b2c/register
|
|
3279
|
+
*/
|
|
2062
3280
|
register(registrationParams: TypesRegisterDto, headers?: {
|
|
3281
|
+
/** Branch id/slug/code, with which user should work */
|
|
2063
3282
|
BRANCH?: string;
|
|
3283
|
+
/** Firm id/slug, with which user should work */
|
|
2064
3284
|
FIRM?: string;
|
|
2065
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3285
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CauthRegisterSerializer, HandleError>>;
|
|
3286
|
+
/**
|
|
3287
|
+
* @description Reset B2C user password
|
|
3288
|
+
* @tags b2c_auth
|
|
3289
|
+
* @name ResetPassword
|
|
3290
|
+
* @summary Reset B2C user password
|
|
3291
|
+
* @request PUT:/v1/auth/b2c/reset-password
|
|
3292
|
+
*/
|
|
2066
3293
|
resetPassword(B2CResetPasswordParams: TypesB2CResetPasswordDto, headers?: {
|
|
3294
|
+
/** Run endpoint in debug mode */
|
|
2067
3295
|
'Debug-Token'?: string;
|
|
3296
|
+
/** Branch id/slug/code, with which user should work */
|
|
2068
3297
|
BRANCH?: string;
|
|
3298
|
+
/** Firm id/slug, with which user should work */
|
|
2069
3299
|
FIRM?: string;
|
|
2070
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3300
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3301
|
+
/**
|
|
3302
|
+
* @description Send MFA code for B2C user
|
|
3303
|
+
* @tags b2c_auth
|
|
3304
|
+
* @name SendMfaCode
|
|
3305
|
+
* @summary Send MFA code for B2C user
|
|
3306
|
+
* @request PUT:/v1/auth/b2c/send-mfa-code
|
|
3307
|
+
*/
|
|
2071
3308
|
sendMfaCode(SendB2CMfaCodeDto: TypesSendB2CMfaCodeDto, headers?: {
|
|
3309
|
+
/** Branch id/slug/code, with which user should work */
|
|
2072
3310
|
BRANCH?: string;
|
|
3311
|
+
/** Firm id/slug, with which user should work */
|
|
2073
3312
|
FIRM?: string;
|
|
2074
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2075
|
-
|
|
3313
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3314
|
+
/**
|
|
3315
|
+
* @description Send reset password code for B2C user
|
|
3316
|
+
* @tags b2c_auth
|
|
3317
|
+
* @name SendResetPasswordCode
|
|
3318
|
+
* @summary Send reset password code for B2C user
|
|
3319
|
+
* @request PUT:/v1/auth/b2c/send-reset-password-code
|
|
3320
|
+
*/
|
|
3321
|
+
sendResetPasswordCode(B2CSendResetPasswordCodeParams: TypesSendB2CResetPasswordCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3322
|
+
/**
|
|
3323
|
+
* @description Send verification code for B2C user
|
|
3324
|
+
* @tags b2c_auth
|
|
3325
|
+
* @name SendVerificationCode
|
|
3326
|
+
* @summary Send verification code for B2C user
|
|
3327
|
+
* @request PUT:/v1/auth/b2c/send-verification-code
|
|
3328
|
+
*/
|
|
2076
3329
|
sendVerificationCode(B2CSendVerificationCodeDto: TypesB2CSendVerificationCodeDto, headers?: {
|
|
3330
|
+
/** Branch id/slug/code, with which user should work */
|
|
2077
3331
|
BRANCH?: string;
|
|
3332
|
+
/** Firm id/slug, with which user should work */
|
|
2078
3333
|
FIRM?: string;
|
|
2079
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3334
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3335
|
+
/**
|
|
3336
|
+
* @description Verify contact for B2C user
|
|
3337
|
+
* @tags b2c_auth
|
|
3338
|
+
* @name VerifyContact
|
|
3339
|
+
* @summary Verify contact for B2C user
|
|
3340
|
+
* @request PUT:/v1/auth/b2c/verify
|
|
3341
|
+
*/
|
|
2080
3342
|
verifyContact(VerifyContactDto: TypesVerifyContactDto, headers?: {
|
|
3343
|
+
/** Branch id/slug/code, with which user should work */
|
|
2081
3344
|
BRANCH?: string;
|
|
3345
|
+
/** Firm id/slug, with which user should work */
|
|
2082
3346
|
FIRM?: string;
|
|
2083
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3347
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2084
3348
|
}
|
|
2085
3349
|
export class B2CUsers<HandleError extends boolean = boolean> {
|
|
2086
3350
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2087
3351
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
3352
|
+
/**
|
|
3353
|
+
* @description Create B2C User
|
|
3354
|
+
* @tags b2c_users
|
|
3355
|
+
* @name Create
|
|
3356
|
+
* @summary Create B2C User
|
|
3357
|
+
* @request POST:/v1/users/b2c
|
|
3358
|
+
* @secure
|
|
3359
|
+
*/
|
|
3360
|
+
create(createB2CUser: TypesCreateB2CUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CusersB2CUserSerializer, HandleError>>;
|
|
3361
|
+
/**
|
|
3362
|
+
* @description Delete B2C user by id
|
|
3363
|
+
* @tags b2c_users
|
|
3364
|
+
* @name DeleteMany
|
|
3365
|
+
* @summary Delete B2C user by id
|
|
3366
|
+
* @request DELETE:/v1/users/b2c
|
|
3367
|
+
* @secure
|
|
3368
|
+
*/
|
|
3369
|
+
deleteMany(deleteB2CUsers: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Get B2C User by id
|
|
3372
|
+
* @tags b2c_users
|
|
3373
|
+
* @name GetById
|
|
3374
|
+
* @summary Get B2C User by id
|
|
3375
|
+
* @request GET:/v1/users/b2c/{id}
|
|
3376
|
+
* @secure
|
|
3377
|
+
*/
|
|
3378
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CusersB2CUserSerializer, HandleError>>;
|
|
3379
|
+
/**
|
|
3380
|
+
* @description Update B2C User
|
|
3381
|
+
* @tags b2c_users
|
|
3382
|
+
* @name Update
|
|
3383
|
+
* @summary Update B2C User
|
|
3384
|
+
* @request PUT:/v1/users/b2c/{id}
|
|
3385
|
+
* @secure
|
|
3386
|
+
*/
|
|
3387
|
+
update(id: number, createB2BUser: TypesUpdateB2CUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CusersB2CUserSerializer, HandleError>>;
|
|
3388
|
+
/**
|
|
3389
|
+
* @description Get B2C users with pagination
|
|
3390
|
+
* @tags b2c_users
|
|
3391
|
+
* @name Get
|
|
3392
|
+
* @summary Get B2C users with pagination
|
|
3393
|
+
* @request POST:/v2/users/b2c/list
|
|
3394
|
+
* @secure
|
|
3395
|
+
*/
|
|
3396
|
+
get(getB2CUsers: TypesGetB2CUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserscommonGetUsersListSerializerTypesAdminB2CUserSerializer, HandleError>>;
|
|
2093
3397
|
}
|
|
2094
3398
|
export class B2CUserSettings<HandleError extends boolean = boolean> {
|
|
2095
3399
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2096
3400
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3401
|
+
/**
|
|
3402
|
+
* @description Set B2C User Settings
|
|
3403
|
+
* @tags b2c_user_settings
|
|
3404
|
+
* @name SetUserSettings
|
|
3405
|
+
* @summary Set B2C User Settings
|
|
3406
|
+
* @request PUT:/v1/b2c/settings
|
|
3407
|
+
* @secure
|
|
3408
|
+
*/
|
|
2097
3409
|
setUserSettings(setB2CUserSettings: TypesSetB2CUserSettingsDto, headers?: {
|
|
3410
|
+
/** Branch id/slug/code, with which user should work */
|
|
2098
3411
|
BRANCH?: string;
|
|
2099
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3412
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CusersettingsB2CUserSettingsChangeSerializer, HandleError>>;
|
|
3413
|
+
/**
|
|
3414
|
+
* @description Send B2C user contact change code
|
|
3415
|
+
* @tags b2c_user_settings
|
|
3416
|
+
* @name SendContactChangeCode
|
|
3417
|
+
* @summary Send B2C user contact change code
|
|
3418
|
+
* @request POST:/v1/b2c/settings/codes
|
|
3419
|
+
* @secure
|
|
3420
|
+
*/
|
|
2100
3421
|
sendContactChangeCode(b2cSendContactChangeCodeDto: TypesB2CSendContactChangeCodeDto, headers?: {
|
|
3422
|
+
/** Branch id/slug/code, with which user should work */
|
|
2101
3423
|
BRANCH?: string;
|
|
2102
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
3424
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3425
|
+
/**
|
|
3426
|
+
* @description Get Available B2C Branch Mfa Options
|
|
3427
|
+
* @tags b2c_user_settings
|
|
3428
|
+
* @name AvailableMfaOptions
|
|
3429
|
+
* @summary Get Available B2C Branch Mfa Options
|
|
3430
|
+
* @request GET:/v1/b2c/settings/mfa-options
|
|
3431
|
+
* @secure
|
|
3432
|
+
*/
|
|
2103
3433
|
availableMfaOptions(headers?: {
|
|
3434
|
+
/** Branch id/slug/code, with which user should work */
|
|
2104
3435
|
BRANCH?: string;
|
|
2105
|
-
}, config?: RequestConfig<HandleError>): Promise<
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
3436
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<B2CusersettingsAvailableB2CMfaOptionsResponse, HandleError>>;
|
|
3437
|
+
/**
|
|
3438
|
+
* @description Delete B2C OAuth2 Bindings
|
|
3439
|
+
* @tags b2c_user_settings
|
|
3440
|
+
* @name DeleteManyOAuthBindings
|
|
3441
|
+
* @summary Delete B2C OAuth2 Bindings
|
|
3442
|
+
* @request DELETE:/v1/b2c/settings/oauth-links
|
|
3443
|
+
* @secure
|
|
3444
|
+
*/
|
|
3445
|
+
deleteManyOAuthBindings(deleteByIDsDto: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3446
|
+
/**
|
|
3447
|
+
* @description Finish Apple OAuth2 Profile Linking
|
|
3448
|
+
* @tags b2c_user_settings
|
|
3449
|
+
* @name FinishAppleProfileLinking
|
|
3450
|
+
* @summary Finish Apple OAuth2 Profile Linking
|
|
3451
|
+
* @request POST:/v1/b2c/settings/oauth-links/apple/finish
|
|
3452
|
+
*/
|
|
3453
|
+
finishAppleProfileLinking(finishOAuthLoginDto: TypesFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3454
|
+
/**
|
|
3455
|
+
* @description Initialize Apple OAuth2 Profile Linking
|
|
3456
|
+
* @tags b2c_user_settings
|
|
3457
|
+
* @name InitAppleProfileLinking
|
|
3458
|
+
* @summary Initialize Apple OAuth2 Profile Linking
|
|
3459
|
+
* @request POST:/v1/b2c/settings/oauth-links/apple/start
|
|
3460
|
+
* @secure
|
|
3461
|
+
*/
|
|
3462
|
+
initAppleProfileLinking(initOAuthLinkingDto: TypesInitOAuthLinkingDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesB2CInitOAuthResponse, HandleError>>;
|
|
3463
|
+
/**
|
|
3464
|
+
* @description Finish Google OAuth2 Profile Linking
|
|
3465
|
+
* @tags b2c_user_settings
|
|
3466
|
+
* @name FinishGoogleProfileLinking
|
|
3467
|
+
* @summary Finish Google OAuth2 Profile Linking
|
|
3468
|
+
* @request POST:/v1/b2c/settings/oauth-links/google/finish
|
|
3469
|
+
*/
|
|
3470
|
+
finishGoogleProfileLinking(finishOAuthLoginDto: TypesFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3471
|
+
/**
|
|
3472
|
+
* @description Initialize Google OAuth2 Profile Linking
|
|
3473
|
+
* @tags b2c_user_settings
|
|
3474
|
+
* @name InitGoogleProfileLinking
|
|
3475
|
+
* @summary Initialize Google OAuth2 Profile Linking
|
|
3476
|
+
* @request POST:/v1/b2c/settings/oauth-links/google/start
|
|
3477
|
+
* @secure
|
|
3478
|
+
*/
|
|
3479
|
+
initGoogleProfileLinking(initOAuthLinkingDto: TypesInitOAuthLinkingDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesB2CInitOAuthResponse, HandleError>>;
|
|
3480
|
+
/**
|
|
3481
|
+
* @description Get B2C OAuth2 Bindings with pagination. Available sort fields are `id, name, app_type, b2b_user_id, b2c_user_id, provider_user_id, created_at, updated_at`. Search is performed by `name, app_type, provider_user_id` fields
|
|
3482
|
+
* @tags b2c_user_settings
|
|
3483
|
+
* @name GetOAuthBindings
|
|
3484
|
+
* @summary Get B2C OAuth2 Bindings with pagination
|
|
3485
|
+
* @request POST:/v1/b2c/settings/oauth-links/list
|
|
3486
|
+
* @secure
|
|
3487
|
+
*/
|
|
3488
|
+
getOAuthBindings(getOAuth2BindingsListDto: TypesGetOAuth2BindingsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TypesAuthProviderUserBindingsResponse, HandleError>>;
|
|
2112
3489
|
}
|
|
2113
3490
|
export class Branches<HandleError extends boolean = boolean> {
|
|
2114
3491
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2115
3492
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
3493
|
+
/**
|
|
3494
|
+
* @description Create Branch
|
|
3495
|
+
* @tags branches
|
|
3496
|
+
* @name Create
|
|
3497
|
+
* @summary Create Branch
|
|
3498
|
+
* @request POST:/v1/branches
|
|
3499
|
+
* @secure
|
|
3500
|
+
*/
|
|
3501
|
+
create(createBranch: TypesCreateBranchDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<BranchesBranchMutationSerializer, HandleError>>;
|
|
3502
|
+
/**
|
|
3503
|
+
* @description Delete Branch by id
|
|
3504
|
+
* @tags branches
|
|
3505
|
+
* @name DeleteMany
|
|
3506
|
+
* @summary Delete Branch by id
|
|
3507
|
+
* @request DELETE:/v1/branches
|
|
3508
|
+
* @secure
|
|
3509
|
+
*/
|
|
3510
|
+
deleteMany(deleteBranches: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3511
|
+
/**
|
|
3512
|
+
* @description Get Branch by id
|
|
3513
|
+
* @tags branches
|
|
3514
|
+
* @name GetById
|
|
3515
|
+
* @summary Get Branch by id
|
|
3516
|
+
* @request GET:/v1/branches/{id}
|
|
3517
|
+
* @secure
|
|
3518
|
+
*/
|
|
3519
|
+
getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BranchesBranchMutationSerializer, HandleError>>;
|
|
3520
|
+
/**
|
|
3521
|
+
* @description Update Branch
|
|
3522
|
+
* @tags branches
|
|
3523
|
+
* @name Update
|
|
3524
|
+
* @summary Update Branch
|
|
3525
|
+
* @request PUT:/v1/branches/{id}
|
|
3526
|
+
* @secure
|
|
3527
|
+
*/
|
|
3528
|
+
update(id: number, updateBranch: TypesUpdateBranchDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<BranchesBranchMutationSerializer, HandleError>>;
|
|
3529
|
+
/**
|
|
3530
|
+
* @description Get Branches with pagination
|
|
3531
|
+
* @tags branches
|
|
3532
|
+
* @name Get
|
|
3533
|
+
* @summary Get Branches with pagination
|
|
3534
|
+
* @request POST:/v2/branches/list
|
|
3535
|
+
* @secure
|
|
3536
|
+
*/
|
|
3537
|
+
get(getBranches: TypesGetBranchesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<BranchesGetBranchesListSerializer, HandleError>>;
|
|
2121
3538
|
}
|
|
2122
3539
|
export class Countries<HandleError extends boolean = boolean> {
|
|
2123
3540
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2124
3541
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2125
|
-
|
|
3542
|
+
/**
|
|
3543
|
+
* @description Get Countries info
|
|
3544
|
+
* @tags countries
|
|
3545
|
+
* @name Get
|
|
3546
|
+
* @summary Get Countries info
|
|
3547
|
+
* @request GET:/v1/countries
|
|
3548
|
+
*/
|
|
3549
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<CountriesGetCountriesSerializer, HandleError>>;
|
|
2126
3550
|
}
|
|
2127
3551
|
export class Endpoints<HandleError extends boolean = boolean> {
|
|
2128
3552
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2129
3553
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
3554
|
+
/**
|
|
3555
|
+
* @description Create Endpoint
|
|
3556
|
+
* @tags endpoints
|
|
3557
|
+
* @name Create
|
|
3558
|
+
* @summary Create Endpoint
|
|
3559
|
+
* @request POST:/v1/b2b/endpoints
|
|
3560
|
+
* @secure
|
|
3561
|
+
*/
|
|
3562
|
+
create(endpointDto: TypesCreateEndpointDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<EndpointsEndpointMutationSerializer, HandleError>>;
|
|
3563
|
+
/**
|
|
3564
|
+
* @description Delete endpoint by id
|
|
3565
|
+
* @tags endpoints
|
|
3566
|
+
* @name DeleteMany
|
|
3567
|
+
* @summary Delete endpoint by id
|
|
3568
|
+
* @request DELETE:/v1/b2b/endpoints
|
|
3569
|
+
* @secure
|
|
3570
|
+
*/
|
|
3571
|
+
deleteMany(deleteEndpointsDto: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description Get Endpoint by id
|
|
3574
|
+
* @tags endpoints
|
|
3575
|
+
* @name GetById
|
|
3576
|
+
* @summary Get Endpoint by id
|
|
3577
|
+
* @request GET:/v1/b2b/endpoints/{id}
|
|
3578
|
+
* @secure
|
|
3579
|
+
*/
|
|
3580
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<EndpointsEndpointMutationSerializer, HandleError>>;
|
|
3581
|
+
/**
|
|
3582
|
+
* @description Update endpoint record
|
|
3583
|
+
* @tags endpoints
|
|
3584
|
+
* @name Update
|
|
3585
|
+
* @summary Update endpoint record
|
|
3586
|
+
* @request PUT:/v1/b2b/endpoints/{id}
|
|
3587
|
+
* @secure
|
|
3588
|
+
*/
|
|
3589
|
+
update(id: number, endpointDto: TypesUpdateEndpointDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<EndpointsEndpointMutationSerializer, HandleError>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* @description Get endpoints with pagination
|
|
3592
|
+
* @tags endpoints
|
|
3593
|
+
* @name Get
|
|
3594
|
+
* @summary Get endpoints with pagination
|
|
3595
|
+
* @request POST:/v2/b2b/endpoints/list
|
|
3596
|
+
* @secure
|
|
3597
|
+
*/
|
|
3598
|
+
get(endpointDto: TypesGetEndpointsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<EndpointsGetEndpointsListSerializer, HandleError>>;
|
|
2135
3599
|
}
|
|
2136
3600
|
export class Firms<HandleError extends boolean = boolean> {
|
|
2137
3601
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2138
3602
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
3603
|
+
/**
|
|
3604
|
+
* @description Create Firm
|
|
3605
|
+
* @tags firms
|
|
3606
|
+
* @name Create
|
|
3607
|
+
* @summary Create Firm
|
|
3608
|
+
* @request POST:/v1/firms
|
|
3609
|
+
* @secure
|
|
3610
|
+
*/
|
|
3611
|
+
create(createFirm: TypesCreateFirmDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<FirmsFirmMutationSerializer, HandleError>>;
|
|
3612
|
+
/**
|
|
3613
|
+
* @description Deletes Firm by ids
|
|
3614
|
+
* @tags firms
|
|
3615
|
+
* @name DeleteMany
|
|
3616
|
+
* @summary Deletes Firm by ids
|
|
3617
|
+
* @request DELETE:/v1/firms
|
|
3618
|
+
* @secure
|
|
3619
|
+
*/
|
|
3620
|
+
deleteMany(deleteFirms: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3621
|
+
/**
|
|
3622
|
+
* @description Get Firm by id
|
|
3623
|
+
* @tags firms
|
|
3624
|
+
* @name GetById
|
|
3625
|
+
* @summary Get Firm by id
|
|
3626
|
+
* @request GET:/v1/firms/{id}
|
|
3627
|
+
* @secure
|
|
3628
|
+
*/
|
|
3629
|
+
getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<FirmsFirmMutationSerializer, HandleError>>;
|
|
3630
|
+
/**
|
|
3631
|
+
* @description Update Firm
|
|
3632
|
+
* @tags firms
|
|
3633
|
+
* @name Update
|
|
3634
|
+
* @summary Update Firm
|
|
3635
|
+
* @request PUT:/v1/firms/{id}
|
|
3636
|
+
* @secure
|
|
3637
|
+
*/
|
|
3638
|
+
update(id: number, updateFirm: TypesUpdateFirmDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<FirmsFirmMutationSerializer, HandleError>>;
|
|
3639
|
+
/**
|
|
3640
|
+
* @description Get Firms with pagination
|
|
3641
|
+
* @tags firms
|
|
3642
|
+
* @name Get
|
|
3643
|
+
* @summary Get Firms with pagination
|
|
3644
|
+
* @request POST:/v2/firms/list
|
|
3645
|
+
* @secure
|
|
3646
|
+
*/
|
|
3647
|
+
get(getFirms: TypesGetFirmsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<FirmsGetFirmsListSerializer, HandleError>>;
|
|
2144
3648
|
}
|
|
2145
3649
|
export class IdentityProviders<HandleError extends boolean = boolean> {
|
|
2146
3650
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2147
3651
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
3652
|
+
/**
|
|
3653
|
+
* @description Create Identity Provider
|
|
3654
|
+
* @tags identity_providers
|
|
3655
|
+
* @name Create
|
|
3656
|
+
* @summary Create Identity Provider
|
|
3657
|
+
* @request POST:/v1/b2b/identity-providers
|
|
3658
|
+
* @secure
|
|
3659
|
+
*/
|
|
3660
|
+
create(createIdentityProviderDto: TypesCreateIdentityProviderDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<IdentityprovidersIdentityProviderResponseSerializer, HandleError>>;
|
|
3661
|
+
/**
|
|
3662
|
+
* @description Delete Identity providers by id
|
|
3663
|
+
* @tags identity_providers
|
|
3664
|
+
* @name DeleteMany
|
|
3665
|
+
* @summary Delete Identity providers by ids
|
|
3666
|
+
* @request DELETE:/v1/b2b/identity-providers
|
|
3667
|
+
* @secure
|
|
3668
|
+
*/
|
|
3669
|
+
deleteMany(deleteIdentityProvidersDto: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3670
|
+
/**
|
|
3671
|
+
* @description Get Identity Provider by id
|
|
3672
|
+
* @tags identity_providers
|
|
3673
|
+
* @name GetById
|
|
3674
|
+
* @summary Get Identity Provider by id
|
|
3675
|
+
* @request GET:/v1/b2b/identity-providers/{id}
|
|
3676
|
+
* @secure
|
|
3677
|
+
*/
|
|
3678
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<IdentityprovidersIdentityProviderResponseSerializer, HandleError>>;
|
|
3679
|
+
/**
|
|
3680
|
+
* @description Update identity provider record
|
|
3681
|
+
* @tags identity_providers
|
|
3682
|
+
* @name Update
|
|
3683
|
+
* @summary Update identity provider record
|
|
3684
|
+
* @request PUT:/v1/b2b/identity-providers/{id}
|
|
3685
|
+
* @secure
|
|
3686
|
+
*/
|
|
3687
|
+
update(id: number, identityProvidersDto: TypesUpdateIdentityProviderDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<IdentityprovidersIdentityProviderResponseSerializer, HandleError>>;
|
|
3688
|
+
/**
|
|
3689
|
+
* @description Get Identity Providers with pagination
|
|
3690
|
+
* @tags identity_providers
|
|
3691
|
+
* @name Get
|
|
3692
|
+
* @summary Get Identity Providers with pagination
|
|
3693
|
+
* @request POST:/v2/b2b/identity-providers/list
|
|
3694
|
+
* @secure
|
|
3695
|
+
*/
|
|
3696
|
+
get(identityProvidersDto: TypesGetIdentityProvidersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<IdentityprovidersGetIdentityProvidersListSerializer, HandleError>>;
|
|
2153
3697
|
}
|
|
2154
3698
|
export class Locales<HandleError extends boolean = boolean> {
|
|
2155
3699
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2156
3700
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2157
|
-
|
|
3701
|
+
/**
|
|
3702
|
+
* @description get all language locales
|
|
3703
|
+
* @tags locales
|
|
3704
|
+
* @name Get
|
|
3705
|
+
* @summary get all locales
|
|
3706
|
+
* @request GET:/v1/locales
|
|
3707
|
+
*/
|
|
3708
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<LocalesLocaleSerializer[], HandleError>>;
|
|
2158
3709
|
}
|
|
2159
3710
|
export class Microservices<HandleError extends boolean = boolean> {
|
|
2160
3711
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2161
3712
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
3713
|
+
/**
|
|
3714
|
+
* @description Create Microservice with domains, used to proxy user requests from public domains to internal
|
|
3715
|
+
* @tags microservices
|
|
3716
|
+
* @name Create
|
|
3717
|
+
* @summary Create Microservice
|
|
3718
|
+
* @request POST:/v1/b2b/microservices
|
|
3719
|
+
* @secure
|
|
3720
|
+
*/
|
|
3721
|
+
create(microserviceDto: TypesCreateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MicroservicesMicroserviceMutationSerializer, HandleError>>;
|
|
3722
|
+
/**
|
|
3723
|
+
* @description Delete microservice by id
|
|
3724
|
+
* @tags microservices
|
|
3725
|
+
* @name DeleteMany
|
|
3726
|
+
* @summary Delete microservice by id
|
|
3727
|
+
* @request DELETE:/v1/b2b/microservices
|
|
3728
|
+
* @secure
|
|
3729
|
+
*/
|
|
3730
|
+
deleteMany(deleteMicroservices: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3731
|
+
/**
|
|
3732
|
+
* @description Get Microservice by id
|
|
3733
|
+
* @tags microservices
|
|
3734
|
+
* @name GetById
|
|
3735
|
+
* @summary Get Microservice by id
|
|
3736
|
+
* @request GET:/v1/b2b/microservices/{id}
|
|
3737
|
+
* @secure
|
|
3738
|
+
*/
|
|
3739
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<MicroservicesMicroserviceMutationSerializer, HandleError>>;
|
|
3740
|
+
/**
|
|
3741
|
+
* @description Update microservice record
|
|
3742
|
+
* @tags microservices
|
|
3743
|
+
* @name Update
|
|
3744
|
+
* @summary Update microservice record
|
|
3745
|
+
* @request PUT:/v1/b2b/microservices/{id}
|
|
3746
|
+
* @secure
|
|
3747
|
+
*/
|
|
3748
|
+
update(id: number, microserviceDto: TypesUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MicroservicesMicroserviceMutationSerializer, HandleError>>;
|
|
3749
|
+
/**
|
|
3750
|
+
* @description Get microservices with pagination
|
|
3751
|
+
* @tags microservices
|
|
3752
|
+
* @name Get
|
|
3753
|
+
* @summary Get microservices with pagination
|
|
3754
|
+
* @request POST:/v2/b2b/microservices/list
|
|
3755
|
+
* @secure
|
|
3756
|
+
*/
|
|
3757
|
+
get(microserviceDto: TypesGetMicroservicesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MicroservicesGetMicroservicesListSerializer, HandleError>>;
|
|
2167
3758
|
}
|
|
2168
3759
|
export class MigrationUtils<HandleError extends boolean = boolean> {
|
|
2169
3760
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2170
3761
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2171
|
-
|
|
3762
|
+
/**
|
|
3763
|
+
* @description Upsert Users from deprecated DB's
|
|
3764
|
+
* @tags migration-utils
|
|
3765
|
+
* @name UsersUpsertCreate
|
|
3766
|
+
* @summary Upsert Users
|
|
3767
|
+
* @request POST:/v1/migration-utils/users/upsert
|
|
3768
|
+
* @secure
|
|
3769
|
+
*/
|
|
3770
|
+
usersUpsertCreate(upsertUsers: TypesUpsertUsersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<MigrationutilsUpsertUsersSerializer, HandleError>>;
|
|
2172
3771
|
}
|
|
2173
3772
|
export class Permissions<HandleError extends boolean = boolean> {
|
|
2174
3773
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2175
3774
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
3775
|
+
/**
|
|
3776
|
+
* @description Create Permission
|
|
3777
|
+
* @tags permissions
|
|
3778
|
+
* @name Create
|
|
3779
|
+
* @summary Create Permission
|
|
3780
|
+
* @request POST:/v1/permissions
|
|
3781
|
+
* @secure
|
|
3782
|
+
*/
|
|
3783
|
+
create(createPermission: TypesCreatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<PermissionsPermissionMutationSerializer, HandleError>>;
|
|
3784
|
+
/**
|
|
3785
|
+
* @description Delete Permissions by id
|
|
3786
|
+
* @tags permissions
|
|
3787
|
+
* @name DeleteMany
|
|
3788
|
+
* @summary Delete Permissions by id
|
|
3789
|
+
* @request DELETE:/v1/permissions
|
|
3790
|
+
* @secure
|
|
3791
|
+
*/
|
|
3792
|
+
deleteMany(deletePermissions: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3793
|
+
/**
|
|
3794
|
+
* @description Get Permission by id
|
|
3795
|
+
* @tags permissions
|
|
3796
|
+
* @name GetById
|
|
3797
|
+
* @summary Get Permission by id
|
|
3798
|
+
* @request GET:/v1/permissions/{id}
|
|
3799
|
+
* @secure
|
|
3800
|
+
*/
|
|
3801
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<PermissionsPermissionMutationSerializer, HandleError>>;
|
|
3802
|
+
/**
|
|
3803
|
+
* @description Update Permission
|
|
3804
|
+
* @tags permissions
|
|
3805
|
+
* @name Update
|
|
3806
|
+
* @summary Update Permission
|
|
3807
|
+
* @request PUT:/v1/permissions/{id}
|
|
3808
|
+
* @secure
|
|
3809
|
+
*/
|
|
3810
|
+
update(id: number, updatePermission: TypesUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<PermissionsPermissionMutationSerializer, HandleError>>;
|
|
3811
|
+
/**
|
|
3812
|
+
* @description Get Permissions with pagination
|
|
3813
|
+
* @tags permissions
|
|
3814
|
+
* @name Get
|
|
3815
|
+
* @summary Get Permissions with pagination
|
|
3816
|
+
* @request POST:/v2/permissions/list
|
|
3817
|
+
* @secure
|
|
3818
|
+
*/
|
|
3819
|
+
get(getPermissions: TypesGetPermissionsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<PermissionsGetPermissionsListSerializer, HandleError>>;
|
|
2181
3820
|
}
|
|
2182
3821
|
export class PublicSettings<HandleError extends boolean = boolean> {
|
|
2183
3822
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2184
3823
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2185
|
-
|
|
3824
|
+
/**
|
|
3825
|
+
* @description Get public settings
|
|
3826
|
+
* @tags public_settings
|
|
3827
|
+
* @name Get
|
|
3828
|
+
* @summary Get public settings
|
|
3829
|
+
* @request GET:/v1/public-settings
|
|
3830
|
+
*/
|
|
3831
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<PublicsettingsPublicSettingsResponseSerializer, HandleError>>;
|
|
2186
3832
|
}
|
|
2187
3833
|
export class Roles<HandleError extends boolean = boolean> {
|
|
2188
3834
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2189
3835
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
3836
|
+
/**
|
|
3837
|
+
* @description Create Role
|
|
3838
|
+
* @tags roles
|
|
3839
|
+
* @name Create
|
|
3840
|
+
* @summary Create Role
|
|
3841
|
+
* @request POST:/v1/roles
|
|
3842
|
+
* @secure
|
|
3843
|
+
*/
|
|
3844
|
+
create(createRole: TypesCreateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RolesRoleMutationSerializer, HandleError>>;
|
|
3845
|
+
/**
|
|
3846
|
+
* @description Delete Roles by ids
|
|
3847
|
+
* @tags roles
|
|
3848
|
+
* @name DeleteMany
|
|
3849
|
+
* @summary Delete Roles by ids
|
|
3850
|
+
* @request DELETE:/v1/roles
|
|
3851
|
+
* @secure
|
|
3852
|
+
*/
|
|
3853
|
+
deleteMany(deleteRoles: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3854
|
+
/**
|
|
3855
|
+
* @description Get Role by id
|
|
3856
|
+
* @tags roles
|
|
3857
|
+
* @name GetById
|
|
3858
|
+
* @summary Get Role by id
|
|
3859
|
+
* @request GET:/v1/roles/{id}
|
|
3860
|
+
* @secure
|
|
3861
|
+
*/
|
|
3862
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<RolesRoleMutationSerializer, HandleError>>;
|
|
3863
|
+
/**
|
|
3864
|
+
* @description Update Role
|
|
3865
|
+
* @tags roles
|
|
3866
|
+
* @name Update
|
|
3867
|
+
* @summary Update Role
|
|
3868
|
+
* @request PUT:/v1/roles/{id}
|
|
3869
|
+
* @secure
|
|
3870
|
+
*/
|
|
3871
|
+
update(id: number, updateRole: TypesUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RolesRoleMutationSerializer, HandleError>>;
|
|
3872
|
+
/**
|
|
3873
|
+
* @description Get Roles with pagination
|
|
3874
|
+
* @tags roles
|
|
3875
|
+
* @name Get
|
|
3876
|
+
* @summary Get Roles with pagination
|
|
3877
|
+
* @request POST:/v2/roles/list
|
|
3878
|
+
* @secure
|
|
3879
|
+
*/
|
|
3880
|
+
get(getRoles: TypesGetRolesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RolesGetRolesListSerializer, HandleError>>;
|
|
2195
3881
|
}
|
|
2196
3882
|
export class RoleTypes<HandleError extends boolean = boolean> {
|
|
2197
3883
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2198
3884
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
|
|
2203
|
-
|
|
3885
|
+
/**
|
|
3886
|
+
* @description Create Role Type
|
|
3887
|
+
* @tags role_types
|
|
3888
|
+
* @name Create
|
|
3889
|
+
* @summary Create Role Type
|
|
3890
|
+
* @request POST:/v1/b2b/role-types
|
|
3891
|
+
* @secure
|
|
3892
|
+
*/
|
|
3893
|
+
create(createRoleType: TypesCreateRoleTypeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RoletypesRoleTypeResponseSerializer, HandleError>>;
|
|
3894
|
+
/**
|
|
3895
|
+
* @description Delete Role Types by ids
|
|
3896
|
+
* @tags role_types
|
|
3897
|
+
* @name DeleteMany
|
|
3898
|
+
* @summary Delete Role Types by ids
|
|
3899
|
+
* @request DELETE:/v1/b2b/role-types
|
|
3900
|
+
* @secure
|
|
3901
|
+
*/
|
|
3902
|
+
deleteMany(deleteRoleTypes: TypesDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3903
|
+
/**
|
|
3904
|
+
* @description Get Role Type by id
|
|
3905
|
+
* @tags role_types
|
|
3906
|
+
* @name GetById
|
|
3907
|
+
* @summary Get Role Type by id
|
|
3908
|
+
* @request GET:/v1/b2b/role-types/{id}
|
|
3909
|
+
* @secure
|
|
3910
|
+
*/
|
|
3911
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<RoletypesRoleTypeResponseSerializer, HandleError>>;
|
|
3912
|
+
/**
|
|
3913
|
+
* @description Update Role Type
|
|
3914
|
+
* @tags role_types
|
|
3915
|
+
* @name Update
|
|
3916
|
+
* @summary Update Role Type
|
|
3917
|
+
* @request PUT:/v1/b2b/role-types/{id}
|
|
3918
|
+
* @secure
|
|
3919
|
+
*/
|
|
3920
|
+
update(id: number, updateRoleType: TypesUpdateRoleTypeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RoletypesRoleTypeResponseSerializer, HandleError>>;
|
|
3921
|
+
/**
|
|
3922
|
+
* @description Get Role Types with pagination
|
|
3923
|
+
* @tags role_types
|
|
3924
|
+
* @name Get
|
|
3925
|
+
* @summary Get Role Types with pagination
|
|
3926
|
+
* @request POST:/v2/b2b/role-types/list
|
|
3927
|
+
* @secure
|
|
3928
|
+
*/
|
|
3929
|
+
get(getRoleTypes: TypesGetRoleTypesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<RoletypesGetRoleTypesListSerializer, HandleError>>;
|
|
2204
3930
|
}
|
|
2205
3931
|
export class SecretNotes<HandleError extends boolean = boolean> {
|
|
2206
3932
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2207
3933
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
3934
|
+
/**
|
|
3935
|
+
* @description Create Secret note. For type `password` field `note_params` should contain `password` field only.
|
|
3936
|
+
* @tags secret_notes
|
|
3937
|
+
* @name Create
|
|
3938
|
+
* @summary Create Secret note
|
|
3939
|
+
* @request POST:/v1/secret-notes
|
|
3940
|
+
* @secure
|
|
3941
|
+
*/
|
|
3942
|
+
create(createSecretNote: TypesCreateSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<SecretnotesSecretNoteCreationSuccessSerializer, HandleError>>;
|
|
3943
|
+
/**
|
|
3944
|
+
* @description Get Secret note
|
|
3945
|
+
* @tags secret_notes
|
|
3946
|
+
* @name GetOne
|
|
3947
|
+
* @summary Get Secret note
|
|
3948
|
+
* @request POST:/v1/secret-notes/fetch
|
|
3949
|
+
*/
|
|
3950
|
+
getOne(getSecretNote: TypesGetSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<SecretnotesSingleSecretNoteSerializer, HandleError>>;
|
|
3951
|
+
/**
|
|
3952
|
+
* @description Send Secret note verification code
|
|
3953
|
+
* @tags secret_notes
|
|
3954
|
+
* @name SendVerificationCode
|
|
3955
|
+
* @summary Send Secret note verification code
|
|
3956
|
+
* @request PUT:/v1/secret-notes/verification
|
|
3957
|
+
*/
|
|
3958
|
+
sendVerificationCode(sendVerificationCodeForSecretNote: TypesSendVerificationCodeForSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2211
3959
|
}
|
|
2212
3960
|
export class Sessions<HandleError extends boolean = boolean> {
|
|
2213
3961
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2214
3962
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2215
|
-
|
|
2216
|
-
|
|
3963
|
+
/**
|
|
3964
|
+
* @description et current user sessions info
|
|
3965
|
+
* @tags sessions
|
|
3966
|
+
* @name GetCurrentUserSessions
|
|
3967
|
+
* @summary Get current user sessions info
|
|
3968
|
+
* @request GET:/v1/auth/sessions
|
|
3969
|
+
* @secure
|
|
3970
|
+
*/
|
|
3971
|
+
getCurrentUserSessions(config?: RequestConfig<HandleError>): Promise<ClientResponse<SessionsGetSessionsListSerializer, HandleError>>;
|
|
3972
|
+
/**
|
|
3973
|
+
* @description Delete current user sessions by pair id's
|
|
3974
|
+
* @tags sessions
|
|
3975
|
+
* @name DeleteCurrentUserSessions
|
|
3976
|
+
* @summary Delete current user sessions by pair id's
|
|
3977
|
+
* @request DELETE:/v1/auth/sessions
|
|
3978
|
+
* @secure
|
|
3979
|
+
*/
|
|
3980
|
+
deleteCurrentUserSessions(deleteSessions: TypesDeleteSessionsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2217
3981
|
}
|
|
2218
3982
|
export class TablePresets<HandleError extends boolean = boolean> {
|
|
2219
3983
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2220
3984
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2221
|
-
|
|
2222
|
-
|
|
3985
|
+
/**
|
|
3986
|
+
* @description Get user Table Presets
|
|
3987
|
+
* @tags table_presets
|
|
3988
|
+
* @name GetUserPresets
|
|
3989
|
+
* @summary Get user Table Presets
|
|
3990
|
+
* @request GET:/v1/b2b/table-presets
|
|
3991
|
+
* @secure
|
|
3992
|
+
*/
|
|
3993
|
+
getUserPresets(config?: RequestConfig<HandleError>): Promise<ClientResponse<TablepresetsTablePresetsListResponseSerializer, HandleError>>;
|
|
3994
|
+
/**
|
|
3995
|
+
* @description Upsert Table Preset
|
|
3996
|
+
* @tags table_presets
|
|
3997
|
+
* @name Upsert
|
|
3998
|
+
* @summary Upsert Table Preset
|
|
3999
|
+
* @request PUT:/v1/b2b/table-presets
|
|
4000
|
+
* @secure
|
|
4001
|
+
*/
|
|
4002
|
+
upsert(upsertTablePreset: TypesUpsertTablePresetDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TablepresetsTablePresetResponseSerializer, HandleError>>;
|
|
2223
4003
|
}
|
|
2224
4004
|
export class Tags<HandleError extends boolean = boolean> {
|
|
2225
4005
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2226
4006
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
|
|
4007
|
+
/**
|
|
4008
|
+
* @description Create Tag
|
|
4009
|
+
* @tags tags
|
|
4010
|
+
* @name Create
|
|
4011
|
+
* @summary Create Tag
|
|
4012
|
+
* @request POST:/v1/tags
|
|
4013
|
+
* @secure
|
|
4014
|
+
*/
|
|
4015
|
+
create(createTagDto: TypesCreateTagDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TagsTagMutationSerializer, HandleError>>;
|
|
4016
|
+
/**
|
|
4017
|
+
* @description Delete Tags
|
|
4018
|
+
* @tags tags
|
|
4019
|
+
* @name DeleteMany
|
|
4020
|
+
* @summary Delete Tags
|
|
4021
|
+
* @request DELETE:/v1/tags
|
|
4022
|
+
* @secure
|
|
4023
|
+
*/
|
|
4024
|
+
deleteMany(deleteByIDsDto: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4025
|
+
/**
|
|
4026
|
+
* @description Get Tags List. Available fields for sorting are `id, name, created_at, updated_at`. Search is performed by `name`
|
|
4027
|
+
* @tags tags
|
|
4028
|
+
* @name Get
|
|
4029
|
+
* @summary Get Tags List
|
|
4030
|
+
* @request POST:/v1/tags/list
|
|
4031
|
+
* @secure
|
|
4032
|
+
*/
|
|
4033
|
+
get(getTagsDto: TypesGetTagsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TagsGetTagsListSerializer, HandleError>>;
|
|
4034
|
+
/**
|
|
4035
|
+
* @description Get Tags By ID
|
|
4036
|
+
* @tags tags
|
|
4037
|
+
* @name GetById
|
|
4038
|
+
* @summary Get Tag By ID
|
|
4039
|
+
* @request GET:/v1/tags/{id}
|
|
4040
|
+
* @secure
|
|
4041
|
+
*/
|
|
4042
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<TagsTagMutationSerializer, HandleError>>;
|
|
4043
|
+
/**
|
|
4044
|
+
* @description Update Tag
|
|
4045
|
+
* @tags tags
|
|
4046
|
+
* @name Update
|
|
4047
|
+
* @summary Update Tag
|
|
4048
|
+
* @request PUT:/v1/tags/{id}
|
|
4049
|
+
* @secure
|
|
4050
|
+
*/
|
|
4051
|
+
update(id: number, updateTagDto: TypesUpdateTagDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<TagsTagMutationSerializer, HandleError>>;
|
|
2232
4052
|
}
|
|
2233
4053
|
export class UserDetails<HandleError extends boolean = boolean> {
|
|
2234
4054
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2235
4055
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2236
|
-
|
|
2237
|
-
|
|
4056
|
+
/**
|
|
4057
|
+
* @description Get User Details by JWT-token
|
|
4058
|
+
* @tags user_details
|
|
4059
|
+
* @name GetUserDetails
|
|
4060
|
+
* @summary Get User Details by JWT-token
|
|
4061
|
+
* @request POST:/v1/users/details/show
|
|
4062
|
+
* @secure
|
|
4063
|
+
*/
|
|
4064
|
+
getUserDetails(getUserDetailsDto: TypesGetUserDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UserdetailsGetUserDetailsSerializer, HandleError>>;
|
|
4065
|
+
/**
|
|
4066
|
+
* @description Revoke user sessions by JWT-token
|
|
4067
|
+
* @tags user_details
|
|
4068
|
+
* @name RevokeSessions
|
|
4069
|
+
* @summary Revoke user sessions by JWT-token
|
|
4070
|
+
* @request POST:/v1/users/revoke-sessions
|
|
4071
|
+
* @secure
|
|
4072
|
+
*/
|
|
4073
|
+
revokeSessions(revokeUserSessionsDto: TypesRevokeUserSessionsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2238
4074
|
}
|
|
2239
4075
|
export class UsersCommon<HandleError extends boolean = boolean> {
|
|
2240
4076
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2241
4077
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2242
|
-
|
|
4078
|
+
/**
|
|
4079
|
+
* @description Link Watchmen user to UMA
|
|
4080
|
+
* @tags users_common
|
|
4081
|
+
* @name LinkWatchmenUsersToUma
|
|
4082
|
+
* @summary Link Watchmen user to UMA
|
|
4083
|
+
* @request POST:/v1/users/watchmen/link
|
|
4084
|
+
* @secure
|
|
4085
|
+
*/
|
|
4086
|
+
linkWatchmenUsersToUma(linkWatchmenUserToUmaDto: TypesLinkWatchmenUserToUmaDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2243
4087
|
}
|
|
2244
4088
|
export class WatchmenAuth<HandleError extends boolean = boolean> {
|
|
2245
4089
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2246
4090
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2247
|
-
|
|
2248
|
-
|
|
4091
|
+
/**
|
|
4092
|
+
* @description Generate Watchmen Auth Token
|
|
4093
|
+
* @tags watchmen_auth
|
|
4094
|
+
* @name GenerateWatchmenAuthToken
|
|
4095
|
+
* @summary Generate Watchmen Auth Token
|
|
4096
|
+
* @request POST:/v1/auth/watchmen/authentication-tokens
|
|
4097
|
+
* @secure
|
|
4098
|
+
*/
|
|
4099
|
+
generateWatchmenAuthToken(config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmenauthTokenGenerationResponseSerializer, HandleError>>;
|
|
4100
|
+
/**
|
|
4101
|
+
* @description Verify Watchmen Auth Token
|
|
4102
|
+
* @tags watchmen_auth
|
|
4103
|
+
* @name VerifyWatchmenAuthToken
|
|
4104
|
+
* @summary Verify Watchmen Auth Token
|
|
4105
|
+
* @request PUT:/v1/auth/watchmen/authentication-tokens/verify
|
|
4106
|
+
* @secure
|
|
4107
|
+
*/
|
|
4108
|
+
verifyWatchmenAuthToken(verifyWatchmenAuthToken: TypesVerifyWatchmenAuthTokenDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmenauthTokenDetailsResponseSerializer, HandleError>>;
|
|
2249
4109
|
}
|
|
2250
4110
|
export class WatchmenInstances<HandleError extends boolean = boolean> {
|
|
2251
4111
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2252
4112
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
4113
|
+
/**
|
|
4114
|
+
* @description Create Watchmen Instance
|
|
4115
|
+
* @tags watchmen_instances
|
|
4116
|
+
* @name Create
|
|
4117
|
+
* @summary Create Watchmen Instance
|
|
4118
|
+
* @request POST:/v1/watchmen-instances
|
|
4119
|
+
* @secure
|
|
4120
|
+
*/
|
|
4121
|
+
create(createWatchmenInstance: TypesCreateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmeninstancesWatchmenInstanceMutationSerializer, HandleError>>;
|
|
4122
|
+
/**
|
|
4123
|
+
* @description Delete Watchmen Instances
|
|
4124
|
+
* @tags watchmen_instances
|
|
4125
|
+
* @name DeleteMany
|
|
4126
|
+
* @summary Delete Watchmen Instances
|
|
4127
|
+
* @request DELETE:/v1/watchmen-instances
|
|
4128
|
+
* @secure
|
|
4129
|
+
*/
|
|
4130
|
+
deleteMany(deleteWatchmenInstances: TypesDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4131
|
+
/**
|
|
4132
|
+
* @description Get Watchmen Instances with pagination. Available sort fields are `id, name, slug, url, created_at, updated_at`. Search is performed by `name, url, slug` fields.
|
|
4133
|
+
* @tags watchmen_instances
|
|
4134
|
+
* @name GetMany
|
|
4135
|
+
* @summary Get Watchmen Instances with pagination
|
|
4136
|
+
* @request POST:/v1/watchmen-instances/list
|
|
4137
|
+
* @secure
|
|
4138
|
+
*/
|
|
4139
|
+
getMany(getWatchmenInstances: TypesGetWatchmenInstancesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmeninstancesGetWatchmenInstancesListSerializer, HandleError>>;
|
|
4140
|
+
/**
|
|
4141
|
+
* @description Get Watchmen Instance by id
|
|
4142
|
+
* @tags watchmen_instances
|
|
4143
|
+
* @name GetById
|
|
4144
|
+
* @summary Get Watchmen Instance by id
|
|
4145
|
+
* @request GET:/v1/watchmen-instances/{id}
|
|
4146
|
+
* @secure
|
|
4147
|
+
*/
|
|
4148
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmeninstancesWatchmenInstanceMutationSerializer, HandleError>>;
|
|
4149
|
+
/**
|
|
4150
|
+
* @description Update Watchmen Instance
|
|
4151
|
+
* @tags watchmen_instances
|
|
4152
|
+
* @name Update
|
|
4153
|
+
* @summary Update Watchmen Instance
|
|
4154
|
+
* @request PUT:/v1/watchmen-instances/{id}
|
|
4155
|
+
* @secure
|
|
4156
|
+
*/
|
|
4157
|
+
update(id: number, updateWatchmenInstance: TypesUpdateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<WatchmeninstancesWatchmenInstanceMutationSerializer, HandleError>>;
|
|
2258
4158
|
}
|
|
2259
4159
|
declare class _B2BAuth1<HandleError extends boolean = boolean> extends B2BAuth<HandleError> {
|
|
2260
4160
|
basicLogin(basicLoginParams: TypesBasicB2BLoginDto, headers?: {
|
|
@@ -2271,7 +4171,7 @@ export interface UmaClientConfig<HandleError extends boolean = boolean> extends
|
|
|
2271
4171
|
firmId: string;
|
|
2272
4172
|
authFormSlug: string;
|
|
2273
4173
|
}
|
|
2274
|
-
export class UmaApi<HandleError extends boolean =
|
|
4174
|
+
export class UmaApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
2275
4175
|
actionLog: ActionLogs<HandleError>;
|
|
2276
4176
|
apiKeys: ApiKeys<HandleError>;
|
|
2277
4177
|
authApps: AuthApps<HandleError>;
|