@orbis-systems/orbis-api-clients 0.3.1 → 0.4.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/aesmidas/index.d.ts +3756 -0
- package/dist/aesmidas/index.d.ts.map +1 -0
- package/dist/aesmidas/index.esm.js +2 -0
- package/dist/aesmidas/index.esm.js.map +1 -0
- package/dist/aesmidas/index.js +2 -0
- package/dist/aesmidas/index.js.map +1 -0
- package/dist/index.d.ts +12 -26962
- 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/dist/insight/index.d.ts +4255 -0
- package/dist/insight/index.d.ts.map +1 -0
- package/dist/insight/index.esm.js +2 -0
- package/dist/insight/index.esm.js.map +1 -0
- package/dist/insight/index.js +2 -0
- package/dist/insight/index.js.map +1 -0
- package/dist/middleware/index.d.ts +555 -0
- package/dist/middleware/index.d.ts.map +1 -0
- package/dist/middleware/index.esm.js +2 -0
- package/dist/middleware/index.esm.js.map +1 -0
- package/dist/middleware/index.js +2 -0
- package/dist/middleware/index.js.map +1 -0
- package/dist/orbis/index.d.ts +15336 -0
- package/dist/orbis/index.d.ts.map +1 -0
- package/dist/orbis/index.esm.js +2 -0
- package/dist/orbis/index.esm.js.map +1 -0
- package/dist/orbis/index.js +2 -0
- package/dist/orbis/index.js.map +1 -0
- package/dist/uma/index.d.ts +3859 -0
- package/dist/uma/index.d.ts.map +1 -0
- package/dist/uma/index.esm.js +2 -0
- package/dist/uma/index.esm.js.map +1 -0
- package/dist/uma/index.js +2 -0
- package/dist/uma/index.js.map +1 -0
- package/package.json +63 -24
|
@@ -0,0 +1,3859 @@
|
|
|
1
|
+
import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
|
|
2
|
+
interface BaseClientConfig<HandleError extends boolean = boolean> {
|
|
3
|
+
baseUrl: string;
|
|
4
|
+
errorHandling?: HandleError;
|
|
5
|
+
storage?: Storage;
|
|
6
|
+
defaultHeaders?: Record<string, string>;
|
|
7
|
+
defaultSecure?: boolean;
|
|
8
|
+
authDataStorageKey?: string;
|
|
9
|
+
onAxiosError?: (error: AxiosError) => void;
|
|
10
|
+
onError?: (error: unknown) => void;
|
|
11
|
+
}
|
|
12
|
+
enum ContentType {
|
|
13
|
+
Json = "application/json",
|
|
14
|
+
FormData = "multipart/form-data",
|
|
15
|
+
UrlEncoded = "application/x-www-form-urlencoded",
|
|
16
|
+
Text = "text/plain"
|
|
17
|
+
}
|
|
18
|
+
type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
|
|
19
|
+
secure?: boolean;
|
|
20
|
+
contentType?: ContentType;
|
|
21
|
+
};
|
|
22
|
+
type ResponseStatus = {
|
|
23
|
+
status: HttpStatusCode | -1;
|
|
24
|
+
statusText: string;
|
|
25
|
+
};
|
|
26
|
+
type SuccessClientResponse<Data = unknown> = ResponseStatus & {
|
|
27
|
+
success: true;
|
|
28
|
+
data: Data;
|
|
29
|
+
};
|
|
30
|
+
type ErrorClientResponse = ResponseStatus & {
|
|
31
|
+
success: false;
|
|
32
|
+
data?: any;
|
|
33
|
+
error: unknown;
|
|
34
|
+
};
|
|
35
|
+
type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
|
|
36
|
+
declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
|
|
37
|
+
protected readonly config: BaseClientConfig<HandleError>;
|
|
38
|
+
protected readonly axiosInstance: AxiosInstance;
|
|
39
|
+
protected readonly storage: Storage;
|
|
40
|
+
constructor(config: BaseClientConfig<HandleError>);
|
|
41
|
+
protected stringifyFormItem(formItem: unknown): string;
|
|
42
|
+
protected createFormData(input: Record<string, unknown>): FormData;
|
|
43
|
+
request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
44
|
+
get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
45
|
+
delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
46
|
+
head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
47
|
+
options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
48
|
+
post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
49
|
+
put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
50
|
+
patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
51
|
+
getAxios(): AxiosInstance;
|
|
52
|
+
setAuthData(data: AuthData | null): void;
|
|
53
|
+
getAuthData(): AuthData | null;
|
|
54
|
+
getConfig(): BaseClientConfig<HandleError>;
|
|
55
|
+
abstract prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
|
|
56
|
+
}
|
|
57
|
+
declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
|
|
58
|
+
protected readonly apiClient: ApiClient;
|
|
59
|
+
constructor(apiClient: ApiClient);
|
|
60
|
+
getApiClient(): ApiClient;
|
|
61
|
+
}
|
|
62
|
+
interface JwtClientConfig<HandleError extends boolean = boolean> extends BaseClientConfig<HandleError> {
|
|
63
|
+
authSchema?: string;
|
|
64
|
+
}
|
|
65
|
+
interface JwtAuthData {
|
|
66
|
+
accessToken: string;
|
|
67
|
+
refreshToken: string;
|
|
68
|
+
}
|
|
69
|
+
declare class JwtClient<HandleError extends boolean = boolean> extends BaseClient<HandleError, JwtAuthData> {
|
|
70
|
+
protected readonly config: JwtClientConfig<HandleError>;
|
|
71
|
+
constructor(config: JwtClientConfig<HandleError>);
|
|
72
|
+
getConfig(): JwtClientConfig<HandleError>;
|
|
73
|
+
prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
|
|
74
|
+
scheduleTokenRenewal(renewTokenCallback: () => Promise<JwtAuthData>): void;
|
|
75
|
+
cancelTokenRenewal(): void;
|
|
76
|
+
}
|
|
77
|
+
export interface UmaGetActionLogsSerializer {
|
|
78
|
+
action_logs: UmaActionLogSerializer[];
|
|
79
|
+
current_page: number;
|
|
80
|
+
pages_count: number;
|
|
81
|
+
status: number;
|
|
82
|
+
total_records: number;
|
|
83
|
+
}
|
|
84
|
+
export interface UmaAPIKeysMutationSerializer {
|
|
85
|
+
api_keys: UmaAPIKeys;
|
|
86
|
+
status: number;
|
|
87
|
+
}
|
|
88
|
+
export interface UmaGetAPIKeysSerializer {
|
|
89
|
+
api_keys: UmaAPIKeys[];
|
|
90
|
+
current_page: number;
|
|
91
|
+
pages_count: number;
|
|
92
|
+
status: number;
|
|
93
|
+
total_records: number;
|
|
94
|
+
}
|
|
95
|
+
export interface UmaAuthAppResponseSerializer {
|
|
96
|
+
auth_app: UmaAuthAppSerializer;
|
|
97
|
+
status: number;
|
|
98
|
+
}
|
|
99
|
+
export interface UmaFinishTOTPRegistrationResponseSerializer {
|
|
100
|
+
backup_codes: string[];
|
|
101
|
+
status: number;
|
|
102
|
+
}
|
|
103
|
+
export interface UmaGetAuthAppsListSerializer {
|
|
104
|
+
auth_apps_list: UmaAuthAppSerializer[];
|
|
105
|
+
status: number;
|
|
106
|
+
}
|
|
107
|
+
export interface UmaBasicLoginResultSerializer {
|
|
108
|
+
tokens: UmaTokens;
|
|
109
|
+
user: UmaUserSerializer;
|
|
110
|
+
}
|
|
111
|
+
export interface UmaAuthFormMutationSerializer {
|
|
112
|
+
form: UmaAuthFormSerializer;
|
|
113
|
+
status: number;
|
|
114
|
+
}
|
|
115
|
+
export interface UmaGetAuthFormsListSerializer {
|
|
116
|
+
current_page: number;
|
|
117
|
+
forms_list: UmaAuthFormSerializer[];
|
|
118
|
+
pages_count: number;
|
|
119
|
+
status: number;
|
|
120
|
+
total_records: number;
|
|
121
|
+
}
|
|
122
|
+
export interface UmaBasicB2BLoginResultSerializer {
|
|
123
|
+
tokens: UmaTokens;
|
|
124
|
+
user: UmaB2BUserSerializer;
|
|
125
|
+
}
|
|
126
|
+
export interface UmaBasicB2BLoginSerializer {
|
|
127
|
+
login_basic: UmaBasicB2BLoginResultSerializer;
|
|
128
|
+
status: number;
|
|
129
|
+
}
|
|
130
|
+
export interface UmaGetCurrentB2BUserSerializer {
|
|
131
|
+
current_user: UmaB2BUserSerializer;
|
|
132
|
+
status: number;
|
|
133
|
+
}
|
|
134
|
+
export interface UmaSimpleB2BLoginResultSerializer {
|
|
135
|
+
tokens: UmaTokens;
|
|
136
|
+
}
|
|
137
|
+
export interface UmaSimpleB2BLoginSerializer {
|
|
138
|
+
api_keys_login: UmaSimpleB2BLoginResultSerializer;
|
|
139
|
+
status: number;
|
|
140
|
+
}
|
|
141
|
+
export interface UmaB2BUserSerializer {
|
|
142
|
+
b2b_user: UmaAdminB2BUserSerializer;
|
|
143
|
+
status: number;
|
|
144
|
+
}
|
|
145
|
+
export interface UmaB2BUploadAvatarResponseSerializer {
|
|
146
|
+
avatar: UmaB2BUploadAvatarSerializer;
|
|
147
|
+
status: number;
|
|
148
|
+
}
|
|
149
|
+
export interface UmaB2BUserSettingsChangeSerializer {
|
|
150
|
+
settings: UmaB2BUserSettingsSerializer;
|
|
151
|
+
status: number;
|
|
152
|
+
}
|
|
153
|
+
export interface UmaB2BUserSettingsSerializer {
|
|
154
|
+
do_not_ask_mfa_again: boolean;
|
|
155
|
+
/** @example "test@gmail.com" */
|
|
156
|
+
email: string;
|
|
157
|
+
first_name: string;
|
|
158
|
+
last_name: string;
|
|
159
|
+
/** @example true */
|
|
160
|
+
mfa_enabled: boolean;
|
|
161
|
+
mode: string;
|
|
162
|
+
/** @example "+1231231234" */
|
|
163
|
+
phone: string;
|
|
164
|
+
theme: string;
|
|
165
|
+
}
|
|
166
|
+
export interface UmaB2CLoginResultSerializer {
|
|
167
|
+
email_verification_needed: boolean;
|
|
168
|
+
login_basic: UmaBasicLoginResultSerializer;
|
|
169
|
+
phone_verification_needed: boolean;
|
|
170
|
+
redirect_to: string;
|
|
171
|
+
status: number;
|
|
172
|
+
}
|
|
173
|
+
export interface UmaGetCurrentB2CUserSerializer {
|
|
174
|
+
current_user: UmaUserSerializer;
|
|
175
|
+
status: number;
|
|
176
|
+
}
|
|
177
|
+
export interface UmaRefreshResultSerializer {
|
|
178
|
+
login_basic: UmaBasicLoginResultSerializer;
|
|
179
|
+
redirect_to: string;
|
|
180
|
+
status: number;
|
|
181
|
+
}
|
|
182
|
+
export interface UmaRegisterResultSerializer {
|
|
183
|
+
user: UmaUserSerializer;
|
|
184
|
+
}
|
|
185
|
+
export interface UmaRegisterSerializer {
|
|
186
|
+
register: UmaRegisterResultSerializer;
|
|
187
|
+
/** @example 201 */
|
|
188
|
+
status: number;
|
|
189
|
+
}
|
|
190
|
+
export interface UmaB2CUserSerializer {
|
|
191
|
+
b2c_user: UmaAdminB2CUserSerializer;
|
|
192
|
+
status: number;
|
|
193
|
+
}
|
|
194
|
+
export interface UmaAvailableB2CMfaOptionsResponse {
|
|
195
|
+
options?: UmaAuthAppType[];
|
|
196
|
+
status?: number;
|
|
197
|
+
}
|
|
198
|
+
export interface UmaB2CUserSettingsChangeSerializer {
|
|
199
|
+
settings: UmaB2CUserSettingsSerializer;
|
|
200
|
+
status: number;
|
|
201
|
+
}
|
|
202
|
+
export interface UmaBranchMutationSerializer {
|
|
203
|
+
branch: UmaBranchAdminSerializer;
|
|
204
|
+
status: number;
|
|
205
|
+
}
|
|
206
|
+
export interface UmaGetBranchesListSerializer {
|
|
207
|
+
branches_list: UmaBranchAdminListItemSerializer[];
|
|
208
|
+
current_page: number;
|
|
209
|
+
is_create_allowed: boolean;
|
|
210
|
+
pages_count: number;
|
|
211
|
+
status: number;
|
|
212
|
+
total_records: number;
|
|
213
|
+
}
|
|
214
|
+
export enum UmaAuthAppType {
|
|
215
|
+
EmailCodeAuthAppType = "email_code",
|
|
216
|
+
SmsCodeAuthAppType = "sms_code",
|
|
217
|
+
YubicoOTPAuthAppType = "yubico_otp",
|
|
218
|
+
WebAuthnAuthAppType = "webauthn",
|
|
219
|
+
TOTPAuthAppType = "totp"
|
|
220
|
+
}
|
|
221
|
+
export enum UmaAuthUserType {
|
|
222
|
+
AllAuthUserType = "all",
|
|
223
|
+
B2BAuthUserType = "b2b",
|
|
224
|
+
B2CAuthUserType = "b2c"
|
|
225
|
+
}
|
|
226
|
+
export interface UmaPaginationDto {
|
|
227
|
+
page?: number;
|
|
228
|
+
/** @max 100 */
|
|
229
|
+
size?: number;
|
|
230
|
+
}
|
|
231
|
+
export enum UmaResetPasswordType {
|
|
232
|
+
PasswordResetByContactCode = "by_contact_code",
|
|
233
|
+
PasswordResetByEmailLink = "by_email_link"
|
|
234
|
+
}
|
|
235
|
+
export interface UmaSortDto {
|
|
236
|
+
direction?: string;
|
|
237
|
+
field?: string;
|
|
238
|
+
}
|
|
239
|
+
export interface UmaGetCountriesSerializer {
|
|
240
|
+
countries: UmaCountrySerializer[];
|
|
241
|
+
status: number;
|
|
242
|
+
}
|
|
243
|
+
export interface UmaEndpointMutationSerializer {
|
|
244
|
+
endpoint: UmaEndpointSerializer;
|
|
245
|
+
status: number;
|
|
246
|
+
}
|
|
247
|
+
export interface UmaGetEndpointsListSerializer {
|
|
248
|
+
current_page: number;
|
|
249
|
+
endpoints_list: UmaEndpointSerializer[];
|
|
250
|
+
pages_count: number;
|
|
251
|
+
status: number;
|
|
252
|
+
total_records: number;
|
|
253
|
+
}
|
|
254
|
+
export interface UmaFirmMutationSerializer {
|
|
255
|
+
firm: UmaFirmWithCredsSerializer;
|
|
256
|
+
status: number;
|
|
257
|
+
}
|
|
258
|
+
export interface UmaGetFirmsListSerializer {
|
|
259
|
+
current_page: number;
|
|
260
|
+
firms_list: UmaFirmWithCredsSerializer[];
|
|
261
|
+
pages_count: number;
|
|
262
|
+
status: number;
|
|
263
|
+
total_records: number;
|
|
264
|
+
}
|
|
265
|
+
export interface UmaError {
|
|
266
|
+
/** @example ["'sms'"," 'email'"] */
|
|
267
|
+
available_options?: UmaOption[];
|
|
268
|
+
/** @example 400 */
|
|
269
|
+
code?: UmaErrorCode;
|
|
270
|
+
description?: string;
|
|
271
|
+
field?: string;
|
|
272
|
+
request_id?: string;
|
|
273
|
+
}
|
|
274
|
+
export enum UmaErrorCode {
|
|
275
|
+
JSONValidationErr = 4000,
|
|
276
|
+
JSONReadErr = 4001,
|
|
277
|
+
JSONParseErr = 4002,
|
|
278
|
+
ForbiddenErr = 4003,
|
|
279
|
+
ForbiddenDueLimit = 4030,
|
|
280
|
+
RecordNotFoundErr = 4004,
|
|
281
|
+
RecordAlreadyExistsErr = 4005,
|
|
282
|
+
ImageValidationErr = 4006,
|
|
283
|
+
InappropriateImageErr = 4007,
|
|
284
|
+
FaceNotFoundOnImageErr = 4008,
|
|
285
|
+
UnauthorizedErr = 4010,
|
|
286
|
+
TokenRevokedErr = 4012,
|
|
287
|
+
TokenNotActiveErr = 4013,
|
|
288
|
+
EmailNotVerifiedErr = 4015,
|
|
289
|
+
TokenParsingErr = 4016,
|
|
290
|
+
PhoneNotVerifiedErr = 4017,
|
|
291
|
+
UUIDParseErr = 4026,
|
|
292
|
+
InvalidEmailOrPasswordOrTypeErr = 4028,
|
|
293
|
+
InvalidMfaCodeErr = 4128,
|
|
294
|
+
MfaRequiredErr = 4228,
|
|
295
|
+
TokenVerificationErr = 4328,
|
|
296
|
+
InvalidAPIKeyOrSecretErr = 4428,
|
|
297
|
+
MfaAddingNotAllowedErr = 4528,
|
|
298
|
+
BranchRequestNotAllowed = 4103,
|
|
299
|
+
ForbiddenForUserTypeErr = 4203,
|
|
300
|
+
SecondForbiddenErr = 4031,
|
|
301
|
+
ThirdForbiddenErr = 4032,
|
|
302
|
+
EntitiesChoiceNotAllowed = 4303,
|
|
303
|
+
RecaptchaErr = 4403,
|
|
304
|
+
UpdateOfOldEntityStateErr = 4503,
|
|
305
|
+
ChiefadminMutationErr = 4603,
|
|
306
|
+
ChildEntitiesExistErr = 4703,
|
|
307
|
+
TenantActionForbiddenErr = 4803,
|
|
308
|
+
RBACManipulationErr = 4903,
|
|
309
|
+
YubicoMaxKeysLimitReachedErr = 4113,
|
|
310
|
+
ConflictErr = 4090,
|
|
311
|
+
SecondFieldConflictErr = 4091,
|
|
312
|
+
ThirdFieldConflictErr = 4092,
|
|
313
|
+
FourthFieldConflictErr = 4093,
|
|
314
|
+
FifthFieldConflictErr = 4094,
|
|
315
|
+
SixthFieldConflictErr = 4095,
|
|
316
|
+
SeventhFieldConflictErr = 4096,
|
|
317
|
+
GoneErr = 4100,
|
|
318
|
+
SecondGoneErr = 4101,
|
|
319
|
+
UnprocessableEntity = 4222,
|
|
320
|
+
TooEarlyDuplicateRequest = 4250,
|
|
321
|
+
RateLimitErr = 4291,
|
|
322
|
+
ForbiddenByFirmsStatusErr = 4292,
|
|
323
|
+
NotAcceptableError = 4600,
|
|
324
|
+
InternalServerErr = 5000,
|
|
325
|
+
InvalidRequest = 6000
|
|
326
|
+
}
|
|
327
|
+
export interface UmaErrorsSerializer {
|
|
328
|
+
errors: UmaError[];
|
|
329
|
+
}
|
|
330
|
+
export interface UmaGetIdentityProvidersListSerializer {
|
|
331
|
+
current_page: number;
|
|
332
|
+
identity_providers_list: UmaIdentityProviderSerializer[];
|
|
333
|
+
pages_count: number;
|
|
334
|
+
status: number;
|
|
335
|
+
total_records: number;
|
|
336
|
+
}
|
|
337
|
+
export interface UmaIdentityProviderResponseSerializer {
|
|
338
|
+
identity_provider: UmaIdentityProviderSerializer;
|
|
339
|
+
status: number;
|
|
340
|
+
}
|
|
341
|
+
export interface UmaLocaleSerializer {
|
|
342
|
+
/** @example 1 */
|
|
343
|
+
id: number;
|
|
344
|
+
/** @example "fr" */
|
|
345
|
+
locale: string;
|
|
346
|
+
/** @example "French" */
|
|
347
|
+
name: string;
|
|
348
|
+
}
|
|
349
|
+
export enum UmaOption {
|
|
350
|
+
SmsMfaOption = "sms",
|
|
351
|
+
EmailMfaOption = "email",
|
|
352
|
+
VoiceMfaOption = "voice",
|
|
353
|
+
WebAuthnMfaOption = "webauthn",
|
|
354
|
+
YubicoOTPMfaOption = "yubico_otp",
|
|
355
|
+
TOTPMfaOption = "totp"
|
|
356
|
+
}
|
|
357
|
+
export interface UmaGetMicroservicesListSerializer {
|
|
358
|
+
current_page: number;
|
|
359
|
+
microservices_list: UmaMicroserviceSerializer[];
|
|
360
|
+
pages_count: number;
|
|
361
|
+
status: number;
|
|
362
|
+
total_records: number;
|
|
363
|
+
}
|
|
364
|
+
export interface UmaMicroserviceMutationSerializer {
|
|
365
|
+
microservice: UmaMicroserviceSerializer;
|
|
366
|
+
status: number;
|
|
367
|
+
}
|
|
368
|
+
export interface UmaUpsertUsersSerializer {
|
|
369
|
+
status: number;
|
|
370
|
+
users: UmaAdminUserSerializer[];
|
|
371
|
+
}
|
|
372
|
+
export interface UmaGetPermissionsListSerializer {
|
|
373
|
+
current_page: number;
|
|
374
|
+
pages_count: number;
|
|
375
|
+
permissions_list: UmaPermissionSerializer[];
|
|
376
|
+
status: number;
|
|
377
|
+
total_records: number;
|
|
378
|
+
}
|
|
379
|
+
export interface UmaPermissionMutationSerializer {
|
|
380
|
+
permission: UmaPermissionSerializer;
|
|
381
|
+
status: number;
|
|
382
|
+
}
|
|
383
|
+
export enum UmaAuthProviderAppType {
|
|
384
|
+
GoogleOAuth2Provider = "google-oauth2",
|
|
385
|
+
AppleIDOAuth2Provider = "apple-id"
|
|
386
|
+
}
|
|
387
|
+
export enum UmaEndpointType {
|
|
388
|
+
RegularEndpoint = "regular",
|
|
389
|
+
DisplayOnlyEndpoint = "display_only"
|
|
390
|
+
}
|
|
391
|
+
export enum UmaEntityAccessType {
|
|
392
|
+
GranularEntityAccessType = "granular",
|
|
393
|
+
HighLevelEntityAccessType = "high-level"
|
|
394
|
+
}
|
|
395
|
+
export interface UmaEntityData {
|
|
396
|
+
name?: string;
|
|
397
|
+
value?: UmaEntityAccessType;
|
|
398
|
+
}
|
|
399
|
+
export enum UmaPermissionAG {
|
|
400
|
+
ChiefadminPermissionAG = "chiefadmin",
|
|
401
|
+
SuperadminPermissionAG = "superadmin",
|
|
402
|
+
B2BOnlyPermissionAG = "b2b_only",
|
|
403
|
+
RegularPermissionAG = "regular"
|
|
404
|
+
}
|
|
405
|
+
export enum UmaUserStatus {
|
|
406
|
+
ActiveUserStatus = "active",
|
|
407
|
+
BlockedUserStatus = "blocked",
|
|
408
|
+
ArchivedUserStatus = "archived"
|
|
409
|
+
}
|
|
410
|
+
export interface UmaPublicSettingsResponseSerializer {
|
|
411
|
+
settings: UmaPublicSettingsSerializer;
|
|
412
|
+
status: number;
|
|
413
|
+
}
|
|
414
|
+
export interface UmaGetRolesListSerializer {
|
|
415
|
+
current_page: number;
|
|
416
|
+
pages_count: number;
|
|
417
|
+
roles_list: UmaRoleSerializer[];
|
|
418
|
+
status: number;
|
|
419
|
+
total_records: number;
|
|
420
|
+
}
|
|
421
|
+
export interface UmaRoleMutationSerializer {
|
|
422
|
+
role: UmaRoleSerializer;
|
|
423
|
+
status: number;
|
|
424
|
+
}
|
|
425
|
+
export interface UmaGetRoleTypesListSerializer {
|
|
426
|
+
current_page: number;
|
|
427
|
+
pages_count: number;
|
|
428
|
+
role_types_list: UmaRoleTypeSerializer[];
|
|
429
|
+
status: number;
|
|
430
|
+
total_records: number;
|
|
431
|
+
}
|
|
432
|
+
export interface UmaRoleTypeResponseSerializer {
|
|
433
|
+
role_type: UmaRoleTypeSerializer;
|
|
434
|
+
status: number;
|
|
435
|
+
}
|
|
436
|
+
export interface UmaSecretNoteCreationSuccessSerializer {
|
|
437
|
+
secret_note_link: string;
|
|
438
|
+
status: number;
|
|
439
|
+
}
|
|
440
|
+
export interface UmaSingleSecretNoteSerializer {
|
|
441
|
+
secret_note: UmaSecretNoteSerializer;
|
|
442
|
+
status: number;
|
|
443
|
+
}
|
|
444
|
+
export interface UmaGetSessionsListSerializer {
|
|
445
|
+
sessions: UmaSessionSerializer[];
|
|
446
|
+
status: number;
|
|
447
|
+
}
|
|
448
|
+
export interface UmaTablePresetResponseSerializer {
|
|
449
|
+
status: number;
|
|
450
|
+
table_preset: UmaTablePresetSerializer;
|
|
451
|
+
}
|
|
452
|
+
export interface UmaTablePresetsListResponseSerializer {
|
|
453
|
+
status: number;
|
|
454
|
+
table_presets: UmaTablePresetSerializer[];
|
|
455
|
+
}
|
|
456
|
+
export interface UmaGetTagsListSerializer {
|
|
457
|
+
current_page: number;
|
|
458
|
+
pages_count: number;
|
|
459
|
+
status: number;
|
|
460
|
+
tags_list: UmaTagSerializer[];
|
|
461
|
+
total_records: number;
|
|
462
|
+
}
|
|
463
|
+
export interface UmaTagMutationSerializer {
|
|
464
|
+
status: number;
|
|
465
|
+
tag: UmaTagSerializer;
|
|
466
|
+
}
|
|
467
|
+
export interface UmaAPIKeys {
|
|
468
|
+
ac_same_as_for_user?: boolean;
|
|
469
|
+
api_key?: string;
|
|
470
|
+
api_secret?: string;
|
|
471
|
+
branches?: UmaBranchSerializer[];
|
|
472
|
+
created_at?: string;
|
|
473
|
+
firms?: UmaFirmAccessSerializer[];
|
|
474
|
+
id?: number;
|
|
475
|
+
microservices?: UmaMicroserviceSerializer[];
|
|
476
|
+
name?: string;
|
|
477
|
+
permissions?: UmaPermissionSerializer[];
|
|
478
|
+
roles?: UmaRoleSerializer[];
|
|
479
|
+
updated_at?: string;
|
|
480
|
+
}
|
|
481
|
+
export interface UmaAPIKeysB2BLoginDto {
|
|
482
|
+
/** @maxLength 255 */
|
|
483
|
+
api_key: string;
|
|
484
|
+
/** @maxLength 255 */
|
|
485
|
+
api_secret: string;
|
|
486
|
+
}
|
|
487
|
+
export interface UmaActionLogEntityFilterDto {
|
|
488
|
+
entity_id?: number;
|
|
489
|
+
entity_name?: string;
|
|
490
|
+
}
|
|
491
|
+
export interface UmaActionLogSerializer {
|
|
492
|
+
action_type: string;
|
|
493
|
+
created_at: string;
|
|
494
|
+
entity_id: number;
|
|
495
|
+
entity_name: string;
|
|
496
|
+
id: number;
|
|
497
|
+
initiator: UmaUserSerializer;
|
|
498
|
+
initiator_id: number;
|
|
499
|
+
new_state: Record<string, any>;
|
|
500
|
+
prev_state: Record<string, any>;
|
|
501
|
+
trigger_type: string;
|
|
502
|
+
updated_at: string;
|
|
503
|
+
}
|
|
504
|
+
export interface UmaAdminB2BUserSerializer {
|
|
505
|
+
allow_feedback: boolean;
|
|
506
|
+
big_avatar_url: string;
|
|
507
|
+
branches: UmaBranchSerializer[];
|
|
508
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
509
|
+
created_at: string;
|
|
510
|
+
/** @example true */
|
|
511
|
+
do_not_ask_mfa_again: boolean;
|
|
512
|
+
/** @example "test@email.com" */
|
|
513
|
+
email: string;
|
|
514
|
+
/** @example true */
|
|
515
|
+
email_verified: boolean;
|
|
516
|
+
firms: UmaFirmAccessSerializer[];
|
|
517
|
+
/** @example "Mike" */
|
|
518
|
+
first_name: string;
|
|
519
|
+
has_access_to_all_firm_branches: boolean;
|
|
520
|
+
/** @example 1 */
|
|
521
|
+
id: number;
|
|
522
|
+
initiator_id: number;
|
|
523
|
+
/** @example "Jenkins" */
|
|
524
|
+
last_name: string;
|
|
525
|
+
locale: UmaLocaleSerializer;
|
|
526
|
+
locale_id: number;
|
|
527
|
+
/** @example true */
|
|
528
|
+
mfa_enabled: boolean;
|
|
529
|
+
microservices: UmaMicroserviceSerializer[];
|
|
530
|
+
mode: string;
|
|
531
|
+
permissions: UmaPermissionSerializer[];
|
|
532
|
+
/** @example "+123478844" */
|
|
533
|
+
phone: string;
|
|
534
|
+
/** @example true */
|
|
535
|
+
phone_verified: boolean;
|
|
536
|
+
primary_firm_id: number;
|
|
537
|
+
rep_code: string;
|
|
538
|
+
roles: UmaRoleSerializer[];
|
|
539
|
+
should_reset_password: boolean;
|
|
540
|
+
small_avatar_url: string;
|
|
541
|
+
status: UmaUserStatus;
|
|
542
|
+
status_change_notes: string;
|
|
543
|
+
status_change_reason: UmaUserStatusChangeReasonSerializer;
|
|
544
|
+
status_change_reason_id: number;
|
|
545
|
+
status_changed_at: string;
|
|
546
|
+
theme: string;
|
|
547
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
548
|
+
updated_at: string;
|
|
549
|
+
username: string;
|
|
550
|
+
watchmen_user_links: UmaWatchmenUserLinkSerializer[];
|
|
551
|
+
}
|
|
552
|
+
export interface UmaAdminB2CUserSerializer {
|
|
553
|
+
allow_feedback: boolean;
|
|
554
|
+
big_avatar_url: string;
|
|
555
|
+
branches: UmaBranchSerializer[];
|
|
556
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
557
|
+
created_at: string;
|
|
558
|
+
/** @example true */
|
|
559
|
+
do_not_ask_mfa_again: boolean;
|
|
560
|
+
/** @example "test@email.com" */
|
|
561
|
+
email: string;
|
|
562
|
+
/** @example true */
|
|
563
|
+
email_verified: boolean;
|
|
564
|
+
firms: UmaFirmAccessSerializer[];
|
|
565
|
+
/** @example "Mike" */
|
|
566
|
+
first_name: string;
|
|
567
|
+
/** @example 1 */
|
|
568
|
+
id: number;
|
|
569
|
+
initiator_id: number;
|
|
570
|
+
/** @example "Jenkins" */
|
|
571
|
+
last_name: string;
|
|
572
|
+
locale: UmaLocaleSerializer;
|
|
573
|
+
locale_id: number;
|
|
574
|
+
/** @example true */
|
|
575
|
+
mfa_enabled: boolean;
|
|
576
|
+
microservices: UmaMicroserviceSerializer[];
|
|
577
|
+
permissions: UmaPermissionSerializer[];
|
|
578
|
+
/** @example "+123478844" */
|
|
579
|
+
phone: string;
|
|
580
|
+
/** @example true */
|
|
581
|
+
phone_verified: boolean;
|
|
582
|
+
primary_firm_id: number;
|
|
583
|
+
rep_code: string;
|
|
584
|
+
roles: UmaRoleSerializer[];
|
|
585
|
+
should_reset_password: boolean;
|
|
586
|
+
small_avatar_url: string;
|
|
587
|
+
status: UmaUserStatus;
|
|
588
|
+
status_change_notes: string;
|
|
589
|
+
status_change_reason: UmaUserStatusChangeReasonSerializer;
|
|
590
|
+
status_change_reason_id: number;
|
|
591
|
+
status_changed_at: string;
|
|
592
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
593
|
+
updated_at: string;
|
|
594
|
+
username: string;
|
|
595
|
+
watchmen_user_links: UmaWatchmenUserLinkSerializer[];
|
|
596
|
+
}
|
|
597
|
+
export interface UmaAdminUserSerializer {
|
|
598
|
+
allow_feedback: boolean;
|
|
599
|
+
big_avatar_url: string;
|
|
600
|
+
branches: UmaBranchSerializer[];
|
|
601
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
602
|
+
created_at: string;
|
|
603
|
+
/** @example true */
|
|
604
|
+
do_not_ask_mfa_again: boolean;
|
|
605
|
+
/** @example "test@email.com" */
|
|
606
|
+
email: string;
|
|
607
|
+
/** @example true */
|
|
608
|
+
email_verified: boolean;
|
|
609
|
+
firms: UmaFirmAccessSerializer[];
|
|
610
|
+
/** @example "Mike" */
|
|
611
|
+
first_name: string;
|
|
612
|
+
/** @example 1 */
|
|
613
|
+
id: number;
|
|
614
|
+
initiator_id: number;
|
|
615
|
+
/** @example "Jenkins" */
|
|
616
|
+
last_name: string;
|
|
617
|
+
locale: UmaLocaleSerializer;
|
|
618
|
+
locale_id: number;
|
|
619
|
+
/** @example true */
|
|
620
|
+
mfa_enabled: boolean;
|
|
621
|
+
microservices: UmaMicroserviceSerializer[];
|
|
622
|
+
permissions: UmaPermissionSerializer[];
|
|
623
|
+
/** @example "+123478844" */
|
|
624
|
+
phone: string;
|
|
625
|
+
/** @example true */
|
|
626
|
+
phone_verified: boolean;
|
|
627
|
+
primary_firm_id: number;
|
|
628
|
+
rep_code: string;
|
|
629
|
+
roles: UmaRoleSerializer[];
|
|
630
|
+
should_reset_password: boolean;
|
|
631
|
+
small_avatar_url: string;
|
|
632
|
+
status: UmaUserStatus;
|
|
633
|
+
status_change_notes: string;
|
|
634
|
+
status_change_reason: UmaUserStatusChangeReasonSerializer;
|
|
635
|
+
status_change_reason_id: number;
|
|
636
|
+
status_changed_at: string;
|
|
637
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
638
|
+
updated_at: string;
|
|
639
|
+
username: string;
|
|
640
|
+
watchmen_user_links: UmaWatchmenUserLinkSerializer[];
|
|
641
|
+
}
|
|
642
|
+
export interface UmaAuthAppSerializer {
|
|
643
|
+
created_at: string;
|
|
644
|
+
id: number;
|
|
645
|
+
last_used_at: string;
|
|
646
|
+
name: string;
|
|
647
|
+
status: string;
|
|
648
|
+
type: string;
|
|
649
|
+
updated_at: string;
|
|
650
|
+
}
|
|
651
|
+
export interface UmaAuthAppsLimitsSerializer {
|
|
652
|
+
totp_max_apps: number;
|
|
653
|
+
webauthn_max_apps: number;
|
|
654
|
+
yubico_otp_max_apps: number;
|
|
655
|
+
}
|
|
656
|
+
export interface UmaAuthFormDto {
|
|
657
|
+
branch_id?: number;
|
|
658
|
+
client_platform_slug?: string;
|
|
659
|
+
firm_id?: number;
|
|
660
|
+
logo_base_url?: string;
|
|
661
|
+
logo_path?: string;
|
|
662
|
+
redirect_url: string;
|
|
663
|
+
reset_password_link_template?: string;
|
|
664
|
+
reset_password_type: UmaAuthFormDtoResetPasswordTypeEnum;
|
|
665
|
+
slug: string;
|
|
666
|
+
}
|
|
667
|
+
export interface UmaAuthFormSerializer {
|
|
668
|
+
branch: UmaBranchSerializer;
|
|
669
|
+
branch_id: number;
|
|
670
|
+
client_platform_slug: string;
|
|
671
|
+
created_at: string;
|
|
672
|
+
firm: UmaFirmSerializer;
|
|
673
|
+
firm_id: number;
|
|
674
|
+
id: number;
|
|
675
|
+
logo_base_url: string;
|
|
676
|
+
logo_path: string;
|
|
677
|
+
redirect_url: string;
|
|
678
|
+
reset_password_link_template: string;
|
|
679
|
+
reset_password_type: UmaAuthFormSerializerResetPasswordTypeEnum;
|
|
680
|
+
slug: string;
|
|
681
|
+
updated_at: string;
|
|
682
|
+
}
|
|
683
|
+
export interface UmaAuthProviderUserBindingSerializer {
|
|
684
|
+
app_type: UmaAuthProviderAppType;
|
|
685
|
+
b2b_user_id: number;
|
|
686
|
+
b2c_user_id: number;
|
|
687
|
+
created_at: string;
|
|
688
|
+
firm_id: number;
|
|
689
|
+
id: number;
|
|
690
|
+
name: string;
|
|
691
|
+
provider_user_id: string;
|
|
692
|
+
updated_at: string;
|
|
693
|
+
}
|
|
694
|
+
export interface UmaAuthProviderUserBindingsResponse {
|
|
695
|
+
bindings?: UmaAuthProviderUserBindingSerializer[];
|
|
696
|
+
current_page?: number;
|
|
697
|
+
pages_count?: number;
|
|
698
|
+
status?: number;
|
|
699
|
+
total_records?: number;
|
|
700
|
+
}
|
|
701
|
+
export interface UmaAvatarSettingsSerializer {
|
|
702
|
+
allowed_extensions: string[];
|
|
703
|
+
big_dimensions: UmaImageDimensionsSerializer;
|
|
704
|
+
max_size_in_bytes: number;
|
|
705
|
+
}
|
|
706
|
+
export interface UmaB2BResetPasswordDto {
|
|
707
|
+
captcha_response?: string;
|
|
708
|
+
/** @maxLength 255 */
|
|
709
|
+
code: string;
|
|
710
|
+
/** @maxLength 255 */
|
|
711
|
+
contact: string;
|
|
712
|
+
/** @maxLength 100 */
|
|
713
|
+
new_password: string;
|
|
714
|
+
old_password?: string;
|
|
715
|
+
}
|
|
716
|
+
export interface UmaB2BSendContactChangeCodeDto {
|
|
717
|
+
/** @maxLength 255 */
|
|
718
|
+
contact: string;
|
|
719
|
+
type: UmaB2BSendContactChangeCodeDtoTypeEnum;
|
|
720
|
+
}
|
|
721
|
+
export interface UmaB2BUploadAvatarSerializer {
|
|
722
|
+
big_avatar_path: string;
|
|
723
|
+
small_avatar_path: string;
|
|
724
|
+
}
|
|
725
|
+
export interface UmaB2BUserSerializer {
|
|
726
|
+
admin_of_firm_ids: number[];
|
|
727
|
+
allow_feedback: boolean;
|
|
728
|
+
big_avatar_url: string;
|
|
729
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
730
|
+
created_at: string;
|
|
731
|
+
/** @example true */
|
|
732
|
+
do_not_ask_mfa_again: boolean;
|
|
733
|
+
/** @example "test@email.com" */
|
|
734
|
+
email: string;
|
|
735
|
+
/** @example true */
|
|
736
|
+
email_verified: boolean;
|
|
737
|
+
/** @example "Mike" */
|
|
738
|
+
first_name: string;
|
|
739
|
+
/** @example 1 */
|
|
740
|
+
id: number;
|
|
741
|
+
initiator_id: number;
|
|
742
|
+
is_chief_admin: boolean;
|
|
743
|
+
/** @example "Jenkins" */
|
|
744
|
+
last_name: string;
|
|
745
|
+
locale: UmaLocaleSerializer;
|
|
746
|
+
locale_id: number;
|
|
747
|
+
/** @example true */
|
|
748
|
+
mfa_enabled: boolean;
|
|
749
|
+
microservices: UmaMicroserviceAccessSerializer[];
|
|
750
|
+
mode: string;
|
|
751
|
+
/** @example "+123478844" */
|
|
752
|
+
phone: string;
|
|
753
|
+
/** @example true */
|
|
754
|
+
phone_verified: boolean;
|
|
755
|
+
rep_code: string;
|
|
756
|
+
should_reset_password: boolean;
|
|
757
|
+
small_avatar_url: string;
|
|
758
|
+
theme: string;
|
|
759
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
760
|
+
updated_at: string;
|
|
761
|
+
username: string;
|
|
762
|
+
}
|
|
763
|
+
export interface UmaB2CInitOAuthResponse {
|
|
764
|
+
data?: UmaInitOAuthLoginSerializer;
|
|
765
|
+
status?: number;
|
|
766
|
+
}
|
|
767
|
+
export interface UmaB2CRefreshDto {
|
|
768
|
+
auth_form_slug?: string;
|
|
769
|
+
refresh_token: string;
|
|
770
|
+
send_redirect?: boolean;
|
|
771
|
+
}
|
|
772
|
+
export interface UmaB2CResetPasswordDto {
|
|
773
|
+
auth_form_slug: string;
|
|
774
|
+
captcha_response?: string;
|
|
775
|
+
code: string;
|
|
776
|
+
/** @maxLength 255 */
|
|
777
|
+
contact?: string;
|
|
778
|
+
/** @maxLength 100 */
|
|
779
|
+
new_password: string;
|
|
780
|
+
reset_type: UmaB2CResetPasswordDtoResetTypeEnum;
|
|
781
|
+
}
|
|
782
|
+
export interface UmaB2CSendContactChangeCodeDto {
|
|
783
|
+
/** @maxLength 255 */
|
|
784
|
+
contact: string;
|
|
785
|
+
type: UmaB2CSendContactChangeCodeDtoTypeEnum;
|
|
786
|
+
}
|
|
787
|
+
export interface UmaB2CSendVerificationCodeDto {
|
|
788
|
+
code_type: UmaB2CSendVerificationCodeDtoCodeTypeEnum;
|
|
789
|
+
contact: string;
|
|
790
|
+
}
|
|
791
|
+
export interface UmaB2CUserSettingsSerializer {
|
|
792
|
+
email: string;
|
|
793
|
+
email_verified: boolean;
|
|
794
|
+
first_name: string;
|
|
795
|
+
last_name: string;
|
|
796
|
+
mfa_enabled: boolean;
|
|
797
|
+
phone: string;
|
|
798
|
+
phone_verified: boolean;
|
|
799
|
+
}
|
|
800
|
+
export interface UmaBasicB2BLoginDto {
|
|
801
|
+
/** @maxLength 255 */
|
|
802
|
+
device_id: string;
|
|
803
|
+
/**
|
|
804
|
+
* @maxLength 255
|
|
805
|
+
* @example "test@gmail.com"
|
|
806
|
+
*/
|
|
807
|
+
email: string;
|
|
808
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
809
|
+
/**
|
|
810
|
+
* @maxLength 100
|
|
811
|
+
* @example "TeStPaSS"
|
|
812
|
+
*/
|
|
813
|
+
password: string;
|
|
814
|
+
/** @example true */
|
|
815
|
+
remember_me?: boolean;
|
|
816
|
+
}
|
|
817
|
+
export interface UmaBasicB2CLoginDto {
|
|
818
|
+
auth_form_slug?: string;
|
|
819
|
+
client_platform_slug?: string;
|
|
820
|
+
/** @maxLength 255 */
|
|
821
|
+
device_id: string;
|
|
822
|
+
/**
|
|
823
|
+
* @maxLength 255
|
|
824
|
+
* @example "test@gmail.com"
|
|
825
|
+
*/
|
|
826
|
+
login: string;
|
|
827
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
828
|
+
/**
|
|
829
|
+
* @maxLength 100
|
|
830
|
+
* @example "TeStPaSS"
|
|
831
|
+
*/
|
|
832
|
+
password: string;
|
|
833
|
+
/** @example true */
|
|
834
|
+
remember_me?: boolean;
|
|
835
|
+
send_redirect?: boolean;
|
|
836
|
+
}
|
|
837
|
+
export interface UmaBranchAdminListItemSerializer {
|
|
838
|
+
branch_admins_count: number;
|
|
839
|
+
/** @example "1000" */
|
|
840
|
+
code: string;
|
|
841
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
842
|
+
created_at: string;
|
|
843
|
+
firm: UmaFirmSerializer;
|
|
844
|
+
/** @example 1 */
|
|
845
|
+
firm_id: number;
|
|
846
|
+
/** @example 1 */
|
|
847
|
+
id: number;
|
|
848
|
+
is_delete_allowed: boolean;
|
|
849
|
+
is_update_allowed: boolean;
|
|
850
|
+
/** @example "New York" */
|
|
851
|
+
name: string;
|
|
852
|
+
retail_available_mfa_options: string[];
|
|
853
|
+
retail_email_verification_required: boolean;
|
|
854
|
+
retail_login_enabled: boolean;
|
|
855
|
+
retail_mfa_enabling_required: boolean;
|
|
856
|
+
retail_phone_verification_required: boolean;
|
|
857
|
+
/** @example "new-york" */
|
|
858
|
+
slug: string;
|
|
859
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
860
|
+
updated_at: string;
|
|
861
|
+
}
|
|
862
|
+
export interface UmaBranchAdminSerializer {
|
|
863
|
+
branch_admins_count: number;
|
|
864
|
+
/** @example "1000" */
|
|
865
|
+
code: string;
|
|
866
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
867
|
+
created_at: string;
|
|
868
|
+
firm: UmaFirmSerializer;
|
|
869
|
+
/** @example 1 */
|
|
870
|
+
firm_id: number;
|
|
871
|
+
/** @example 1 */
|
|
872
|
+
id: number;
|
|
873
|
+
/** @example "New York" */
|
|
874
|
+
name: string;
|
|
875
|
+
retail_available_mfa_options: string[];
|
|
876
|
+
retail_email_verification_required: boolean;
|
|
877
|
+
retail_login_enabled: boolean;
|
|
878
|
+
retail_mfa_enabling_required: boolean;
|
|
879
|
+
retail_phone_verification_required: boolean;
|
|
880
|
+
/** @example "new-york" */
|
|
881
|
+
slug: string;
|
|
882
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
883
|
+
updated_at: string;
|
|
884
|
+
}
|
|
885
|
+
export interface UmaBranchSerializer {
|
|
886
|
+
/** @example "1000" */
|
|
887
|
+
code: string;
|
|
888
|
+
/** @example 1 */
|
|
889
|
+
firm_id: number;
|
|
890
|
+
/** @example 1 */
|
|
891
|
+
id: number;
|
|
892
|
+
/** @example "New York" */
|
|
893
|
+
name: string;
|
|
894
|
+
/** @example "new-york" */
|
|
895
|
+
slug: string;
|
|
896
|
+
}
|
|
897
|
+
export interface UmaChangeUserStatusDto {
|
|
898
|
+
new_status?: UmaUserStatus;
|
|
899
|
+
notes?: string;
|
|
900
|
+
/** @min 1 */
|
|
901
|
+
reason_id?: number;
|
|
902
|
+
}
|
|
903
|
+
export interface UmaCountrySerializer {
|
|
904
|
+
code: string;
|
|
905
|
+
dial_code: string;
|
|
906
|
+
id: number;
|
|
907
|
+
name: string;
|
|
908
|
+
}
|
|
909
|
+
export interface UmaCreateAPIKeysDto {
|
|
910
|
+
ac_same_as_for_user?: boolean;
|
|
911
|
+
branches?: number[];
|
|
912
|
+
firms?: UmaFirmInfo[];
|
|
913
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
914
|
+
/** @maxLength 255 */
|
|
915
|
+
name: string;
|
|
916
|
+
permissions?: number[];
|
|
917
|
+
roles?: number[];
|
|
918
|
+
}
|
|
919
|
+
export interface UmaCreateB2BUserDto {
|
|
920
|
+
add_default_domain_permissions?: boolean;
|
|
921
|
+
allow_feedback?: boolean;
|
|
922
|
+
branches?: number[];
|
|
923
|
+
/**
|
|
924
|
+
* @maxLength 255
|
|
925
|
+
* @example "test@gmail.com"
|
|
926
|
+
*/
|
|
927
|
+
email?: string;
|
|
928
|
+
/** @minItems 1 */
|
|
929
|
+
firms: UmaFirmInfo[];
|
|
930
|
+
/** @maxLength 255 */
|
|
931
|
+
first_name: string;
|
|
932
|
+
has_access_to_all_firm_branches?: boolean;
|
|
933
|
+
/** @maxLength 255 */
|
|
934
|
+
last_name: string;
|
|
935
|
+
/** @example "TeStPaSS" */
|
|
936
|
+
password: string;
|
|
937
|
+
permissions?: number[];
|
|
938
|
+
/**
|
|
939
|
+
* @maxLength 255
|
|
940
|
+
* @example "+1231231234"
|
|
941
|
+
*/
|
|
942
|
+
phone?: string;
|
|
943
|
+
primary_firm_id?: number;
|
|
944
|
+
rep_code?: string;
|
|
945
|
+
/** @minItems 1 */
|
|
946
|
+
roles: number[];
|
|
947
|
+
should_reset_password?: boolean;
|
|
948
|
+
/** @maxLength 255 */
|
|
949
|
+
username?: string;
|
|
950
|
+
watchmen_user_links?: UmaWatchmenUserLinkDto[];
|
|
951
|
+
}
|
|
952
|
+
export interface UmaCreateB2CUserDto {
|
|
953
|
+
allow_feedback?: boolean;
|
|
954
|
+
/** @minItems 1 */
|
|
955
|
+
branches: number[];
|
|
956
|
+
/**
|
|
957
|
+
* @maxLength 255
|
|
958
|
+
* @example "test@gmail.com"
|
|
959
|
+
*/
|
|
960
|
+
email?: string;
|
|
961
|
+
/** @min 1 */
|
|
962
|
+
firm_id: number;
|
|
963
|
+
/** @maxLength 255 */
|
|
964
|
+
first_name: string;
|
|
965
|
+
/** @maxLength 255 */
|
|
966
|
+
last_name: string;
|
|
967
|
+
/**
|
|
968
|
+
* @maxLength 100
|
|
969
|
+
* @example "TeStPaSS"
|
|
970
|
+
*/
|
|
971
|
+
password: string;
|
|
972
|
+
permissions?: number[];
|
|
973
|
+
/**
|
|
974
|
+
* @maxLength 255
|
|
975
|
+
* @example "+1231231234"
|
|
976
|
+
*/
|
|
977
|
+
phone?: string;
|
|
978
|
+
/** @minItems 1 */
|
|
979
|
+
roles: number[];
|
|
980
|
+
/** @maxLength 255 */
|
|
981
|
+
username?: string;
|
|
982
|
+
watchmen_user_links?: UmaWatchmenUserLinkDto[];
|
|
983
|
+
}
|
|
984
|
+
export interface UmaCreateBranchDto {
|
|
985
|
+
/** @maxLength 255 */
|
|
986
|
+
code?: string;
|
|
987
|
+
/** @min 1 */
|
|
988
|
+
firm_id: number;
|
|
989
|
+
/** @maxLength 255 */
|
|
990
|
+
name: string;
|
|
991
|
+
retail_available_auth_app_options?: UmaAuthAppType[];
|
|
992
|
+
retail_email_verification_required?: boolean;
|
|
993
|
+
retail_login_enabled?: boolean;
|
|
994
|
+
retail_mfa_enabling_required?: boolean;
|
|
995
|
+
retail_phone_verification_required?: boolean;
|
|
996
|
+
settings?: UmaTenantSettingDto[];
|
|
997
|
+
/** @maxLength 255 */
|
|
998
|
+
slug: string;
|
|
999
|
+
}
|
|
1000
|
+
export interface UmaCreateEndpointDto {
|
|
1001
|
+
is_active?: boolean;
|
|
1002
|
+
is_public?: boolean;
|
|
1003
|
+
metadata?: UmaEndpointMetadataDto;
|
|
1004
|
+
method: UmaCreateEndpointDtoMethodEnum;
|
|
1005
|
+
/** @min 1 */
|
|
1006
|
+
microservice_id: number;
|
|
1007
|
+
required_permissions?: number[];
|
|
1008
|
+
/** @maxLength 255 */
|
|
1009
|
+
route: string;
|
|
1010
|
+
type?: UmaCreateEndpointDtoTypeEnum;
|
|
1011
|
+
}
|
|
1012
|
+
export interface UmaCreateFirmDto {
|
|
1013
|
+
allow_b2c_email_notifications?: boolean;
|
|
1014
|
+
firm_tags?: number[];
|
|
1015
|
+
mailgun_creds?: UmaFirmMailgunCredsDto;
|
|
1016
|
+
/** @maxLength 255 */
|
|
1017
|
+
name: string;
|
|
1018
|
+
/** @maxLength 255 */
|
|
1019
|
+
slug: string;
|
|
1020
|
+
twilio_creds?: UmaFirmTwilioCredsDto;
|
|
1021
|
+
}
|
|
1022
|
+
export interface UmaCreateIdentityProviderDto {
|
|
1023
|
+
/** @maxLength 1000 */
|
|
1024
|
+
auth_url: string;
|
|
1025
|
+
/** @maxLength 255 */
|
|
1026
|
+
client_id: string;
|
|
1027
|
+
/** @maxLength 255 */
|
|
1028
|
+
client_secret: string;
|
|
1029
|
+
/** @maxLength 1000 */
|
|
1030
|
+
company_domain: string;
|
|
1031
|
+
/** @min 1 */
|
|
1032
|
+
firm_id: number;
|
|
1033
|
+
/** @min 1 */
|
|
1034
|
+
priority: number;
|
|
1035
|
+
/** @maxLength 1000 */
|
|
1036
|
+
redirect_url?: string;
|
|
1037
|
+
type: UmaCreateIdentityProviderDtoTypeEnum;
|
|
1038
|
+
}
|
|
1039
|
+
export interface UmaCreateMicroserviceDto {
|
|
1040
|
+
domains?: UmaMicroserviceDomainDto[];
|
|
1041
|
+
is_active?: boolean;
|
|
1042
|
+
is_visible_on_admin_sidebar?: boolean;
|
|
1043
|
+
/** @maxLength 1000 */
|
|
1044
|
+
logo_url?: string;
|
|
1045
|
+
/** @maxLength 255 */
|
|
1046
|
+
name: string;
|
|
1047
|
+
/** @maxLength 255 */
|
|
1048
|
+
slug: string;
|
|
1049
|
+
}
|
|
1050
|
+
export interface UmaCreatePermissionDto {
|
|
1051
|
+
assignment_group: UmaCreatePermissionDtoAssignmentGroupEnum;
|
|
1052
|
+
metadata?: UmaPermissionMetadataDto;
|
|
1053
|
+
microservice_id?: number;
|
|
1054
|
+
/** @maxLength 1000 */
|
|
1055
|
+
permission: string;
|
|
1056
|
+
}
|
|
1057
|
+
export interface UmaCreateRoleDto {
|
|
1058
|
+
assignment_group?: UmaCreateRoleDtoAssignmentGroupEnum;
|
|
1059
|
+
/** @min 0 */
|
|
1060
|
+
firm_id?: number;
|
|
1061
|
+
microservice_id: number;
|
|
1062
|
+
/** @maxLength 255 */
|
|
1063
|
+
name: string;
|
|
1064
|
+
/** @minItems 1 */
|
|
1065
|
+
permissions: number[];
|
|
1066
|
+
permissions_can_assign_role?: number[];
|
|
1067
|
+
/** @min 1 */
|
|
1068
|
+
type_id: number;
|
|
1069
|
+
}
|
|
1070
|
+
export interface UmaCreateRoleTypeDto {
|
|
1071
|
+
/** @maxLength 255 */
|
|
1072
|
+
color: string;
|
|
1073
|
+
/** @maxLength 255 */
|
|
1074
|
+
type: string;
|
|
1075
|
+
}
|
|
1076
|
+
export interface UmaCreateSecretNoteDto {
|
|
1077
|
+
/** @maxLength 255 */
|
|
1078
|
+
email: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* supported suffixes are h, m, s, ms. Min 15 mins, max 7 days
|
|
1081
|
+
* @example "48h"
|
|
1082
|
+
*/
|
|
1083
|
+
expires_in: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* @min 1
|
|
1086
|
+
* @max 5
|
|
1087
|
+
*/
|
|
1088
|
+
max_view_count: number;
|
|
1089
|
+
name?: string;
|
|
1090
|
+
note_params: Record<string, string>;
|
|
1091
|
+
type: UmaCreateSecretNoteDtoTypeEnum;
|
|
1092
|
+
}
|
|
1093
|
+
export interface UmaCreateTagDto {
|
|
1094
|
+
name: string;
|
|
1095
|
+
}
|
|
1096
|
+
export interface UmaCreateWatchmenInstanceDto {
|
|
1097
|
+
/**
|
|
1098
|
+
* @minLength 1
|
|
1099
|
+
* @maxLength 255
|
|
1100
|
+
*/
|
|
1101
|
+
name: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* @minLength 1
|
|
1104
|
+
* @maxLength 255
|
|
1105
|
+
*/
|
|
1106
|
+
slug: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* @minLength 1
|
|
1109
|
+
* @maxLength 1000
|
|
1110
|
+
*/
|
|
1111
|
+
url: string;
|
|
1112
|
+
}
|
|
1113
|
+
export interface UmaCreateYubicoOTPDto {
|
|
1114
|
+
/** @maxLength 255 */
|
|
1115
|
+
name: string;
|
|
1116
|
+
otp: string;
|
|
1117
|
+
}
|
|
1118
|
+
export interface UmaDeleteAPIKeysDto {
|
|
1119
|
+
/** @minItems 1 */
|
|
1120
|
+
ids: number[];
|
|
1121
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
1122
|
+
}
|
|
1123
|
+
export interface UmaDeleteByIDsDtoInt {
|
|
1124
|
+
/** @minItems 1 */
|
|
1125
|
+
ids: number[];
|
|
1126
|
+
}
|
|
1127
|
+
export interface UmaDeleteByIDsDtoInt64 {
|
|
1128
|
+
/** @minItems 1 */
|
|
1129
|
+
ids: number[];
|
|
1130
|
+
}
|
|
1131
|
+
export interface UmaDeleteSessionsDto {
|
|
1132
|
+
/** @minItems 1 */
|
|
1133
|
+
pair_ids: string[];
|
|
1134
|
+
}
|
|
1135
|
+
export interface UmaEndpointMetadataDto {
|
|
1136
|
+
admin_ui_permission_key?: string;
|
|
1137
|
+
skip_email_verification_check?: boolean;
|
|
1138
|
+
skip_mfa_enabled_check?: boolean;
|
|
1139
|
+
skip_phone_verification_check?: boolean;
|
|
1140
|
+
user_type?: UmaEndpointMetadataDtoUserTypeEnum;
|
|
1141
|
+
}
|
|
1142
|
+
export interface UmaEndpointMetadataSerializer {
|
|
1143
|
+
admin_ui_permission_key: string;
|
|
1144
|
+
skip_email_verification_check: boolean;
|
|
1145
|
+
skip_mfa_enabled_check: boolean;
|
|
1146
|
+
skip_phone_verification_check: boolean;
|
|
1147
|
+
user_type: string;
|
|
1148
|
+
}
|
|
1149
|
+
export interface UmaEndpointSerializer {
|
|
1150
|
+
created_at: string;
|
|
1151
|
+
id: number;
|
|
1152
|
+
is_active: boolean;
|
|
1153
|
+
is_public: boolean;
|
|
1154
|
+
metadata: UmaEndpointMetadataSerializer;
|
|
1155
|
+
method: UmaEndpointSerializerMethodEnum;
|
|
1156
|
+
microservice: UmaMicroserviceSerializer;
|
|
1157
|
+
microservice_id: number;
|
|
1158
|
+
required_permissions: UmaPermissionSerializer[];
|
|
1159
|
+
route: string;
|
|
1160
|
+
type: UmaEndpointType;
|
|
1161
|
+
updated_at: string;
|
|
1162
|
+
}
|
|
1163
|
+
export interface UmaFinishOAuthLoginDto {
|
|
1164
|
+
authentication_code: string;
|
|
1165
|
+
state: string;
|
|
1166
|
+
}
|
|
1167
|
+
export interface UmaFinishTOTPRegistrationDto {
|
|
1168
|
+
/**
|
|
1169
|
+
* @minLength 6
|
|
1170
|
+
* @maxLength 8
|
|
1171
|
+
*/
|
|
1172
|
+
code: string;
|
|
1173
|
+
/** @maxLength 255 */
|
|
1174
|
+
name: string;
|
|
1175
|
+
}
|
|
1176
|
+
export interface UmaFirmAccessSerializer {
|
|
1177
|
+
admins_count: number;
|
|
1178
|
+
allow_b2c_email_notifications: boolean;
|
|
1179
|
+
branches: UmaBranchSerializer[];
|
|
1180
|
+
branches_count: number;
|
|
1181
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1182
|
+
created_at: string;
|
|
1183
|
+
have_access_to_all_firm_branches: boolean;
|
|
1184
|
+
/** @example 1 */
|
|
1185
|
+
id: number;
|
|
1186
|
+
last_status_change_at: string;
|
|
1187
|
+
/** @example "ViewTrade" */
|
|
1188
|
+
name: string;
|
|
1189
|
+
/** @example "viewtrade" */
|
|
1190
|
+
slug: string;
|
|
1191
|
+
status: string;
|
|
1192
|
+
tags: UmaTagSerializer[];
|
|
1193
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1194
|
+
updated_at: string;
|
|
1195
|
+
}
|
|
1196
|
+
export interface UmaFirmInfo {
|
|
1197
|
+
/** @min 1 */
|
|
1198
|
+
firm_id: number;
|
|
1199
|
+
have_access_to_all_firm_branches?: boolean;
|
|
1200
|
+
}
|
|
1201
|
+
export interface UmaFirmMailgunCredsDto {
|
|
1202
|
+
/** @maxLength 255 */
|
|
1203
|
+
domain?: string;
|
|
1204
|
+
/** @maxLength 255 */
|
|
1205
|
+
from_address?: string;
|
|
1206
|
+
/** @maxLength 255 */
|
|
1207
|
+
from_name?: string;
|
|
1208
|
+
/** @maxLength 255 */
|
|
1209
|
+
private_api_key?: string;
|
|
1210
|
+
}
|
|
1211
|
+
export interface UmaFirmSerializer {
|
|
1212
|
+
admins_count: number;
|
|
1213
|
+
allow_b2c_email_notifications: boolean;
|
|
1214
|
+
branches: UmaBranchSerializer[];
|
|
1215
|
+
branches_count: number;
|
|
1216
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1217
|
+
created_at: string;
|
|
1218
|
+
/** @example 1 */
|
|
1219
|
+
id: number;
|
|
1220
|
+
last_status_change_at: string;
|
|
1221
|
+
/** @example "ViewTrade" */
|
|
1222
|
+
name: string;
|
|
1223
|
+
/** @example "viewtrade" */
|
|
1224
|
+
slug: string;
|
|
1225
|
+
status: string;
|
|
1226
|
+
tags: UmaTagSerializer[];
|
|
1227
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1228
|
+
updated_at: string;
|
|
1229
|
+
}
|
|
1230
|
+
export interface UmaFirmTwilioCredsDto {
|
|
1231
|
+
/** @maxLength 255 */
|
|
1232
|
+
account_sid?: string;
|
|
1233
|
+
/** @maxLength 255 */
|
|
1234
|
+
auth_token?: string;
|
|
1235
|
+
/** @maxLength 255 */
|
|
1236
|
+
phone_number?: string;
|
|
1237
|
+
/** @maxLength 255 */
|
|
1238
|
+
subaccount_sid?: string;
|
|
1239
|
+
}
|
|
1240
|
+
export interface UmaFirmWithCredsSerializer {
|
|
1241
|
+
admins_count: number;
|
|
1242
|
+
allow_b2c_email_notifications: boolean;
|
|
1243
|
+
branches: UmaBranchSerializer[];
|
|
1244
|
+
branches_count: number;
|
|
1245
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1246
|
+
created_at: string;
|
|
1247
|
+
/** @example 1 */
|
|
1248
|
+
id: number;
|
|
1249
|
+
last_status_change_at: string;
|
|
1250
|
+
mailgun_creds: UmaFirmMailgunCredsDto;
|
|
1251
|
+
/** @example "ViewTrade" */
|
|
1252
|
+
name: string;
|
|
1253
|
+
/** @example "viewtrade" */
|
|
1254
|
+
slug: string;
|
|
1255
|
+
status: string;
|
|
1256
|
+
tags: UmaTagSerializer[];
|
|
1257
|
+
twilio_creds: UmaFirmTwilioCredsDto;
|
|
1258
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
1259
|
+
updated_at: string;
|
|
1260
|
+
}
|
|
1261
|
+
export interface UmaGenerateWatchmenAuthTokenDto {
|
|
1262
|
+
/** @min 1 */
|
|
1263
|
+
branch_id?: number;
|
|
1264
|
+
}
|
|
1265
|
+
export interface UmaGeneratedWatchmenTokenInfoSerializer {
|
|
1266
|
+
expires_at: number;
|
|
1267
|
+
token: string;
|
|
1268
|
+
}
|
|
1269
|
+
export interface UmaGetAPIKeysListDto {
|
|
1270
|
+
pagination?: UmaPaginationDto;
|
|
1271
|
+
search?: string;
|
|
1272
|
+
sorts?: UmaSortDto[];
|
|
1273
|
+
}
|
|
1274
|
+
export interface UmaGetActionLogsListDto {
|
|
1275
|
+
filters?: UmaGetActionLogsListFiltersDto;
|
|
1276
|
+
pagination: UmaPaginationDto;
|
|
1277
|
+
sorts?: UmaSortDto[];
|
|
1278
|
+
}
|
|
1279
|
+
export interface UmaGetActionLogsListFiltersDto {
|
|
1280
|
+
action_types?: string[];
|
|
1281
|
+
entities?: UmaActionLogEntityFilterDto[];
|
|
1282
|
+
ids?: number[];
|
|
1283
|
+
initiator_ids?: number[];
|
|
1284
|
+
show_only_fields_changes?: string[];
|
|
1285
|
+
trigger_types?: string[];
|
|
1286
|
+
}
|
|
1287
|
+
export interface UmaGetAuthFormsListDto {
|
|
1288
|
+
filters?: UmaGetAuthFormsListFiltersDto;
|
|
1289
|
+
pagination?: UmaPaginationDto;
|
|
1290
|
+
search?: string;
|
|
1291
|
+
sorts?: UmaSortDto[];
|
|
1292
|
+
}
|
|
1293
|
+
export interface UmaGetAuthFormsListFiltersDto {
|
|
1294
|
+
branch_ids?: number[];
|
|
1295
|
+
firm_ids?: number[];
|
|
1296
|
+
ids?: number[];
|
|
1297
|
+
}
|
|
1298
|
+
export interface UmaGetB2BUsersListDto {
|
|
1299
|
+
filters?: UmaGetUsersListFiltersDto;
|
|
1300
|
+
include_chiefadmin?: boolean;
|
|
1301
|
+
pagination?: UmaPaginationDto;
|
|
1302
|
+
search?: string;
|
|
1303
|
+
sorts?: UmaSortDto[];
|
|
1304
|
+
}
|
|
1305
|
+
export interface UmaGetB2CUsersListDto {
|
|
1306
|
+
filters?: UmaGetB2CUsersListFiltersDto;
|
|
1307
|
+
pagination?: UmaPaginationDto;
|
|
1308
|
+
search?: string;
|
|
1309
|
+
sorts?: UmaSortDto[];
|
|
1310
|
+
}
|
|
1311
|
+
export interface UmaGetB2CUsersListFiltersDto {
|
|
1312
|
+
branch_ids?: number[];
|
|
1313
|
+
email_verified?: boolean;
|
|
1314
|
+
firm_ids?: number[];
|
|
1315
|
+
firm_tag_ids?: number[];
|
|
1316
|
+
ids?: number[];
|
|
1317
|
+
is_blocked?: boolean;
|
|
1318
|
+
microservice_ids?: number[];
|
|
1319
|
+
neither_verified?: boolean;
|
|
1320
|
+
permission_ids?: number[];
|
|
1321
|
+
permission_names?: string[];
|
|
1322
|
+
phone_verified?: boolean;
|
|
1323
|
+
role_ids?: number[];
|
|
1324
|
+
show_only?: UmaGetB2CUsersListFiltersDtoShowOnlyEnum;
|
|
1325
|
+
show_users_linked_to_watchmen?: boolean;
|
|
1326
|
+
status_change_reason_ids?: number[];
|
|
1327
|
+
statuses?: UmaUserStatus[];
|
|
1328
|
+
}
|
|
1329
|
+
export interface UmaGetBranchesListDto {
|
|
1330
|
+
count_branch_admins?: boolean;
|
|
1331
|
+
filters?: UmaGetBranchesListFiltersDto;
|
|
1332
|
+
pagination?: UmaPaginationDto;
|
|
1333
|
+
search?: string;
|
|
1334
|
+
search_fields?: string[];
|
|
1335
|
+
sorts?: UmaSortDto[];
|
|
1336
|
+
}
|
|
1337
|
+
export interface UmaGetBranchesListFiltersDto {
|
|
1338
|
+
firm_ids?: number[];
|
|
1339
|
+
ids?: number[];
|
|
1340
|
+
retail_email_verification_required?: boolean;
|
|
1341
|
+
retail_login_enabled?: boolean;
|
|
1342
|
+
retail_phone_verification_required?: boolean;
|
|
1343
|
+
}
|
|
1344
|
+
export interface UmaGetEndpointsListDto {
|
|
1345
|
+
filters?: UmaGetEndpointsListFiltersDto;
|
|
1346
|
+
pagination?: UmaPaginationDto;
|
|
1347
|
+
search?: string;
|
|
1348
|
+
sorts?: UmaSortDto[];
|
|
1349
|
+
}
|
|
1350
|
+
export interface UmaGetEndpointsListFiltersDto {
|
|
1351
|
+
ids?: number[];
|
|
1352
|
+
is_public?: boolean;
|
|
1353
|
+
methods?: string[];
|
|
1354
|
+
microservice_ids?: number[];
|
|
1355
|
+
}
|
|
1356
|
+
export interface UmaGetFirmsListDto {
|
|
1357
|
+
count_admins?: boolean;
|
|
1358
|
+
count_branches?: boolean;
|
|
1359
|
+
filters?: UmaGetFirmsListFiltersDto;
|
|
1360
|
+
pagination?: UmaPaginationDto;
|
|
1361
|
+
search?: string;
|
|
1362
|
+
show_only_firms_accessible_in_branch_mutations?: boolean;
|
|
1363
|
+
sorts?: UmaSortDto[];
|
|
1364
|
+
}
|
|
1365
|
+
export interface UmaGetFirmsListFiltersDto {
|
|
1366
|
+
ids?: number[];
|
|
1367
|
+
statuses?: UmaGetFirmsListFiltersDtoStatusesEnum;
|
|
1368
|
+
tag_ids?: number[];
|
|
1369
|
+
}
|
|
1370
|
+
export interface UmaGetIdentityProvidersListDto {
|
|
1371
|
+
filters?: UmaGetIdentityProvidersListFiltersDto;
|
|
1372
|
+
pagination?: UmaPaginationDto;
|
|
1373
|
+
search?: string;
|
|
1374
|
+
sorts?: UmaSortDto[];
|
|
1375
|
+
}
|
|
1376
|
+
export interface UmaGetIdentityProvidersListFiltersDto {
|
|
1377
|
+
firm_ids?: number[];
|
|
1378
|
+
ids?: number[];
|
|
1379
|
+
types?: UmaGetIdentityProvidersListFiltersDtoTypesEnum[];
|
|
1380
|
+
}
|
|
1381
|
+
export interface UmaGetMicroservicesListDto {
|
|
1382
|
+
filters?: UmaGetMicroservicesListFiltersDto;
|
|
1383
|
+
pagination?: UmaPaginationDto;
|
|
1384
|
+
search?: string;
|
|
1385
|
+
sorts?: UmaSortDto[];
|
|
1386
|
+
}
|
|
1387
|
+
export interface UmaGetMicroservicesListFiltersDto {
|
|
1388
|
+
ids?: number[];
|
|
1389
|
+
slugs?: string[];
|
|
1390
|
+
}
|
|
1391
|
+
export interface UmaGetOAuth2BindingsListDto {
|
|
1392
|
+
pagination?: UmaPaginationDto;
|
|
1393
|
+
search?: string;
|
|
1394
|
+
sorts?: UmaSortDto[];
|
|
1395
|
+
}
|
|
1396
|
+
export interface UmaGetPermissionsListDto {
|
|
1397
|
+
filters?: UmaGetPermissionsListFiltersDto;
|
|
1398
|
+
include_chiefadmin?: boolean;
|
|
1399
|
+
pagination?: UmaOptionalPaginationDto;
|
|
1400
|
+
search?: string;
|
|
1401
|
+
sorts?: UmaSortDto[];
|
|
1402
|
+
}
|
|
1403
|
+
export interface UmaGetPermissionsListFiltersDto {
|
|
1404
|
+
assignment_groups?: UmaPermissionAG[];
|
|
1405
|
+
ids?: number[];
|
|
1406
|
+
microservice_ids?: number[];
|
|
1407
|
+
}
|
|
1408
|
+
export interface UmaGetRoleTypesListDto {
|
|
1409
|
+
filters?: UmaGetRoleTypesListFiltersDto;
|
|
1410
|
+
pagination?: UmaPaginationDto;
|
|
1411
|
+
search?: string;
|
|
1412
|
+
sorts?: UmaSortDto[];
|
|
1413
|
+
}
|
|
1414
|
+
export interface UmaGetRoleTypesListFiltersDto {
|
|
1415
|
+
ids?: number[];
|
|
1416
|
+
}
|
|
1417
|
+
export interface UmaGetRolesListDto {
|
|
1418
|
+
filters?: UmaGetRolesListFiltersDto;
|
|
1419
|
+
pagination?: UmaPaginationDto;
|
|
1420
|
+
search?: string;
|
|
1421
|
+
sorts?: UmaSortDto[];
|
|
1422
|
+
}
|
|
1423
|
+
export interface UmaGetRolesListFiltersDto {
|
|
1424
|
+
assignment_groups?: UmaPermissionAG[];
|
|
1425
|
+
ids?: number[];
|
|
1426
|
+
microservice_ids?: number[];
|
|
1427
|
+
type_ids?: number[];
|
|
1428
|
+
}
|
|
1429
|
+
export interface UmaGetSecretNoteDto {
|
|
1430
|
+
/** @maxLength 255 */
|
|
1431
|
+
email: string;
|
|
1432
|
+
email_code: string;
|
|
1433
|
+
id: string;
|
|
1434
|
+
}
|
|
1435
|
+
export interface UmaGetTagsDto {
|
|
1436
|
+
pagination: UmaPaginationDto;
|
|
1437
|
+
search?: string;
|
|
1438
|
+
sorts?: UmaSortDto[];
|
|
1439
|
+
}
|
|
1440
|
+
export interface UmaGetTotpQRDto {
|
|
1441
|
+
/** @min 6 */
|
|
1442
|
+
digits: number;
|
|
1443
|
+
name?: string;
|
|
1444
|
+
}
|
|
1445
|
+
export interface UmaGetUserDetailsDto {
|
|
1446
|
+
access_token: string;
|
|
1447
|
+
}
|
|
1448
|
+
export interface UmaGetUserStatusChangeReasonsDto {
|
|
1449
|
+
filters?: UmaGetUserStatusChangeReasonsListFiltersDto;
|
|
1450
|
+
pagination: UmaPaginationDto;
|
|
1451
|
+
search?: string;
|
|
1452
|
+
sorts?: UmaSortDto[];
|
|
1453
|
+
}
|
|
1454
|
+
export interface UmaGetUserStatusChangeReasonsListFiltersDto {
|
|
1455
|
+
types: string[];
|
|
1456
|
+
}
|
|
1457
|
+
export interface UmaGetUsersListFiltersDto {
|
|
1458
|
+
branch_ids?: number[];
|
|
1459
|
+
email_verified?: boolean;
|
|
1460
|
+
firm_ids?: number[];
|
|
1461
|
+
firm_tag_ids?: number[];
|
|
1462
|
+
ids?: number[];
|
|
1463
|
+
microservice_ids?: number[];
|
|
1464
|
+
neither_verified?: boolean;
|
|
1465
|
+
permission_ids?: number[];
|
|
1466
|
+
permission_names?: string[];
|
|
1467
|
+
phone_verified?: boolean;
|
|
1468
|
+
role_ids?: number[];
|
|
1469
|
+
show_only?: UmaGetUsersListFiltersDtoShowOnlyEnum;
|
|
1470
|
+
show_users_linked_to_watchmen?: boolean;
|
|
1471
|
+
status_change_reason_ids?: number[];
|
|
1472
|
+
statuses?: UmaUserStatus[];
|
|
1473
|
+
}
|
|
1474
|
+
export interface UmaGetWatchmenInstancesDto {
|
|
1475
|
+
pagination: UmaPaginationDto;
|
|
1476
|
+
search?: string;
|
|
1477
|
+
sorts?: UmaSortDto[];
|
|
1478
|
+
}
|
|
1479
|
+
export interface UmaGetWebAuthnLoginChallengeDto {
|
|
1480
|
+
/** @maxLength 255 */
|
|
1481
|
+
email: string;
|
|
1482
|
+
user_type?: UmaGetWebAuthnLoginChallengeDtoUserTypeEnum;
|
|
1483
|
+
}
|
|
1484
|
+
export interface UmaIdentityProviderSerializer {
|
|
1485
|
+
auth_url: string;
|
|
1486
|
+
client_id: string;
|
|
1487
|
+
client_secret: string;
|
|
1488
|
+
company_domain: string;
|
|
1489
|
+
created_at: string;
|
|
1490
|
+
firm_id: number;
|
|
1491
|
+
id: number;
|
|
1492
|
+
priority: number;
|
|
1493
|
+
redirect_url: string;
|
|
1494
|
+
type: UmaIdentityProviderSerializerTypeEnum;
|
|
1495
|
+
updated_at: string;
|
|
1496
|
+
}
|
|
1497
|
+
export interface UmaImageDimensionsSerializer {
|
|
1498
|
+
height: number;
|
|
1499
|
+
width: number;
|
|
1500
|
+
}
|
|
1501
|
+
export interface UmaInitOAuthLinkingDto {
|
|
1502
|
+
password: string;
|
|
1503
|
+
platform_slug: string;
|
|
1504
|
+
}
|
|
1505
|
+
export interface UmaInitOAuthLoginDto {
|
|
1506
|
+
platform_slug: string;
|
|
1507
|
+
}
|
|
1508
|
+
export interface UmaInitOAuthLoginSerializer {
|
|
1509
|
+
client_id: string;
|
|
1510
|
+
redirect_url: string;
|
|
1511
|
+
sign_in_url: string;
|
|
1512
|
+
state: string;
|
|
1513
|
+
}
|
|
1514
|
+
export interface UmaLinkWatchmenUserToUmaDto {
|
|
1515
|
+
branch_slug_or_code: string;
|
|
1516
|
+
/** @min 1 */
|
|
1517
|
+
uma_user_id: number;
|
|
1518
|
+
uma_user_type: UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum;
|
|
1519
|
+
watchmen_instance_slug: string;
|
|
1520
|
+
/** @min 1 */
|
|
1521
|
+
watchmen_user_id: number;
|
|
1522
|
+
watchmen_username?: string;
|
|
1523
|
+
}
|
|
1524
|
+
export interface UmaLocaleSerializer {
|
|
1525
|
+
/** @example 1 */
|
|
1526
|
+
id: number;
|
|
1527
|
+
/** @example "en" */
|
|
1528
|
+
locale: string;
|
|
1529
|
+
/** @example "English" */
|
|
1530
|
+
name: string;
|
|
1531
|
+
}
|
|
1532
|
+
export interface UmaLogoutDto {
|
|
1533
|
+
refresh_token: string;
|
|
1534
|
+
}
|
|
1535
|
+
export interface UmaMfaCodesDto {
|
|
1536
|
+
/** @example "12345" */
|
|
1537
|
+
email?: string;
|
|
1538
|
+
/** @example "12345" */
|
|
1539
|
+
phone?: string;
|
|
1540
|
+
totp?: string;
|
|
1541
|
+
yubico_otp?: string;
|
|
1542
|
+
yubico_webauthn?: UmaWebAuthnLoginSolutionDto;
|
|
1543
|
+
}
|
|
1544
|
+
export interface UmaMicroserviceAccessSerializer {
|
|
1545
|
+
entities: Record<string, Record<string, boolean>>;
|
|
1546
|
+
/** @example 1 */
|
|
1547
|
+
id: number;
|
|
1548
|
+
is_active: boolean;
|
|
1549
|
+
is_visible_on_admin_sidebar: boolean;
|
|
1550
|
+
logo_url: string;
|
|
1551
|
+
name: string;
|
|
1552
|
+
slug: string;
|
|
1553
|
+
}
|
|
1554
|
+
export interface UmaMicroserviceDomainDto {
|
|
1555
|
+
/**
|
|
1556
|
+
* @maxLength 255
|
|
1557
|
+
* @example "internal.com"
|
|
1558
|
+
*/
|
|
1559
|
+
internal_domain: string;
|
|
1560
|
+
/** @maxLength 255 */
|
|
1561
|
+
internal_protocol: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* @maxLength 255
|
|
1564
|
+
* @example "/insights-api"
|
|
1565
|
+
*/
|
|
1566
|
+
public_path_prefix: string;
|
|
1567
|
+
}
|
|
1568
|
+
export interface UmaMicroserviceDomainSerializer {
|
|
1569
|
+
/** @example "internal.com" */
|
|
1570
|
+
internal_domain: string;
|
|
1571
|
+
/** @example "https" */
|
|
1572
|
+
internal_protocol: string;
|
|
1573
|
+
/** @example "public.com" */
|
|
1574
|
+
public_path_prefix: string;
|
|
1575
|
+
}
|
|
1576
|
+
export interface UmaMicroserviceSerializer {
|
|
1577
|
+
created_at: string;
|
|
1578
|
+
domains: UmaMicroserviceDomainSerializer[];
|
|
1579
|
+
/** @example 1 */
|
|
1580
|
+
id: number;
|
|
1581
|
+
is_active: boolean;
|
|
1582
|
+
is_visible_on_admin_sidebar: boolean;
|
|
1583
|
+
logo_url: string;
|
|
1584
|
+
name: string;
|
|
1585
|
+
parent_id: number;
|
|
1586
|
+
slug: string;
|
|
1587
|
+
updated_at: string;
|
|
1588
|
+
}
|
|
1589
|
+
export interface UmaOptionalPaginationDto {
|
|
1590
|
+
/** @min 0 */
|
|
1591
|
+
page?: number;
|
|
1592
|
+
/**
|
|
1593
|
+
* @min 0
|
|
1594
|
+
* @max 100
|
|
1595
|
+
*/
|
|
1596
|
+
size?: number;
|
|
1597
|
+
}
|
|
1598
|
+
export interface UmaPermissionMetadataDto {
|
|
1599
|
+
entities?: Record<string, UmaEntityAccessType>;
|
|
1600
|
+
entities_new?: UmaEntityData[];
|
|
1601
|
+
is_microservice_global?: boolean;
|
|
1602
|
+
one_of_group?: string;
|
|
1603
|
+
}
|
|
1604
|
+
export interface UmaPermissionMetadataSerializer {
|
|
1605
|
+
entities: object;
|
|
1606
|
+
entities_new: UmaEntityData[];
|
|
1607
|
+
is_microservice_global: boolean;
|
|
1608
|
+
}
|
|
1609
|
+
export interface UmaPermissionSerializer {
|
|
1610
|
+
assignment_group: UmaPermissionSerializerAssignmentGroupEnum;
|
|
1611
|
+
created_at: string;
|
|
1612
|
+
/** @example 1 */
|
|
1613
|
+
id: number;
|
|
1614
|
+
metadata: UmaPermissionMetadataSerializer;
|
|
1615
|
+
microservice: UmaMicroserviceSerializer;
|
|
1616
|
+
microservice_id: number;
|
|
1617
|
+
permission: string;
|
|
1618
|
+
updated_at: string;
|
|
1619
|
+
}
|
|
1620
|
+
export interface UmaPublicSettingsSerializer {
|
|
1621
|
+
auth_apps_limits: UmaAuthAppsLimitsSerializer;
|
|
1622
|
+
avatar: UmaAvatarSettingsSerializer;
|
|
1623
|
+
b2c_mfa_options: UmaAuthAppType[];
|
|
1624
|
+
reset_password: UmaResetPasswordSettingsSerializer;
|
|
1625
|
+
totp: UmaTOTPSerializer;
|
|
1626
|
+
verification: UmaVerificationSettingsSerializer;
|
|
1627
|
+
}
|
|
1628
|
+
export interface UmaRefreshDto {
|
|
1629
|
+
refresh_token: string;
|
|
1630
|
+
}
|
|
1631
|
+
export interface UmaRegisterDto {
|
|
1632
|
+
captcha_response?: string;
|
|
1633
|
+
/**
|
|
1634
|
+
* @maxLength 255
|
|
1635
|
+
* @example "test@gmail.com"
|
|
1636
|
+
*/
|
|
1637
|
+
email?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* @maxLength 255
|
|
1640
|
+
* @example "Mike"
|
|
1641
|
+
*/
|
|
1642
|
+
first_name: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* @maxLength 255
|
|
1645
|
+
* @example "Jenkins"
|
|
1646
|
+
*/
|
|
1647
|
+
last_name: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* @maxLength 100
|
|
1650
|
+
* @example "TeStPaSS"
|
|
1651
|
+
*/
|
|
1652
|
+
password: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* @maxLength 255
|
|
1655
|
+
* @example "+12312312312"
|
|
1656
|
+
*/
|
|
1657
|
+
phone?: string;
|
|
1658
|
+
/** @maxLength 255 */
|
|
1659
|
+
username?: string;
|
|
1660
|
+
}
|
|
1661
|
+
export interface UmaResetPasswordSettingsSerializer {
|
|
1662
|
+
expires_in_minutes: number;
|
|
1663
|
+
}
|
|
1664
|
+
export interface UmaRevokeUserSessionsDto {
|
|
1665
|
+
/** @min 1 */
|
|
1666
|
+
user_id: number;
|
|
1667
|
+
user_type: UmaRevokeUserSessionsDtoUserTypeEnum;
|
|
1668
|
+
}
|
|
1669
|
+
export interface UmaRoleSerializer {
|
|
1670
|
+
assignment_group: UmaPermissionAG;
|
|
1671
|
+
created_at: string;
|
|
1672
|
+
firm: UmaFirmSerializer;
|
|
1673
|
+
firm_id: number;
|
|
1674
|
+
id: number;
|
|
1675
|
+
microservice: UmaMicroserviceSerializer;
|
|
1676
|
+
microservice_id: number;
|
|
1677
|
+
name: string;
|
|
1678
|
+
permissions: UmaPermissionSerializer[];
|
|
1679
|
+
permissions_can_assign_role: UmaPermissionSerializer[];
|
|
1680
|
+
type: UmaRoleTypeSerializer;
|
|
1681
|
+
type_id: number;
|
|
1682
|
+
updated_at: string;
|
|
1683
|
+
}
|
|
1684
|
+
export interface UmaRoleTypeSerializer {
|
|
1685
|
+
color: string;
|
|
1686
|
+
created_at: string;
|
|
1687
|
+
id: number;
|
|
1688
|
+
type: string;
|
|
1689
|
+
updated_at: string;
|
|
1690
|
+
}
|
|
1691
|
+
export interface UmaSecretNoteSerializer {
|
|
1692
|
+
email: string;
|
|
1693
|
+
expires_at: string;
|
|
1694
|
+
id: string;
|
|
1695
|
+
name: string;
|
|
1696
|
+
note_params: Record<string, string>;
|
|
1697
|
+
type: UmaSecretNoteSerializerTypeEnum;
|
|
1698
|
+
views_left: number;
|
|
1699
|
+
}
|
|
1700
|
+
export interface UmaSendB2BMfaCodeDto {
|
|
1701
|
+
/** @maxLength 255 */
|
|
1702
|
+
device_id?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* @maxLength 255
|
|
1705
|
+
* @example "test@gmail.com"
|
|
1706
|
+
*/
|
|
1707
|
+
email: string;
|
|
1708
|
+
type: UmaSendB2BMfaCodeDtoTypeEnum;
|
|
1709
|
+
}
|
|
1710
|
+
export interface UmaSendB2CMfaCodeDto {
|
|
1711
|
+
/** @maxLength 255 */
|
|
1712
|
+
device_id?: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* @maxLength 255
|
|
1715
|
+
* @example "test@gmail.com"
|
|
1716
|
+
*/
|
|
1717
|
+
login: string;
|
|
1718
|
+
type: UmaSendB2CMfaCodeDtoTypeEnum;
|
|
1719
|
+
}
|
|
1720
|
+
export interface UmaSendB2CResetPasswordCodeDto {
|
|
1721
|
+
auth_form_slug: string;
|
|
1722
|
+
code_type?: UmaSendB2CResetPasswordCodeDtoCodeTypeEnum;
|
|
1723
|
+
contact: string;
|
|
1724
|
+
reset_type: UmaSendB2CResetPasswordCodeDtoResetTypeEnum;
|
|
1725
|
+
}
|
|
1726
|
+
export interface UmaSendResetPasswordCodeDto {
|
|
1727
|
+
contact: string;
|
|
1728
|
+
type: UmaSendResetPasswordCodeDtoTypeEnum;
|
|
1729
|
+
}
|
|
1730
|
+
export interface UmaSendVerificationCodeForSecretNoteDto {
|
|
1731
|
+
/** @maxLength 255 */
|
|
1732
|
+
email: string;
|
|
1733
|
+
id: string;
|
|
1734
|
+
}
|
|
1735
|
+
export interface UmaSessionSerializer {
|
|
1736
|
+
browser_name: string;
|
|
1737
|
+
browser_version: string;
|
|
1738
|
+
country: string;
|
|
1739
|
+
device: string;
|
|
1740
|
+
ip: string;
|
|
1741
|
+
is_current: boolean;
|
|
1742
|
+
last_used_at: string;
|
|
1743
|
+
os_name: string;
|
|
1744
|
+
os_version: string;
|
|
1745
|
+
pair_id: string;
|
|
1746
|
+
user_agent: string;
|
|
1747
|
+
}
|
|
1748
|
+
export interface UmaSetB2BUserSettingsDto {
|
|
1749
|
+
captcha_response?: string;
|
|
1750
|
+
do_not_ask_mfa_again?: boolean;
|
|
1751
|
+
/**
|
|
1752
|
+
* @maxLength 255
|
|
1753
|
+
* @example "test@gmail.com"
|
|
1754
|
+
*/
|
|
1755
|
+
email: string;
|
|
1756
|
+
email_change_code?: string;
|
|
1757
|
+
/** @maxLength 255 */
|
|
1758
|
+
first_name: string;
|
|
1759
|
+
/** @maxLength 255 */
|
|
1760
|
+
last_name: string;
|
|
1761
|
+
/** @example true */
|
|
1762
|
+
mfa_enabled?: boolean;
|
|
1763
|
+
/** @maxLength 255 */
|
|
1764
|
+
mode?: string;
|
|
1765
|
+
/** @maxLength 255 */
|
|
1766
|
+
new_password?: string;
|
|
1767
|
+
old_password?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* @maxLength 255
|
|
1770
|
+
* @example "+1231231234"
|
|
1771
|
+
*/
|
|
1772
|
+
phone?: string;
|
|
1773
|
+
phone_change_code?: string;
|
|
1774
|
+
/** @maxLength 255 */
|
|
1775
|
+
theme?: string;
|
|
1776
|
+
}
|
|
1777
|
+
export interface UmaSetB2CUserSettingsDto {
|
|
1778
|
+
/** @maxLength 255 */
|
|
1779
|
+
email: string;
|
|
1780
|
+
email_change_code?: string;
|
|
1781
|
+
enable_email_mfa?: boolean;
|
|
1782
|
+
enable_phone_mfa?: boolean;
|
|
1783
|
+
/** @maxLength 255 */
|
|
1784
|
+
first_name?: string;
|
|
1785
|
+
/** @maxLength 255 */
|
|
1786
|
+
last_name?: string;
|
|
1787
|
+
/** @example true */
|
|
1788
|
+
mfa_enabled?: boolean;
|
|
1789
|
+
/** @maxLength 255 */
|
|
1790
|
+
new_password?: string;
|
|
1791
|
+
old_password?: string;
|
|
1792
|
+
/**
|
|
1793
|
+
* @maxLength 255
|
|
1794
|
+
* @example "+1231231234"
|
|
1795
|
+
*/
|
|
1796
|
+
phone?: string;
|
|
1797
|
+
phone_change_code?: string;
|
|
1798
|
+
}
|
|
1799
|
+
export interface UmaTOTPSerializer {
|
|
1800
|
+
backup_codes_count: number;
|
|
1801
|
+
backup_codes_length: number;
|
|
1802
|
+
}
|
|
1803
|
+
export interface UmaTablePresetSerializer {
|
|
1804
|
+
b2b_user_id: number;
|
|
1805
|
+
id: number;
|
|
1806
|
+
presets: object;
|
|
1807
|
+
table_name: string;
|
|
1808
|
+
}
|
|
1809
|
+
export interface UmaTagSerializer {
|
|
1810
|
+
created_at: string;
|
|
1811
|
+
id: number;
|
|
1812
|
+
name: string;
|
|
1813
|
+
updated_at: string;
|
|
1814
|
+
}
|
|
1815
|
+
export interface UmaTenantSettingDto {
|
|
1816
|
+
label: UmaTenantSettingDtoLabelEnum;
|
|
1817
|
+
value: string;
|
|
1818
|
+
}
|
|
1819
|
+
export enum UmaTenantSettingLabel {
|
|
1820
|
+
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
1821
|
+
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
1822
|
+
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
1823
|
+
}
|
|
1824
|
+
export interface UmaTokens {
|
|
1825
|
+
access_expires_at?: number;
|
|
1826
|
+
access_token?: string;
|
|
1827
|
+
pair_id?: string;
|
|
1828
|
+
refresh_expires_at?: number;
|
|
1829
|
+
refresh_token?: string;
|
|
1830
|
+
}
|
|
1831
|
+
export interface UmaUpdateAPIKeysDto {
|
|
1832
|
+
ac_same_as_for_user?: boolean;
|
|
1833
|
+
branches?: number[];
|
|
1834
|
+
firms?: UmaFirmInfo[];
|
|
1835
|
+
mfa_codes?: UmaMfaCodesDto;
|
|
1836
|
+
/** @maxLength 255 */
|
|
1837
|
+
name: string;
|
|
1838
|
+
permissions?: number[];
|
|
1839
|
+
roles?: number[];
|
|
1840
|
+
updated_at: string;
|
|
1841
|
+
}
|
|
1842
|
+
export interface UmaUpdateAuthAppDto {
|
|
1843
|
+
/** @maxLength 255 */
|
|
1844
|
+
name: string;
|
|
1845
|
+
status: UmaUpdateAuthAppDtoStatusEnum;
|
|
1846
|
+
}
|
|
1847
|
+
export interface UmaUpdateB2BUserDto {
|
|
1848
|
+
allow_feedback?: boolean;
|
|
1849
|
+
branches?: number[];
|
|
1850
|
+
/**
|
|
1851
|
+
* @maxLength 255
|
|
1852
|
+
* @example "test@gmail.com"
|
|
1853
|
+
*/
|
|
1854
|
+
email?: string;
|
|
1855
|
+
/** @minItems 1 */
|
|
1856
|
+
firms: UmaFirmInfo[];
|
|
1857
|
+
/** @maxLength 255 */
|
|
1858
|
+
first_name: string;
|
|
1859
|
+
has_access_to_all_firm_branches?: boolean;
|
|
1860
|
+
/** @maxLength 255 */
|
|
1861
|
+
last_name: string;
|
|
1862
|
+
/** @example "TeStPaSS" */
|
|
1863
|
+
password?: string;
|
|
1864
|
+
permissions?: number[];
|
|
1865
|
+
/**
|
|
1866
|
+
* @maxLength 255
|
|
1867
|
+
* @example "+1231231234"
|
|
1868
|
+
*/
|
|
1869
|
+
phone?: string;
|
|
1870
|
+
primary_firm_id?: number;
|
|
1871
|
+
rep_code?: string;
|
|
1872
|
+
/** @minItems 1 */
|
|
1873
|
+
roles: number[];
|
|
1874
|
+
should_reset_password?: boolean;
|
|
1875
|
+
updated_at: string;
|
|
1876
|
+
/** @maxLength 255 */
|
|
1877
|
+
username?: string;
|
|
1878
|
+
watchmen_user_links?: UmaWatchmenUserLinkDto[];
|
|
1879
|
+
}
|
|
1880
|
+
export interface UmaUpdateB2CUserDto {
|
|
1881
|
+
allow_feedback?: boolean;
|
|
1882
|
+
/** @minItems 1 */
|
|
1883
|
+
branches: number[];
|
|
1884
|
+
/**
|
|
1885
|
+
* @maxLength 255
|
|
1886
|
+
* @example "test@gmail.com"
|
|
1887
|
+
*/
|
|
1888
|
+
email?: string;
|
|
1889
|
+
/** @min 1 */
|
|
1890
|
+
firm_id: number;
|
|
1891
|
+
/** @maxLength 255 */
|
|
1892
|
+
first_name: string;
|
|
1893
|
+
/** @maxLength 255 */
|
|
1894
|
+
last_name: string;
|
|
1895
|
+
/**
|
|
1896
|
+
* @maxLength 100
|
|
1897
|
+
* @example "TeStPaSS"
|
|
1898
|
+
*/
|
|
1899
|
+
password?: string;
|
|
1900
|
+
permissions?: number[];
|
|
1901
|
+
/**
|
|
1902
|
+
* @maxLength 255
|
|
1903
|
+
* @example "+1231231234"
|
|
1904
|
+
*/
|
|
1905
|
+
phone?: string;
|
|
1906
|
+
/** @minItems 1 */
|
|
1907
|
+
roles: number[];
|
|
1908
|
+
updated_at: string;
|
|
1909
|
+
/** @maxLength 255 */
|
|
1910
|
+
username?: string;
|
|
1911
|
+
watchmen_user_links?: UmaWatchmenUserLinkDto[];
|
|
1912
|
+
}
|
|
1913
|
+
export interface UmaUpdateBranchDto {
|
|
1914
|
+
/** @maxLength 255 */
|
|
1915
|
+
code?: string;
|
|
1916
|
+
/** @maxLength 255 */
|
|
1917
|
+
name: string;
|
|
1918
|
+
retail_available_auth_app_options?: UmaAuthAppType[];
|
|
1919
|
+
retail_email_verification_required?: boolean;
|
|
1920
|
+
retail_login_enabled?: boolean;
|
|
1921
|
+
retail_mfa_enabling_required?: boolean;
|
|
1922
|
+
retail_phone_verification_required?: boolean;
|
|
1923
|
+
settings?: UmaTenantSettingDto[];
|
|
1924
|
+
/** @maxLength 255 */
|
|
1925
|
+
slug: string;
|
|
1926
|
+
updated_at: string;
|
|
1927
|
+
}
|
|
1928
|
+
export interface UmaUpdateEndpointDto {
|
|
1929
|
+
is_active?: boolean;
|
|
1930
|
+
is_public?: boolean;
|
|
1931
|
+
metadata?: UmaEndpointMetadataDto;
|
|
1932
|
+
method: UmaUpdateEndpointDtoMethodEnum;
|
|
1933
|
+
/** @min 1 */
|
|
1934
|
+
microservice_id: number;
|
|
1935
|
+
required_permissions?: number[];
|
|
1936
|
+
/** @maxLength 255 */
|
|
1937
|
+
route: string;
|
|
1938
|
+
type?: UmaUpdateEndpointDtoTypeEnum;
|
|
1939
|
+
updated_at: string;
|
|
1940
|
+
}
|
|
1941
|
+
export interface UmaUpdateFirmDto {
|
|
1942
|
+
allow_b2c_email_notifications?: boolean;
|
|
1943
|
+
firm_tags?: number[];
|
|
1944
|
+
mailgun_creds?: UmaFirmMailgunCredsDto;
|
|
1945
|
+
/** @maxLength 255 */
|
|
1946
|
+
name: string;
|
|
1947
|
+
/** @maxLength 255 */
|
|
1948
|
+
slug: string;
|
|
1949
|
+
status: UmaUpdateFirmDtoStatusEnum;
|
|
1950
|
+
twilio_creds?: UmaFirmTwilioCredsDto;
|
|
1951
|
+
updated_at: string;
|
|
1952
|
+
}
|
|
1953
|
+
export interface UmaUpdateIdentityProviderDto {
|
|
1954
|
+
/** @maxLength 1000 */
|
|
1955
|
+
auth_url: string;
|
|
1956
|
+
/** @maxLength 255 */
|
|
1957
|
+
client_id: string;
|
|
1958
|
+
/** @maxLength 255 */
|
|
1959
|
+
client_secret: string;
|
|
1960
|
+
/** @maxLength 1000 */
|
|
1961
|
+
company_domain: string;
|
|
1962
|
+
/** @min 1 */
|
|
1963
|
+
firm_id: number;
|
|
1964
|
+
/** @min 1 */
|
|
1965
|
+
priority: number;
|
|
1966
|
+
/** @maxLength 1000 */
|
|
1967
|
+
redirect_url?: string;
|
|
1968
|
+
type: UmaUpdateIdentityProviderDtoTypeEnum;
|
|
1969
|
+
updated_at: string;
|
|
1970
|
+
}
|
|
1971
|
+
export interface UmaUpdateMicroserviceDto {
|
|
1972
|
+
domains?: UmaMicroserviceDomainDto[];
|
|
1973
|
+
is_active?: boolean;
|
|
1974
|
+
is_visible_on_admin_sidebar?: boolean;
|
|
1975
|
+
/** @maxLength 1000 */
|
|
1976
|
+
logo_url?: string;
|
|
1977
|
+
/** @maxLength 255 */
|
|
1978
|
+
name: string;
|
|
1979
|
+
/** @maxLength 255 */
|
|
1980
|
+
slug: string;
|
|
1981
|
+
updated_at: string;
|
|
1982
|
+
}
|
|
1983
|
+
export interface UmaUpdatePermissionDto {
|
|
1984
|
+
metadata?: UmaPermissionMetadataDto;
|
|
1985
|
+
microservice_id?: number;
|
|
1986
|
+
/** @maxLength 1000 */
|
|
1987
|
+
permission: string;
|
|
1988
|
+
updated_at: string;
|
|
1989
|
+
}
|
|
1990
|
+
export interface UmaUpdateRoleDto {
|
|
1991
|
+
/** @maxLength 255 */
|
|
1992
|
+
name: string;
|
|
1993
|
+
/** @minItems 1 */
|
|
1994
|
+
permissions: number[];
|
|
1995
|
+
permissions_can_assign_role?: number[];
|
|
1996
|
+
/** @min 1 */
|
|
1997
|
+
type_id: number;
|
|
1998
|
+
updated_at: string;
|
|
1999
|
+
}
|
|
2000
|
+
export interface UmaUpdateRoleTypeDto {
|
|
2001
|
+
/** @maxLength 255 */
|
|
2002
|
+
color: string;
|
|
2003
|
+
/** @maxLength 255 */
|
|
2004
|
+
type: string;
|
|
2005
|
+
updated_at: string;
|
|
2006
|
+
}
|
|
2007
|
+
export interface UmaUpdateTagDto {
|
|
2008
|
+
name: string;
|
|
2009
|
+
updated_at: string;
|
|
2010
|
+
}
|
|
2011
|
+
export interface UmaUpdateWatchmenInstanceDto {
|
|
2012
|
+
/**
|
|
2013
|
+
* @minLength 1
|
|
2014
|
+
* @maxLength 255
|
|
2015
|
+
*/
|
|
2016
|
+
name: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* @minLength 1
|
|
2019
|
+
* @maxLength 255
|
|
2020
|
+
*/
|
|
2021
|
+
slug: string;
|
|
2022
|
+
updated_at: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* @minLength 1
|
|
2025
|
+
* @maxLength 1000
|
|
2026
|
+
*/
|
|
2027
|
+
url: string;
|
|
2028
|
+
}
|
|
2029
|
+
export interface UmaUpsertTablePresetDto {
|
|
2030
|
+
presets?: object;
|
|
2031
|
+
/** @maxLength 255 */
|
|
2032
|
+
table_name: string;
|
|
2033
|
+
}
|
|
2034
|
+
export interface UmaUpsertUserDto {
|
|
2035
|
+
branches: number[];
|
|
2036
|
+
/** @example "test@gmail.com" */
|
|
2037
|
+
email: string;
|
|
2038
|
+
firms: number[];
|
|
2039
|
+
first_name?: string;
|
|
2040
|
+
initiator_id?: number;
|
|
2041
|
+
last_name?: string;
|
|
2042
|
+
permissions: number[];
|
|
2043
|
+
/** @example "+1231231234" */
|
|
2044
|
+
phone?: string;
|
|
2045
|
+
rep_code?: string;
|
|
2046
|
+
roles: number[];
|
|
2047
|
+
type: UmaUpsertUserDtoTypeEnum;
|
|
2048
|
+
}
|
|
2049
|
+
export interface UmaUpsertUsersDto {
|
|
2050
|
+
/** @maxItems 100 */
|
|
2051
|
+
users: UmaUpsertUserDto[];
|
|
2052
|
+
}
|
|
2053
|
+
export interface UmaUserSerializer {
|
|
2054
|
+
allow_feedback: boolean;
|
|
2055
|
+
big_avatar_url: string;
|
|
2056
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
2057
|
+
created_at: string;
|
|
2058
|
+
/** @example true */
|
|
2059
|
+
do_not_ask_mfa_again: boolean;
|
|
2060
|
+
/** @example "test@email.com" */
|
|
2061
|
+
email: string;
|
|
2062
|
+
/** @example true */
|
|
2063
|
+
email_verified: boolean;
|
|
2064
|
+
/** @example "Mike" */
|
|
2065
|
+
first_name: string;
|
|
2066
|
+
/** @example 1 */
|
|
2067
|
+
id: number;
|
|
2068
|
+
initiator_id: number;
|
|
2069
|
+
/** @example "Jenkins" */
|
|
2070
|
+
last_name: string;
|
|
2071
|
+
locale: UmaLocaleSerializer;
|
|
2072
|
+
locale_id: number;
|
|
2073
|
+
/** @example true */
|
|
2074
|
+
mfa_enabled: boolean;
|
|
2075
|
+
/** @example "+123478844" */
|
|
2076
|
+
phone: string;
|
|
2077
|
+
/** @example true */
|
|
2078
|
+
phone_verified: boolean;
|
|
2079
|
+
rep_code: string;
|
|
2080
|
+
should_reset_password: boolean;
|
|
2081
|
+
small_avatar_url: string;
|
|
2082
|
+
/** @example "2022-02-02T00:00:00Z" */
|
|
2083
|
+
updated_at: string;
|
|
2084
|
+
username: string;
|
|
2085
|
+
}
|
|
2086
|
+
export interface UmaUserStatusChangeReasonSerializer {
|
|
2087
|
+
code: string;
|
|
2088
|
+
created_at: string;
|
|
2089
|
+
id: number;
|
|
2090
|
+
name: string;
|
|
2091
|
+
type: string;
|
|
2092
|
+
updated_at: string;
|
|
2093
|
+
}
|
|
2094
|
+
export interface UmaVerificationSettingsSerializer {
|
|
2095
|
+
expires_in_minutes: number;
|
|
2096
|
+
}
|
|
2097
|
+
export interface UmaVerifyContactDto {
|
|
2098
|
+
code: string;
|
|
2099
|
+
code_type: UmaVerifyContactDtoCodeTypeEnum;
|
|
2100
|
+
contact: string;
|
|
2101
|
+
}
|
|
2102
|
+
export interface UmaVerifyWatchmenAuthTokenDto {
|
|
2103
|
+
tmp_token: string;
|
|
2104
|
+
}
|
|
2105
|
+
export interface UmaWatchmenAuthTokenDetailsSerializer {
|
|
2106
|
+
expires_at: number;
|
|
2107
|
+
is_valid: boolean;
|
|
2108
|
+
token_id: string;
|
|
2109
|
+
watchmen_instance_id: number;
|
|
2110
|
+
watchmen_user_id: number;
|
|
2111
|
+
}
|
|
2112
|
+
export interface UmaWatchmenInstanceSerializer {
|
|
2113
|
+
created_at: string;
|
|
2114
|
+
id: number;
|
|
2115
|
+
name: string;
|
|
2116
|
+
slug: string;
|
|
2117
|
+
updated_at: string;
|
|
2118
|
+
url: string;
|
|
2119
|
+
}
|
|
2120
|
+
export interface UmaWatchmenUserLinkDto {
|
|
2121
|
+
/** @min 1 */
|
|
2122
|
+
branch_id: number;
|
|
2123
|
+
/** @min 1 */
|
|
2124
|
+
watchmen_instance_id: number;
|
|
2125
|
+
/** @min 1 */
|
|
2126
|
+
watchmen_user_id: number;
|
|
2127
|
+
}
|
|
2128
|
+
export interface UmaWatchmenUserLinkSerializer {
|
|
2129
|
+
branch: UmaBranchSerializer;
|
|
2130
|
+
branch_id: number;
|
|
2131
|
+
created_at: string;
|
|
2132
|
+
id: number;
|
|
2133
|
+
updated_at: string;
|
|
2134
|
+
watchmen_instance: UmaWatchmenInstanceSerializer;
|
|
2135
|
+
watchmen_instance_id: number;
|
|
2136
|
+
watchmen_user_id: number;
|
|
2137
|
+
}
|
|
2138
|
+
export interface UmaWebAuthnAssertionResponse {
|
|
2139
|
+
authenticator_data?: string;
|
|
2140
|
+
client_data_json?: string;
|
|
2141
|
+
signature?: string;
|
|
2142
|
+
user_handle?: string;
|
|
2143
|
+
}
|
|
2144
|
+
export interface UmaWebAuthnAttestationResponse {
|
|
2145
|
+
attestation_object?: string;
|
|
2146
|
+
client_data_json?: string;
|
|
2147
|
+
}
|
|
2148
|
+
export interface UmaWebAuthnAuthenticatorSelection {
|
|
2149
|
+
authenticator_attachment?: string;
|
|
2150
|
+
require_resident_key?: boolean;
|
|
2151
|
+
resident_key?: string;
|
|
2152
|
+
user_verification?: string;
|
|
2153
|
+
}
|
|
2154
|
+
export interface UmaWebAuthnCredentialAssertionSerializer {
|
|
2155
|
+
public_key: UmaWebAuthnPublicKeyCredentialAssertionSerializer;
|
|
2156
|
+
}
|
|
2157
|
+
export interface UmaWebAuthnCredentialCreationSerializer {
|
|
2158
|
+
public_key: UmaWebAuthnPublicKeyCredentialCreationSerializer;
|
|
2159
|
+
}
|
|
2160
|
+
export interface UmaWebAuthnCredentialDescriptor {
|
|
2161
|
+
id?: string;
|
|
2162
|
+
transports?: string[];
|
|
2163
|
+
type?: string;
|
|
2164
|
+
}
|
|
2165
|
+
export interface UmaWebAuthnCredentialParameterSerializer {
|
|
2166
|
+
alg: number;
|
|
2167
|
+
type: string;
|
|
2168
|
+
}
|
|
2169
|
+
export interface UmaWebAuthnLoginSolutionDto {
|
|
2170
|
+
client_extension_results?: object;
|
|
2171
|
+
id?: string;
|
|
2172
|
+
raw_id?: string;
|
|
2173
|
+
response?: UmaWebAuthnAssertionResponse;
|
|
2174
|
+
type?: string;
|
|
2175
|
+
}
|
|
2176
|
+
export interface UmaWebAuthnPublicKeyCredentialAssertionSerializer {
|
|
2177
|
+
allow_credentials: UmaWebAuthnCredentialDescriptor[];
|
|
2178
|
+
challenge: string;
|
|
2179
|
+
extensions: object;
|
|
2180
|
+
rp_id: string;
|
|
2181
|
+
timeout: number;
|
|
2182
|
+
user_verification: string;
|
|
2183
|
+
}
|
|
2184
|
+
export interface UmaWebAuthnPublicKeyCredentialCreationSerializer {
|
|
2185
|
+
attestation: string;
|
|
2186
|
+
authenticator_selection: UmaWebAuthnAuthenticatorSelection;
|
|
2187
|
+
challenge: string;
|
|
2188
|
+
exclude_credentials: UmaWebAuthnCredentialDescriptor[];
|
|
2189
|
+
extensions: object;
|
|
2190
|
+
pub_key_cred_params: UmaWebAuthnCredentialParameterSerializer[];
|
|
2191
|
+
rp: UmaWebAuthnRelyingPartyEntitySerializer;
|
|
2192
|
+
timeout: number;
|
|
2193
|
+
user: UmaWebAuthnUserEntitySerializer;
|
|
2194
|
+
}
|
|
2195
|
+
export interface UmaWebAuthnRegistrationSolutionDto {
|
|
2196
|
+
client_extension_results?: object;
|
|
2197
|
+
id?: string;
|
|
2198
|
+
/** @maxLength 255 */
|
|
2199
|
+
name: string;
|
|
2200
|
+
raw_id?: string;
|
|
2201
|
+
response?: UmaWebAuthnAttestationResponse;
|
|
2202
|
+
type?: string;
|
|
2203
|
+
}
|
|
2204
|
+
export interface UmaWebAuthnRelyingPartyEntitySerializer {
|
|
2205
|
+
icon: string;
|
|
2206
|
+
id: string;
|
|
2207
|
+
name: string;
|
|
2208
|
+
}
|
|
2209
|
+
export interface UmaWebAuthnUserEntitySerializer {
|
|
2210
|
+
display_name: string;
|
|
2211
|
+
icon: string;
|
|
2212
|
+
id: any;
|
|
2213
|
+
name: string;
|
|
2214
|
+
}
|
|
2215
|
+
export interface UmaGetUserDetailsSerializer {
|
|
2216
|
+
b2b_user: UmaAdminUserSerializer;
|
|
2217
|
+
b2c_user: UmaAdminB2CUserSerializer;
|
|
2218
|
+
status: number;
|
|
2219
|
+
}
|
|
2220
|
+
export interface UmaGetUserStatusChangeReasonsListSerializer {
|
|
2221
|
+
current_page: number;
|
|
2222
|
+
pages_count: number;
|
|
2223
|
+
reasons_list: UmaUserStatusChangeReasonSerializer[];
|
|
2224
|
+
status: number;
|
|
2225
|
+
total_records: number;
|
|
2226
|
+
}
|
|
2227
|
+
export interface UmaGetUsersListSerializerTypesAdminB2BUserSerializer {
|
|
2228
|
+
current_page: number;
|
|
2229
|
+
pages_count: number;
|
|
2230
|
+
status: number;
|
|
2231
|
+
total_records: number;
|
|
2232
|
+
users_list: UmaAdminB2BUserSerializer[];
|
|
2233
|
+
}
|
|
2234
|
+
export interface UmaGetUsersListSerializerTypesAdminB2CUserSerializer {
|
|
2235
|
+
current_page: number;
|
|
2236
|
+
pages_count: number;
|
|
2237
|
+
status: number;
|
|
2238
|
+
total_records: number;
|
|
2239
|
+
users_list: UmaAdminB2CUserSerializer[];
|
|
2240
|
+
}
|
|
2241
|
+
export interface UmaTokenDetailsResponseSerializer {
|
|
2242
|
+
data: UmaWatchmenAuthTokenDetailsSerializer;
|
|
2243
|
+
status: number;
|
|
2244
|
+
}
|
|
2245
|
+
export interface UmaTokenGenerationResponseSerializer {
|
|
2246
|
+
data: UmaGeneratedWatchmenTokenInfoSerializer;
|
|
2247
|
+
status: number;
|
|
2248
|
+
}
|
|
2249
|
+
export interface UmaGetWatchmenInstancesListSerializer {
|
|
2250
|
+
current_page: number;
|
|
2251
|
+
pages_count: number;
|
|
2252
|
+
status: number;
|
|
2253
|
+
total_records: number;
|
|
2254
|
+
watchmen_instances_list: UmaWatchmenInstanceSerializer[];
|
|
2255
|
+
}
|
|
2256
|
+
export interface UmaWatchmenInstanceMutationSerializer {
|
|
2257
|
+
status: number;
|
|
2258
|
+
watchmen_instance: UmaWatchmenInstanceSerializer;
|
|
2259
|
+
}
|
|
2260
|
+
export enum UmaAuthFormDtoResetPasswordTypeEnum {
|
|
2261
|
+
ByContactCode = "by_contact_code",
|
|
2262
|
+
ByEmailLink = "by_email_link"
|
|
2263
|
+
}
|
|
2264
|
+
export enum UmaAuthFormSerializerResetPasswordTypeEnum {
|
|
2265
|
+
ByContactCode = "by_contact_code",
|
|
2266
|
+
ByEmailLink = "by_email_link"
|
|
2267
|
+
}
|
|
2268
|
+
export enum UmaB2BSendContactChangeCodeDtoTypeEnum {
|
|
2269
|
+
Email = "email",
|
|
2270
|
+
Voice = "voice",
|
|
2271
|
+
Sms = "sms"
|
|
2272
|
+
}
|
|
2273
|
+
export enum UmaB2CResetPasswordDtoResetTypeEnum {
|
|
2274
|
+
ByContactCode = "by_contact_code",
|
|
2275
|
+
ByEmailLink = "by_email_link"
|
|
2276
|
+
}
|
|
2277
|
+
export enum UmaB2CSendContactChangeCodeDtoTypeEnum {
|
|
2278
|
+
Email = "email",
|
|
2279
|
+
Voice = "voice",
|
|
2280
|
+
Sms = "sms"
|
|
2281
|
+
}
|
|
2282
|
+
export enum UmaB2CSendVerificationCodeDtoCodeTypeEnum {
|
|
2283
|
+
Email = "email",
|
|
2284
|
+
Voice = "voice",
|
|
2285
|
+
Sms = "sms"
|
|
2286
|
+
}
|
|
2287
|
+
export enum UmaCreateEndpointDtoMethodEnum {
|
|
2288
|
+
POST = "POST",
|
|
2289
|
+
PUT = "PUT",
|
|
2290
|
+
DELETE = "DELETE",
|
|
2291
|
+
GET = "GET",
|
|
2292
|
+
PATCH = "PATCH",
|
|
2293
|
+
ALL = "ALL"
|
|
2294
|
+
}
|
|
2295
|
+
export enum UmaCreateEndpointDtoTypeEnum {
|
|
2296
|
+
Regular = "regular",
|
|
2297
|
+
DisplayOnly = "display_only"
|
|
2298
|
+
}
|
|
2299
|
+
export enum UmaCreateIdentityProviderDtoTypeEnum {
|
|
2300
|
+
Okta = "okta"
|
|
2301
|
+
}
|
|
2302
|
+
export enum UmaCreatePermissionDtoAssignmentGroupEnum {
|
|
2303
|
+
Regular = "regular",
|
|
2304
|
+
Superadmin = "superadmin",
|
|
2305
|
+
B2BOnly = "b2b_only"
|
|
2306
|
+
}
|
|
2307
|
+
export enum UmaCreateRoleDtoAssignmentGroupEnum {
|
|
2308
|
+
Regular = "regular",
|
|
2309
|
+
Superadmin = "superadmin",
|
|
2310
|
+
B2BOnly = "b2b_only"
|
|
2311
|
+
}
|
|
2312
|
+
export enum UmaCreateSecretNoteDtoTypeEnum {
|
|
2313
|
+
Password = "password"
|
|
2314
|
+
}
|
|
2315
|
+
export enum UmaEndpointMetadataDtoUserTypeEnum {
|
|
2316
|
+
B2B = "b2b",
|
|
2317
|
+
B2C = "b2c"
|
|
2318
|
+
}
|
|
2319
|
+
export enum UmaEndpointSerializerMethodEnum {
|
|
2320
|
+
POST = "POST",
|
|
2321
|
+
PUT = "PUT",
|
|
2322
|
+
DELETE = "DELETE",
|
|
2323
|
+
GET = "GET",
|
|
2324
|
+
PATCH = "PATCH",
|
|
2325
|
+
ALL = "ALL"
|
|
2326
|
+
}
|
|
2327
|
+
export enum UmaGetB2CUsersListFiltersDtoShowOnlyEnum {
|
|
2328
|
+
Admin = "admin",
|
|
2329
|
+
BranchAdmin = "branch_admin",
|
|
2330
|
+
Compliance = "compliance"
|
|
2331
|
+
}
|
|
2332
|
+
export enum UmaGetFirmsListFiltersDtoStatusesEnum {
|
|
2333
|
+
InProgress = "in_progress",
|
|
2334
|
+
Active = "active",
|
|
2335
|
+
Suspended = "suspended",
|
|
2336
|
+
Deleted = "deleted"
|
|
2337
|
+
}
|
|
2338
|
+
export enum UmaGetIdentityProvidersListFiltersDtoTypesEnum {
|
|
2339
|
+
Okta = "okta"
|
|
2340
|
+
}
|
|
2341
|
+
export enum UmaGetUsersListFiltersDtoShowOnlyEnum {
|
|
2342
|
+
Admin = "admin",
|
|
2343
|
+
BranchAdmin = "branch_admin",
|
|
2344
|
+
Compliance = "compliance"
|
|
2345
|
+
}
|
|
2346
|
+
export enum UmaGetWebAuthnLoginChallengeDtoUserTypeEnum {
|
|
2347
|
+
B2B = "b2b",
|
|
2348
|
+
B2C = "b2c"
|
|
2349
|
+
}
|
|
2350
|
+
export enum UmaIdentityProviderSerializerTypeEnum {
|
|
2351
|
+
Okta = "okta"
|
|
2352
|
+
}
|
|
2353
|
+
export enum UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum {
|
|
2354
|
+
B2B = "b2b",
|
|
2355
|
+
B2C = "b2c"
|
|
2356
|
+
}
|
|
2357
|
+
export enum UmaPermissionSerializerAssignmentGroupEnum {
|
|
2358
|
+
Regular = "regular",
|
|
2359
|
+
Chiefadmin = "chiefadmin",
|
|
2360
|
+
Superadmin = "superadmin"
|
|
2361
|
+
}
|
|
2362
|
+
export enum UmaRevokeUserSessionsDtoUserTypeEnum {
|
|
2363
|
+
B2B = "b2b",
|
|
2364
|
+
B2C = "b2c"
|
|
2365
|
+
}
|
|
2366
|
+
export enum UmaSecretNoteSerializerTypeEnum {
|
|
2367
|
+
Password = "password"
|
|
2368
|
+
}
|
|
2369
|
+
export enum UmaSendB2BMfaCodeDtoTypeEnum {
|
|
2370
|
+
Email = "email",
|
|
2371
|
+
Voice = "voice",
|
|
2372
|
+
Sms = "sms"
|
|
2373
|
+
}
|
|
2374
|
+
export enum UmaSendB2CMfaCodeDtoTypeEnum {
|
|
2375
|
+
Email = "email",
|
|
2376
|
+
Voice = "voice",
|
|
2377
|
+
Sms = "sms"
|
|
2378
|
+
}
|
|
2379
|
+
export enum UmaSendB2CResetPasswordCodeDtoCodeTypeEnum {
|
|
2380
|
+
Email = "email",
|
|
2381
|
+
Voice = "voice",
|
|
2382
|
+
Sms = "sms"
|
|
2383
|
+
}
|
|
2384
|
+
export enum UmaSendB2CResetPasswordCodeDtoResetTypeEnum {
|
|
2385
|
+
ByContactCode = "by_contact_code",
|
|
2386
|
+
ByEmailLink = "by_email_link"
|
|
2387
|
+
}
|
|
2388
|
+
export enum UmaSendResetPasswordCodeDtoTypeEnum {
|
|
2389
|
+
Email = "email",
|
|
2390
|
+
Voice = "voice",
|
|
2391
|
+
Sms = "sms"
|
|
2392
|
+
}
|
|
2393
|
+
export enum UmaTenantSettingDtoLabelEnum {
|
|
2394
|
+
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
2395
|
+
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
2396
|
+
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
2397
|
+
}
|
|
2398
|
+
export enum UmaUpdateAuthAppDtoStatusEnum {
|
|
2399
|
+
Active = "active",
|
|
2400
|
+
Disabled = "disabled"
|
|
2401
|
+
}
|
|
2402
|
+
export enum UmaUpdateEndpointDtoMethodEnum {
|
|
2403
|
+
POST = "POST",
|
|
2404
|
+
PUT = "PUT",
|
|
2405
|
+
DELETE = "DELETE",
|
|
2406
|
+
GET = "GET",
|
|
2407
|
+
PATCH = "PATCH",
|
|
2408
|
+
ALL = "ALL"
|
|
2409
|
+
}
|
|
2410
|
+
export enum UmaUpdateEndpointDtoTypeEnum {
|
|
2411
|
+
Regular = "regular",
|
|
2412
|
+
DisplayOnly = "display_only"
|
|
2413
|
+
}
|
|
2414
|
+
export enum UmaUpdateFirmDtoStatusEnum {
|
|
2415
|
+
InProgress = "in_progress",
|
|
2416
|
+
Active = "active",
|
|
2417
|
+
Suspended = "suspended",
|
|
2418
|
+
Deleted = "deleted"
|
|
2419
|
+
}
|
|
2420
|
+
export enum UmaUpdateIdentityProviderDtoTypeEnum {
|
|
2421
|
+
Okta = "okta"
|
|
2422
|
+
}
|
|
2423
|
+
export enum UmaUpsertUserDtoTypeEnum {
|
|
2424
|
+
B2B = "b2b",
|
|
2425
|
+
B2C = "b2c"
|
|
2426
|
+
}
|
|
2427
|
+
export enum UmaVerifyContactDtoCodeTypeEnum {
|
|
2428
|
+
Email = "email",
|
|
2429
|
+
Voice = "voice",
|
|
2430
|
+
Sms = "sms"
|
|
2431
|
+
}
|
|
2432
|
+
export class ActionLogs<HandleError extends boolean = boolean> {
|
|
2433
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2434
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Get Action logs list
|
|
2437
|
+
* @tags action_logs
|
|
2438
|
+
* @name GetActionLogs
|
|
2439
|
+
* @summary Get Action logs list
|
|
2440
|
+
* @request POST:/v1/action-logs/list
|
|
2441
|
+
* @secure
|
|
2442
|
+
*/
|
|
2443
|
+
getActionLogs(getActionLogsDto: UmaGetActionLogsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetActionLogsSerializer, HandleError>>;
|
|
2444
|
+
}
|
|
2445
|
+
export class B2BAuth<HandleError extends boolean = boolean> {
|
|
2446
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2447
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2448
|
+
/**
|
|
2449
|
+
* @description Get current B2B user info by access token.
|
|
2450
|
+
* @tags b2b_auth
|
|
2451
|
+
* @name GetCurrent
|
|
2452
|
+
* @summary Get current B2B user info by access token
|
|
2453
|
+
* @request GET:/v1/auth/b2b/current
|
|
2454
|
+
* @secure
|
|
2455
|
+
*/
|
|
2456
|
+
getCurrent(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetCurrentB2BUserSerializer, HandleError>>;
|
|
2457
|
+
/**
|
|
2458
|
+
* @description Login B2B user by API Keys
|
|
2459
|
+
* @tags b2b_auth
|
|
2460
|
+
* @name ApiKeysLogin
|
|
2461
|
+
* @summary Login B2B user by API Keys
|
|
2462
|
+
* @request POST:/v1/auth/b2b/login/api-keys
|
|
2463
|
+
*/
|
|
2464
|
+
apiKeysLogin(apiKeysLoginParams: UmaAPIKeysB2BLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSimpleB2BLoginSerializer, HandleError>>;
|
|
2465
|
+
/**
|
|
2466
|
+
* @description Login B2B user by email/password.
|
|
2467
|
+
* @tags b2b_auth
|
|
2468
|
+
* @name BasicLogin
|
|
2469
|
+
* @summary Login B2B user by email/password
|
|
2470
|
+
* @request POST:/v1/auth/b2b/login/basic
|
|
2471
|
+
*/
|
|
2472
|
+
basicLogin(basicLoginParams: UmaBasicB2BLoginDto, headers?: {
|
|
2473
|
+
/** Run endpoint in debug mode */
|
|
2474
|
+
'Debug-Token'?: string;
|
|
2475
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
|
|
2476
|
+
/**
|
|
2477
|
+
* @description logout from B2B user session
|
|
2478
|
+
* @tags b2b_auth
|
|
2479
|
+
* @name Logout
|
|
2480
|
+
* @summary logout from B2B user session
|
|
2481
|
+
* @request DELETE:/v1/auth/b2b/logout
|
|
2482
|
+
*/
|
|
2483
|
+
logout(B2BLogoutParams: UmaLogoutDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2484
|
+
/**
|
|
2485
|
+
* @description Refresh B2B user token pair
|
|
2486
|
+
* @tags b2b_auth
|
|
2487
|
+
* @name RefreshTokens
|
|
2488
|
+
* @summary Refresh B2B user token pair
|
|
2489
|
+
* @request POST:/v1/auth/b2b/refresh
|
|
2490
|
+
*/
|
|
2491
|
+
refreshTokens(B2BRefreshParams: UmaRefreshDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
|
|
2492
|
+
/**
|
|
2493
|
+
* @description Reset B2B user password
|
|
2494
|
+
* @tags b2b_auth
|
|
2495
|
+
* @name ResetPassword
|
|
2496
|
+
* @summary Reset B2B user password
|
|
2497
|
+
* @request PUT:/v1/auth/b2b/reset-password
|
|
2498
|
+
*/
|
|
2499
|
+
resetPassword(B2BResetPasswordParams: UmaB2BResetPasswordDto, headers?: {
|
|
2500
|
+
/** Run endpoint in debug mode */
|
|
2501
|
+
'Debug-Token'?: string;
|
|
2502
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSimpleB2BLoginSerializer, HandleError>>;
|
|
2503
|
+
/**
|
|
2504
|
+
* @description Send MFA code for B2B user
|
|
2505
|
+
* @tags b2b_auth
|
|
2506
|
+
* @name SendMfaCode
|
|
2507
|
+
* @summary Send MFA code for B2B user
|
|
2508
|
+
* @request PUT:/v1/auth/b2b/send-mfa-code
|
|
2509
|
+
*/
|
|
2510
|
+
sendMfaCode(SendB2BMfaCodeDto: UmaSendB2BMfaCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2511
|
+
/**
|
|
2512
|
+
* @description Send reset password code for B2B user
|
|
2513
|
+
* @tags b2b_auth
|
|
2514
|
+
* @name SendResetPasswordCode
|
|
2515
|
+
* @summary Send reset password code for B2B user
|
|
2516
|
+
* @request PUT:/v1/auth/b2b/send-reset-password-code
|
|
2517
|
+
*/
|
|
2518
|
+
sendResetPasswordCode(B2BSendResetPasswordCodeParams: UmaSendResetPasswordCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2519
|
+
}
|
|
2520
|
+
export class B2CAuth<HandleError extends boolean = boolean> {
|
|
2521
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2522
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2523
|
+
/**
|
|
2524
|
+
* @description Get current B2C user info by access token.
|
|
2525
|
+
* @tags b2c_auth
|
|
2526
|
+
* @name GetCurrent
|
|
2527
|
+
* @summary Get current B2C user info by access token
|
|
2528
|
+
* @request GET:/v1/auth/b2c/current
|
|
2529
|
+
* @secure
|
|
2530
|
+
*/
|
|
2531
|
+
getCurrent(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetCurrentB2CUserSerializer, HandleError>>;
|
|
2532
|
+
/**
|
|
2533
|
+
* @description Initialize Apple OAuth2 Login
|
|
2534
|
+
* @tags b2c_auth
|
|
2535
|
+
* @name InitAppleLogin
|
|
2536
|
+
* @summary Initialize Apple OAuth2 Login
|
|
2537
|
+
* @request POST:/v1/auth/b2c/login/apple
|
|
2538
|
+
*/
|
|
2539
|
+
initAppleLogin(initOAuthLoginDto: UmaInitOAuthLoginDto, headers?: {
|
|
2540
|
+
/** Branch id/slug/code, with which user should work */
|
|
2541
|
+
BRANCH?: string;
|
|
2542
|
+
/** Firm id/slug, with which user should work */
|
|
2543
|
+
FIRM?: string;
|
|
2544
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CInitOAuthResponse, HandleError>>;
|
|
2545
|
+
/**
|
|
2546
|
+
* @description Finish Apple OAuth2 Login
|
|
2547
|
+
* @tags b2c_auth
|
|
2548
|
+
* @name FinishAppleLogin
|
|
2549
|
+
* @summary Finish Apple OAuth2 Login
|
|
2550
|
+
* @request POST:/v1/auth/b2c/login/apple/callback
|
|
2551
|
+
*/
|
|
2552
|
+
finishAppleLogin(finishOAuthLoginDto: UmaFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
|
|
2553
|
+
/**
|
|
2554
|
+
* @description Login B2C user by email/password.
|
|
2555
|
+
* @tags b2c_auth
|
|
2556
|
+
* @name BasicLogin
|
|
2557
|
+
* @summary Login B2C user by email/password
|
|
2558
|
+
* @request POST:/v1/auth/b2c/login/basic
|
|
2559
|
+
*/
|
|
2560
|
+
basicLogin(basicLoginParams: UmaBasicB2CLoginDto, headers?: {
|
|
2561
|
+
/** Branch id/slug/code, with which user should work */
|
|
2562
|
+
BRANCH?: string;
|
|
2563
|
+
/** Firm id/slug, with which user should work */
|
|
2564
|
+
FIRM?: string;
|
|
2565
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
|
|
2566
|
+
/**
|
|
2567
|
+
* @description Initialize Google OAuth2 Login
|
|
2568
|
+
* @tags b2c_auth
|
|
2569
|
+
* @name InitGoogleLogin
|
|
2570
|
+
* @summary Initialize Google OAuth2 Login
|
|
2571
|
+
* @request POST:/v1/auth/b2c/login/google
|
|
2572
|
+
*/
|
|
2573
|
+
initGoogleLogin(initOAuthLoginDto: UmaInitOAuthLoginDto, headers?: {
|
|
2574
|
+
/** Branch id/slug/code, with which user should work */
|
|
2575
|
+
BRANCH?: string;
|
|
2576
|
+
/** Firm id/slug, with which user should work */
|
|
2577
|
+
FIRM?: string;
|
|
2578
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CInitOAuthResponse, HandleError>>;
|
|
2579
|
+
/**
|
|
2580
|
+
* @description Finish Google OAuth2 Login
|
|
2581
|
+
* @tags b2c_auth
|
|
2582
|
+
* @name FinishGoogleLogin
|
|
2583
|
+
* @summary Finish Google OAuth2 Login
|
|
2584
|
+
* @request POST:/v1/auth/b2c/login/google/callback
|
|
2585
|
+
*/
|
|
2586
|
+
finishGoogleLogin(finishOAuthLoginDto: UmaFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
|
|
2587
|
+
/**
|
|
2588
|
+
* @description logout from B2C user session
|
|
2589
|
+
* @tags b2c_auth
|
|
2590
|
+
* @name Logout
|
|
2591
|
+
* @summary logout from B2C user session
|
|
2592
|
+
* @request DELETE:/v1/auth/b2c/logout
|
|
2593
|
+
*/
|
|
2594
|
+
logout(B2CLogoutParams: UmaLogoutDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2595
|
+
/**
|
|
2596
|
+
* @description Refresh B2C user token pair
|
|
2597
|
+
* @tags b2c_auth
|
|
2598
|
+
* @name RefreshTokens
|
|
2599
|
+
* @summary Refresh B2C user token pair
|
|
2600
|
+
* @request POST:/v1/auth/b2c/refresh
|
|
2601
|
+
*/
|
|
2602
|
+
refreshTokens(b2cRefreshDto: UmaB2CRefreshDto, headers?: {
|
|
2603
|
+
/**
|
|
2604
|
+
* token
|
|
2605
|
+
* @default "refresh_token=xxx"
|
|
2606
|
+
*/
|
|
2607
|
+
Cookie?: string;
|
|
2608
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRefreshResultSerializer, HandleError>>;
|
|
2609
|
+
/**
|
|
2610
|
+
* @description Register new B2C user. This endpoint should be used for Web GUI only
|
|
2611
|
+
* @tags b2c_auth
|
|
2612
|
+
* @name Register
|
|
2613
|
+
* @summary Register new B2C user
|
|
2614
|
+
* @request POST:/v1/auth/b2c/register
|
|
2615
|
+
*/
|
|
2616
|
+
register(registrationParams: UmaRegisterDto, headers?: {
|
|
2617
|
+
/** Branch id/slug/code, with which user should work */
|
|
2618
|
+
BRANCH?: string;
|
|
2619
|
+
/** Firm id/slug, with which user should work */
|
|
2620
|
+
FIRM?: string;
|
|
2621
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRegisterSerializer, HandleError>>;
|
|
2622
|
+
/**
|
|
2623
|
+
* @description Reset B2C user password
|
|
2624
|
+
* @tags b2c_auth
|
|
2625
|
+
* @name ResetPassword
|
|
2626
|
+
* @summary Reset B2C user password
|
|
2627
|
+
* @request PUT:/v1/auth/b2c/reset-password
|
|
2628
|
+
*/
|
|
2629
|
+
resetPassword(B2CResetPasswordParams: UmaB2CResetPasswordDto, headers?: {
|
|
2630
|
+
/** Run endpoint in debug mode */
|
|
2631
|
+
'Debug-Token'?: string;
|
|
2632
|
+
/** Branch id/slug/code, with which user should work */
|
|
2633
|
+
BRANCH?: string;
|
|
2634
|
+
/** Firm id/slug, with which user should work */
|
|
2635
|
+
FIRM?: string;
|
|
2636
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2637
|
+
/**
|
|
2638
|
+
* @description Send MFA code for B2C user
|
|
2639
|
+
* @tags b2c_auth
|
|
2640
|
+
* @name SendMfaCode
|
|
2641
|
+
* @summary Send MFA code for B2C user
|
|
2642
|
+
* @request PUT:/v1/auth/b2c/send-mfa-code
|
|
2643
|
+
*/
|
|
2644
|
+
sendMfaCode(SendB2CMfaCodeDto: UmaSendB2CMfaCodeDto, headers?: {
|
|
2645
|
+
/** Branch id/slug/code, with which user should work */
|
|
2646
|
+
BRANCH?: string;
|
|
2647
|
+
/** Firm id/slug, with which user should work */
|
|
2648
|
+
FIRM?: string;
|
|
2649
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2650
|
+
/**
|
|
2651
|
+
* @description Send reset password code for B2C user
|
|
2652
|
+
* @tags b2c_auth
|
|
2653
|
+
* @name SendResetPasswordCode
|
|
2654
|
+
* @summary Send reset password code for B2C user
|
|
2655
|
+
* @request PUT:/v1/auth/b2c/send-reset-password-code
|
|
2656
|
+
*/
|
|
2657
|
+
sendResetPasswordCode(B2CSendResetPasswordCodeParams: UmaSendB2CResetPasswordCodeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2658
|
+
/**
|
|
2659
|
+
* @description Send verification code for B2C user
|
|
2660
|
+
* @tags b2c_auth
|
|
2661
|
+
* @name SendVerificationCode
|
|
2662
|
+
* @summary Send verification code for B2C user
|
|
2663
|
+
* @request PUT:/v1/auth/b2c/send-verification-code
|
|
2664
|
+
*/
|
|
2665
|
+
sendVerificationCode(B2CSendVerificationCodeDto: UmaB2CSendVerificationCodeDto, headers?: {
|
|
2666
|
+
/** Branch id/slug/code, with which user should work */
|
|
2667
|
+
BRANCH?: string;
|
|
2668
|
+
/** Firm id/slug, with which user should work */
|
|
2669
|
+
FIRM?: string;
|
|
2670
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2671
|
+
/**
|
|
2672
|
+
* @description Verify contact for B2C user
|
|
2673
|
+
* @tags b2c_auth
|
|
2674
|
+
* @name VerifyContact
|
|
2675
|
+
* @summary Verify contact for B2C user
|
|
2676
|
+
* @request PUT:/v1/auth/b2c/verify
|
|
2677
|
+
*/
|
|
2678
|
+
verifyContact(VerifyContactDto: UmaVerifyContactDto, headers?: {
|
|
2679
|
+
/** Branch id/slug/code, with which user should work */
|
|
2680
|
+
BRANCH?: string;
|
|
2681
|
+
/** Firm id/slug, with which user should work */
|
|
2682
|
+
FIRM?: string;
|
|
2683
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2684
|
+
}
|
|
2685
|
+
export class Sessions<HandleError extends boolean = boolean> {
|
|
2686
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2687
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2688
|
+
/**
|
|
2689
|
+
* @description et current user sessions info
|
|
2690
|
+
* @tags sessions
|
|
2691
|
+
* @name GetCurrentUserSessions
|
|
2692
|
+
* @summary Get current user sessions info
|
|
2693
|
+
* @request GET:/v1/auth/sessions
|
|
2694
|
+
* @secure
|
|
2695
|
+
*/
|
|
2696
|
+
getCurrentUserSessions(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetSessionsListSerializer, HandleError>>;
|
|
2697
|
+
/**
|
|
2698
|
+
* @description Delete current user sessions by pair id's
|
|
2699
|
+
* @tags sessions
|
|
2700
|
+
* @name DeleteCurrentUserSessions
|
|
2701
|
+
* @summary Delete current user sessions by pair id's
|
|
2702
|
+
* @request DELETE:/v1/auth/sessions
|
|
2703
|
+
* @secure
|
|
2704
|
+
*/
|
|
2705
|
+
deleteCurrentUserSessions(deleteSessions: UmaDeleteSessionsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2706
|
+
}
|
|
2707
|
+
export class WatchmenAuth<HandleError extends boolean = boolean> {
|
|
2708
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2709
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2710
|
+
/**
|
|
2711
|
+
* @description Generate Watchmen Auth Token
|
|
2712
|
+
* @tags watchmen_auth
|
|
2713
|
+
* @name GenerateWatchmenAuthToken
|
|
2714
|
+
* @summary Generate Watchmen Auth Token
|
|
2715
|
+
* @request POST:/v1/auth/watchmen/authentication-tokens
|
|
2716
|
+
* @secure
|
|
2717
|
+
*/
|
|
2718
|
+
generateWatchmenAuthToken(generateWatchmenAuthTokenDto: UmaGenerateWatchmenAuthTokenDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTokenGenerationResponseSerializer, HandleError>>;
|
|
2719
|
+
/**
|
|
2720
|
+
* @description Verify Watchmen Auth Token
|
|
2721
|
+
* @tags watchmen_auth
|
|
2722
|
+
* @name VerifyWatchmenAuthToken
|
|
2723
|
+
* @summary Verify Watchmen Auth Token
|
|
2724
|
+
* @request PUT:/v1/auth/watchmen/authentication-tokens/verify
|
|
2725
|
+
* @secure
|
|
2726
|
+
*/
|
|
2727
|
+
verifyWatchmenAuthToken(verifyWatchmenAuthToken: UmaVerifyWatchmenAuthTokenDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTokenDetailsResponseSerializer, HandleError>>;
|
|
2728
|
+
}
|
|
2729
|
+
export class AuthForms<HandleError extends boolean = boolean> {
|
|
2730
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2731
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2732
|
+
/**
|
|
2733
|
+
* @description Create Auth Form
|
|
2734
|
+
* @tags auth_forms
|
|
2735
|
+
* @name Create
|
|
2736
|
+
* @summary Create Auth Form
|
|
2737
|
+
* @request POST:/v1/auth-forms
|
|
2738
|
+
* @secure
|
|
2739
|
+
*/
|
|
2740
|
+
create(authFormDto: UmaAuthFormDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthFormMutationSerializer, HandleError>>;
|
|
2741
|
+
/**
|
|
2742
|
+
* @description Delete Auth Forms by ids
|
|
2743
|
+
* @tags auth_forms
|
|
2744
|
+
* @name DeleteMany
|
|
2745
|
+
* @summary Delete Auth Forms by ids
|
|
2746
|
+
* @request DELETE:/v1/auth-forms
|
|
2747
|
+
* @secure
|
|
2748
|
+
*/
|
|
2749
|
+
deleteMany(deleteAuthFormsDto: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2750
|
+
/**
|
|
2751
|
+
* @description Get Auth Forms with pagination. Available sort fields are `id, branch_id, slug, created_at, updated_at`. Search is performed by slug field
|
|
2752
|
+
* @tags auth_forms
|
|
2753
|
+
* @name Get
|
|
2754
|
+
* @summary Get Auth Forms with pagination
|
|
2755
|
+
* @request POST:/v1/auth-forms/list
|
|
2756
|
+
* @secure
|
|
2757
|
+
*/
|
|
2758
|
+
get(getAuthFormListDto: UmaGetAuthFormsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAuthFormsListSerializer, HandleError>>;
|
|
2759
|
+
/**
|
|
2760
|
+
* @description Get Auth Forms by slug
|
|
2761
|
+
* @tags auth_forms
|
|
2762
|
+
* @name GetBySlug
|
|
2763
|
+
* @summary Get Auth Forms by slug
|
|
2764
|
+
* @request GET:/v1/auth-forms/public/{slug}
|
|
2765
|
+
*/
|
|
2766
|
+
getBySlug(slug: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthFormMutationSerializer, HandleError>>;
|
|
2767
|
+
/**
|
|
2768
|
+
* @description Get Auth Forms by id
|
|
2769
|
+
* @tags auth_forms
|
|
2770
|
+
* @name GetById
|
|
2771
|
+
* @summary Get Auth Forms by id
|
|
2772
|
+
* @request GET:/v1/auth-forms/{id}
|
|
2773
|
+
* @secure
|
|
2774
|
+
*/
|
|
2775
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthFormMutationSerializer, HandleError>>;
|
|
2776
|
+
/**
|
|
2777
|
+
* @description Update Auth Form record
|
|
2778
|
+
* @tags auth_forms
|
|
2779
|
+
* @name Update
|
|
2780
|
+
* @summary Update Auth Form record
|
|
2781
|
+
* @request PUT:/v1/auth-forms/{id}
|
|
2782
|
+
* @secure
|
|
2783
|
+
*/
|
|
2784
|
+
update(id: number, authFormDto: UmaAuthFormDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthFormMutationSerializer, HandleError>>;
|
|
2785
|
+
}
|
|
2786
|
+
export class ApiKeys<HandleError extends boolean = boolean> {
|
|
2787
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2788
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2789
|
+
/**
|
|
2790
|
+
* @description Delete API Key by id (would throw 404 error if API key not found or belongs to different user)
|
|
2791
|
+
* @tags api_keys
|
|
2792
|
+
* @name DeleteMany
|
|
2793
|
+
* @summary Delete API Key by id
|
|
2794
|
+
* @request DELETE:/v1/b2b/api-keys
|
|
2795
|
+
* @secure
|
|
2796
|
+
*/
|
|
2797
|
+
deleteMany(deleteAPIKeys: UmaDeleteAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2798
|
+
/**
|
|
2799
|
+
* @description Get APIKey by id
|
|
2800
|
+
* @tags api_keys
|
|
2801
|
+
* @name GetById
|
|
2802
|
+
* @summary Get APIKey by id
|
|
2803
|
+
* @request GET:/v1/b2b/api-keys/{id}
|
|
2804
|
+
* @secure
|
|
2805
|
+
*/
|
|
2806
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError>>;
|
|
2807
|
+
/**
|
|
2808
|
+
* @description Create API Key & API Secret Pair. API Secret won't be accessible for read after that
|
|
2809
|
+
* @tags api_keys
|
|
2810
|
+
* @name Create
|
|
2811
|
+
* @summary Create API Key & API Secret Pair
|
|
2812
|
+
* @request POST:/v2/b2b/api-keys
|
|
2813
|
+
* @secure
|
|
2814
|
+
*/
|
|
2815
|
+
create(createApiKeys: UmaCreateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError>>;
|
|
2816
|
+
/**
|
|
2817
|
+
* @description Get API Keys info(would return API Keys without secrets)
|
|
2818
|
+
* @tags api_keys
|
|
2819
|
+
* @name Get
|
|
2820
|
+
* @summary Get API Keys info(would return API Keys without secrets)
|
|
2821
|
+
* @request POST:/v2/b2b/api-keys/list
|
|
2822
|
+
* @secure
|
|
2823
|
+
*/
|
|
2824
|
+
get(apiKeys: UmaGetAPIKeysListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAPIKeysSerializer, HandleError>>;
|
|
2825
|
+
/**
|
|
2826
|
+
* @description Update API Key Record
|
|
2827
|
+
* @tags api_keys
|
|
2828
|
+
* @name Update
|
|
2829
|
+
* @summary Update API Key Record
|
|
2830
|
+
* @request PUT:/v2/b2b/api-keys/{id}
|
|
2831
|
+
* @secure
|
|
2832
|
+
*/
|
|
2833
|
+
update(id: number, apiKeys: UmaUpdateAPIKeysDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAPIKeysMutationSerializer, HandleError>>;
|
|
2834
|
+
}
|
|
2835
|
+
export class AuthApps<HandleError extends boolean = boolean> {
|
|
2836
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2837
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2838
|
+
/**
|
|
2839
|
+
* @description Get auth apps
|
|
2840
|
+
* @tags auth_apps
|
|
2841
|
+
* @name Get
|
|
2842
|
+
* @summary Get auth apps
|
|
2843
|
+
* @request GET:/v1/auth-apps
|
|
2844
|
+
* @secure
|
|
2845
|
+
*/
|
|
2846
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetAuthAppsListSerializer, HandleError>>;
|
|
2847
|
+
/**
|
|
2848
|
+
* @description Delete auth apps
|
|
2849
|
+
* @tags auth_apps
|
|
2850
|
+
* @name DeleteMany
|
|
2851
|
+
* @summary Delete auth apps
|
|
2852
|
+
* @request DELETE:/v1/auth-apps
|
|
2853
|
+
* @secure
|
|
2854
|
+
*/
|
|
2855
|
+
deleteMany(deleteAuthAppsDto: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2856
|
+
/**
|
|
2857
|
+
* @description Get TOTP registration QR
|
|
2858
|
+
* @tags auth_apps
|
|
2859
|
+
* @name GetRegistrationQr
|
|
2860
|
+
* @summary Get TOTP registration QR
|
|
2861
|
+
* @request POST:/v1/auth-apps/totp/registration/qr
|
|
2862
|
+
* @secure
|
|
2863
|
+
*/
|
|
2864
|
+
getRegistrationQr(getTotpQRDto: UmaGetTotpQRDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<File, HandleError>>;
|
|
2865
|
+
/**
|
|
2866
|
+
* @description Finish TOTP registration
|
|
2867
|
+
* @tags auth_apps
|
|
2868
|
+
* @name FinishRegistration
|
|
2869
|
+
* @summary Finish TOTP registration
|
|
2870
|
+
* @request POST:/v1/auth-apps/totp/registration/response
|
|
2871
|
+
* @secure
|
|
2872
|
+
*/
|
|
2873
|
+
finishRegistration(finishTOTPRegistrationDto: UmaFinishTOTPRegistrationDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaFinishTOTPRegistrationResponseSerializer, HandleError>>;
|
|
2874
|
+
/**
|
|
2875
|
+
* @description Get WebAuthn login challenge
|
|
2876
|
+
* @tags auth_apps
|
|
2877
|
+
* @name GetLoginChallenge
|
|
2878
|
+
* @summary Get WebAuthn login challenge
|
|
2879
|
+
* @request POST:/v1/auth-apps/webauthn/login/request
|
|
2880
|
+
*/
|
|
2881
|
+
getLoginChallenge(getWebAuthnLoginChallengeDto: UmaGetWebAuthnLoginChallengeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWebAuthnCredentialAssertionSerializer, HandleError>>;
|
|
2882
|
+
/**
|
|
2883
|
+
* @description Get WebAuthn register challenge
|
|
2884
|
+
* @tags auth_apps
|
|
2885
|
+
* @name GetRegisterChallenge
|
|
2886
|
+
* @summary Get WebAuthn register challenge
|
|
2887
|
+
* @request POST:/v1/auth-apps/webauthn/registration/request
|
|
2888
|
+
* @secure
|
|
2889
|
+
*/
|
|
2890
|
+
getRegisterChallenge(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWebAuthnCredentialCreationSerializer, HandleError>>;
|
|
2891
|
+
/**
|
|
2892
|
+
* @description Finish WebAuthn credential registration
|
|
2893
|
+
* @tags auth_apps
|
|
2894
|
+
* @name FinishCredentialRegistration
|
|
2895
|
+
* @summary Finish WebAuthn credential registration
|
|
2896
|
+
* @request POST:/v1/auth-apps/webauthn/registration/response
|
|
2897
|
+
* @secure
|
|
2898
|
+
*/
|
|
2899
|
+
finishCredentialRegistration(webAuthnRegistrationSolutionDto: UmaWebAuthnRegistrationSolutionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2900
|
+
/**
|
|
2901
|
+
* @description Register Yubico OTP Key
|
|
2902
|
+
* @tags auth_apps
|
|
2903
|
+
* @name Register
|
|
2904
|
+
* @summary Register Yubico OTP Key
|
|
2905
|
+
* @request POST:/v1/auth-apps/yubico/otp/registration
|
|
2906
|
+
* @secure
|
|
2907
|
+
*/
|
|
2908
|
+
register(yubicoOTPDto: UmaCreateYubicoOTPDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2909
|
+
/**
|
|
2910
|
+
* @description Update auth app
|
|
2911
|
+
* @tags auth_apps
|
|
2912
|
+
* @name Update
|
|
2913
|
+
* @summary Update auth app
|
|
2914
|
+
* @request PUT:/v1/auth-apps/{id}
|
|
2915
|
+
* @secure
|
|
2916
|
+
*/
|
|
2917
|
+
update(id: number, updateAuthAppDto: UmaUpdateAuthAppDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthAppResponseSerializer, HandleError>>;
|
|
2918
|
+
}
|
|
2919
|
+
export class Endpoints<HandleError extends boolean = boolean> {
|
|
2920
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2921
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2922
|
+
/**
|
|
2923
|
+
* @description Create Endpoint
|
|
2924
|
+
* @tags endpoints
|
|
2925
|
+
* @name Create
|
|
2926
|
+
* @summary Create Endpoint
|
|
2927
|
+
* @request POST:/v1/b2b/endpoints
|
|
2928
|
+
* @secure
|
|
2929
|
+
*/
|
|
2930
|
+
create(endpointDto: UmaCreateEndpointDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaEndpointMutationSerializer, HandleError>>;
|
|
2931
|
+
/**
|
|
2932
|
+
* @description Delete endpoint by id
|
|
2933
|
+
* @tags endpoints
|
|
2934
|
+
* @name DeleteMany
|
|
2935
|
+
* @summary Delete endpoint by id
|
|
2936
|
+
* @request DELETE:/v1/b2b/endpoints
|
|
2937
|
+
* @secure
|
|
2938
|
+
*/
|
|
2939
|
+
deleteMany(deleteEndpointsDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2940
|
+
/**
|
|
2941
|
+
* @description Get Endpoint by id
|
|
2942
|
+
* @tags endpoints
|
|
2943
|
+
* @name GetById
|
|
2944
|
+
* @summary Get Endpoint by id
|
|
2945
|
+
* @request GET:/v1/b2b/endpoints/{id}
|
|
2946
|
+
* @secure
|
|
2947
|
+
*/
|
|
2948
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaEndpointMutationSerializer, HandleError>>;
|
|
2949
|
+
/**
|
|
2950
|
+
* @description Update endpoint record
|
|
2951
|
+
* @tags endpoints
|
|
2952
|
+
* @name Update
|
|
2953
|
+
* @summary Update endpoint record
|
|
2954
|
+
* @request PUT:/v1/b2b/endpoints/{id}
|
|
2955
|
+
* @secure
|
|
2956
|
+
*/
|
|
2957
|
+
update(id: number, endpointDto: UmaUpdateEndpointDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaEndpointMutationSerializer, HandleError>>;
|
|
2958
|
+
/**
|
|
2959
|
+
* @description Get endpoints with pagination
|
|
2960
|
+
* @tags endpoints
|
|
2961
|
+
* @name Get
|
|
2962
|
+
* @summary Get endpoints with pagination
|
|
2963
|
+
* @request POST:/v2/b2b/endpoints/list
|
|
2964
|
+
* @secure
|
|
2965
|
+
*/
|
|
2966
|
+
get(endpointDto: UmaGetEndpointsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetEndpointsListSerializer, HandleError>>;
|
|
2967
|
+
}
|
|
2968
|
+
export class IdentityProviders<HandleError extends boolean = boolean> {
|
|
2969
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2970
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2971
|
+
/**
|
|
2972
|
+
* @description Create Identity Provider
|
|
2973
|
+
* @tags identity_providers
|
|
2974
|
+
* @name Create
|
|
2975
|
+
* @summary Create Identity Provider
|
|
2976
|
+
* @request POST:/v1/b2b/identity-providers
|
|
2977
|
+
* @secure
|
|
2978
|
+
*/
|
|
2979
|
+
create(createIdentityProviderDto: UmaCreateIdentityProviderDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaIdentityProviderResponseSerializer, HandleError>>;
|
|
2980
|
+
/**
|
|
2981
|
+
* @description Delete Identity providers by id
|
|
2982
|
+
* @tags identity_providers
|
|
2983
|
+
* @name DeleteMany
|
|
2984
|
+
* @summary Delete Identity providers by ids
|
|
2985
|
+
* @request DELETE:/v1/b2b/identity-providers
|
|
2986
|
+
* @secure
|
|
2987
|
+
*/
|
|
2988
|
+
deleteMany(deleteIdentityProvidersDto: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2989
|
+
/**
|
|
2990
|
+
* @description Get Identity Provider by id
|
|
2991
|
+
* @tags identity_providers
|
|
2992
|
+
* @name GetById
|
|
2993
|
+
* @summary Get Identity Provider by id
|
|
2994
|
+
* @request GET:/v1/b2b/identity-providers/{id}
|
|
2995
|
+
* @secure
|
|
2996
|
+
*/
|
|
2997
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaIdentityProviderResponseSerializer, HandleError>>;
|
|
2998
|
+
/**
|
|
2999
|
+
* @description Update identity provider record
|
|
3000
|
+
* @tags identity_providers
|
|
3001
|
+
* @name Update
|
|
3002
|
+
* @summary Update identity provider record
|
|
3003
|
+
* @request PUT:/v1/b2b/identity-providers/{id}
|
|
3004
|
+
* @secure
|
|
3005
|
+
*/
|
|
3006
|
+
update(id: number, identityProvidersDto: UmaUpdateIdentityProviderDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaIdentityProviderResponseSerializer, HandleError>>;
|
|
3007
|
+
/**
|
|
3008
|
+
* @description Get Identity Providers with pagination
|
|
3009
|
+
* @tags identity_providers
|
|
3010
|
+
* @name Get
|
|
3011
|
+
* @summary Get Identity Providers with pagination
|
|
3012
|
+
* @request POST:/v2/b2b/identity-providers/list
|
|
3013
|
+
* @secure
|
|
3014
|
+
*/
|
|
3015
|
+
get(identityProvidersDto: UmaGetIdentityProvidersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetIdentityProvidersListSerializer, HandleError>>;
|
|
3016
|
+
}
|
|
3017
|
+
export class RoleTypes<HandleError extends boolean = boolean> {
|
|
3018
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3019
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3020
|
+
/**
|
|
3021
|
+
* @description Create Role Type
|
|
3022
|
+
* @tags role_types
|
|
3023
|
+
* @name Create
|
|
3024
|
+
* @summary Create Role Type
|
|
3025
|
+
* @request POST:/v1/b2b/role-types
|
|
3026
|
+
* @secure
|
|
3027
|
+
*/
|
|
3028
|
+
create(createRoleType: UmaCreateRoleTypeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleTypeResponseSerializer, HandleError>>;
|
|
3029
|
+
/**
|
|
3030
|
+
* @description Delete Role Types by ids
|
|
3031
|
+
* @tags role_types
|
|
3032
|
+
* @name DeleteMany
|
|
3033
|
+
* @summary Delete Role Types by ids
|
|
3034
|
+
* @request DELETE:/v1/b2b/role-types
|
|
3035
|
+
* @secure
|
|
3036
|
+
*/
|
|
3037
|
+
deleteMany(deleteRoleTypes: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3038
|
+
/**
|
|
3039
|
+
* @description Get Role Type by id
|
|
3040
|
+
* @tags role_types
|
|
3041
|
+
* @name GetById
|
|
3042
|
+
* @summary Get Role Type by id
|
|
3043
|
+
* @request GET:/v1/b2b/role-types/{id}
|
|
3044
|
+
* @secure
|
|
3045
|
+
*/
|
|
3046
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleTypeResponseSerializer, HandleError>>;
|
|
3047
|
+
/**
|
|
3048
|
+
* @description Update Role Type
|
|
3049
|
+
* @tags role_types
|
|
3050
|
+
* @name Update
|
|
3051
|
+
* @summary Update Role Type
|
|
3052
|
+
* @request PUT:/v1/b2b/role-types/{id}
|
|
3053
|
+
* @secure
|
|
3054
|
+
*/
|
|
3055
|
+
update(id: number, updateRoleType: UmaUpdateRoleTypeDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleTypeResponseSerializer, HandleError>>;
|
|
3056
|
+
/**
|
|
3057
|
+
* @description Get Role Types with pagination
|
|
3058
|
+
* @tags role_types
|
|
3059
|
+
* @name Get
|
|
3060
|
+
* @summary Get Role Types with pagination
|
|
3061
|
+
* @request POST:/v2/b2b/role-types/list
|
|
3062
|
+
* @secure
|
|
3063
|
+
*/
|
|
3064
|
+
get(getRoleTypes: UmaGetRoleTypesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetRoleTypesListSerializer, HandleError>>;
|
|
3065
|
+
}
|
|
3066
|
+
export class Microservices<HandleError extends boolean = boolean> {
|
|
3067
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3068
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3069
|
+
/**
|
|
3070
|
+
* @description Create Microservice with domains, used to proxy user requests from public domains to internal
|
|
3071
|
+
* @tags microservices
|
|
3072
|
+
* @name Create
|
|
3073
|
+
* @summary Create Microservice
|
|
3074
|
+
* @request POST:/v1/b2b/microservices
|
|
3075
|
+
* @secure
|
|
3076
|
+
*/
|
|
3077
|
+
create(microserviceDto: UmaCreateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError>>;
|
|
3078
|
+
/**
|
|
3079
|
+
* @description Delete microservice by id
|
|
3080
|
+
* @tags microservices
|
|
3081
|
+
* @name DeleteMany
|
|
3082
|
+
* @summary Delete microservice by id
|
|
3083
|
+
* @request DELETE:/v1/b2b/microservices
|
|
3084
|
+
* @secure
|
|
3085
|
+
*/
|
|
3086
|
+
deleteMany(deleteMicroservices: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3087
|
+
/**
|
|
3088
|
+
* @description Get Microservice by id
|
|
3089
|
+
* @tags microservices
|
|
3090
|
+
* @name GetById
|
|
3091
|
+
* @summary Get Microservice by id
|
|
3092
|
+
* @request GET:/v1/b2b/microservices/{id}
|
|
3093
|
+
* @secure
|
|
3094
|
+
*/
|
|
3095
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError>>;
|
|
3096
|
+
/**
|
|
3097
|
+
* @description Update microservice record
|
|
3098
|
+
* @tags microservices
|
|
3099
|
+
* @name Update
|
|
3100
|
+
* @summary Update microservice record
|
|
3101
|
+
* @request PUT:/v1/b2b/microservices/{id}
|
|
3102
|
+
* @secure
|
|
3103
|
+
*/
|
|
3104
|
+
update(id: number, microserviceDto: UmaUpdateMicroserviceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaMicroserviceMutationSerializer, HandleError>>;
|
|
3105
|
+
/**
|
|
3106
|
+
* @description Get microservices with pagination
|
|
3107
|
+
* @tags microservices
|
|
3108
|
+
* @name Get
|
|
3109
|
+
* @summary Get microservices with pagination
|
|
3110
|
+
* @request POST:/v2/b2b/microservices/list
|
|
3111
|
+
* @secure
|
|
3112
|
+
*/
|
|
3113
|
+
get(microserviceDto: UmaGetMicroservicesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetMicroservicesListSerializer, HandleError>>;
|
|
3114
|
+
}
|
|
3115
|
+
export class B2BUserSettings<HandleError extends boolean = boolean> {
|
|
3116
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3117
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3118
|
+
/**
|
|
3119
|
+
* @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
|
|
3120
|
+
* @tags b2b_user_settings
|
|
3121
|
+
* @name SetUserSettings
|
|
3122
|
+
* @summary Set B2B User Settings
|
|
3123
|
+
* @request PUT:/v1/b2b/settings
|
|
3124
|
+
* @secure
|
|
3125
|
+
*/
|
|
3126
|
+
setUserSettings(setB2BUserSettings: UmaSetB2BUserSettingsDto, headers?: {
|
|
3127
|
+
/** Run endpoint in debug mode */
|
|
3128
|
+
'Debug-Token'?: string;
|
|
3129
|
+
/** Branch id, with which user should work */
|
|
3130
|
+
BRANCH?: string;
|
|
3131
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSettingsChangeSerializer, HandleError>>;
|
|
3132
|
+
/**
|
|
3133
|
+
* @description Upload avatar for B2B user
|
|
3134
|
+
* @tags b2b_user_settings
|
|
3135
|
+
* @name UploadAvatar
|
|
3136
|
+
* @summary Upload avatar for B2B user
|
|
3137
|
+
* @request PUT:/v1/b2b/settings/avatar
|
|
3138
|
+
* @secure
|
|
3139
|
+
*/
|
|
3140
|
+
uploadAvatar(data: {
|
|
3141
|
+
/**
|
|
3142
|
+
* Avatar to upload
|
|
3143
|
+
* @format binary
|
|
3144
|
+
*/
|
|
3145
|
+
avatar?: File;
|
|
3146
|
+
/** Should delete old avatar instead of uploading new one */
|
|
3147
|
+
delete_avatar?: boolean;
|
|
3148
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUploadAvatarResponseSerializer, HandleError>>;
|
|
3149
|
+
/**
|
|
3150
|
+
* @description Send B2B user contact change code
|
|
3151
|
+
* @tags b2b_user_settings
|
|
3152
|
+
* @name SendContactChangeCode
|
|
3153
|
+
* @summary Send B2B user contact change code
|
|
3154
|
+
* @request POST:/v1/b2b/settings/codes
|
|
3155
|
+
* @secure
|
|
3156
|
+
*/
|
|
3157
|
+
sendContactChangeCode(b2bSendContactChangeCodeDto: UmaB2BSendContactChangeCodeDto, headers?: {
|
|
3158
|
+
/** Branch id, with which user should work */
|
|
3159
|
+
BRANCH?: string;
|
|
3160
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3161
|
+
}
|
|
3162
|
+
export class TablePresets<HandleError extends boolean = boolean> {
|
|
3163
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3164
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3165
|
+
/**
|
|
3166
|
+
* @description Get user Table Presets
|
|
3167
|
+
* @tags table_presets
|
|
3168
|
+
* @name GetUserPresets
|
|
3169
|
+
* @summary Get user Table Presets
|
|
3170
|
+
* @request GET:/v1/b2b/table-presets
|
|
3171
|
+
* @secure
|
|
3172
|
+
*/
|
|
3173
|
+
getUserPresets(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTablePresetsListResponseSerializer, HandleError>>;
|
|
3174
|
+
/**
|
|
3175
|
+
* @description Upsert Table Preset
|
|
3176
|
+
* @tags table_presets
|
|
3177
|
+
* @name Upsert
|
|
3178
|
+
* @summary Upsert Table Preset
|
|
3179
|
+
* @request PUT:/v1/b2b/table-presets
|
|
3180
|
+
* @secure
|
|
3181
|
+
*/
|
|
3182
|
+
upsert(upsertTablePreset: UmaUpsertTablePresetDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTablePresetResponseSerializer, HandleError>>;
|
|
3183
|
+
}
|
|
3184
|
+
export class B2CUserSettings<HandleError extends boolean = boolean> {
|
|
3185
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3186
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3187
|
+
/**
|
|
3188
|
+
* @description Set B2C User Settings
|
|
3189
|
+
* @tags b2c_user_settings
|
|
3190
|
+
* @name SetUserSettings
|
|
3191
|
+
* @summary Set B2C User Settings
|
|
3192
|
+
* @request PUT:/v1/b2c/settings
|
|
3193
|
+
* @secure
|
|
3194
|
+
*/
|
|
3195
|
+
setUserSettings(setB2CUserSettings: UmaSetB2CUserSettingsDto, headers?: {
|
|
3196
|
+
/** Branch id/slug/code, with which user should work */
|
|
3197
|
+
BRANCH?: string;
|
|
3198
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSettingsChangeSerializer, HandleError>>;
|
|
3199
|
+
/**
|
|
3200
|
+
* @description Send B2C user contact change code
|
|
3201
|
+
* @tags b2c_user_settings
|
|
3202
|
+
* @name SendContactChangeCode
|
|
3203
|
+
* @summary Send B2C user contact change code
|
|
3204
|
+
* @request POST:/v1/b2c/settings/codes
|
|
3205
|
+
* @secure
|
|
3206
|
+
*/
|
|
3207
|
+
sendContactChangeCode(b2cSendContactChangeCodeDto: UmaB2CSendContactChangeCodeDto, headers?: {
|
|
3208
|
+
/** Branch id/slug/code, with which user should work */
|
|
3209
|
+
BRANCH?: string;
|
|
3210
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3211
|
+
/**
|
|
3212
|
+
* @description Get Available B2C Branch Mfa Options
|
|
3213
|
+
* @tags b2c_user_settings
|
|
3214
|
+
* @name AvailableMfaOptions
|
|
3215
|
+
* @summary Get Available B2C Branch Mfa Options
|
|
3216
|
+
* @request GET:/v1/b2c/settings/mfa-options
|
|
3217
|
+
* @secure
|
|
3218
|
+
*/
|
|
3219
|
+
availableMfaOptions(headers?: {
|
|
3220
|
+
/** Branch id/slug/code, with which user should work */
|
|
3221
|
+
BRANCH?: string;
|
|
3222
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAvailableB2CMfaOptionsResponse, HandleError>>;
|
|
3223
|
+
/**
|
|
3224
|
+
* @description Delete B2C OAuth2 Bindings
|
|
3225
|
+
* @tags b2c_user_settings
|
|
3226
|
+
* @name DeleteManyOAuthBindings
|
|
3227
|
+
* @summary Delete B2C OAuth2 Bindings
|
|
3228
|
+
* @request DELETE:/v1/b2c/settings/oauth-links
|
|
3229
|
+
* @secure
|
|
3230
|
+
*/
|
|
3231
|
+
deleteManyOAuthBindings(deleteByIDsDto: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3232
|
+
/**
|
|
3233
|
+
* @description Finish Apple OAuth2 Profile Linking
|
|
3234
|
+
* @tags b2c_user_settings
|
|
3235
|
+
* @name FinishAppleProfileLinking
|
|
3236
|
+
* @summary Finish Apple OAuth2 Profile Linking
|
|
3237
|
+
* @request POST:/v1/b2c/settings/oauth-links/apple/finish
|
|
3238
|
+
*/
|
|
3239
|
+
finishAppleProfileLinking(finishOAuthLoginDto: UmaFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3240
|
+
/**
|
|
3241
|
+
* @description Initialize Apple OAuth2 Profile Linking
|
|
3242
|
+
* @tags b2c_user_settings
|
|
3243
|
+
* @name InitAppleProfileLinking
|
|
3244
|
+
* @summary Initialize Apple OAuth2 Profile Linking
|
|
3245
|
+
* @request POST:/v1/b2c/settings/oauth-links/apple/start
|
|
3246
|
+
* @secure
|
|
3247
|
+
*/
|
|
3248
|
+
initAppleProfileLinking(initOAuthLinkingDto: UmaInitOAuthLinkingDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CInitOAuthResponse, HandleError>>;
|
|
3249
|
+
/**
|
|
3250
|
+
* @description Finish Google OAuth2 Profile Linking
|
|
3251
|
+
* @tags b2c_user_settings
|
|
3252
|
+
* @name FinishGoogleProfileLinking
|
|
3253
|
+
* @summary Finish Google OAuth2 Profile Linking
|
|
3254
|
+
* @request POST:/v1/b2c/settings/oauth-links/google/finish
|
|
3255
|
+
*/
|
|
3256
|
+
finishGoogleProfileLinking(finishOAuthLoginDto: UmaFinishOAuthLoginDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3257
|
+
/**
|
|
3258
|
+
* @description Initialize Google OAuth2 Profile Linking
|
|
3259
|
+
* @tags b2c_user_settings
|
|
3260
|
+
* @name InitGoogleProfileLinking
|
|
3261
|
+
* @summary Initialize Google OAuth2 Profile Linking
|
|
3262
|
+
* @request POST:/v1/b2c/settings/oauth-links/google/start
|
|
3263
|
+
* @secure
|
|
3264
|
+
*/
|
|
3265
|
+
initGoogleProfileLinking(initOAuthLinkingDto: UmaInitOAuthLinkingDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CInitOAuthResponse, HandleError>>;
|
|
3266
|
+
/**
|
|
3267
|
+
* @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
|
|
3268
|
+
* @tags b2c_user_settings
|
|
3269
|
+
* @name GetOAuthBindings
|
|
3270
|
+
* @summary Get B2C OAuth2 Bindings with pagination
|
|
3271
|
+
* @request POST:/v1/b2c/settings/oauth-links/list
|
|
3272
|
+
* @secure
|
|
3273
|
+
*/
|
|
3274
|
+
getOAuthBindings(getOAuth2BindingsListDto: UmaGetOAuth2BindingsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaAuthProviderUserBindingsResponse, HandleError>>;
|
|
3275
|
+
}
|
|
3276
|
+
export class Branches<HandleError extends boolean = boolean> {
|
|
3277
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3278
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3279
|
+
/**
|
|
3280
|
+
* @description Create Branch
|
|
3281
|
+
* @tags branches
|
|
3282
|
+
* @name Create
|
|
3283
|
+
* @summary Create Branch
|
|
3284
|
+
* @request POST:/v1/branches
|
|
3285
|
+
* @secure
|
|
3286
|
+
*/
|
|
3287
|
+
create(createBranch: UmaCreateBranchDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBranchMutationSerializer, HandleError>>;
|
|
3288
|
+
/**
|
|
3289
|
+
* @description Delete Branch by id
|
|
3290
|
+
* @tags branches
|
|
3291
|
+
* @name DeleteMany
|
|
3292
|
+
* @summary Delete Branch by id
|
|
3293
|
+
* @request DELETE:/v1/branches
|
|
3294
|
+
* @secure
|
|
3295
|
+
*/
|
|
3296
|
+
deleteMany(deleteBranches: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3297
|
+
/**
|
|
3298
|
+
* @description Get Branch by id
|
|
3299
|
+
* @tags branches
|
|
3300
|
+
* @name GetById
|
|
3301
|
+
* @summary Get Branch by id
|
|
3302
|
+
* @request GET:/v1/branches/{id}
|
|
3303
|
+
* @secure
|
|
3304
|
+
*/
|
|
3305
|
+
getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBranchMutationSerializer, HandleError>>;
|
|
3306
|
+
/**
|
|
3307
|
+
* @description Update Branch
|
|
3308
|
+
* @tags branches
|
|
3309
|
+
* @name Update
|
|
3310
|
+
* @summary Update Branch
|
|
3311
|
+
* @request PUT:/v1/branches/{id}
|
|
3312
|
+
* @secure
|
|
3313
|
+
*/
|
|
3314
|
+
update(id: number, updateBranch: UmaUpdateBranchDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaBranchMutationSerializer, HandleError>>;
|
|
3315
|
+
/**
|
|
3316
|
+
* @description Get Branches with pagination
|
|
3317
|
+
* @tags branches
|
|
3318
|
+
* @name Get
|
|
3319
|
+
* @summary Get Branches with pagination
|
|
3320
|
+
* @request POST:/v2/branches/list
|
|
3321
|
+
* @secure
|
|
3322
|
+
*/
|
|
3323
|
+
get(getBranches: UmaGetBranchesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetBranchesListSerializer, HandleError>>;
|
|
3324
|
+
}
|
|
3325
|
+
export class Countries<HandleError extends boolean = boolean> {
|
|
3326
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3327
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3328
|
+
/**
|
|
3329
|
+
* @description Get Countries info
|
|
3330
|
+
* @tags countries
|
|
3331
|
+
* @name Get
|
|
3332
|
+
* @summary Get Countries info
|
|
3333
|
+
* @request GET:/v1/countries/
|
|
3334
|
+
*/
|
|
3335
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetCountriesSerializer, HandleError>>;
|
|
3336
|
+
}
|
|
3337
|
+
export class Locales<HandleError extends boolean = boolean> {
|
|
3338
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3339
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3340
|
+
/**
|
|
3341
|
+
* @description get all language locales
|
|
3342
|
+
* @tags locales
|
|
3343
|
+
* @name Get
|
|
3344
|
+
* @summary get all locales
|
|
3345
|
+
* @request GET:/v1/locales
|
|
3346
|
+
*/
|
|
3347
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaLocaleSerializer[], HandleError>>;
|
|
3348
|
+
}
|
|
3349
|
+
export class Firms<HandleError extends boolean = boolean> {
|
|
3350
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3351
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3352
|
+
/**
|
|
3353
|
+
* @description Create Firm
|
|
3354
|
+
* @tags firms
|
|
3355
|
+
* @name Create
|
|
3356
|
+
* @summary Create Firm
|
|
3357
|
+
* @request POST:/v1/firms
|
|
3358
|
+
* @secure
|
|
3359
|
+
*/
|
|
3360
|
+
create(createFirm: UmaCreateFirmDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaFirmMutationSerializer, HandleError>>;
|
|
3361
|
+
/**
|
|
3362
|
+
* @description Deletes Firm by ids
|
|
3363
|
+
* @tags firms
|
|
3364
|
+
* @name DeleteMany
|
|
3365
|
+
* @summary Deletes Firm by ids
|
|
3366
|
+
* @request DELETE:/v1/firms
|
|
3367
|
+
* @secure
|
|
3368
|
+
*/
|
|
3369
|
+
deleteMany(deleteFirms: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Get Firm by id
|
|
3372
|
+
* @tags firms
|
|
3373
|
+
* @name GetById
|
|
3374
|
+
* @summary Get Firm by id
|
|
3375
|
+
* @request GET:/v1/firms/{id}
|
|
3376
|
+
* @secure
|
|
3377
|
+
*/
|
|
3378
|
+
getById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaFirmMutationSerializer, HandleError>>;
|
|
3379
|
+
/**
|
|
3380
|
+
* @description Update Firm
|
|
3381
|
+
* @tags firms
|
|
3382
|
+
* @name Update
|
|
3383
|
+
* @summary Update Firm
|
|
3384
|
+
* @request PUT:/v1/firms/{id}
|
|
3385
|
+
* @secure
|
|
3386
|
+
*/
|
|
3387
|
+
update(id: number, updateFirm: UmaUpdateFirmDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaFirmMutationSerializer, HandleError>>;
|
|
3388
|
+
/**
|
|
3389
|
+
* @description Get Firms with pagination
|
|
3390
|
+
* @tags firms
|
|
3391
|
+
* @name Get
|
|
3392
|
+
* @summary Get Firms with pagination
|
|
3393
|
+
* @request POST:/v2/firms/list
|
|
3394
|
+
* @secure
|
|
3395
|
+
*/
|
|
3396
|
+
get(getFirms: UmaGetFirmsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetFirmsListSerializer, HandleError>>;
|
|
3397
|
+
}
|
|
3398
|
+
export class MigrationUtils<HandleError extends boolean = boolean> {
|
|
3399
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3400
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3401
|
+
/**
|
|
3402
|
+
* @description Upsert Users from deprecated DB's
|
|
3403
|
+
* @tags migration-utils
|
|
3404
|
+
* @name PostUsersUpsert
|
|
3405
|
+
* @summary Upsert Users
|
|
3406
|
+
* @request POST:/v1/migration-utils/users/upsert
|
|
3407
|
+
* @secure
|
|
3408
|
+
*/
|
|
3409
|
+
postUsersUpsert(upsertUsers: UmaUpsertUsersDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaUpsertUsersSerializer, HandleError>>;
|
|
3410
|
+
}
|
|
3411
|
+
export class Permissions<HandleError extends boolean = boolean> {
|
|
3412
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3413
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3414
|
+
/**
|
|
3415
|
+
* @description Create Permission
|
|
3416
|
+
* @tags permissions
|
|
3417
|
+
* @name Create
|
|
3418
|
+
* @summary Create Permission
|
|
3419
|
+
* @request POST:/v1/permissions
|
|
3420
|
+
* @secure
|
|
3421
|
+
*/
|
|
3422
|
+
create(createPermission: UmaCreatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError>>;
|
|
3423
|
+
/**
|
|
3424
|
+
* @description Delete Permissions by id
|
|
3425
|
+
* @tags permissions
|
|
3426
|
+
* @name DeleteMany
|
|
3427
|
+
* @summary Delete Permissions by id
|
|
3428
|
+
* @request DELETE:/v1/permissions
|
|
3429
|
+
* @secure
|
|
3430
|
+
*/
|
|
3431
|
+
deleteMany(deletePermissions: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3432
|
+
/**
|
|
3433
|
+
* @description Get Permission by id
|
|
3434
|
+
* @tags permissions
|
|
3435
|
+
* @name GetById
|
|
3436
|
+
* @summary Get Permission by id
|
|
3437
|
+
* @request GET:/v1/permissions/{id}
|
|
3438
|
+
* @secure
|
|
3439
|
+
*/
|
|
3440
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError>>;
|
|
3441
|
+
/**
|
|
3442
|
+
* @description Update Permission
|
|
3443
|
+
* @tags permissions
|
|
3444
|
+
* @name Update
|
|
3445
|
+
* @summary Update Permission
|
|
3446
|
+
* @request PUT:/v1/permissions/{id}
|
|
3447
|
+
* @secure
|
|
3448
|
+
*/
|
|
3449
|
+
update(id: number, updatePermission: UmaUpdatePermissionDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPermissionMutationSerializer, HandleError>>;
|
|
3450
|
+
/**
|
|
3451
|
+
* @description Get Permissions with pagination
|
|
3452
|
+
* @tags permissions
|
|
3453
|
+
* @name Get
|
|
3454
|
+
* @summary Get Permissions with pagination
|
|
3455
|
+
* @request POST:/v2/permissions/list
|
|
3456
|
+
* @secure
|
|
3457
|
+
*/
|
|
3458
|
+
get(getPermissions: UmaGetPermissionsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetPermissionsListSerializer, HandleError>>;
|
|
3459
|
+
}
|
|
3460
|
+
export class PublicSettings<HandleError extends boolean = boolean> {
|
|
3461
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3462
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3463
|
+
/**
|
|
3464
|
+
* @description Get public settings
|
|
3465
|
+
* @tags public_settings
|
|
3466
|
+
* @name Get
|
|
3467
|
+
* @summary Get public settings
|
|
3468
|
+
* @request GET:/v1/public-settings
|
|
3469
|
+
*/
|
|
3470
|
+
get(config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaPublicSettingsResponseSerializer, HandleError>>;
|
|
3471
|
+
}
|
|
3472
|
+
export class Roles<HandleError extends boolean = boolean> {
|
|
3473
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3474
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3475
|
+
/**
|
|
3476
|
+
* @description Create Role
|
|
3477
|
+
* @tags roles
|
|
3478
|
+
* @name Create
|
|
3479
|
+
* @summary Create Role
|
|
3480
|
+
* @request POST:/v1/roles
|
|
3481
|
+
* @secure
|
|
3482
|
+
*/
|
|
3483
|
+
create(createRole: UmaCreateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError>>;
|
|
3484
|
+
/**
|
|
3485
|
+
* @description Delete Roles by ids
|
|
3486
|
+
* @tags roles
|
|
3487
|
+
* @name DeleteMany
|
|
3488
|
+
* @summary Delete Roles by ids
|
|
3489
|
+
* @request DELETE:/v1/roles
|
|
3490
|
+
* @secure
|
|
3491
|
+
*/
|
|
3492
|
+
deleteMany(deleteRoles: UmaDeleteByIDsDtoInt, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3493
|
+
/**
|
|
3494
|
+
* @description Get Role by id
|
|
3495
|
+
* @tags roles
|
|
3496
|
+
* @name GetById
|
|
3497
|
+
* @summary Get Role by id
|
|
3498
|
+
* @request GET:/v1/roles/{id}
|
|
3499
|
+
* @secure
|
|
3500
|
+
*/
|
|
3501
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError>>;
|
|
3502
|
+
/**
|
|
3503
|
+
* @description Update Role
|
|
3504
|
+
* @tags roles
|
|
3505
|
+
* @name Update
|
|
3506
|
+
* @summary Update Role
|
|
3507
|
+
* @request PUT:/v1/roles/{id}
|
|
3508
|
+
* @secure
|
|
3509
|
+
*/
|
|
3510
|
+
update(id: number, updateRole: UmaUpdateRoleDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaRoleMutationSerializer, HandleError>>;
|
|
3511
|
+
/**
|
|
3512
|
+
* @description Get Roles with pagination
|
|
3513
|
+
* @tags roles
|
|
3514
|
+
* @name Get
|
|
3515
|
+
* @summary Get Roles with pagination
|
|
3516
|
+
* @request POST:/v2/roles/list
|
|
3517
|
+
* @secure
|
|
3518
|
+
*/
|
|
3519
|
+
get(getRoles: UmaGetRolesListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetRolesListSerializer, HandleError>>;
|
|
3520
|
+
}
|
|
3521
|
+
export class SecretNotes<HandleError extends boolean = boolean> {
|
|
3522
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3523
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3524
|
+
/**
|
|
3525
|
+
* @description Create Secret note. For type `password` field `note_params` should contain `password` field only.
|
|
3526
|
+
* @tags secret_notes
|
|
3527
|
+
* @name Create
|
|
3528
|
+
* @summary Create Secret note
|
|
3529
|
+
* @request POST:/v1/secret-notes
|
|
3530
|
+
* @secure
|
|
3531
|
+
*/
|
|
3532
|
+
create(createSecretNote: UmaCreateSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSecretNoteCreationSuccessSerializer, HandleError>>;
|
|
3533
|
+
/**
|
|
3534
|
+
* @description Get Secret note
|
|
3535
|
+
* @tags secret_notes
|
|
3536
|
+
* @name GetOne
|
|
3537
|
+
* @summary Get Secret note
|
|
3538
|
+
* @request POST:/v1/secret-notes/fetch
|
|
3539
|
+
*/
|
|
3540
|
+
getOne(getSecretNote: UmaGetSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaSingleSecretNoteSerializer, HandleError>>;
|
|
3541
|
+
/**
|
|
3542
|
+
* @description Send Secret note verification code
|
|
3543
|
+
* @tags secret_notes
|
|
3544
|
+
* @name SendVerificationCode
|
|
3545
|
+
* @summary Send Secret note verification code
|
|
3546
|
+
* @request PUT:/v1/secret-notes/verification
|
|
3547
|
+
*/
|
|
3548
|
+
sendVerificationCode(sendVerificationCodeForSecretNote: UmaSendVerificationCodeForSecretNoteDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3549
|
+
}
|
|
3550
|
+
export class Tags<HandleError extends boolean = boolean> {
|
|
3551
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3552
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3553
|
+
/**
|
|
3554
|
+
* @description Create Tag
|
|
3555
|
+
* @tags tags
|
|
3556
|
+
* @name Create
|
|
3557
|
+
* @summary Create Tag
|
|
3558
|
+
* @request POST:/v1/tags
|
|
3559
|
+
* @secure
|
|
3560
|
+
*/
|
|
3561
|
+
create(createTagDto: UmaCreateTagDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTagMutationSerializer, HandleError>>;
|
|
3562
|
+
/**
|
|
3563
|
+
* @description Delete Tags
|
|
3564
|
+
* @tags tags
|
|
3565
|
+
* @name DeleteMany
|
|
3566
|
+
* @summary Delete Tags
|
|
3567
|
+
* @request DELETE:/v1/tags
|
|
3568
|
+
* @secure
|
|
3569
|
+
*/
|
|
3570
|
+
deleteMany(deleteByIDsDto: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3571
|
+
/**
|
|
3572
|
+
* @description Get Tags List. Available fields for sorting are `id, name, created_at, updated_at`. Search is performed by `name`
|
|
3573
|
+
* @tags tags
|
|
3574
|
+
* @name Get
|
|
3575
|
+
* @summary Get Tags List
|
|
3576
|
+
* @request POST:/v1/tags/list
|
|
3577
|
+
* @secure
|
|
3578
|
+
*/
|
|
3579
|
+
get(getTagsDto: UmaGetTagsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetTagsListSerializer, HandleError>>;
|
|
3580
|
+
/**
|
|
3581
|
+
* @description Get Tags By ID
|
|
3582
|
+
* @tags tags
|
|
3583
|
+
* @name GetById
|
|
3584
|
+
* @summary Get Tag By ID
|
|
3585
|
+
* @request GET:/v1/tags/{id}
|
|
3586
|
+
* @secure
|
|
3587
|
+
*/
|
|
3588
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTagMutationSerializer, HandleError>>;
|
|
3589
|
+
/**
|
|
3590
|
+
* @description Update Tag
|
|
3591
|
+
* @tags tags
|
|
3592
|
+
* @name Update
|
|
3593
|
+
* @summary Update Tag
|
|
3594
|
+
* @request PUT:/v1/tags/{id}
|
|
3595
|
+
* @secure
|
|
3596
|
+
*/
|
|
3597
|
+
update(id: number, updateTagDto: UmaUpdateTagDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaTagMutationSerializer, HandleError>>;
|
|
3598
|
+
}
|
|
3599
|
+
export class B2BUsers<HandleError extends boolean = boolean> {
|
|
3600
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3601
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3602
|
+
/**
|
|
3603
|
+
* @description Delete B2B user by id
|
|
3604
|
+
* @tags b2b_users
|
|
3605
|
+
* @name DeleteMany
|
|
3606
|
+
* @summary Delete B2B user by id
|
|
3607
|
+
* @request DELETE:/v1/users/b2b
|
|
3608
|
+
* @secure
|
|
3609
|
+
*/
|
|
3610
|
+
deleteMany(deleteB2BUsers: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3611
|
+
/**
|
|
3612
|
+
* @description Get B2B User by id
|
|
3613
|
+
* @tags b2b_users
|
|
3614
|
+
* @name GetById
|
|
3615
|
+
* @summary Get B2B User by id
|
|
3616
|
+
* @request GET:/v1/users/b2b/{id}
|
|
3617
|
+
* @secure
|
|
3618
|
+
*/
|
|
3619
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError>>;
|
|
3620
|
+
/**
|
|
3621
|
+
* @description Change B2B User status
|
|
3622
|
+
* @tags b2b_users
|
|
3623
|
+
* @name ChangeStatus
|
|
3624
|
+
* @summary Change B2B User status
|
|
3625
|
+
* @request PATCH:/v1/users/b2b/{id}/status
|
|
3626
|
+
* @secure
|
|
3627
|
+
*/
|
|
3628
|
+
changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3629
|
+
/**
|
|
3630
|
+
* @description Create B2B User
|
|
3631
|
+
* @tags b2b_users
|
|
3632
|
+
* @name Create
|
|
3633
|
+
* @summary Create B2B User
|
|
3634
|
+
* @request POST:/v2/users/b2b
|
|
3635
|
+
* @secure
|
|
3636
|
+
*/
|
|
3637
|
+
create(createB2BUser: UmaCreateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError>>;
|
|
3638
|
+
/**
|
|
3639
|
+
* @description Get B2B users with pagination
|
|
3640
|
+
* @tags b2b_users
|
|
3641
|
+
* @name Get
|
|
3642
|
+
* @summary Get B2B users with pagination
|
|
3643
|
+
* @request POST:/v2/users/b2b/list
|
|
3644
|
+
* @secure
|
|
3645
|
+
*/
|
|
3646
|
+
get(getB2BUsers: UmaGetB2BUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUsersListSerializerTypesAdminB2BUserSerializer, HandleError>>;
|
|
3647
|
+
/**
|
|
3648
|
+
* @description Update B2B User
|
|
3649
|
+
* @tags b2b_users
|
|
3650
|
+
* @name Update
|
|
3651
|
+
* @summary Update B2B User
|
|
3652
|
+
* @request PUT:/v2/users/b2b/{id}
|
|
3653
|
+
* @secure
|
|
3654
|
+
*/
|
|
3655
|
+
update(id: number, createB2BUserNew: UmaUpdateB2BUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2BUserSerializer, HandleError>>;
|
|
3656
|
+
}
|
|
3657
|
+
export class UserDetails<HandleError extends boolean = boolean> {
|
|
3658
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3659
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3660
|
+
/**
|
|
3661
|
+
* @description Get User Details by JWT-token
|
|
3662
|
+
* @tags user_details
|
|
3663
|
+
* @name GetUserDetails
|
|
3664
|
+
* @summary Get User Details by JWT-token
|
|
3665
|
+
* @request POST:/v1/users/details/show
|
|
3666
|
+
* @secure
|
|
3667
|
+
*/
|
|
3668
|
+
getUserDetails(getUserDetailsDto: UmaGetUserDetailsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUserDetailsSerializer, HandleError>>;
|
|
3669
|
+
/**
|
|
3670
|
+
* @description Revoke user sessions by JWT-token
|
|
3671
|
+
* @tags user_details
|
|
3672
|
+
* @name RevokeSessions
|
|
3673
|
+
* @summary Revoke user sessions by JWT-token
|
|
3674
|
+
* @request POST:/v1/users/revoke-sessions
|
|
3675
|
+
* @secure
|
|
3676
|
+
*/
|
|
3677
|
+
revokeSessions(revokeUserSessionsDto: UmaRevokeUserSessionsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3678
|
+
}
|
|
3679
|
+
export class B2CUsers<HandleError extends boolean = boolean> {
|
|
3680
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3681
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3682
|
+
/**
|
|
3683
|
+
* @description Create B2C User
|
|
3684
|
+
* @tags b2c_users
|
|
3685
|
+
* @name Create
|
|
3686
|
+
* @summary Create B2C User
|
|
3687
|
+
* @request POST:/v1/users/b2c
|
|
3688
|
+
* @secure
|
|
3689
|
+
*/
|
|
3690
|
+
create(createB2CUser: UmaCreateB2CUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError>>;
|
|
3691
|
+
/**
|
|
3692
|
+
* @description Delete B2C user by id
|
|
3693
|
+
* @tags b2c_users
|
|
3694
|
+
* @name DeleteMany
|
|
3695
|
+
* @summary Delete B2C user by id
|
|
3696
|
+
* @request DELETE:/v1/users/b2c
|
|
3697
|
+
* @secure
|
|
3698
|
+
*/
|
|
3699
|
+
deleteMany(deleteB2CUsers: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3700
|
+
/**
|
|
3701
|
+
* @description Get B2C User by id
|
|
3702
|
+
* @tags b2c_users
|
|
3703
|
+
* @name GetById
|
|
3704
|
+
* @summary Get B2C User by id
|
|
3705
|
+
* @request GET:/v1/users/b2c/{id}
|
|
3706
|
+
* @secure
|
|
3707
|
+
*/
|
|
3708
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError>>;
|
|
3709
|
+
/**
|
|
3710
|
+
* @description Update B2C User
|
|
3711
|
+
* @tags b2c_users
|
|
3712
|
+
* @name Update
|
|
3713
|
+
* @summary Update B2C User
|
|
3714
|
+
* @request PUT:/v1/users/b2c/{id}
|
|
3715
|
+
* @secure
|
|
3716
|
+
*/
|
|
3717
|
+
update(id: number, createB2BUser: UmaUpdateB2CUserDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaB2CUserSerializer, HandleError>>;
|
|
3718
|
+
/**
|
|
3719
|
+
* @description Change B2C User status
|
|
3720
|
+
* @tags b2c_users
|
|
3721
|
+
* @name ChangeStatus
|
|
3722
|
+
* @summary Change B2C User status
|
|
3723
|
+
* @request PATCH:/v1/users/b2c/{id}/status
|
|
3724
|
+
* @secure
|
|
3725
|
+
*/
|
|
3726
|
+
changeStatus(id: number, changeUserStatus: UmaChangeUserStatusDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3727
|
+
/**
|
|
3728
|
+
* @description Get B2C users with pagination
|
|
3729
|
+
* @tags b2c_users
|
|
3730
|
+
* @name Get
|
|
3731
|
+
* @summary Get B2C users with pagination
|
|
3732
|
+
* @request POST:/v2/users/b2c/list
|
|
3733
|
+
* @secure
|
|
3734
|
+
*/
|
|
3735
|
+
get(getB2CUsers: UmaGetB2CUsersListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUsersListSerializerTypesAdminB2CUserSerializer, HandleError>>;
|
|
3736
|
+
}
|
|
3737
|
+
export class UsersCommon<HandleError extends boolean = boolean> {
|
|
3738
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3739
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3740
|
+
/**
|
|
3741
|
+
* @description Get user status change reasons list
|
|
3742
|
+
* @tags users_common
|
|
3743
|
+
* @name GetUserStatusChangeReasonsList
|
|
3744
|
+
* @summary Get user status change reasons list
|
|
3745
|
+
* @request POST:/v1/users/status-change-reasons/list
|
|
3746
|
+
* @secure
|
|
3747
|
+
*/
|
|
3748
|
+
getUserStatusChangeReasonsList(getUserStatusChangeReasonsDto: UmaGetUserStatusChangeReasonsDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetUserStatusChangeReasonsListSerializer, HandleError>>;
|
|
3749
|
+
/**
|
|
3750
|
+
* @description Link Watchmen user to UMA
|
|
3751
|
+
* @tags users_common
|
|
3752
|
+
* @name LinkWatchmenUsersToUma
|
|
3753
|
+
* @summary Link Watchmen user to UMA
|
|
3754
|
+
* @request POST:/v1/users/watchmen/link
|
|
3755
|
+
* @secure
|
|
3756
|
+
*/
|
|
3757
|
+
linkWatchmenUsersToUma(linkWatchmenUserToUmaDto: UmaLinkWatchmenUserToUmaDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3758
|
+
}
|
|
3759
|
+
export class WatchmenInstances<HandleError extends boolean = boolean> {
|
|
3760
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3761
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3762
|
+
/**
|
|
3763
|
+
* @description Create Watchmen Instance
|
|
3764
|
+
* @tags watchmen_instances
|
|
3765
|
+
* @name Create
|
|
3766
|
+
* @summary Create Watchmen Instance
|
|
3767
|
+
* @request POST:/v1/watchmen-instances
|
|
3768
|
+
* @secure
|
|
3769
|
+
*/
|
|
3770
|
+
create(createWatchmenInstance: UmaCreateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError>>;
|
|
3771
|
+
/**
|
|
3772
|
+
* @description Delete Watchmen Instances
|
|
3773
|
+
* @tags watchmen_instances
|
|
3774
|
+
* @name DeleteMany
|
|
3775
|
+
* @summary Delete Watchmen Instances
|
|
3776
|
+
* @request DELETE:/v1/watchmen-instances
|
|
3777
|
+
* @secure
|
|
3778
|
+
*/
|
|
3779
|
+
deleteMany(deleteWatchmenInstances: UmaDeleteByIDsDtoInt64, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3780
|
+
/**
|
|
3781
|
+
* @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.
|
|
3782
|
+
* @tags watchmen_instances
|
|
3783
|
+
* @name GetMany
|
|
3784
|
+
* @summary Get Watchmen Instances with pagination
|
|
3785
|
+
* @request POST:/v1/watchmen-instances/list
|
|
3786
|
+
* @secure
|
|
3787
|
+
*/
|
|
3788
|
+
getMany(getWatchmenInstances: UmaGetWatchmenInstancesDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetWatchmenInstancesListSerializer, HandleError>>;
|
|
3789
|
+
/**
|
|
3790
|
+
* @description Get Watchmen Instance by id
|
|
3791
|
+
* @tags watchmen_instances
|
|
3792
|
+
* @name GetById
|
|
3793
|
+
* @summary Get Watchmen Instance by id
|
|
3794
|
+
* @request GET:/v1/watchmen-instances/{id}
|
|
3795
|
+
* @secure
|
|
3796
|
+
*/
|
|
3797
|
+
getById(id: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError>>;
|
|
3798
|
+
/**
|
|
3799
|
+
* @description Update Watchmen Instance
|
|
3800
|
+
* @tags watchmen_instances
|
|
3801
|
+
* @name Update
|
|
3802
|
+
* @summary Update Watchmen Instance
|
|
3803
|
+
* @request PUT:/v1/watchmen-instances/{id}
|
|
3804
|
+
* @secure
|
|
3805
|
+
*/
|
|
3806
|
+
update(id: number, updateWatchmenInstance: UmaUpdateWatchmenInstanceDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaWatchmenInstanceMutationSerializer, HandleError>>;
|
|
3807
|
+
}
|
|
3808
|
+
declare class _B2BAuth1<HandleError extends boolean = boolean> extends B2BAuth<HandleError> {
|
|
3809
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3810
|
+
basicLogin(basicLoginParams: UmaBasicB2BLoginDto, headers?: {
|
|
3811
|
+
'Debug-Token'?: string;
|
|
3812
|
+
}, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
|
|
3813
|
+
}
|
|
3814
|
+
declare class _B2CAuth1<HandleError extends boolean = boolean> extends B2CAuth<HandleError> {
|
|
3815
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3816
|
+
basicLogin(basicLoginParams: UmaBasicB2CLoginDto, headers?: {
|
|
3817
|
+
BRANCH?: string;
|
|
3818
|
+
FIRM?: string;
|
|
3819
|
+
}, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
|
|
3820
|
+
}
|
|
3821
|
+
export interface UmaClientConfig<HandleError extends boolean = boolean> extends JwtClientConfig<HandleError> {
|
|
3822
|
+
firmId: string;
|
|
3823
|
+
authFormSlug: string;
|
|
3824
|
+
}
|
|
3825
|
+
export class UmaApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
3826
|
+
actionLog: ActionLogs<HandleError>;
|
|
3827
|
+
apiKeys: ApiKeys<HandleError>;
|
|
3828
|
+
authApps: AuthApps<HandleError>;
|
|
3829
|
+
authForms: AuthForms<HandleError>;
|
|
3830
|
+
b2bAuth: _B2BAuth1<HandleError>;
|
|
3831
|
+
b2bUsers: B2BUsers<HandleError>;
|
|
3832
|
+
b2bUserSettings: B2BUserSettings<HandleError>;
|
|
3833
|
+
b2cAuth: _B2CAuth1<HandleError>;
|
|
3834
|
+
b2cUsers: B2CUsers<HandleError>;
|
|
3835
|
+
b2cUserSettings: B2CUserSettings<HandleError>;
|
|
3836
|
+
branches: Branches<HandleError>;
|
|
3837
|
+
countries: Countries<HandleError>;
|
|
3838
|
+
endpoints: Endpoints<HandleError>;
|
|
3839
|
+
fims: Firms<HandleError>;
|
|
3840
|
+
identityProviders: IdentityProviders<HandleError>;
|
|
3841
|
+
locales: Locales<HandleError>;
|
|
3842
|
+
microservices: Microservices<HandleError>;
|
|
3843
|
+
migrationUtils: MigrationUtils<HandleError>;
|
|
3844
|
+
permissions: Permissions<HandleError>;
|
|
3845
|
+
publicSettings: PublicSettings<HandleError>;
|
|
3846
|
+
roles: Roles<HandleError>;
|
|
3847
|
+
roleTypes: RoleTypes<HandleError>;
|
|
3848
|
+
secretNotes: SecretNotes<HandleError>;
|
|
3849
|
+
sessions: Sessions<HandleError>;
|
|
3850
|
+
tablePresets: TablePresets<HandleError>;
|
|
3851
|
+
tags: Tags<HandleError>;
|
|
3852
|
+
userDetails: UserDetails<HandleError>;
|
|
3853
|
+
usersCommon: UsersCommon<HandleError>;
|
|
3854
|
+
watchmenAuth: WatchmenAuth<HandleError>;
|
|
3855
|
+
watchmenInstances: WatchmenInstances<HandleError>;
|
|
3856
|
+
constructor(config: UmaClientConfig<HandleError>);
|
|
3857
|
+
}
|
|
3858
|
+
|
|
3859
|
+
//# sourceMappingURL=index.d.ts.map
|