@flipdish/authorization 0.0.2-rc.1756734895 → 0.0.2-rc.1766090571
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/README.md +216 -101
- package/api.ts +3420 -693
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2601 -449
- package/dist/api.js +2976 -448
- package/dist/common.d.ts +1 -1
- package/dist/common.js +2 -2
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -30,7 +30,7 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM
|
|
|
30
30
|
*/
|
|
31
31
|
export interface AssignRoleRequestBody {
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
*
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof AssignRoleRequestBody
|
|
36
36
|
*/
|
|
@@ -47,6 +47,12 @@ export interface AssignRoleRequestBody {
|
|
|
47
47
|
* @memberof AssignRoleRequestBody
|
|
48
48
|
*/
|
|
49
49
|
'principal': AuthorizationRequestPrincipal;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof AssignRoleRequestBody
|
|
54
|
+
*/
|
|
55
|
+
'brandId': string;
|
|
50
56
|
}
|
|
51
57
|
|
|
52
58
|
export const AssignRoleRequestBodyRoleEnum = {
|
|
@@ -147,10 +153,10 @@ export interface AssignRoleSuccessResponse {
|
|
|
147
153
|
export interface AuthenticateAndAuthorizeRequest {
|
|
148
154
|
/**
|
|
149
155
|
* Incoming request headers to be used for authentication
|
|
150
|
-
* @type {{ [key: string]:
|
|
156
|
+
* @type {{ [key: string]: string; }}
|
|
151
157
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
152
158
|
*/
|
|
153
|
-
'headers': { [key: string]:
|
|
159
|
+
'headers': { [key: string]: string; };
|
|
154
160
|
/**
|
|
155
161
|
*
|
|
156
162
|
* @type {AuthorizationRequestAction}
|
|
@@ -163,7 +169,21 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
163
169
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
164
170
|
*/
|
|
165
171
|
'resource'?: AuthorizationRequestResource;
|
|
172
|
+
/**
|
|
173
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
174
|
+
* @type {string}
|
|
175
|
+
* @memberof AuthenticateAndAuthorizeRequest
|
|
176
|
+
*/
|
|
177
|
+
'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
|
|
166
178
|
}
|
|
179
|
+
|
|
180
|
+
export const AuthenticateAndAuthorizeRequestCheckModeEnum = {
|
|
181
|
+
Any: 'any',
|
|
182
|
+
All: 'all'
|
|
183
|
+
} as const;
|
|
184
|
+
|
|
185
|
+
export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
|
|
186
|
+
|
|
167
187
|
/**
|
|
168
188
|
* Response containing the authentication and authorization decision
|
|
169
189
|
* @export
|
|
@@ -172,10 +192,10 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
172
192
|
export interface AuthenticateAndAuthorizeResponse {
|
|
173
193
|
/**
|
|
174
194
|
*
|
|
175
|
-
* @type {
|
|
195
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
176
196
|
* @memberof AuthenticateAndAuthorizeResponse
|
|
177
197
|
*/
|
|
178
|
-
'authentication':
|
|
198
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
179
199
|
/**
|
|
180
200
|
*
|
|
181
201
|
* @type {AuthorizationResponse}
|
|
@@ -186,506 +206,113 @@ export interface AuthenticateAndAuthorizeResponse {
|
|
|
186
206
|
/**
|
|
187
207
|
*
|
|
188
208
|
* @export
|
|
189
|
-
* @interface
|
|
190
|
-
*/
|
|
191
|
-
export interface AuthenticateAndAuthorizeResponseAuthentication {
|
|
192
|
-
/**
|
|
193
|
-
*
|
|
194
|
-
* @type {AuthorizationRequestPrincipal}
|
|
195
|
-
* @memberof AuthenticateAndAuthorizeResponseAuthentication
|
|
196
|
-
*/
|
|
197
|
-
'principal': AuthorizationRequestPrincipal;
|
|
198
|
-
/**
|
|
199
|
-
* Whether the user is authenticated
|
|
200
|
-
* @type {boolean}
|
|
201
|
-
* @memberof AuthenticateAndAuthorizeResponseAuthentication
|
|
202
|
-
*/
|
|
203
|
-
'authenticated': boolean;
|
|
204
|
-
/**
|
|
205
|
-
* The reason for the authentication failure
|
|
206
|
-
* @type {string}
|
|
207
|
-
* @memberof AuthenticateAndAuthorizeResponseAuthentication
|
|
208
|
-
*/
|
|
209
|
-
'reason'?: string;
|
|
210
|
-
}
|
|
211
|
-
/**
|
|
212
|
-
* Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
|
|
213
|
-
* @export
|
|
214
|
-
* @interface AuthorizationRequest
|
|
215
|
-
*/
|
|
216
|
-
export interface AuthorizationRequest {
|
|
217
|
-
/**
|
|
218
|
-
*
|
|
219
|
-
* @type {AuthorizationRequestPrincipal}
|
|
220
|
-
* @memberof AuthorizationRequest
|
|
221
|
-
*/
|
|
222
|
-
'principal': AuthorizationRequestPrincipal;
|
|
223
|
-
/**
|
|
224
|
-
*
|
|
225
|
-
* @type {AuthorizationRequestAction}
|
|
226
|
-
* @memberof AuthorizationRequest
|
|
227
|
-
*/
|
|
228
|
-
'action': AuthorizationRequestAction;
|
|
229
|
-
/**
|
|
230
|
-
*
|
|
231
|
-
* @type {AuthorizationRequestResource}
|
|
232
|
-
* @memberof AuthorizationRequest
|
|
233
|
-
*/
|
|
234
|
-
'resource'?: AuthorizationRequestResource;
|
|
235
|
-
}
|
|
236
|
-
/**
|
|
237
|
-
*
|
|
238
|
-
* @export
|
|
239
|
-
* @interface AuthorizationRequestAction
|
|
240
|
-
*/
|
|
241
|
-
export interface AuthorizationRequestAction {
|
|
242
|
-
}
|
|
243
|
-
/**
|
|
244
|
-
*
|
|
245
|
-
* @export
|
|
246
|
-
* @interface AuthorizationRequestPrincipal
|
|
209
|
+
* @interface AuthenticateAndCheckIsInRoleRequest
|
|
247
210
|
*/
|
|
248
|
-
export interface
|
|
249
|
-
/**
|
|
250
|
-
*
|
|
251
|
-
* @type {string}
|
|
252
|
-
* @memberof AuthorizationRequestPrincipal
|
|
253
|
-
*/
|
|
254
|
-
'type': AuthorizationRequestPrincipalTypeEnum;
|
|
255
|
-
/**
|
|
256
|
-
*
|
|
257
|
-
* @type {string}
|
|
258
|
-
* @memberof AuthorizationRequestPrincipal
|
|
259
|
-
*/
|
|
260
|
-
'id': string;
|
|
261
|
-
/**
|
|
262
|
-
*
|
|
263
|
-
* @type {string}
|
|
264
|
-
* @memberof AuthorizationRequestPrincipal
|
|
265
|
-
*/
|
|
266
|
-
'name'?: string;
|
|
267
|
-
/**
|
|
268
|
-
*
|
|
269
|
-
* @type {string}
|
|
270
|
-
* @memberof AuthorizationRequestPrincipal
|
|
271
|
-
*/
|
|
272
|
-
'email'?: string;
|
|
211
|
+
export interface AuthenticateAndCheckIsInRoleRequest {
|
|
273
212
|
/**
|
|
274
|
-
*
|
|
275
|
-
* @type {string}
|
|
276
|
-
* @memberof
|
|
213
|
+
* Incoming request headers to be used for authentication
|
|
214
|
+
* @type {{ [key: string]: string; }}
|
|
215
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
277
216
|
*/
|
|
278
|
-
'
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
export const AuthorizationRequestPrincipalTypeEnum = {
|
|
282
|
-
User: 'User',
|
|
283
|
-
Automation: 'Automation'
|
|
284
|
-
} as const;
|
|
285
|
-
|
|
286
|
-
export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
|
|
287
|
-
|
|
288
|
-
/**
|
|
289
|
-
* @type AuthorizationRequestResource
|
|
290
|
-
* @export
|
|
291
|
-
*/
|
|
292
|
-
export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
*
|
|
296
|
-
* @export
|
|
297
|
-
* @interface AuthorizationRequestResourceOneOf
|
|
298
|
-
*/
|
|
299
|
-
export interface AuthorizationRequestResourceOneOf {
|
|
217
|
+
'headers': { [key: string]: string; };
|
|
300
218
|
/**
|
|
301
|
-
*
|
|
302
|
-
* @type {string}
|
|
303
|
-
* @memberof
|
|
219
|
+
* Array of roles to check if the principal is in
|
|
220
|
+
* @type {Array<string>}
|
|
221
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
304
222
|
*/
|
|
305
|
-
'
|
|
223
|
+
'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
|
|
306
224
|
/**
|
|
307
225
|
*
|
|
308
226
|
* @type {string}
|
|
309
|
-
* @memberof
|
|
227
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
310
228
|
*/
|
|
311
|
-
'
|
|
229
|
+
'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
|
|
312
230
|
}
|
|
313
231
|
|
|
314
|
-
export const
|
|
315
|
-
|
|
232
|
+
export const AuthenticateAndCheckIsInRoleRequestRolesEnum = {
|
|
233
|
+
Admin: 'Admin',
|
|
234
|
+
Factory: 'Factory'
|
|
316
235
|
} as const;
|
|
317
236
|
|
|
318
|
-
export type
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
* @export
|
|
323
|
-
* @interface AuthorizationRequestResourceOneOf1
|
|
324
|
-
*/
|
|
325
|
-
export interface AuthorizationRequestResourceOneOf1 {
|
|
326
|
-
/**
|
|
327
|
-
*
|
|
328
|
-
* @type {string}
|
|
329
|
-
* @memberof AuthorizationRequestResourceOneOf1
|
|
330
|
-
*/
|
|
331
|
-
'type': AuthorizationRequestResourceOneOf1TypeEnum;
|
|
332
|
-
/**
|
|
333
|
-
*
|
|
334
|
-
* @type {string}
|
|
335
|
-
* @memberof AuthorizationRequestResourceOneOf1
|
|
336
|
-
*/
|
|
337
|
-
'id': string;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
export const AuthorizationRequestResourceOneOf1TypeEnum = {
|
|
341
|
-
Org: 'Org'
|
|
237
|
+
export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
|
|
238
|
+
export const AuthenticateAndCheckIsInRoleRequestCheckModeEnum = {
|
|
239
|
+
Any: 'any',
|
|
240
|
+
All: 'all'
|
|
342
241
|
} as const;
|
|
343
242
|
|
|
344
|
-
export type
|
|
243
|
+
export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
|
|
345
244
|
|
|
346
245
|
/**
|
|
347
|
-
*
|
|
246
|
+
* Response containing whether the principal is in any/all of the roles
|
|
348
247
|
* @export
|
|
349
|
-
* @interface
|
|
248
|
+
* @interface AuthenticateAndCheckIsInRoleResponse
|
|
350
249
|
*/
|
|
351
|
-
export interface
|
|
250
|
+
export interface AuthenticateAndCheckIsInRoleResponse {
|
|
352
251
|
/**
|
|
353
252
|
*
|
|
354
|
-
* @type {
|
|
355
|
-
* @memberof
|
|
253
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
254
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
356
255
|
*/
|
|
357
|
-
'
|
|
256
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
358
257
|
/**
|
|
359
|
-
*
|
|
360
|
-
* @type {
|
|
361
|
-
* @memberof
|
|
258
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
259
|
+
* @type {boolean}
|
|
260
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
362
261
|
*/
|
|
363
|
-
'
|
|
262
|
+
'authorized': boolean;
|
|
364
263
|
}
|
|
365
|
-
|
|
366
|
-
export const AuthorizationRequestResourceOneOf2TypeEnum = {
|
|
367
|
-
Brand: 'Brand'
|
|
368
|
-
} as const;
|
|
369
|
-
|
|
370
|
-
export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
|
|
371
|
-
|
|
372
264
|
/**
|
|
373
265
|
*
|
|
374
266
|
* @export
|
|
375
|
-
* @interface
|
|
267
|
+
* @interface AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
376
268
|
*/
|
|
377
|
-
export interface
|
|
378
|
-
/**
|
|
379
|
-
*
|
|
380
|
-
* @type {string}
|
|
381
|
-
* @memberof AuthorizationRequestResourceOneOf3
|
|
382
|
-
*/
|
|
383
|
-
'type': AuthorizationRequestResourceOneOf3TypeEnum;
|
|
269
|
+
export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
|
|
384
270
|
/**
|
|
385
271
|
*
|
|
386
|
-
* @type {
|
|
387
|
-
* @memberof
|
|
272
|
+
* @type {AuthorizationRequestPrincipal}
|
|
273
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
388
274
|
*/
|
|
389
|
-
'
|
|
390
|
-
}
|
|
391
|
-
|
|
392
|
-
export const AuthorizationRequestResourceOneOf3TypeEnum = {
|
|
393
|
-
SalesChannel: 'SalesChannel'
|
|
394
|
-
} as const;
|
|
395
|
-
|
|
396
|
-
export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
|
|
397
|
-
|
|
398
|
-
/**
|
|
399
|
-
* Response containing the authorization decision
|
|
400
|
-
* @export
|
|
401
|
-
* @interface AuthorizationResponse
|
|
402
|
-
*/
|
|
403
|
-
export interface AuthorizationResponse {
|
|
275
|
+
'principal': AuthorizationRequestPrincipal;
|
|
404
276
|
/**
|
|
405
|
-
* Whether the
|
|
277
|
+
* Whether the user is authenticated
|
|
406
278
|
* @type {boolean}
|
|
407
|
-
* @memberof
|
|
279
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
408
280
|
*/
|
|
409
|
-
'
|
|
281
|
+
'authenticated': boolean;
|
|
410
282
|
/**
|
|
411
|
-
* The
|
|
283
|
+
* The reason for the authentication failure
|
|
412
284
|
* @type {string}
|
|
413
|
-
* @memberof
|
|
414
|
-
*/
|
|
415
|
-
'decision': string;
|
|
416
|
-
/**
|
|
417
|
-
* The policy IDs that were used to make the decision
|
|
418
|
-
* @type {Array<string>}
|
|
419
|
-
* @memberof AuthorizationResponse
|
|
285
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
420
286
|
*/
|
|
421
|
-
'
|
|
287
|
+
'reason'?: string;
|
|
422
288
|
}
|
|
423
289
|
/**
|
|
424
290
|
*
|
|
425
291
|
* @export
|
|
426
|
-
* @interface
|
|
427
|
-
*/
|
|
428
|
-
export interface ErrorResponse {
|
|
429
|
-
/**
|
|
430
|
-
*
|
|
431
|
-
* @type {string}
|
|
432
|
-
* @memberof ErrorResponse
|
|
433
|
-
*/
|
|
434
|
-
'message': string;
|
|
435
|
-
}
|
|
436
|
-
/**
|
|
437
|
-
* Successful permissions retrieval response
|
|
438
|
-
* @export
|
|
439
|
-
* @interface GetPermissionsSuccessResponse
|
|
440
|
-
*/
|
|
441
|
-
export interface GetPermissionsSuccessResponse {
|
|
442
|
-
/**
|
|
443
|
-
*
|
|
444
|
-
* @type {Permissions & Array<string>}
|
|
445
|
-
* @memberof GetPermissionsSuccessResponse
|
|
446
|
-
*/
|
|
447
|
-
'permissions': Permissions & Array<string>;
|
|
448
|
-
}
|
|
449
|
-
/**
|
|
450
|
-
* Details for getting roles for a principal
|
|
451
|
-
* @export
|
|
452
|
-
* @interface GetPrincipalRolesRequestBody
|
|
292
|
+
* @interface AuthorizationBatchRequest
|
|
453
293
|
*/
|
|
454
|
-
export interface
|
|
294
|
+
export interface AuthorizationBatchRequest {
|
|
455
295
|
/**
|
|
456
296
|
*
|
|
457
297
|
* @type {AuthorizationRequestPrincipal}
|
|
458
|
-
* @memberof
|
|
298
|
+
* @memberof AuthorizationBatchRequest
|
|
459
299
|
*/
|
|
460
300
|
'principal': AuthorizationRequestPrincipal;
|
|
461
301
|
/**
|
|
462
|
-
*
|
|
463
|
-
* @type {
|
|
464
|
-
* @memberof
|
|
302
|
+
* The action to check authorisation for
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof AuthorizationBatchRequest
|
|
465
305
|
*/
|
|
466
|
-
'
|
|
467
|
-
}
|
|
468
|
-
/**
|
|
469
|
-
* Successful roles retrieval response
|
|
470
|
-
* @export
|
|
471
|
-
* @interface GetPrincipalRolesSuccessResponse
|
|
472
|
-
*/
|
|
473
|
-
export interface GetPrincipalRolesSuccessResponse {
|
|
306
|
+
'action': AuthorizationBatchRequestActionEnum;
|
|
474
307
|
/**
|
|
475
|
-
*
|
|
476
|
-
* @type {Array<
|
|
477
|
-
* @memberof
|
|
308
|
+
* Array of resources to check authorisation for
|
|
309
|
+
* @type {Array<AuthorizationRequestResource>}
|
|
310
|
+
* @memberof AuthorizationBatchRequest
|
|
478
311
|
*/
|
|
479
|
-
'
|
|
312
|
+
'resources': Array<AuthorizationRequestResource>;
|
|
480
313
|
}
|
|
481
|
-
/**
|
|
482
|
-
*
|
|
483
|
-
* @export
|
|
484
|
-
* @interface GetPrincipalRolesSuccessResponseRolesInner
|
|
485
|
-
*/
|
|
486
|
-
export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
487
|
-
/**
|
|
488
|
-
* Policy ID
|
|
489
|
-
* @type {string}
|
|
490
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
491
|
-
*/
|
|
492
|
-
'policyId': string;
|
|
493
|
-
/**
|
|
494
|
-
* Role name
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
497
|
-
*/
|
|
498
|
-
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum;
|
|
499
|
-
/**
|
|
500
|
-
* Date and time the role was assigned
|
|
501
|
-
* @type {string}
|
|
502
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
503
|
-
*/
|
|
504
|
-
'assignedAt': string;
|
|
505
|
-
/**
|
|
506
|
-
* User who assigned the role
|
|
507
|
-
* @type {string}
|
|
508
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
509
|
-
*/
|
|
510
|
-
'assignedBy': string;
|
|
511
|
-
/**
|
|
512
|
-
* Type of resource the role is assigned to
|
|
513
|
-
* @type {string}
|
|
514
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
515
|
-
*/
|
|
516
|
-
'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
517
|
-
/**
|
|
518
|
-
* Organization ID
|
|
519
|
-
* @type {string}
|
|
520
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
521
|
-
*/
|
|
522
|
-
'orgId'?: string;
|
|
523
|
-
/**
|
|
524
|
-
* Property ID
|
|
525
|
-
* @type {string}
|
|
526
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
527
|
-
*/
|
|
528
|
-
'propertyId'?: string;
|
|
529
|
-
/**
|
|
530
|
-
* Brand ID this role is scoped to
|
|
531
|
-
* @type {string}
|
|
532
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
533
|
-
*/
|
|
534
|
-
'brandId'?: string;
|
|
535
|
-
/**
|
|
536
|
-
* Sales channel ID this role is scoped to
|
|
537
|
-
* @type {string}
|
|
538
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
539
|
-
*/
|
|
540
|
-
'salesChannelId'?: string;
|
|
541
|
-
}
|
|
542
|
-
|
|
543
|
-
export const GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = {
|
|
544
|
-
OrgViewer: 'OrgViewer',
|
|
545
|
-
OrgManager: 'OrgManager',
|
|
546
|
-
OrgAdmin: 'OrgAdmin',
|
|
547
|
-
BrandViewer: 'BrandViewer',
|
|
548
|
-
BrandManager: 'BrandManager',
|
|
549
|
-
BrandAdmin: 'BrandAdmin',
|
|
550
|
-
StoreViewer: 'StoreViewer',
|
|
551
|
-
StoreEditor: 'StoreEditor',
|
|
552
|
-
StoreManager: 'StoreManager',
|
|
553
|
-
CustomerViewer: 'CustomerViewer',
|
|
554
|
-
CustomerManager: 'CustomerManager',
|
|
555
|
-
VoucherViewer: 'VoucherViewer',
|
|
556
|
-
VoucherEditor: 'VoucherEditor',
|
|
557
|
-
VoucherManager: 'VoucherManager',
|
|
558
|
-
VoucherCampaignManager: 'VoucherCampaignManager',
|
|
559
|
-
VoucherStatisticsViewer: 'VoucherStatisticsViewer',
|
|
560
|
-
AnalyticsViewer: 'AnalyticsViewer',
|
|
561
|
-
ReportsViewer: 'ReportsViewer',
|
|
562
|
-
FinanceViewer: 'FinanceViewer',
|
|
563
|
-
FinanceManager: 'FinanceManager',
|
|
564
|
-
TeamViewer: 'TeamViewer',
|
|
565
|
-
TeamManager: 'TeamManager',
|
|
566
|
-
TeamAdmin: 'TeamAdmin',
|
|
567
|
-
TechViewer: 'TechViewer',
|
|
568
|
-
TechManager: 'TechManager',
|
|
569
|
-
AppStoreViewer: 'AppStoreViewer',
|
|
570
|
-
AppStoreManager: 'AppStoreManager',
|
|
571
|
-
SalesChannelViewer: 'SalesChannelViewer',
|
|
572
|
-
SalesChannelEditor: 'SalesChannelEditor',
|
|
573
|
-
SalesChannelManager: 'SalesChannelManager',
|
|
574
|
-
DeliveryViewer: 'DeliveryViewer',
|
|
575
|
-
DeliveryManager: 'DeliveryManager',
|
|
576
|
-
DriverManager: 'DriverManager',
|
|
577
|
-
AuditViewer: 'AuditViewer',
|
|
578
|
-
AuditManager: 'AuditManager',
|
|
579
|
-
AccountsViewer: 'AccountsViewer',
|
|
580
|
-
AccountsEditor: 'AccountsEditor',
|
|
581
|
-
DocumentExplorerViewer: 'DocumentExplorerViewer',
|
|
582
|
-
DocumentExplorerEditor: 'DocumentExplorerEditor',
|
|
583
|
-
PayrollViewer: 'PayrollViewer',
|
|
584
|
-
PayrollEditor: 'PayrollEditor',
|
|
585
|
-
PropertyViewer: 'PropertyViewer',
|
|
586
|
-
PropertyManager: 'PropertyManager',
|
|
587
|
-
PropertyAdmin: 'PropertyAdmin',
|
|
588
|
-
WebsiteContentEditor: 'WebsiteContentEditor',
|
|
589
|
-
WebsiteContentViewer: 'WebsiteContentViewer',
|
|
590
|
-
WebsiteTechViewer: 'WebsiteTechViewer',
|
|
591
|
-
MenuViewer: 'MenuViewer',
|
|
592
|
-
MenuEditor: 'MenuEditor',
|
|
593
|
-
MenuManager: 'MenuManager',
|
|
594
|
-
MenuMetaFieldManager: 'MenuMetaFieldManager',
|
|
595
|
-
MenuMetaFieldEditor: 'MenuMetaFieldEditor',
|
|
596
|
-
MenuMetaFieldViewer: 'MenuMetaFieldViewer',
|
|
597
|
-
StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
|
|
598
|
-
StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
|
|
599
|
-
StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
|
|
600
|
-
OrderFulfillmentManager: 'OrderFulfillmentManager',
|
|
601
|
-
OrderManager: 'OrderManager',
|
|
602
|
-
OrderEditor: 'OrderEditor',
|
|
603
|
-
OrderViewer: 'OrderViewer',
|
|
604
|
-
InventoryManager: 'InventoryManager',
|
|
605
|
-
InventoryEditor: 'InventoryEditor',
|
|
606
|
-
InventoryViewer: 'InventoryViewer',
|
|
607
|
-
PaymentManager: 'PaymentManager',
|
|
608
|
-
OnboardingManager: 'OnboardingManager',
|
|
609
|
-
FeatureFlagManager: 'FeatureFlagManager',
|
|
610
|
-
PropertyOwnerMisc: 'PropertyOwnerMisc',
|
|
611
|
-
ManagedOwnerMisc: 'ManagedOwnerMisc',
|
|
612
|
-
IntegratorMisc: 'IntegratorMisc',
|
|
613
|
-
PropertyManagerMisc: 'PropertyManagerMisc',
|
|
614
|
-
FinanceManagerMisc: 'FinanceManagerMisc',
|
|
615
|
-
SupportMisc: 'SupportMisc'
|
|
616
|
-
} as const;
|
|
617
|
-
|
|
618
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum];
|
|
619
|
-
export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
|
|
620
|
-
Property: 'Property',
|
|
621
|
-
Org: 'Org',
|
|
622
|
-
Brand: 'Brand',
|
|
623
|
-
SalesChannel: 'SalesChannel'
|
|
624
|
-
} as const;
|
|
625
|
-
|
|
626
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
627
|
-
|
|
628
|
-
/**
|
|
629
|
-
* Successful roles retrieval response
|
|
630
|
-
* @export
|
|
631
|
-
* @interface GetRolesSuccessResponse
|
|
632
|
-
*/
|
|
633
|
-
export interface GetRolesSuccessResponse {
|
|
634
|
-
/**
|
|
635
|
-
* List of roles available and their permissions
|
|
636
|
-
* @type {Array<RolesInner>}
|
|
637
|
-
* @memberof GetRolesSuccessResponse
|
|
638
|
-
*/
|
|
639
|
-
'roles': Array<RolesInner>;
|
|
640
|
-
}
|
|
641
|
-
/**
|
|
642
|
-
* Successful user permissions retrieval response
|
|
643
|
-
* @export
|
|
644
|
-
* @interface GetUserPermissionsSuccessResponse
|
|
645
|
-
*/
|
|
646
|
-
export interface GetUserPermissionsSuccessResponse {
|
|
647
|
-
/**
|
|
648
|
-
* Map of resource IDs to permissions
|
|
649
|
-
* @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
|
|
650
|
-
* @memberof GetUserPermissionsSuccessResponse
|
|
651
|
-
*/
|
|
652
|
-
'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; };
|
|
653
|
-
}
|
|
654
|
-
/**
|
|
655
|
-
*
|
|
656
|
-
* @export
|
|
657
|
-
* @interface GetUserPermissionsSuccessResponseResourcesValue
|
|
658
|
-
*/
|
|
659
|
-
export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
660
|
-
/**
|
|
661
|
-
* Type of resource the permissions are assigned to
|
|
662
|
-
* @type {string}
|
|
663
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
664
|
-
*/
|
|
665
|
-
'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
|
|
666
|
-
/**
|
|
667
|
-
*
|
|
668
|
-
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
669
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
670
|
-
*/
|
|
671
|
-
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
672
|
-
/**
|
|
673
|
-
* List of permissions that are assigned to the user for the resource
|
|
674
|
-
* @type {Array<string>}
|
|
675
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
676
|
-
*/
|
|
677
|
-
'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
|
|
678
|
-
}
|
|
679
|
-
|
|
680
|
-
export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
|
|
681
|
-
Property: 'Property',
|
|
682
|
-
Org: 'Org',
|
|
683
|
-
Brand: 'Brand',
|
|
684
|
-
SalesChannel: 'SalesChannel'
|
|
685
|
-
} as const;
|
|
686
314
|
|
|
687
|
-
export
|
|
688
|
-
export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
|
|
315
|
+
export const AuthorizationBatchRequestActionEnum = {
|
|
689
316
|
AnyAuditLogs: 'AnyAuditLogs',
|
|
690
317
|
ViewApp: 'ViewApp',
|
|
691
318
|
CreateApp: 'CreateApp',
|
|
@@ -909,57 +536,332 @@ export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
|
|
|
909
536
|
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
910
537
|
CreateOrg: 'CreateOrg',
|
|
911
538
|
EditOrg: 'EditOrg',
|
|
912
|
-
ViewOrg: 'ViewOrg'
|
|
539
|
+
ViewOrg: 'ViewOrg',
|
|
540
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
541
|
+
EditWebhooks: 'EditWebhooks',
|
|
542
|
+
RoleAdmin: 'RoleAdmin',
|
|
543
|
+
RoleFactory: 'RoleFactory'
|
|
913
544
|
} as const;
|
|
914
545
|
|
|
915
|
-
export type
|
|
546
|
+
export type AuthorizationBatchRequestActionEnum = typeof AuthorizationBatchRequestActionEnum[keyof typeof AuthorizationBatchRequestActionEnum];
|
|
916
547
|
|
|
917
548
|
/**
|
|
918
|
-
*
|
|
549
|
+
*
|
|
919
550
|
* @export
|
|
920
|
-
* @interface
|
|
551
|
+
* @interface AuthorizationBatchResponse
|
|
921
552
|
*/
|
|
922
|
-
export interface
|
|
553
|
+
export interface AuthorizationBatchResponse {
|
|
554
|
+
/**
|
|
555
|
+
* Array of allowed resources
|
|
556
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
557
|
+
* @memberof AuthorizationBatchResponse
|
|
558
|
+
*/
|
|
559
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
560
|
+
/**
|
|
561
|
+
* Array of denied resources
|
|
562
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
563
|
+
* @memberof AuthorizationBatchResponse
|
|
564
|
+
*/
|
|
565
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
923
566
|
}
|
|
924
567
|
/**
|
|
925
568
|
*
|
|
926
569
|
* @export
|
|
927
|
-
* @interface
|
|
570
|
+
* @interface AuthorizationBatchResponseAllowedResourcesInner
|
|
928
571
|
*/
|
|
929
|
-
export interface
|
|
572
|
+
export interface AuthorizationBatchResponseAllowedResourcesInner {
|
|
930
573
|
/**
|
|
931
|
-
*
|
|
574
|
+
* The authorization decision
|
|
932
575
|
* @type {string}
|
|
933
|
-
* @memberof
|
|
576
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
934
577
|
*/
|
|
935
|
-
'
|
|
578
|
+
'decision': string;
|
|
579
|
+
/**
|
|
580
|
+
* Whether the action is allowed
|
|
581
|
+
* @type {boolean}
|
|
582
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
583
|
+
*/
|
|
584
|
+
'allowed': boolean;
|
|
585
|
+
/**
|
|
586
|
+
* The policy IDs that were used to make the decision
|
|
587
|
+
* @type {Array<string>}
|
|
588
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
589
|
+
*/
|
|
590
|
+
'policyIds': Array<string>;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
|
|
594
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
595
|
+
*/
|
|
596
|
+
'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
|
|
936
597
|
}
|
|
937
598
|
/**
|
|
938
|
-
*
|
|
599
|
+
* @type AuthorizationBatchResponseAllowedResourcesInnerResource
|
|
600
|
+
* Resource that the action was checked for
|
|
601
|
+
* @export
|
|
602
|
+
*/
|
|
603
|
+
export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
|
|
604
|
+
|
|
605
|
+
/**
|
|
606
|
+
* Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on the checkMode - any or all of the permissions must be allowed).
|
|
939
607
|
* @export
|
|
940
|
-
* @interface
|
|
608
|
+
* @interface AuthorizationRequest
|
|
941
609
|
*/
|
|
942
|
-
export interface
|
|
610
|
+
export interface AuthorizationRequest {
|
|
943
611
|
/**
|
|
944
612
|
*
|
|
945
|
-
* @type {
|
|
946
|
-
* @memberof
|
|
613
|
+
* @type {AuthorizationRequestPrincipal}
|
|
614
|
+
* @memberof AuthorizationRequest
|
|
947
615
|
*/
|
|
948
|
-
'
|
|
616
|
+
'principal': AuthorizationRequestPrincipal;
|
|
949
617
|
/**
|
|
950
618
|
*
|
|
619
|
+
* @type {AuthorizationRequestAction}
|
|
620
|
+
* @memberof AuthorizationRequest
|
|
621
|
+
*/
|
|
622
|
+
'action': AuthorizationRequestAction;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {AuthorizationRequestResource}
|
|
626
|
+
* @memberof AuthorizationRequest
|
|
627
|
+
*/
|
|
628
|
+
'resource'?: AuthorizationRequestResource;
|
|
629
|
+
/**
|
|
630
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
951
631
|
* @type {string}
|
|
952
|
-
* @memberof
|
|
632
|
+
* @memberof AuthorizationRequest
|
|
953
633
|
*/
|
|
954
|
-
'
|
|
634
|
+
'checkMode'?: AuthorizationRequestCheckModeEnum;
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
export const AuthorizationRequestCheckModeEnum = {
|
|
638
|
+
Any: 'any',
|
|
639
|
+
All: 'all'
|
|
640
|
+
} as const;
|
|
641
|
+
|
|
642
|
+
export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
|
|
646
|
+
* @export
|
|
647
|
+
* @interface AuthorizationRequestAction
|
|
648
|
+
*/
|
|
649
|
+
export interface AuthorizationRequestAction {
|
|
955
650
|
}
|
|
956
651
|
/**
|
|
957
652
|
*
|
|
958
653
|
* @export
|
|
959
|
-
* @
|
|
654
|
+
* @interface AuthorizationRequestPrincipal
|
|
960
655
|
*/
|
|
961
|
-
|
|
962
|
-
|
|
656
|
+
export interface AuthorizationRequestPrincipal {
|
|
657
|
+
/**
|
|
658
|
+
*
|
|
659
|
+
* @type {string}
|
|
660
|
+
* @memberof AuthorizationRequestPrincipal
|
|
661
|
+
*/
|
|
662
|
+
'type': AuthorizationRequestPrincipalTypeEnum;
|
|
663
|
+
/**
|
|
664
|
+
*
|
|
665
|
+
* @type {string}
|
|
666
|
+
* @memberof AuthorizationRequestPrincipal
|
|
667
|
+
*/
|
|
668
|
+
'id': string;
|
|
669
|
+
/**
|
|
670
|
+
*
|
|
671
|
+
* @type {string}
|
|
672
|
+
* @memberof AuthorizationRequestPrincipal
|
|
673
|
+
*/
|
|
674
|
+
'name'?: string;
|
|
675
|
+
/**
|
|
676
|
+
*
|
|
677
|
+
* @type {string}
|
|
678
|
+
* @memberof AuthorizationRequestPrincipal
|
|
679
|
+
*/
|
|
680
|
+
'email'?: string;
|
|
681
|
+
/**
|
|
682
|
+
*
|
|
683
|
+
* @type {string}
|
|
684
|
+
* @memberof AuthorizationRequestPrincipal
|
|
685
|
+
*/
|
|
686
|
+
'phone'?: string;
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
export const AuthorizationRequestPrincipalTypeEnum = {
|
|
690
|
+
User: 'User',
|
|
691
|
+
Automation: 'Automation'
|
|
692
|
+
} as const;
|
|
693
|
+
|
|
694
|
+
export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
|
|
695
|
+
|
|
696
|
+
/**
|
|
697
|
+
* @type AuthorizationRequestResource
|
|
698
|
+
* @export
|
|
699
|
+
*/
|
|
700
|
+
export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
*
|
|
704
|
+
* @export
|
|
705
|
+
* @interface AuthorizationRequestResourceOneOf
|
|
706
|
+
*/
|
|
707
|
+
export interface AuthorizationRequestResourceOneOf {
|
|
708
|
+
/**
|
|
709
|
+
*
|
|
710
|
+
* @type {string}
|
|
711
|
+
* @memberof AuthorizationRequestResourceOneOf
|
|
712
|
+
*/
|
|
713
|
+
'type': AuthorizationRequestResourceOneOfTypeEnum;
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @type {string}
|
|
717
|
+
* @memberof AuthorizationRequestResourceOneOf
|
|
718
|
+
*/
|
|
719
|
+
'id': string;
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
export const AuthorizationRequestResourceOneOfTypeEnum = {
|
|
723
|
+
Property: 'Property'
|
|
724
|
+
} as const;
|
|
725
|
+
|
|
726
|
+
export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
|
|
727
|
+
|
|
728
|
+
/**
|
|
729
|
+
*
|
|
730
|
+
* @export
|
|
731
|
+
* @interface AuthorizationRequestResourceOneOf1
|
|
732
|
+
*/
|
|
733
|
+
export interface AuthorizationRequestResourceOneOf1 {
|
|
734
|
+
/**
|
|
735
|
+
*
|
|
736
|
+
* @type {string}
|
|
737
|
+
* @memberof AuthorizationRequestResourceOneOf1
|
|
738
|
+
*/
|
|
739
|
+
'type': AuthorizationRequestResourceOneOf1TypeEnum;
|
|
740
|
+
/**
|
|
741
|
+
*
|
|
742
|
+
* @type {string}
|
|
743
|
+
* @memberof AuthorizationRequestResourceOneOf1
|
|
744
|
+
*/
|
|
745
|
+
'id': string;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
export const AuthorizationRequestResourceOneOf1TypeEnum = {
|
|
749
|
+
Org: 'Org'
|
|
750
|
+
} as const;
|
|
751
|
+
|
|
752
|
+
export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
|
|
753
|
+
|
|
754
|
+
/**
|
|
755
|
+
*
|
|
756
|
+
* @export
|
|
757
|
+
* @interface AuthorizationRequestResourceOneOf2
|
|
758
|
+
*/
|
|
759
|
+
export interface AuthorizationRequestResourceOneOf2 {
|
|
760
|
+
/**
|
|
761
|
+
*
|
|
762
|
+
* @type {string}
|
|
763
|
+
* @memberof AuthorizationRequestResourceOneOf2
|
|
764
|
+
*/
|
|
765
|
+
'type': AuthorizationRequestResourceOneOf2TypeEnum;
|
|
766
|
+
/**
|
|
767
|
+
*
|
|
768
|
+
* @type {string}
|
|
769
|
+
* @memberof AuthorizationRequestResourceOneOf2
|
|
770
|
+
*/
|
|
771
|
+
'id': string;
|
|
772
|
+
}
|
|
773
|
+
|
|
774
|
+
export const AuthorizationRequestResourceOneOf2TypeEnum = {
|
|
775
|
+
Brand: 'Brand'
|
|
776
|
+
} as const;
|
|
777
|
+
|
|
778
|
+
export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
|
|
779
|
+
|
|
780
|
+
/**
|
|
781
|
+
*
|
|
782
|
+
* @export
|
|
783
|
+
* @interface AuthorizationRequestResourceOneOf3
|
|
784
|
+
*/
|
|
785
|
+
export interface AuthorizationRequestResourceOneOf3 {
|
|
786
|
+
/**
|
|
787
|
+
*
|
|
788
|
+
* @type {string}
|
|
789
|
+
* @memberof AuthorizationRequestResourceOneOf3
|
|
790
|
+
*/
|
|
791
|
+
'type': AuthorizationRequestResourceOneOf3TypeEnum;
|
|
792
|
+
/**
|
|
793
|
+
*
|
|
794
|
+
* @type {string}
|
|
795
|
+
* @memberof AuthorizationRequestResourceOneOf3
|
|
796
|
+
*/
|
|
797
|
+
'id': string;
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
export const AuthorizationRequestResourceOneOf3TypeEnum = {
|
|
801
|
+
SalesChannel: 'SalesChannel'
|
|
802
|
+
} as const;
|
|
803
|
+
|
|
804
|
+
export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* Response containing the authorization decision
|
|
808
|
+
* @export
|
|
809
|
+
* @interface AuthorizationResponse
|
|
810
|
+
*/
|
|
811
|
+
export interface AuthorizationResponse {
|
|
812
|
+
/**
|
|
813
|
+
* Whether the action is allowed
|
|
814
|
+
* @type {boolean}
|
|
815
|
+
* @memberof AuthorizationResponse
|
|
816
|
+
*/
|
|
817
|
+
'allowed': boolean;
|
|
818
|
+
/**
|
|
819
|
+
* The authorization decision
|
|
820
|
+
* @type {string}
|
|
821
|
+
* @memberof AuthorizationResponse
|
|
822
|
+
*/
|
|
823
|
+
'decision': string;
|
|
824
|
+
/**
|
|
825
|
+
* The policy IDs that were used to make the decision
|
|
826
|
+
* @type {Array<string>}
|
|
827
|
+
* @memberof AuthorizationResponse
|
|
828
|
+
*/
|
|
829
|
+
'policyIds': Array<string>;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
*
|
|
833
|
+
* @export
|
|
834
|
+
* @interface ErrorResponse
|
|
835
|
+
*/
|
|
836
|
+
export interface ErrorResponse {
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
* @type {string}
|
|
840
|
+
* @memberof ErrorResponse
|
|
841
|
+
*/
|
|
842
|
+
'message': string;
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
* Feature based role and its permissions
|
|
846
|
+
* @export
|
|
847
|
+
* @interface FeatureBasedRole
|
|
848
|
+
*/
|
|
849
|
+
export interface FeatureBasedRole {
|
|
850
|
+
/**
|
|
851
|
+
* Name of the role
|
|
852
|
+
* @type {string}
|
|
853
|
+
* @memberof FeatureBasedRole
|
|
854
|
+
*/
|
|
855
|
+
'name': string;
|
|
856
|
+
/**
|
|
857
|
+
* List of permissions
|
|
858
|
+
* @type {Array<string>}
|
|
859
|
+
* @memberof FeatureBasedRole
|
|
860
|
+
*/
|
|
861
|
+
'permissions': Array<FeatureBasedRolePermissionsEnum>;
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
export const FeatureBasedRolePermissionsEnum = {
|
|
963
865
|
AnyAuditLogs: 'AnyAuditLogs',
|
|
964
866
|
ViewApp: 'ViewApp',
|
|
965
867
|
CreateApp: 'CreateApp',
|
|
@@ -1183,79 +1085,1854 @@ export const Permissions = {
|
|
|
1183
1085
|
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1184
1086
|
CreateOrg: 'CreateOrg',
|
|
1185
1087
|
EditOrg: 'EditOrg',
|
|
1186
|
-
ViewOrg: 'ViewOrg'
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
/**
|
|
1193
|
-
* Details for revoking a forbidden role from a principal
|
|
1194
|
-
* @export
|
|
1195
|
-
* @interface RevokeForbiddenRoleRequestBody
|
|
1196
|
-
*/
|
|
1197
|
-
export interface RevokeForbiddenRoleRequestBody {
|
|
1198
|
-
/**
|
|
1199
|
-
*
|
|
1200
|
-
* @type {AuthorizationRequestPrincipal}
|
|
1201
|
-
* @memberof RevokeForbiddenRoleRequestBody
|
|
1202
|
-
*/
|
|
1203
|
-
'principal': AuthorizationRequestPrincipal;
|
|
1204
|
-
/**
|
|
1205
|
-
* Compensation role to revoke the forbidden role from
|
|
1206
|
-
* @type {string}
|
|
1207
|
-
* @memberof RevokeForbiddenRoleRequestBody
|
|
1208
|
-
*/
|
|
1209
|
-
'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
|
|
1210
|
-
}
|
|
1211
|
-
|
|
1212
|
-
export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
|
|
1213
|
-
OwnerCompensating: 'OwnerCompensating',
|
|
1214
|
-
PropertyOwnerCompensating: 'PropertyOwnerCompensating',
|
|
1215
|
-
ManagedOwnerCompensating: 'ManagedOwnerCompensating',
|
|
1216
|
-
IntegratorCompensating: 'IntegratorCompensating',
|
|
1217
|
-
PropertyManagerCompensating: 'PropertyManagerCompensating',
|
|
1218
|
-
FinanceManagerCompensating: 'FinanceManagerCompensating'
|
|
1088
|
+
ViewOrg: 'ViewOrg',
|
|
1089
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1090
|
+
EditWebhooks: 'EditWebhooks',
|
|
1091
|
+
RoleAdmin: 'RoleAdmin',
|
|
1092
|
+
RoleFactory: 'RoleFactory'
|
|
1219
1093
|
} as const;
|
|
1220
1094
|
|
|
1221
|
-
export type
|
|
1095
|
+
export type FeatureBasedRolePermissionsEnum = typeof FeatureBasedRolePermissionsEnum[keyof typeof FeatureBasedRolePermissionsEnum];
|
|
1222
1096
|
|
|
1223
1097
|
/**
|
|
1224
|
-
*
|
|
1098
|
+
* Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
1225
1099
|
* @export
|
|
1226
|
-
* @interface
|
|
1100
|
+
* @interface GetAuthorizedBrandsRequest
|
|
1227
1101
|
*/
|
|
1228
|
-
export interface
|
|
1229
|
-
/**
|
|
1230
|
-
* Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
|
|
1231
|
-
* @type {string}
|
|
1232
|
-
* @memberof RevokeRoleRequestBody
|
|
1233
|
-
*/
|
|
1234
|
-
'role': RevokeRoleRequestBodyRoleEnum;
|
|
1102
|
+
export interface GetAuthorizedBrandsRequest {
|
|
1235
1103
|
/**
|
|
1236
1104
|
*
|
|
1237
|
-
* @type {
|
|
1238
|
-
* @memberof
|
|
1105
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
1106
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
1239
1107
|
*/
|
|
1240
|
-
'
|
|
1108
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
1241
1109
|
/**
|
|
1242
|
-
*
|
|
1243
|
-
* @type {
|
|
1244
|
-
* @memberof
|
|
1110
|
+
* Incoming request headers to be used for authentication
|
|
1111
|
+
* @type {{ [key: string]: string; }}
|
|
1112
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
1245
1113
|
*/
|
|
1246
|
-
'
|
|
1114
|
+
'headers'?: { [key: string]: string; };
|
|
1247
1115
|
/**
|
|
1248
|
-
*
|
|
1116
|
+
* The action to check authorisation for
|
|
1249
1117
|
* @type {string}
|
|
1250
|
-
* @memberof
|
|
1118
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
1251
1119
|
*/
|
|
1252
|
-
'
|
|
1120
|
+
'action': GetAuthorizedBrandsRequestActionEnum;
|
|
1253
1121
|
}
|
|
1254
1122
|
|
|
1255
|
-
export const
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1123
|
+
export const GetAuthorizedBrandsRequestActionEnum = {
|
|
1124
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
1125
|
+
ViewApp: 'ViewApp',
|
|
1126
|
+
CreateApp: 'CreateApp',
|
|
1127
|
+
UpdateApp: 'UpdateApp',
|
|
1128
|
+
ViewAppName: 'ViewAppName',
|
|
1129
|
+
EditAppAssets: 'EditAppAssets',
|
|
1130
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
1131
|
+
ViewTeammates: 'ViewTeammates',
|
|
1132
|
+
EditTeammates: 'EditTeammates',
|
|
1133
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
1134
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
1135
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
1136
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
1137
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
1138
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
1139
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
1140
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
1141
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
1142
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
1143
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
1144
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
1145
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
1146
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
1147
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
1148
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
1149
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
1150
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
1151
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
1152
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
1153
|
+
ViewOrders: 'ViewOrders',
|
|
1154
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
1155
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
1156
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
1157
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
1158
|
+
ViewStores: 'ViewStores',
|
|
1159
|
+
CreateStores: 'CreateStores',
|
|
1160
|
+
EditStores: 'EditStores',
|
|
1161
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
1162
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
1163
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
1164
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
1165
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
1166
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
1167
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
1168
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
1169
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
1170
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
1171
|
+
ArchiveStores: 'ArchiveStores',
|
|
1172
|
+
PublishStores: 'PublishStores',
|
|
1173
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
1174
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
1175
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
1176
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
1177
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
1178
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
1179
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
1180
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
1181
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
1182
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
1183
|
+
ViewMenu: 'ViewMenu',
|
|
1184
|
+
CreateMenu: 'CreateMenu',
|
|
1185
|
+
UpdateMenu: 'UpdateMenu',
|
|
1186
|
+
DeleteMenu: 'DeleteMenu',
|
|
1187
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
1188
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
1189
|
+
EditMenuImage: 'EditMenuImage',
|
|
1190
|
+
ViewVouchers: 'ViewVouchers',
|
|
1191
|
+
EditVouchers: 'EditVouchers',
|
|
1192
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
1193
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
1194
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
1195
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
1196
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
1197
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
1198
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
1199
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
1200
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
1201
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
1202
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
1203
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
1204
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
1205
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
1206
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
1207
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
1208
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
1209
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
1210
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
1211
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
1212
|
+
ViewCustomers: 'ViewCustomers',
|
|
1213
|
+
EditCustomers: 'EditCustomers',
|
|
1214
|
+
CreateCustomers: 'CreateCustomers',
|
|
1215
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
1216
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
1217
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
1218
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
1219
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
1220
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
1221
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
1222
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
1223
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
1224
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
1225
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
1226
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
1227
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
1228
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
1229
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
1230
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
1231
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
1232
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
1233
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
1234
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
1235
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
1236
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
1237
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
1238
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
1239
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
1240
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
1241
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
1242
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
1243
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
1244
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
1245
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
1246
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
1247
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
1248
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
1249
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
1250
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
1251
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
1252
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
1253
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
1254
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
1255
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
1256
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
1257
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
1258
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
1259
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
1260
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
1261
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
1262
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
1263
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
1264
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
1265
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
1266
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
1267
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
1268
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
1269
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
1270
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
1271
|
+
ViewPayouts: 'ViewPayouts',
|
|
1272
|
+
ViewChannels: 'ViewChannels',
|
|
1273
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
1274
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
1275
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
1276
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
1277
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
1278
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
1279
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
1280
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
1281
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
1282
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
1283
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
1284
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
1285
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
1286
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
1287
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
1288
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
1289
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
1290
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
1291
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
1292
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
1293
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
1294
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
1295
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
1296
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
1297
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
1298
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
1299
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
1300
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
1301
|
+
ViewInvoices: 'ViewInvoices',
|
|
1302
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
1303
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
1304
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
1305
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
1306
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
1307
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
1308
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
1309
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
1310
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
1311
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
1312
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
1313
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
1314
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
1315
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
1316
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
1317
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
1318
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
1319
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
1320
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
1321
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
1322
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
1323
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
1324
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
1325
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
1326
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
1327
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
1328
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
1329
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
1330
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
1331
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
1332
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
1333
|
+
ViewCostReports: 'ViewCostReports',
|
|
1334
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
1335
|
+
ViewBrand: 'ViewBrand',
|
|
1336
|
+
EditBrand: 'EditBrand',
|
|
1337
|
+
CreateBrand: 'CreateBrand',
|
|
1338
|
+
TransferBrand: 'TransferBrand',
|
|
1339
|
+
ViewProperty: 'ViewProperty',
|
|
1340
|
+
EditProperty: 'EditProperty',
|
|
1341
|
+
CreateProperty: 'CreateProperty',
|
|
1342
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
1343
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
1344
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1345
|
+
CreateOrg: 'CreateOrg',
|
|
1346
|
+
EditOrg: 'EditOrg',
|
|
1347
|
+
ViewOrg: 'ViewOrg',
|
|
1348
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1349
|
+
EditWebhooks: 'EditWebhooks',
|
|
1350
|
+
RoleAdmin: 'RoleAdmin',
|
|
1351
|
+
RoleFactory: 'RoleFactory'
|
|
1352
|
+
} as const;
|
|
1353
|
+
|
|
1354
|
+
export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
|
|
1355
|
+
|
|
1356
|
+
/**
|
|
1357
|
+
* Response containing the authorized brands
|
|
1358
|
+
* @export
|
|
1359
|
+
* @interface GetAuthorizedBrandsResponse
|
|
1360
|
+
*/
|
|
1361
|
+
export interface GetAuthorizedBrandsResponse {
|
|
1362
|
+
/**
|
|
1363
|
+
* Array of allowed resources
|
|
1364
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1365
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
1366
|
+
*/
|
|
1367
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Array of denied resources
|
|
1370
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1371
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
1372
|
+
*/
|
|
1373
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1374
|
+
}
|
|
1375
|
+
/**
|
|
1376
|
+
* Request to get authorized orgs for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
1377
|
+
* @export
|
|
1378
|
+
* @interface GetAuthorizedOrgsRequest
|
|
1379
|
+
*/
|
|
1380
|
+
export interface GetAuthorizedOrgsRequest {
|
|
1381
|
+
/**
|
|
1382
|
+
*
|
|
1383
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
1384
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
1385
|
+
*/
|
|
1386
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
1387
|
+
/**
|
|
1388
|
+
* Incoming request headers to be used for authentication
|
|
1389
|
+
* @type {{ [key: string]: string; }}
|
|
1390
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
1391
|
+
*/
|
|
1392
|
+
'headers'?: { [key: string]: string; };
|
|
1393
|
+
/**
|
|
1394
|
+
* The action to check authorisation for
|
|
1395
|
+
* @type {string}
|
|
1396
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
1397
|
+
*/
|
|
1398
|
+
'action': GetAuthorizedOrgsRequestActionEnum;
|
|
1399
|
+
}
|
|
1400
|
+
|
|
1401
|
+
export const GetAuthorizedOrgsRequestActionEnum = {
|
|
1402
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
1403
|
+
ViewApp: 'ViewApp',
|
|
1404
|
+
CreateApp: 'CreateApp',
|
|
1405
|
+
UpdateApp: 'UpdateApp',
|
|
1406
|
+
ViewAppName: 'ViewAppName',
|
|
1407
|
+
EditAppAssets: 'EditAppAssets',
|
|
1408
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
1409
|
+
ViewTeammates: 'ViewTeammates',
|
|
1410
|
+
EditTeammates: 'EditTeammates',
|
|
1411
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
1412
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
1413
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
1414
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
1415
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
1416
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
1417
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
1418
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
1419
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
1420
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
1421
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
1422
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
1423
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
1424
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
1425
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
1426
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
1427
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
1428
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
1429
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
1430
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
1431
|
+
ViewOrders: 'ViewOrders',
|
|
1432
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
1433
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
1434
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
1435
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
1436
|
+
ViewStores: 'ViewStores',
|
|
1437
|
+
CreateStores: 'CreateStores',
|
|
1438
|
+
EditStores: 'EditStores',
|
|
1439
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
1440
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
1441
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
1442
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
1443
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
1444
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
1445
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
1446
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
1447
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
1448
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
1449
|
+
ArchiveStores: 'ArchiveStores',
|
|
1450
|
+
PublishStores: 'PublishStores',
|
|
1451
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
1452
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
1453
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
1454
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
1455
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
1456
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
1457
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
1458
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
1459
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
1460
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
1461
|
+
ViewMenu: 'ViewMenu',
|
|
1462
|
+
CreateMenu: 'CreateMenu',
|
|
1463
|
+
UpdateMenu: 'UpdateMenu',
|
|
1464
|
+
DeleteMenu: 'DeleteMenu',
|
|
1465
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
1466
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
1467
|
+
EditMenuImage: 'EditMenuImage',
|
|
1468
|
+
ViewVouchers: 'ViewVouchers',
|
|
1469
|
+
EditVouchers: 'EditVouchers',
|
|
1470
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
1471
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
1472
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
1473
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
1474
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
1475
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
1476
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
1477
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
1478
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
1479
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
1480
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
1481
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
1482
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
1483
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
1484
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
1485
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
1486
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
1487
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
1488
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
1489
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
1490
|
+
ViewCustomers: 'ViewCustomers',
|
|
1491
|
+
EditCustomers: 'EditCustomers',
|
|
1492
|
+
CreateCustomers: 'CreateCustomers',
|
|
1493
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
1494
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
1495
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
1496
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
1497
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
1498
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
1499
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
1500
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
1501
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
1502
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
1503
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
1504
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
1505
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
1506
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
1507
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
1508
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
1509
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
1510
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
1511
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
1512
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
1513
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
1514
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
1515
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
1516
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
1517
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
1518
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
1519
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
1520
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
1521
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
1522
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
1523
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
1524
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
1525
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
1526
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
1527
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
1528
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
1529
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
1530
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
1531
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
1532
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
1533
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
1534
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
1535
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
1536
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
1537
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
1538
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
1539
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
1540
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
1541
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
1542
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
1543
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
1544
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
1545
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
1546
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
1547
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
1548
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
1549
|
+
ViewPayouts: 'ViewPayouts',
|
|
1550
|
+
ViewChannels: 'ViewChannels',
|
|
1551
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
1552
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
1553
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
1554
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
1555
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
1556
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
1557
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
1558
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
1559
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
1560
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
1561
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
1562
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
1563
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
1564
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
1565
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
1566
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
1567
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
1568
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
1569
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
1570
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
1571
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
1572
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
1573
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
1574
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
1575
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
1576
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
1577
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
1578
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
1579
|
+
ViewInvoices: 'ViewInvoices',
|
|
1580
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
1581
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
1582
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
1583
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
1584
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
1585
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
1586
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
1587
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
1588
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
1589
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
1590
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
1591
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
1592
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
1593
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
1594
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
1595
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
1596
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
1597
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
1598
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
1599
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
1600
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
1601
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
1602
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
1603
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
1604
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
1605
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
1606
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
1607
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
1608
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
1609
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
1610
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
1611
|
+
ViewCostReports: 'ViewCostReports',
|
|
1612
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
1613
|
+
ViewBrand: 'ViewBrand',
|
|
1614
|
+
EditBrand: 'EditBrand',
|
|
1615
|
+
CreateBrand: 'CreateBrand',
|
|
1616
|
+
TransferBrand: 'TransferBrand',
|
|
1617
|
+
ViewProperty: 'ViewProperty',
|
|
1618
|
+
EditProperty: 'EditProperty',
|
|
1619
|
+
CreateProperty: 'CreateProperty',
|
|
1620
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
1621
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
1622
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1623
|
+
CreateOrg: 'CreateOrg',
|
|
1624
|
+
EditOrg: 'EditOrg',
|
|
1625
|
+
ViewOrg: 'ViewOrg',
|
|
1626
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1627
|
+
EditWebhooks: 'EditWebhooks',
|
|
1628
|
+
RoleAdmin: 'RoleAdmin',
|
|
1629
|
+
RoleFactory: 'RoleFactory'
|
|
1630
|
+
} as const;
|
|
1631
|
+
|
|
1632
|
+
export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* The principal to get authorized entities for
|
|
1636
|
+
* @export
|
|
1637
|
+
* @interface GetAuthorizedOrgsRequestPrincipal
|
|
1638
|
+
*/
|
|
1639
|
+
export interface GetAuthorizedOrgsRequestPrincipal {
|
|
1640
|
+
/**
|
|
1641
|
+
*
|
|
1642
|
+
* @type {string}
|
|
1643
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1644
|
+
*/
|
|
1645
|
+
'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
* @type {string}
|
|
1649
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1650
|
+
*/
|
|
1651
|
+
'id': string;
|
|
1652
|
+
/**
|
|
1653
|
+
*
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1656
|
+
*/
|
|
1657
|
+
'name'?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
*
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1662
|
+
*/
|
|
1663
|
+
'email'?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
*
|
|
1666
|
+
* @type {string}
|
|
1667
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1668
|
+
*/
|
|
1669
|
+
'phone'?: string;
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
export const GetAuthorizedOrgsRequestPrincipalTypeEnum = {
|
|
1673
|
+
User: 'User',
|
|
1674
|
+
Automation: 'Automation'
|
|
1675
|
+
} as const;
|
|
1676
|
+
|
|
1677
|
+
export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
|
|
1678
|
+
|
|
1679
|
+
/**
|
|
1680
|
+
* Response containing the authorized orgs
|
|
1681
|
+
* @export
|
|
1682
|
+
* @interface GetAuthorizedOrgsResponse
|
|
1683
|
+
*/
|
|
1684
|
+
export interface GetAuthorizedOrgsResponse {
|
|
1685
|
+
/**
|
|
1686
|
+
* Array of allowed resources
|
|
1687
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1688
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1689
|
+
*/
|
|
1690
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1691
|
+
/**
|
|
1692
|
+
* Array of denied resources
|
|
1693
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1694
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1695
|
+
*/
|
|
1696
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1697
|
+
}
|
|
1698
|
+
/**
|
|
1699
|
+
* Request to get authorized properties for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
|
|
1700
|
+
* @export
|
|
1701
|
+
* @interface GetAuthorizedPropertiesRequest
|
|
1702
|
+
*/
|
|
1703
|
+
export interface GetAuthorizedPropertiesRequest {
|
|
1704
|
+
/**
|
|
1705
|
+
*
|
|
1706
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
1707
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1708
|
+
*/
|
|
1709
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
1710
|
+
/**
|
|
1711
|
+
* Incoming request headers to be used for authentication
|
|
1712
|
+
* @type {{ [key: string]: string; }}
|
|
1713
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1714
|
+
*/
|
|
1715
|
+
'headers'?: { [key: string]: string; };
|
|
1716
|
+
/**
|
|
1717
|
+
* The action to check authorisation for
|
|
1718
|
+
* @type {string}
|
|
1719
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1720
|
+
*/
|
|
1721
|
+
'action': GetAuthorizedPropertiesRequestActionEnum;
|
|
1722
|
+
}
|
|
1723
|
+
|
|
1724
|
+
export const GetAuthorizedPropertiesRequestActionEnum = {
|
|
1725
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
1726
|
+
ViewApp: 'ViewApp',
|
|
1727
|
+
CreateApp: 'CreateApp',
|
|
1728
|
+
UpdateApp: 'UpdateApp',
|
|
1729
|
+
ViewAppName: 'ViewAppName',
|
|
1730
|
+
EditAppAssets: 'EditAppAssets',
|
|
1731
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
1732
|
+
ViewTeammates: 'ViewTeammates',
|
|
1733
|
+
EditTeammates: 'EditTeammates',
|
|
1734
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
1735
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
1736
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
1737
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
1738
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
1739
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
1740
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
1741
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
1742
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
1743
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
1744
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
1745
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
1746
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
1747
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
1748
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
1749
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
1750
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
1751
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
1752
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
1753
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
1754
|
+
ViewOrders: 'ViewOrders',
|
|
1755
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
1756
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
1757
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
1758
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
1759
|
+
ViewStores: 'ViewStores',
|
|
1760
|
+
CreateStores: 'CreateStores',
|
|
1761
|
+
EditStores: 'EditStores',
|
|
1762
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
1763
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
1764
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
1765
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
1766
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
1767
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
1768
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
1769
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
1770
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
1771
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
1772
|
+
ArchiveStores: 'ArchiveStores',
|
|
1773
|
+
PublishStores: 'PublishStores',
|
|
1774
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
1775
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
1776
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
1777
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
1778
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
1779
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
1780
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
1781
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
1782
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
1783
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
1784
|
+
ViewMenu: 'ViewMenu',
|
|
1785
|
+
CreateMenu: 'CreateMenu',
|
|
1786
|
+
UpdateMenu: 'UpdateMenu',
|
|
1787
|
+
DeleteMenu: 'DeleteMenu',
|
|
1788
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
1789
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
1790
|
+
EditMenuImage: 'EditMenuImage',
|
|
1791
|
+
ViewVouchers: 'ViewVouchers',
|
|
1792
|
+
EditVouchers: 'EditVouchers',
|
|
1793
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
1794
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
1795
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
1796
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
1797
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
1798
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
1799
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
1800
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
1801
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
1802
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
1803
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
1804
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
1805
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
1806
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
1807
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
1808
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
1809
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
1810
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
1811
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
1812
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
1813
|
+
ViewCustomers: 'ViewCustomers',
|
|
1814
|
+
EditCustomers: 'EditCustomers',
|
|
1815
|
+
CreateCustomers: 'CreateCustomers',
|
|
1816
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
1817
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
1818
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
1819
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
1820
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
1821
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
1822
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
1823
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
1824
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
1825
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
1826
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
1827
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
1828
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
1829
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
1830
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
1831
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
1832
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
1833
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
1834
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
1835
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
1836
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
1837
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
1838
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
1839
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
1840
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
1841
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
1842
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
1843
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
1844
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
1845
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
1846
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
1847
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
1848
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
1849
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
1850
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
1851
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
1852
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
1853
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
1854
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
1855
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
1856
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
1857
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
1858
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
1859
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
1860
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
1861
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
1862
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
1863
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
1864
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
1865
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
1866
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
1867
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
1868
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
1869
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
1870
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
1871
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
1872
|
+
ViewPayouts: 'ViewPayouts',
|
|
1873
|
+
ViewChannels: 'ViewChannels',
|
|
1874
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
1875
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
1876
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
1877
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
1878
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
1879
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
1880
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
1881
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
1882
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
1883
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
1884
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
1885
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
1886
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
1887
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
1888
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
1889
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
1890
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
1891
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
1892
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
1893
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
1894
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
1895
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
1896
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
1897
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
1898
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
1899
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
1900
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
1901
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
1902
|
+
ViewInvoices: 'ViewInvoices',
|
|
1903
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
1904
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
1905
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
1906
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
1907
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
1908
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
1909
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
1910
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
1911
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
1912
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
1913
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
1914
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
1915
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
1916
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
1917
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
1918
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
1919
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
1920
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
1921
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
1922
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
1923
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
1924
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
1925
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
1926
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
1927
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
1928
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
1929
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
1930
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
1931
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
1932
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
1933
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
1934
|
+
ViewCostReports: 'ViewCostReports',
|
|
1935
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
1936
|
+
ViewBrand: 'ViewBrand',
|
|
1937
|
+
EditBrand: 'EditBrand',
|
|
1938
|
+
CreateBrand: 'CreateBrand',
|
|
1939
|
+
TransferBrand: 'TransferBrand',
|
|
1940
|
+
ViewProperty: 'ViewProperty',
|
|
1941
|
+
EditProperty: 'EditProperty',
|
|
1942
|
+
CreateProperty: 'CreateProperty',
|
|
1943
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
1944
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
1945
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
1946
|
+
CreateOrg: 'CreateOrg',
|
|
1947
|
+
EditOrg: 'EditOrg',
|
|
1948
|
+
ViewOrg: 'ViewOrg',
|
|
1949
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
1950
|
+
EditWebhooks: 'EditWebhooks',
|
|
1951
|
+
RoleAdmin: 'RoleAdmin',
|
|
1952
|
+
RoleFactory: 'RoleFactory'
|
|
1953
|
+
} as const;
|
|
1954
|
+
|
|
1955
|
+
export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
|
|
1956
|
+
|
|
1957
|
+
/**
|
|
1958
|
+
* Response containing the authorized properties
|
|
1959
|
+
* @export
|
|
1960
|
+
* @interface GetAuthorizedPropertiesResponse
|
|
1961
|
+
*/
|
|
1962
|
+
export interface GetAuthorizedPropertiesResponse {
|
|
1963
|
+
/**
|
|
1964
|
+
* Array of allowed resources
|
|
1965
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1966
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1967
|
+
*/
|
|
1968
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1969
|
+
/**
|
|
1970
|
+
* Array of denied resources
|
|
1971
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1972
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1973
|
+
*/
|
|
1974
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1975
|
+
}
|
|
1976
|
+
/**
|
|
1977
|
+
* Details for getting roles for a principal
|
|
1978
|
+
* @export
|
|
1979
|
+
* @interface GetPrincipalRolesRequestBody
|
|
1980
|
+
*/
|
|
1981
|
+
export interface GetPrincipalRolesRequestBody {
|
|
1982
|
+
/**
|
|
1983
|
+
*
|
|
1984
|
+
* @type {AuthorizationRequestPrincipal}
|
|
1985
|
+
* @memberof GetPrincipalRolesRequestBody
|
|
1986
|
+
*/
|
|
1987
|
+
'principal': AuthorizationRequestPrincipal;
|
|
1988
|
+
/**
|
|
1989
|
+
*
|
|
1990
|
+
* @type {AuthorizationRequestResource}
|
|
1991
|
+
* @memberof GetPrincipalRolesRequestBody
|
|
1992
|
+
*/
|
|
1993
|
+
'resource'?: AuthorizationRequestResource;
|
|
1994
|
+
}
|
|
1995
|
+
/**
|
|
1996
|
+
* Successful roles retrieval response
|
|
1997
|
+
* @export
|
|
1998
|
+
* @interface GetPrincipalRolesSuccessResponse
|
|
1999
|
+
*/
|
|
2000
|
+
export interface GetPrincipalRolesSuccessResponse {
|
|
2001
|
+
/**
|
|
2002
|
+
* List of roles assigned to the principal
|
|
2003
|
+
* @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
|
|
2004
|
+
* @memberof GetPrincipalRolesSuccessResponse
|
|
2005
|
+
*/
|
|
2006
|
+
'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
|
|
2007
|
+
}
|
|
2008
|
+
/**
|
|
2009
|
+
*
|
|
2010
|
+
* @export
|
|
2011
|
+
* @interface GetPrincipalRolesSuccessResponseRolesInner
|
|
2012
|
+
*/
|
|
2013
|
+
export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
2014
|
+
/**
|
|
2015
|
+
* Policy ID
|
|
2016
|
+
* @type {string}
|
|
2017
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2018
|
+
*/
|
|
2019
|
+
'policyId': string;
|
|
2020
|
+
/**
|
|
2021
|
+
*
|
|
2022
|
+
* @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
|
|
2023
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2024
|
+
*/
|
|
2025
|
+
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
|
|
2026
|
+
/**
|
|
2027
|
+
* Policy type
|
|
2028
|
+
* @type {string}
|
|
2029
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2030
|
+
*/
|
|
2031
|
+
'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
|
|
2032
|
+
/**
|
|
2033
|
+
* Date and time the role was assigned
|
|
2034
|
+
* @type {string}
|
|
2035
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2036
|
+
*/
|
|
2037
|
+
'assignedAt': string;
|
|
2038
|
+
/**
|
|
2039
|
+
* User who assigned the role
|
|
2040
|
+
* @type {string}
|
|
2041
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2042
|
+
*/
|
|
2043
|
+
'assignedBy': string;
|
|
2044
|
+
/**
|
|
2045
|
+
* Type of resource the role is assigned to
|
|
2046
|
+
* @type {string}
|
|
2047
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2048
|
+
*/
|
|
2049
|
+
'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
2050
|
+
/**
|
|
2051
|
+
* Organization ID
|
|
2052
|
+
* @type {string}
|
|
2053
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2054
|
+
*/
|
|
2055
|
+
'orgId'?: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* Property ID
|
|
2058
|
+
* @type {string}
|
|
2059
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2060
|
+
*/
|
|
2061
|
+
'propertyId'?: string;
|
|
2062
|
+
/**
|
|
2063
|
+
* Brand ID this role is scoped to
|
|
2064
|
+
* @type {string}
|
|
2065
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2066
|
+
*/
|
|
2067
|
+
'brandId'?: string;
|
|
2068
|
+
/**
|
|
2069
|
+
* Sales channel ID this role is scoped to
|
|
2070
|
+
* @type {string}
|
|
2071
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2072
|
+
*/
|
|
2073
|
+
'salesChannelId'?: string;
|
|
2074
|
+
/**
|
|
2075
|
+
* Principal ID this role is assigned to
|
|
2076
|
+
* @type {string}
|
|
2077
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2078
|
+
*/
|
|
2079
|
+
'principalId': string;
|
|
2080
|
+
/**
|
|
2081
|
+
* Type of principal this role is assigned to
|
|
2082
|
+
* @type {string}
|
|
2083
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
2084
|
+
*/
|
|
2085
|
+
'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
|
|
2086
|
+
}
|
|
2087
|
+
|
|
2088
|
+
export const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = {
|
|
2089
|
+
Main: 'Main',
|
|
2090
|
+
BrandOverride: 'BrandOverride',
|
|
2091
|
+
OrgOverride: 'OrgOverride',
|
|
2092
|
+
Forbidden: 'Forbidden',
|
|
2093
|
+
NamedRole: 'NamedRole'
|
|
2094
|
+
} as const;
|
|
2095
|
+
|
|
2096
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
|
|
2097
|
+
export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
|
|
2098
|
+
Property: 'Property',
|
|
2099
|
+
Org: 'Org',
|
|
2100
|
+
Brand: 'Brand',
|
|
2101
|
+
SalesChannel: 'SalesChannel'
|
|
2102
|
+
} as const;
|
|
2103
|
+
|
|
2104
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
2105
|
+
export const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = {
|
|
2106
|
+
User: 'User',
|
|
2107
|
+
Automation: 'Automation'
|
|
2108
|
+
} as const;
|
|
2109
|
+
|
|
2110
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* Role name
|
|
2114
|
+
* @export
|
|
2115
|
+
* @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
|
|
2116
|
+
*/
|
|
2117
|
+
export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
|
|
2118
|
+
}
|
|
2119
|
+
/**
|
|
2120
|
+
* Successful user permissions retrieval response
|
|
2121
|
+
* @export
|
|
2122
|
+
* @interface GetUserPermissionsSuccessResponse
|
|
2123
|
+
*/
|
|
2124
|
+
export interface GetUserPermissionsSuccessResponse {
|
|
2125
|
+
/**
|
|
2126
|
+
* Map of resource IDs to permissions
|
|
2127
|
+
* @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
|
|
2128
|
+
* @memberof GetUserPermissionsSuccessResponse
|
|
2129
|
+
*/
|
|
2130
|
+
'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; };
|
|
2131
|
+
}
|
|
2132
|
+
/**
|
|
2133
|
+
*
|
|
2134
|
+
* @export
|
|
2135
|
+
* @interface GetUserPermissionsSuccessResponseResourcesValue
|
|
2136
|
+
*/
|
|
2137
|
+
export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
2138
|
+
/**
|
|
2139
|
+
* Type of resource the permissions are assigned to
|
|
2140
|
+
* @type {string}
|
|
2141
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
2142
|
+
*/
|
|
2143
|
+
'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
|
|
2144
|
+
/**
|
|
2145
|
+
*
|
|
2146
|
+
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
2147
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
2148
|
+
*/
|
|
2149
|
+
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
2150
|
+
/**
|
|
2151
|
+
* List of permissions that are assigned to the user for the resource
|
|
2152
|
+
* @type {Array<string>}
|
|
2153
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
2154
|
+
*/
|
|
2155
|
+
'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
|
|
2156
|
+
}
|
|
2157
|
+
|
|
2158
|
+
export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
|
|
2159
|
+
Property: 'Property',
|
|
2160
|
+
Org: 'Org',
|
|
2161
|
+
Brand: 'Brand',
|
|
2162
|
+
SalesChannel: 'SalesChannel'
|
|
2163
|
+
} as const;
|
|
2164
|
+
|
|
2165
|
+
export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
|
|
2166
|
+
export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
|
|
2167
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
2168
|
+
ViewApp: 'ViewApp',
|
|
2169
|
+
CreateApp: 'CreateApp',
|
|
2170
|
+
UpdateApp: 'UpdateApp',
|
|
2171
|
+
ViewAppName: 'ViewAppName',
|
|
2172
|
+
EditAppAssets: 'EditAppAssets',
|
|
2173
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
2174
|
+
ViewTeammates: 'ViewTeammates',
|
|
2175
|
+
EditTeammates: 'EditTeammates',
|
|
2176
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
2177
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
2178
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
2179
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
2180
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
2181
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
2182
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
2183
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
2184
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
2185
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
2186
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
2187
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
2188
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
2189
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
2190
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
2191
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
2192
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
2193
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
2194
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
2195
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
2196
|
+
ViewOrders: 'ViewOrders',
|
|
2197
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
2198
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
2199
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
2200
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
2201
|
+
ViewStores: 'ViewStores',
|
|
2202
|
+
CreateStores: 'CreateStores',
|
|
2203
|
+
EditStores: 'EditStores',
|
|
2204
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
2205
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
2206
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
2207
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
2208
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
2209
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
2210
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
2211
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
2212
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
2213
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
2214
|
+
ArchiveStores: 'ArchiveStores',
|
|
2215
|
+
PublishStores: 'PublishStores',
|
|
2216
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
2217
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
2218
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
2219
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
2220
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
2221
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
2222
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
2223
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
2224
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
2225
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
2226
|
+
ViewMenu: 'ViewMenu',
|
|
2227
|
+
CreateMenu: 'CreateMenu',
|
|
2228
|
+
UpdateMenu: 'UpdateMenu',
|
|
2229
|
+
DeleteMenu: 'DeleteMenu',
|
|
2230
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
2231
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
2232
|
+
EditMenuImage: 'EditMenuImage',
|
|
2233
|
+
ViewVouchers: 'ViewVouchers',
|
|
2234
|
+
EditVouchers: 'EditVouchers',
|
|
2235
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
2236
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
2237
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
2238
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
2239
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
2240
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
2241
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
2242
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
2243
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
2244
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
2245
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
2246
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
2247
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
2248
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
2249
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
2250
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
2251
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
2252
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
2253
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
2254
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
2255
|
+
ViewCustomers: 'ViewCustomers',
|
|
2256
|
+
EditCustomers: 'EditCustomers',
|
|
2257
|
+
CreateCustomers: 'CreateCustomers',
|
|
2258
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
2259
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
2260
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
2261
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
2262
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
2263
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
2264
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
2265
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
2266
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
2267
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
2268
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
2269
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
2270
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
2271
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
2272
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
2273
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
2274
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
2275
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
2276
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
2277
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
2278
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
2279
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
2280
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
2281
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
2282
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
2283
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
2284
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
2285
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
2286
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
2287
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
2288
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
2289
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
2290
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
2291
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
2292
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
2293
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
2294
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
2295
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
2296
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
2297
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
2298
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
2299
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
2300
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
2301
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
2302
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
2303
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
2304
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
2305
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
2306
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
2307
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
2308
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
2309
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
2310
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
2311
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
2312
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
2313
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
2314
|
+
ViewPayouts: 'ViewPayouts',
|
|
2315
|
+
ViewChannels: 'ViewChannels',
|
|
2316
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
2317
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
2318
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
2319
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
2320
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
2321
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
2322
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
2323
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
2324
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
2325
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
2326
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
2327
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
2328
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
2329
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
2330
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
2331
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
2332
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
2333
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
2334
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
2335
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
2336
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
2337
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
2338
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
2339
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
2340
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
2341
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
2342
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
2343
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
2344
|
+
ViewInvoices: 'ViewInvoices',
|
|
2345
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
2346
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
2347
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
2348
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
2349
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
2350
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
2351
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
2352
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
2353
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
2354
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
2355
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
2356
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
2357
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
2358
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
2359
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
2360
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
2361
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
2362
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
2363
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
2364
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
2365
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
2366
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
2367
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
2368
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
2369
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
2370
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
2371
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
2372
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
2373
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
2374
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
2375
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
2376
|
+
ViewCostReports: 'ViewCostReports',
|
|
2377
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
2378
|
+
ViewBrand: 'ViewBrand',
|
|
2379
|
+
EditBrand: 'EditBrand',
|
|
2380
|
+
CreateBrand: 'CreateBrand',
|
|
2381
|
+
TransferBrand: 'TransferBrand',
|
|
2382
|
+
ViewProperty: 'ViewProperty',
|
|
2383
|
+
EditProperty: 'EditProperty',
|
|
2384
|
+
CreateProperty: 'CreateProperty',
|
|
2385
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
2386
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
2387
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
2388
|
+
CreateOrg: 'CreateOrg',
|
|
2389
|
+
EditOrg: 'EditOrg',
|
|
2390
|
+
ViewOrg: 'ViewOrg',
|
|
2391
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
2392
|
+
EditWebhooks: 'EditWebhooks',
|
|
2393
|
+
RoleAdmin: 'RoleAdmin',
|
|
2394
|
+
RoleFactory: 'RoleFactory'
|
|
2395
|
+
} as const;
|
|
2396
|
+
|
|
2397
|
+
export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* ID of the resource the permissions are assigned to
|
|
2401
|
+
* @export
|
|
2402
|
+
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
2403
|
+
*/
|
|
2404
|
+
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
2405
|
+
}
|
|
2406
|
+
/**
|
|
2407
|
+
*
|
|
2408
|
+
* @export
|
|
2409
|
+
* @interface IsInRoleRequest
|
|
2410
|
+
*/
|
|
2411
|
+
export interface IsInRoleRequest {
|
|
2412
|
+
/**
|
|
2413
|
+
*
|
|
2414
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2415
|
+
* @memberof IsInRoleRequest
|
|
2416
|
+
*/
|
|
2417
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2418
|
+
/**
|
|
2419
|
+
* Array of roles to check if the principal is in
|
|
2420
|
+
* @type {Array<string>}
|
|
2421
|
+
* @memberof IsInRoleRequest
|
|
2422
|
+
*/
|
|
2423
|
+
'roles': Array<IsInRoleRequestRolesEnum>;
|
|
2424
|
+
/**
|
|
2425
|
+
* How to check authorisation - any or all of the actions must be allowed
|
|
2426
|
+
* @type {string}
|
|
2427
|
+
* @memberof IsInRoleRequest
|
|
2428
|
+
*/
|
|
2429
|
+
'checkMode'?: IsInRoleRequestCheckModeEnum;
|
|
2430
|
+
}
|
|
2431
|
+
|
|
2432
|
+
export const IsInRoleRequestRolesEnum = {
|
|
2433
|
+
Admin: 'Admin',
|
|
2434
|
+
Factory: 'Factory'
|
|
2435
|
+
} as const;
|
|
2436
|
+
|
|
2437
|
+
export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
|
|
2438
|
+
export const IsInRoleRequestCheckModeEnum = {
|
|
2439
|
+
Any: 'any',
|
|
2440
|
+
All: 'all'
|
|
2441
|
+
} as const;
|
|
2442
|
+
|
|
2443
|
+
export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
|
|
2444
|
+
|
|
2445
|
+
/**
|
|
2446
|
+
* Response containing whether the principal is in any/all of the roles
|
|
2447
|
+
* @export
|
|
2448
|
+
* @interface IsInRoleResponse
|
|
2449
|
+
*/
|
|
2450
|
+
export interface IsInRoleResponse {
|
|
2451
|
+
/**
|
|
2452
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
2453
|
+
* @type {boolean}
|
|
2454
|
+
* @memberof IsInRoleResponse
|
|
2455
|
+
*/
|
|
2456
|
+
'authorized': boolean;
|
|
2457
|
+
}
|
|
2458
|
+
/**
|
|
2459
|
+
* Successful feature based roles retrieval response
|
|
2460
|
+
* @export
|
|
2461
|
+
* @interface ListFeatureBasedRolesSuccessResponse
|
|
2462
|
+
*/
|
|
2463
|
+
export interface ListFeatureBasedRolesSuccessResponse {
|
|
2464
|
+
/**
|
|
2465
|
+
*
|
|
2466
|
+
* @type {Array<FeatureBasedRole>}
|
|
2467
|
+
* @memberof ListFeatureBasedRolesSuccessResponse
|
|
2468
|
+
*/
|
|
2469
|
+
'roles': Array<FeatureBasedRole>;
|
|
2470
|
+
}
|
|
2471
|
+
/**
|
|
2472
|
+
*
|
|
2473
|
+
* @export
|
|
2474
|
+
* @interface ListOrgRolesSuccessResponseValueValue
|
|
2475
|
+
*/
|
|
2476
|
+
export interface ListOrgRolesSuccessResponseValueValue {
|
|
2477
|
+
/**
|
|
2478
|
+
* Type of resource the permissions are assigned to
|
|
2479
|
+
* @type {string}
|
|
2480
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
2481
|
+
*/
|
|
2482
|
+
'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
|
|
2483
|
+
/**
|
|
2484
|
+
*
|
|
2485
|
+
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
2486
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
2487
|
+
*/
|
|
2488
|
+
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
2489
|
+
/**
|
|
2490
|
+
* List of roles that are assigned to the user for the resource
|
|
2491
|
+
* @type {Array<string>}
|
|
2492
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
2493
|
+
*/
|
|
2494
|
+
'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
|
|
2495
|
+
}
|
|
2496
|
+
|
|
2497
|
+
export const ListOrgRolesSuccessResponseValueValueResourceTypeEnum = {
|
|
2498
|
+
Property: 'Property',
|
|
2499
|
+
Org: 'Org',
|
|
2500
|
+
Brand: 'Brand',
|
|
2501
|
+
SalesChannel: 'SalesChannel'
|
|
2502
|
+
} as const;
|
|
2503
|
+
|
|
2504
|
+
export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
|
|
2505
|
+
export const ListOrgRolesSuccessResponseValueValueRolesEnum = {
|
|
2506
|
+
OrgViewer: 'OrgViewer',
|
|
2507
|
+
OrgManager: 'OrgManager',
|
|
2508
|
+
OrgAdmin: 'OrgAdmin',
|
|
2509
|
+
BrandViewer: 'BrandViewer',
|
|
2510
|
+
BrandManager: 'BrandManager',
|
|
2511
|
+
BrandAdmin: 'BrandAdmin',
|
|
2512
|
+
StoreViewer: 'StoreViewer',
|
|
2513
|
+
StoreEditor: 'StoreEditor',
|
|
2514
|
+
StoreManager: 'StoreManager',
|
|
2515
|
+
CustomerViewer: 'CustomerViewer',
|
|
2516
|
+
CustomerManager: 'CustomerManager',
|
|
2517
|
+
VoucherViewer: 'VoucherViewer',
|
|
2518
|
+
VoucherEditor: 'VoucherEditor',
|
|
2519
|
+
VoucherManager: 'VoucherManager',
|
|
2520
|
+
VoucherCampaignManager: 'VoucherCampaignManager',
|
|
2521
|
+
VoucherStatisticsViewer: 'VoucherStatisticsViewer',
|
|
2522
|
+
AnalyticsViewer: 'AnalyticsViewer',
|
|
2523
|
+
ReportsViewer: 'ReportsViewer',
|
|
2524
|
+
FinanceViewer: 'FinanceViewer',
|
|
2525
|
+
FinanceManager: 'FinanceManager',
|
|
2526
|
+
TeamViewer: 'TeamViewer',
|
|
2527
|
+
TeamManager: 'TeamManager',
|
|
2528
|
+
TeamAdmin: 'TeamAdmin',
|
|
2529
|
+
TechViewer: 'TechViewer',
|
|
2530
|
+
TechManager: 'TechManager',
|
|
2531
|
+
AppStoreViewer: 'AppStoreViewer',
|
|
2532
|
+
AppStoreManager: 'AppStoreManager',
|
|
2533
|
+
SalesChannelViewer: 'SalesChannelViewer',
|
|
2534
|
+
SalesChannelEditor: 'SalesChannelEditor',
|
|
2535
|
+
SalesChannelManager: 'SalesChannelManager',
|
|
2536
|
+
DeliveryViewer: 'DeliveryViewer',
|
|
2537
|
+
DeliveryManager: 'DeliveryManager',
|
|
2538
|
+
DriverManager: 'DriverManager',
|
|
2539
|
+
AuditViewer: 'AuditViewer',
|
|
2540
|
+
AuditManager: 'AuditManager',
|
|
2541
|
+
AccountsViewer: 'AccountsViewer',
|
|
2542
|
+
AccountsEditor: 'AccountsEditor',
|
|
2543
|
+
DocumentExplorerViewer: 'DocumentExplorerViewer',
|
|
2544
|
+
DocumentExplorerEditor: 'DocumentExplorerEditor',
|
|
2545
|
+
PayrollViewer: 'PayrollViewer',
|
|
2546
|
+
PayrollEditor: 'PayrollEditor',
|
|
2547
|
+
PropertyViewer: 'PropertyViewer',
|
|
2548
|
+
PropertyManager: 'PropertyManager',
|
|
2549
|
+
PropertyAdmin: 'PropertyAdmin',
|
|
2550
|
+
WebsiteContentEditor: 'WebsiteContentEditor',
|
|
2551
|
+
WebsiteContentViewer: 'WebsiteContentViewer',
|
|
2552
|
+
WebsiteTechViewer: 'WebsiteTechViewer',
|
|
2553
|
+
MenuViewer: 'MenuViewer',
|
|
2554
|
+
MenuEditor: 'MenuEditor',
|
|
2555
|
+
MenuManager: 'MenuManager',
|
|
2556
|
+
MenuMetaFieldManager: 'MenuMetaFieldManager',
|
|
2557
|
+
MenuMetaFieldEditor: 'MenuMetaFieldEditor',
|
|
2558
|
+
MenuMetaFieldViewer: 'MenuMetaFieldViewer',
|
|
2559
|
+
StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
|
|
2560
|
+
StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
|
|
2561
|
+
StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
|
|
2562
|
+
OrderFulfillmentManager: 'OrderFulfillmentManager',
|
|
2563
|
+
OrderManager: 'OrderManager',
|
|
2564
|
+
OrderEditor: 'OrderEditor',
|
|
2565
|
+
OrderViewer: 'OrderViewer',
|
|
2566
|
+
InventoryManager: 'InventoryManager',
|
|
2567
|
+
InventoryEditor: 'InventoryEditor',
|
|
2568
|
+
InventoryViewer: 'InventoryViewer',
|
|
2569
|
+
PaymentManager: 'PaymentManager',
|
|
2570
|
+
OnboardingManager: 'OnboardingManager',
|
|
2571
|
+
FeatureFlagManager: 'FeatureFlagManager',
|
|
2572
|
+
PropertyOwnerMisc: 'PropertyOwnerMisc',
|
|
2573
|
+
ManagedOwnerMisc: 'ManagedOwnerMisc',
|
|
2574
|
+
IntegratorMisc: 'IntegratorMisc',
|
|
2575
|
+
PropertyManagerMisc: 'PropertyManagerMisc',
|
|
2576
|
+
FinanceManagerMisc: 'FinanceManagerMisc',
|
|
2577
|
+
SupportMisc: 'SupportMisc'
|
|
2578
|
+
} as const;
|
|
2579
|
+
|
|
2580
|
+
export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
|
|
2581
|
+
|
|
2582
|
+
/**
|
|
2583
|
+
* Successful permissions retrieval response
|
|
2584
|
+
* @export
|
|
2585
|
+
* @interface ListPermissionsSuccessResponse
|
|
2586
|
+
*/
|
|
2587
|
+
export interface ListPermissionsSuccessResponse {
|
|
2588
|
+
/**
|
|
2589
|
+
* List of permissions
|
|
2590
|
+
* @type {Array<string>}
|
|
2591
|
+
* @memberof ListPermissionsSuccessResponse
|
|
2592
|
+
*/
|
|
2593
|
+
'permissions': Array<ListPermissionsSuccessResponsePermissionsEnum>;
|
|
2594
|
+
}
|
|
2595
|
+
|
|
2596
|
+
export const ListPermissionsSuccessResponsePermissionsEnum = {
|
|
2597
|
+
AnyAuditLogs: 'AnyAuditLogs',
|
|
2598
|
+
ViewApp: 'ViewApp',
|
|
2599
|
+
CreateApp: 'CreateApp',
|
|
2600
|
+
UpdateApp: 'UpdateApp',
|
|
2601
|
+
ViewAppName: 'ViewAppName',
|
|
2602
|
+
EditAppAssets: 'EditAppAssets',
|
|
2603
|
+
EditAppFeatures: 'EditAppFeatures',
|
|
2604
|
+
ViewTeammates: 'ViewTeammates',
|
|
2605
|
+
EditTeammates: 'EditTeammates',
|
|
2606
|
+
CreateTeammateOwner: 'CreateTeammateOwner',
|
|
2607
|
+
CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
|
|
2608
|
+
CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
|
|
2609
|
+
CreateTeammateStoreManager: 'CreateTeammateStoreManager',
|
|
2610
|
+
CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
|
|
2611
|
+
CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
|
|
2612
|
+
CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
|
|
2613
|
+
CreateTeammateIntegrator: 'CreateTeammateIntegrator',
|
|
2614
|
+
CreateTeammateOnboarding: 'CreateTeammateOnboarding',
|
|
2615
|
+
CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
|
|
2616
|
+
CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
|
|
2617
|
+
ViewApmConfigurations: 'ViewApmConfigurations',
|
|
2618
|
+
EditApmConfigurations: 'EditApmConfigurations',
|
|
2619
|
+
ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
|
|
2620
|
+
CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
|
|
2621
|
+
UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
|
|
2622
|
+
DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
|
|
2623
|
+
StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
|
|
2624
|
+
ViewDevelopersSettings: 'ViewDevelopersSettings',
|
|
2625
|
+
EditDevelopersSettings: 'EditDevelopersSettings',
|
|
2626
|
+
ViewOrders: 'ViewOrders',
|
|
2627
|
+
UpdateOrdersAccept: 'UpdateOrdersAccept',
|
|
2628
|
+
UpdateOrdersReject: 'UpdateOrdersReject',
|
|
2629
|
+
UpdateOrdersRefund: 'UpdateOrdersRefund',
|
|
2630
|
+
UpdateOrdersDispatch: 'UpdateOrdersDispatch',
|
|
2631
|
+
ViewStores: 'ViewStores',
|
|
2632
|
+
CreateStores: 'CreateStores',
|
|
2633
|
+
EditStores: 'EditStores',
|
|
2634
|
+
ViewStoresOpeningHours: 'ViewStoresOpeningHours',
|
|
2635
|
+
UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
|
|
2636
|
+
UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
|
|
2637
|
+
ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
|
|
2638
|
+
EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
|
|
2639
|
+
EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
|
|
2640
|
+
UpdateStoresName: 'UpdateStoresName',
|
|
2641
|
+
EditStoreKioskSettings: 'EditStoreKioskSettings',
|
|
2642
|
+
EditStoreOrderCapacity: 'EditStoreOrderCapacity',
|
|
2643
|
+
EditStoreNotifications: 'EditStoreNotifications',
|
|
2644
|
+
ArchiveStores: 'ArchiveStores',
|
|
2645
|
+
PublishStores: 'PublishStores',
|
|
2646
|
+
UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
|
|
2647
|
+
UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
|
|
2648
|
+
ViewStoreGroups: 'ViewStoreGroups',
|
|
2649
|
+
CreateStoreGroups: 'CreateStoreGroups',
|
|
2650
|
+
UpdateStoreGroups: 'UpdateStoreGroups',
|
|
2651
|
+
DeleteStoreGroups: 'DeleteStoreGroups',
|
|
2652
|
+
ViewDeliveryZones: 'ViewDeliveryZones',
|
|
2653
|
+
CreateDeliveryZones: 'CreateDeliveryZones',
|
|
2654
|
+
UpdateDeliveryZones: 'UpdateDeliveryZones',
|
|
2655
|
+
DeleteDeliveryZones: 'DeleteDeliveryZones',
|
|
2656
|
+
ViewMenu: 'ViewMenu',
|
|
2657
|
+
CreateMenu: 'CreateMenu',
|
|
2658
|
+
UpdateMenu: 'UpdateMenu',
|
|
2659
|
+
DeleteMenu: 'DeleteMenu',
|
|
2660
|
+
UpdateMenuLock: 'UpdateMenuLock',
|
|
2661
|
+
UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
|
|
2662
|
+
EditMenuImage: 'EditMenuImage',
|
|
2663
|
+
ViewVouchers: 'ViewVouchers',
|
|
2664
|
+
EditVouchers: 'EditVouchers',
|
|
2665
|
+
ViewWebsiteContent: 'ViewWebsiteContent',
|
|
2666
|
+
EditWebsiteContent: 'EditWebsiteContent',
|
|
2667
|
+
ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
|
|
2668
|
+
ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
|
|
2669
|
+
ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
|
|
2670
|
+
ViewBankAccounts: 'ViewBankAccounts',
|
|
2671
|
+
CreateBankAccounts: 'CreateBankAccounts',
|
|
2672
|
+
UpdateBankAccounts: 'UpdateBankAccounts',
|
|
2673
|
+
UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
|
|
2674
|
+
ViewAssignedBankAccount: 'ViewAssignedBankAccount',
|
|
2675
|
+
VerifyBankAccounts: 'VerifyBankAccounts',
|
|
2676
|
+
ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
|
|
2677
|
+
EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
|
|
2678
|
+
EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
|
|
2679
|
+
EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
|
|
2680
|
+
ViewHydraConfig: 'ViewHydraConfig',
|
|
2681
|
+
UpdateHydraConfigManage: 'UpdateHydraConfigManage',
|
|
2682
|
+
InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
|
|
2683
|
+
DeleteTerminal: 'DeleteTerminal',
|
|
2684
|
+
ViewKioskTelemetry: 'ViewKioskTelemetry',
|
|
2685
|
+
ViewCustomers: 'ViewCustomers',
|
|
2686
|
+
EditCustomers: 'EditCustomers',
|
|
2687
|
+
CreateCustomers: 'CreateCustomers',
|
|
2688
|
+
CreateCatalogElements: 'CreateCatalogElements',
|
|
2689
|
+
UpdateCatalogElements: 'UpdateCatalogElements',
|
|
2690
|
+
ViewCatalogElements: 'ViewCatalogElements',
|
|
2691
|
+
DeleteCatalogElements: 'DeleteCatalogElements',
|
|
2692
|
+
ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
|
|
2693
|
+
CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
|
|
2694
|
+
UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
|
|
2695
|
+
DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
|
|
2696
|
+
UpdateMetafields: 'UpdateMetafields',
|
|
2697
|
+
ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
|
|
2698
|
+
PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
|
|
2699
|
+
ViewAppStatistics: 'ViewAppStatistics',
|
|
2700
|
+
ViewApmStatistics: 'ViewApmStatistics',
|
|
2701
|
+
ViewCampaignsStatistics: 'ViewCampaignsStatistics',
|
|
2702
|
+
ViewCustomerStatistics: 'ViewCustomerStatistics',
|
|
2703
|
+
ViewLiveStatistics: 'ViewLiveStatistics',
|
|
2704
|
+
ViewOrderStatistics: 'ViewOrderStatistics',
|
|
2705
|
+
ViewSalesStatistics: 'ViewSalesStatistics',
|
|
2706
|
+
ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
|
|
2707
|
+
ViewVouchersStatistics: 'ViewVouchersStatistics',
|
|
2708
|
+
DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
|
|
2709
|
+
ViewApmAuditLogs: 'ViewApmAuditLogs',
|
|
2710
|
+
ViewStoreAuditLogs: 'ViewStoreAuditLogs',
|
|
2711
|
+
ViewMenuAuditLogs: 'ViewMenuAuditLogs',
|
|
2712
|
+
ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
|
|
2713
|
+
ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
|
|
2714
|
+
ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
|
|
2715
|
+
ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
|
|
2716
|
+
ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
|
|
2717
|
+
ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
|
|
2718
|
+
ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
|
|
2719
|
+
ViewAppAuditLogs: 'ViewAppAuditLogs',
|
|
2720
|
+
ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
|
|
2721
|
+
ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
|
|
2722
|
+
ViewHydraAuditLogs: 'ViewHydraAuditLogs',
|
|
2723
|
+
ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
|
|
2724
|
+
ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
|
|
2725
|
+
ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
|
|
2726
|
+
ViewExternalAuditLogs: 'ViewExternalAuditLogs',
|
|
2727
|
+
CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
|
|
2728
|
+
ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
|
|
2729
|
+
ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
|
|
2730
|
+
ViewChannelAuditLogs: 'ViewChannelAuditLogs',
|
|
2731
|
+
ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
|
|
2732
|
+
SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
|
|
2733
|
+
InviteDriverToApp: 'InviteDriverToApp',
|
|
2734
|
+
GetDriverForApp: 'GetDriverForApp',
|
|
2735
|
+
RemoveDriverFromApp: 'RemoveDriverFromApp',
|
|
2736
|
+
AssignDriverToOrder: 'AssignDriverToOrder',
|
|
2737
|
+
UnassignDriverFromOrder: 'UnassignDriverFromOrder',
|
|
2738
|
+
UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
|
|
2739
|
+
UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
|
|
2740
|
+
ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
|
|
2741
|
+
CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
|
|
2742
|
+
UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
|
|
2743
|
+
DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
|
|
2744
|
+
ViewPayouts: 'ViewPayouts',
|
|
2745
|
+
ViewChannels: 'ViewChannels',
|
|
2746
|
+
ViewOnboarding: 'ViewOnboarding',
|
|
2747
|
+
UpdateOnboarding: 'UpdateOnboarding',
|
|
2748
|
+
ViewClientDevices: 'ViewClientDevices',
|
|
2749
|
+
UpdateClientDevices: 'UpdateClientDevices',
|
|
2750
|
+
EnrollClientDevices: 'EnrollClientDevices',
|
|
2751
|
+
AssignClientDevices: 'AssignClientDevices',
|
|
2752
|
+
ViewClientAuditLogs: 'ViewClientAuditLogs',
|
|
2753
|
+
CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
|
|
2754
|
+
ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
|
|
2755
|
+
UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
|
|
2756
|
+
DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
|
|
2757
|
+
UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
|
|
2758
|
+
CreateAppStoreSubscription: 'CreateAppStoreSubscription',
|
|
2759
|
+
UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
|
|
2760
|
+
DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
|
|
2761
|
+
ViewSalesChannels: 'ViewSalesChannels',
|
|
2762
|
+
EditSalesChannels: 'EditSalesChannels',
|
|
2763
|
+
CreateSalesChannel: 'CreateSalesChannel',
|
|
2764
|
+
ArchiveSalesChannel: 'ArchiveSalesChannel',
|
|
2765
|
+
UnarchiveSalesChannel: 'UnarchiveSalesChannel',
|
|
2766
|
+
PublishSalesChannel: 'PublishSalesChannel',
|
|
2767
|
+
UnpublishSalesChannel: 'UnpublishSalesChannel',
|
|
2768
|
+
CloneSalesChannel: 'CloneSalesChannel',
|
|
2769
|
+
ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
|
|
2770
|
+
CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
|
|
2771
|
+
UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
|
|
2772
|
+
UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
|
|
2773
|
+
ViewSubscriptions: 'ViewSubscriptions',
|
|
2774
|
+
ViewInvoices: 'ViewInvoices',
|
|
2775
|
+
EditAccountsBills: 'EditAccountsBills',
|
|
2776
|
+
ViewAccountsBills: 'ViewAccountsBills',
|
|
2777
|
+
EditAccountsCategories: 'EditAccountsCategories',
|
|
2778
|
+
ViewAccountsCategories: 'ViewAccountsCategories',
|
|
2779
|
+
EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
|
|
2780
|
+
ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
|
|
2781
|
+
EditAccountsCreditBooks: 'EditAccountsCreditBooks',
|
|
2782
|
+
ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
|
|
2783
|
+
EditAccountsExpenses: 'EditAccountsExpenses',
|
|
2784
|
+
ViewAccountsExpenses: 'ViewAccountsExpenses',
|
|
2785
|
+
EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
|
|
2786
|
+
ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
|
|
2787
|
+
EditDocumentExplorer: 'EditDocumentExplorer',
|
|
2788
|
+
ViewDocumentExplorer: 'ViewDocumentExplorer',
|
|
2789
|
+
ViewInventoryReports: 'ViewInventoryReports',
|
|
2790
|
+
EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
|
|
2791
|
+
ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
|
|
2792
|
+
EditInventoryStockItems: 'EditInventoryStockItems',
|
|
2793
|
+
ViewInventoryStockItems: 'ViewInventoryStockItems',
|
|
2794
|
+
EditInventorySupplier: 'EditInventorySupplier',
|
|
2795
|
+
ViewInventorySupplier: 'ViewInventorySupplier',
|
|
2796
|
+
EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
|
|
2797
|
+
ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
|
|
2798
|
+
ViewPayrollReports: 'ViewPayrollReports',
|
|
2799
|
+
EditPayrollHoliday: 'EditPayrollHoliday',
|
|
2800
|
+
ViewPayrollHoliday: 'ViewPayrollHoliday',
|
|
2801
|
+
EditPayrollRota: 'EditPayrollRota',
|
|
2802
|
+
ViewPayrollRota: 'ViewPayrollRota',
|
|
2803
|
+
EditPayrollStaff: 'EditPayrollStaff',
|
|
2804
|
+
ViewPayrollStaff: 'ViewPayrollStaff',
|
|
2805
|
+
ViewSalesReports: 'ViewSalesReports',
|
|
2806
|
+
ViewCostReports: 'ViewCostReports',
|
|
2807
|
+
ViewMenuReports: 'ViewMenuReports',
|
|
2808
|
+
ViewBrand: 'ViewBrand',
|
|
2809
|
+
EditBrand: 'EditBrand',
|
|
2810
|
+
CreateBrand: 'CreateBrand',
|
|
2811
|
+
TransferBrand: 'TransferBrand',
|
|
2812
|
+
ViewProperty: 'ViewProperty',
|
|
2813
|
+
EditProperty: 'EditProperty',
|
|
2814
|
+
CreateProperty: 'CreateProperty',
|
|
2815
|
+
ArchiveProperty: 'ArchiveProperty',
|
|
2816
|
+
ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
|
|
2817
|
+
EditEntityFeatureFlags: 'EditEntityFeatureFlags',
|
|
2818
|
+
CreateOrg: 'CreateOrg',
|
|
2819
|
+
EditOrg: 'EditOrg',
|
|
2820
|
+
ViewOrg: 'ViewOrg',
|
|
2821
|
+
ViewWebhooks: 'ViewWebhooks',
|
|
2822
|
+
EditWebhooks: 'EditWebhooks',
|
|
2823
|
+
RoleAdmin: 'RoleAdmin',
|
|
2824
|
+
RoleFactory: 'RoleFactory'
|
|
2825
|
+
} as const;
|
|
2826
|
+
|
|
2827
|
+
export type ListPermissionsSuccessResponsePermissionsEnum = typeof ListPermissionsSuccessResponsePermissionsEnum[keyof typeof ListPermissionsSuccessResponsePermissionsEnum];
|
|
2828
|
+
|
|
2829
|
+
/**
|
|
2830
|
+
* Successful roles retrieval response
|
|
2831
|
+
* @export
|
|
2832
|
+
* @interface ListRolesSuccessResponse
|
|
2833
|
+
*/
|
|
2834
|
+
export interface ListRolesSuccessResponse {
|
|
2835
|
+
/**
|
|
2836
|
+
* List of named roles
|
|
2837
|
+
* @type {Array<string>}
|
|
2838
|
+
* @memberof ListRolesSuccessResponse
|
|
2839
|
+
*/
|
|
2840
|
+
'roles': Array<ListRolesSuccessResponseRolesEnum>;
|
|
2841
|
+
}
|
|
2842
|
+
|
|
2843
|
+
export const ListRolesSuccessResponseRolesEnum = {
|
|
2844
|
+
Admin: 'Admin',
|
|
2845
|
+
Factory: 'Factory'
|
|
2846
|
+
} as const;
|
|
2847
|
+
|
|
2848
|
+
export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
|
|
2849
|
+
|
|
2850
|
+
/**
|
|
2851
|
+
* Principals in org
|
|
2852
|
+
* @export
|
|
2853
|
+
* @interface PrincipalsInOrgResponse
|
|
2854
|
+
*/
|
|
2855
|
+
export interface PrincipalsInOrgResponse {
|
|
2856
|
+
/**
|
|
2857
|
+
*
|
|
2858
|
+
* @type {string}
|
|
2859
|
+
* @memberof PrincipalsInOrgResponse
|
|
2860
|
+
*/
|
|
2861
|
+
'orgId': string;
|
|
2862
|
+
/**
|
|
2863
|
+
* List of principals in org
|
|
2864
|
+
* @type {Array<AuthorizationRequestPrincipal>}
|
|
2865
|
+
* @memberof PrincipalsInOrgResponse
|
|
2866
|
+
*/
|
|
2867
|
+
'principals': Array<AuthorizationRequestPrincipal>;
|
|
2868
|
+
}
|
|
2869
|
+
/**
|
|
2870
|
+
* Details for revoking a forbidden role from a principal
|
|
2871
|
+
* @export
|
|
2872
|
+
* @interface RevokeForbiddenRoleRequestBody
|
|
2873
|
+
*/
|
|
2874
|
+
export interface RevokeForbiddenRoleRequestBody {
|
|
2875
|
+
/**
|
|
2876
|
+
*
|
|
2877
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2878
|
+
* @memberof RevokeForbiddenRoleRequestBody
|
|
2879
|
+
*/
|
|
2880
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2881
|
+
/**
|
|
2882
|
+
* Compensation role to revoke the forbidden role from
|
|
2883
|
+
* @type {string}
|
|
2884
|
+
* @memberof RevokeForbiddenRoleRequestBody
|
|
2885
|
+
*/
|
|
2886
|
+
'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
|
|
2887
|
+
}
|
|
2888
|
+
|
|
2889
|
+
export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
|
|
2890
|
+
OwnerCompensating: 'OwnerCompensating',
|
|
2891
|
+
PropertyOwnerCompensating: 'PropertyOwnerCompensating',
|
|
2892
|
+
ManagedOwnerCompensating: 'ManagedOwnerCompensating',
|
|
2893
|
+
IntegratorCompensating: 'IntegratorCompensating',
|
|
2894
|
+
PropertyManagerCompensating: 'PropertyManagerCompensating',
|
|
2895
|
+
FinanceManagerCompensating: 'FinanceManagerCompensating'
|
|
2896
|
+
} as const;
|
|
2897
|
+
|
|
2898
|
+
export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
|
|
2899
|
+
|
|
2900
|
+
/**
|
|
2901
|
+
* Details for revoking a role from a principal
|
|
2902
|
+
* @export
|
|
2903
|
+
* @interface RevokeRoleRequestBody
|
|
2904
|
+
*/
|
|
2905
|
+
export interface RevokeRoleRequestBody {
|
|
2906
|
+
/**
|
|
2907
|
+
*
|
|
2908
|
+
* @type {string}
|
|
2909
|
+
* @memberof RevokeRoleRequestBody
|
|
2910
|
+
*/
|
|
2911
|
+
'role': RevokeRoleRequestBodyRoleEnum;
|
|
2912
|
+
/**
|
|
2913
|
+
*
|
|
2914
|
+
* @type {AuthorizationRequestResource}
|
|
2915
|
+
* @memberof RevokeRoleRequestBody
|
|
2916
|
+
*/
|
|
2917
|
+
'resource': AuthorizationRequestResource;
|
|
2918
|
+
/**
|
|
2919
|
+
*
|
|
2920
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2921
|
+
* @memberof RevokeRoleRequestBody
|
|
2922
|
+
*/
|
|
2923
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {string}
|
|
2927
|
+
* @memberof RevokeRoleRequestBody
|
|
2928
|
+
*/
|
|
2929
|
+
'brandId': string;
|
|
2930
|
+
}
|
|
2931
|
+
|
|
2932
|
+
export const RevokeRoleRequestBodyRoleEnum = {
|
|
2933
|
+
OrgViewer: 'OrgViewer',
|
|
2934
|
+
OrgManager: 'OrgManager',
|
|
2935
|
+
OrgAdmin: 'OrgAdmin',
|
|
1259
2936
|
BrandViewer: 'BrandViewer',
|
|
1260
2937
|
BrandManager: 'BrandManager',
|
|
1261
2938
|
BrandAdmin: 'BrandAdmin',
|
|
@@ -1327,82 +3004,326 @@ export const RevokeRoleRequestBodyRoleEnum = {
|
|
|
1327
3004
|
SupportMisc: 'SupportMisc'
|
|
1328
3005
|
} as const;
|
|
1329
3006
|
|
|
1330
|
-
export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
|
|
3007
|
+
export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
|
|
3008
|
+
|
|
3009
|
+
/**
|
|
3010
|
+
* Successful role revocation response
|
|
3011
|
+
* @export
|
|
3012
|
+
* @interface RevokeRoleSuccessResponse
|
|
3013
|
+
*/
|
|
3014
|
+
export interface RevokeRoleSuccessResponse {
|
|
3015
|
+
/**
|
|
3016
|
+
* Confirmation message
|
|
3017
|
+
* @type {string}
|
|
3018
|
+
* @memberof RevokeRoleSuccessResponse
|
|
3019
|
+
*/
|
|
3020
|
+
'message': string;
|
|
3021
|
+
}
|
|
3022
|
+
/**
|
|
3023
|
+
*
|
|
3024
|
+
* @export
|
|
3025
|
+
* @interface ValidationErrorsInner
|
|
3026
|
+
*/
|
|
3027
|
+
export interface ValidationErrorsInner {
|
|
3028
|
+
/**
|
|
3029
|
+
*
|
|
3030
|
+
* @type {Array<ValidationErrorsInnerPathInner>}
|
|
3031
|
+
* @memberof ValidationErrorsInner
|
|
3032
|
+
*/
|
|
3033
|
+
'path'?: Array<ValidationErrorsInnerPathInner>;
|
|
3034
|
+
/**
|
|
3035
|
+
*
|
|
3036
|
+
* @type {string}
|
|
3037
|
+
* @memberof ValidationErrorsInner
|
|
3038
|
+
*/
|
|
3039
|
+
'message': string;
|
|
3040
|
+
}
|
|
3041
|
+
/**
|
|
3042
|
+
*
|
|
3043
|
+
* @export
|
|
3044
|
+
* @interface ValidationErrorsInnerPathInner
|
|
3045
|
+
*/
|
|
3046
|
+
export interface ValidationErrorsInnerPathInner {
|
|
3047
|
+
}
|
|
3048
|
+
|
|
3049
|
+
/**
|
|
3050
|
+
* AuthenticationApi - axios parameter creator
|
|
3051
|
+
* @export
|
|
3052
|
+
*/
|
|
3053
|
+
export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3054
|
+
return {
|
|
3055
|
+
/**
|
|
3056
|
+
* Authenticate and authorize a user to perform an action
|
|
3057
|
+
* @summary Authenticate and authorize Request
|
|
3058
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
3059
|
+
* @param {*} [options] Override http request option.
|
|
3060
|
+
* @throws {RequiredError}
|
|
3061
|
+
*/
|
|
3062
|
+
authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3063
|
+
// verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
|
|
3064
|
+
assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
|
|
3065
|
+
const localVarPath = `/authenticateAndAuthorize`;
|
|
3066
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3067
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3068
|
+
let baseOptions;
|
|
3069
|
+
if (configuration) {
|
|
3070
|
+
baseOptions = configuration.baseOptions;
|
|
3071
|
+
}
|
|
3072
|
+
|
|
3073
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3074
|
+
const localVarHeaderParameter = {} as any;
|
|
3075
|
+
const localVarQueryParameter = {} as any;
|
|
3076
|
+
|
|
3077
|
+
// authentication ApiKeyAuth required
|
|
3078
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3079
|
+
|
|
3080
|
+
|
|
3081
|
+
|
|
3082
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3083
|
+
|
|
3084
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3085
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3086
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3087
|
+
localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
|
|
3088
|
+
|
|
3089
|
+
return {
|
|
3090
|
+
url: toPathString(localVarUrlObj),
|
|
3091
|
+
options: localVarRequestOptions,
|
|
3092
|
+
};
|
|
3093
|
+
},
|
|
3094
|
+
}
|
|
3095
|
+
};
|
|
3096
|
+
|
|
3097
|
+
/**
|
|
3098
|
+
* AuthenticationApi - functional programming interface
|
|
3099
|
+
* @export
|
|
3100
|
+
*/
|
|
3101
|
+
export const AuthenticationApiFp = function(configuration?: Configuration) {
|
|
3102
|
+
const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
|
|
3103
|
+
return {
|
|
3104
|
+
/**
|
|
3105
|
+
* Authenticate and authorize a user to perform an action
|
|
3106
|
+
* @summary Authenticate and authorize Request
|
|
3107
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
3108
|
+
* @param {*} [options] Override http request option.
|
|
3109
|
+
* @throws {RequiredError}
|
|
3110
|
+
*/
|
|
3111
|
+
async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
|
|
3112
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
|
|
3113
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3114
|
+
const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
|
|
3115
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3116
|
+
},
|
|
3117
|
+
}
|
|
3118
|
+
};
|
|
3119
|
+
|
|
3120
|
+
/**
|
|
3121
|
+
* AuthenticationApi - factory interface
|
|
3122
|
+
* @export
|
|
3123
|
+
*/
|
|
3124
|
+
export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3125
|
+
const localVarFp = AuthenticationApiFp(configuration)
|
|
3126
|
+
return {
|
|
3127
|
+
/**
|
|
3128
|
+
* Authenticate and authorize a user to perform an action
|
|
3129
|
+
* @summary Authenticate and authorize Request
|
|
3130
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
3131
|
+
* @param {*} [options] Override http request option.
|
|
3132
|
+
* @throws {RequiredError}
|
|
3133
|
+
*/
|
|
3134
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
|
|
3135
|
+
return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
|
|
3136
|
+
},
|
|
3137
|
+
};
|
|
3138
|
+
};
|
|
3139
|
+
|
|
3140
|
+
/**
|
|
3141
|
+
* AuthenticationApi - object-oriented interface
|
|
3142
|
+
* @export
|
|
3143
|
+
* @class AuthenticationApi
|
|
3144
|
+
* @extends {BaseAPI}
|
|
3145
|
+
*/
|
|
3146
|
+
export class AuthenticationApi extends BaseAPI {
|
|
3147
|
+
/**
|
|
3148
|
+
* Authenticate and authorize a user to perform an action
|
|
3149
|
+
* @summary Authenticate and authorize Request
|
|
3150
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
3151
|
+
* @param {*} [options] Override http request option.
|
|
3152
|
+
* @throws {RequiredError}
|
|
3153
|
+
* @memberof AuthenticationApi
|
|
3154
|
+
*/
|
|
3155
|
+
public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
|
|
3156
|
+
return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3157
|
+
}
|
|
3158
|
+
}
|
|
3159
|
+
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
/**
|
|
3163
|
+
* AuthorizationApi - axios parameter creator
|
|
3164
|
+
* @export
|
|
3165
|
+
*/
|
|
3166
|
+
export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3167
|
+
return {
|
|
3168
|
+
/**
|
|
3169
|
+
* Authenticate and authorize a user to perform an action
|
|
3170
|
+
* @summary Authenticate and authorize Request
|
|
3171
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
3172
|
+
* @param {*} [options] Override http request option.
|
|
3173
|
+
* @throws {RequiredError}
|
|
3174
|
+
*/
|
|
3175
|
+
authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3176
|
+
// verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
|
|
3177
|
+
assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
|
|
3178
|
+
const localVarPath = `/authenticateAndAuthorize`;
|
|
3179
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3180
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3181
|
+
let baseOptions;
|
|
3182
|
+
if (configuration) {
|
|
3183
|
+
baseOptions = configuration.baseOptions;
|
|
3184
|
+
}
|
|
3185
|
+
|
|
3186
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3187
|
+
const localVarHeaderParameter = {} as any;
|
|
3188
|
+
const localVarQueryParameter = {} as any;
|
|
3189
|
+
|
|
3190
|
+
// authentication ApiKeyAuth required
|
|
3191
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3192
|
+
|
|
3193
|
+
|
|
3194
|
+
|
|
3195
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3196
|
+
|
|
3197
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3198
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3199
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3200
|
+
localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
|
|
3201
|
+
|
|
3202
|
+
return {
|
|
3203
|
+
url: toPathString(localVarUrlObj),
|
|
3204
|
+
options: localVarRequestOptions,
|
|
3205
|
+
};
|
|
3206
|
+
},
|
|
3207
|
+
/**
|
|
3208
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
3209
|
+
* @summary Authenticate and Check Is In Role
|
|
3210
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
3211
|
+
* @param {*} [options] Override http request option.
|
|
3212
|
+
* @throws {RequiredError}
|
|
3213
|
+
*/
|
|
3214
|
+
authenticateAndCheckIsInRole: async (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3215
|
+
const localVarPath = `/authenticateAndCheckIsInRole`;
|
|
3216
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3217
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3218
|
+
let baseOptions;
|
|
3219
|
+
if (configuration) {
|
|
3220
|
+
baseOptions = configuration.baseOptions;
|
|
3221
|
+
}
|
|
3222
|
+
|
|
3223
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3224
|
+
const localVarHeaderParameter = {} as any;
|
|
3225
|
+
const localVarQueryParameter = {} as any;
|
|
3226
|
+
|
|
3227
|
+
// authentication ApiKeyAuth required
|
|
3228
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
|
|
3232
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3233
|
+
|
|
3234
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3235
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3236
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3237
|
+
localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndCheckIsInRoleRequest, localVarRequestOptions, configuration)
|
|
3238
|
+
|
|
3239
|
+
return {
|
|
3240
|
+
url: toPathString(localVarUrlObj),
|
|
3241
|
+
options: localVarRequestOptions,
|
|
3242
|
+
};
|
|
3243
|
+
},
|
|
3244
|
+
/**
|
|
3245
|
+
* Check if a user is authorized to perform an action
|
|
3246
|
+
* @summary Authorize Request
|
|
3247
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
3248
|
+
* @param {*} [options] Override http request option.
|
|
3249
|
+
* @throws {RequiredError}
|
|
3250
|
+
*/
|
|
3251
|
+
authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3252
|
+
const localVarPath = `/authorize`;
|
|
3253
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3254
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3255
|
+
let baseOptions;
|
|
3256
|
+
if (configuration) {
|
|
3257
|
+
baseOptions = configuration.baseOptions;
|
|
3258
|
+
}
|
|
3259
|
+
|
|
3260
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3261
|
+
const localVarHeaderParameter = {} as any;
|
|
3262
|
+
const localVarQueryParameter = {} as any;
|
|
3263
|
+
|
|
3264
|
+
// authentication ApiKeyAuth required
|
|
3265
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3266
|
+
|
|
3267
|
+
|
|
3268
|
+
|
|
3269
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3270
|
+
|
|
3271
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3272
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3273
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3274
|
+
localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
|
|
1331
3275
|
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
}
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
* Name of the role
|
|
1353
|
-
* @type {string}
|
|
1354
|
-
* @memberof RolesInner
|
|
1355
|
-
*/
|
|
1356
|
-
'name': string;
|
|
1357
|
-
/**
|
|
1358
|
-
*
|
|
1359
|
-
* @type {Permissions & Array<string>}
|
|
1360
|
-
* @memberof RolesInner
|
|
1361
|
-
*/
|
|
1362
|
-
'permissions': Permissions & Array<string>;
|
|
1363
|
-
}
|
|
1364
|
-
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @export
|
|
1367
|
-
* @interface ValidationErrorsInner
|
|
1368
|
-
*/
|
|
1369
|
-
export interface ValidationErrorsInner {
|
|
1370
|
-
/**
|
|
1371
|
-
*
|
|
1372
|
-
* @type {Array<ValidationErrorsInnerPathInner>}
|
|
1373
|
-
* @memberof ValidationErrorsInner
|
|
1374
|
-
*/
|
|
1375
|
-
'path'?: Array<ValidationErrorsInnerPathInner>;
|
|
1376
|
-
/**
|
|
1377
|
-
*
|
|
1378
|
-
* @type {string}
|
|
1379
|
-
* @memberof ValidationErrorsInner
|
|
1380
|
-
*/
|
|
1381
|
-
'message': string;
|
|
1382
|
-
}
|
|
1383
|
-
/**
|
|
1384
|
-
*
|
|
1385
|
-
* @export
|
|
1386
|
-
* @interface ValidationErrorsInnerPathInner
|
|
1387
|
-
*/
|
|
1388
|
-
export interface ValidationErrorsInnerPathInner {
|
|
1389
|
-
}
|
|
3276
|
+
return {
|
|
3277
|
+
url: toPathString(localVarUrlObj),
|
|
3278
|
+
options: localVarRequestOptions,
|
|
3279
|
+
};
|
|
3280
|
+
},
|
|
3281
|
+
/**
|
|
3282
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
3283
|
+
* @summary Authorize Batch Request
|
|
3284
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
3285
|
+
* @param {*} [options] Override http request option.
|
|
3286
|
+
* @throws {RequiredError}
|
|
3287
|
+
*/
|
|
3288
|
+
authorizeBatch: async (authorizationBatchRequest?: AuthorizationBatchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3289
|
+
const localVarPath = `/authorize/batch`;
|
|
3290
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3292
|
+
let baseOptions;
|
|
3293
|
+
if (configuration) {
|
|
3294
|
+
baseOptions = configuration.baseOptions;
|
|
3295
|
+
}
|
|
1390
3296
|
|
|
1391
|
-
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
3297
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3298
|
+
const localVarHeaderParameter = {} as any;
|
|
3299
|
+
const localVarQueryParameter = {} as any;
|
|
3300
|
+
|
|
3301
|
+
// authentication ApiKeyAuth required
|
|
3302
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3303
|
+
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3307
|
+
|
|
3308
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3309
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3310
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3311
|
+
localVarRequestOptions.data = serializeDataIfNeeded(authorizationBatchRequest, localVarRequestOptions, configuration)
|
|
3312
|
+
|
|
3313
|
+
return {
|
|
3314
|
+
url: toPathString(localVarUrlObj),
|
|
3315
|
+
options: localVarRequestOptions,
|
|
3316
|
+
};
|
|
3317
|
+
},
|
|
1397
3318
|
/**
|
|
1398
|
-
*
|
|
1399
|
-
* @summary
|
|
1400
|
-
* @param {
|
|
3319
|
+
* Check if a user is in any/all of the roles
|
|
3320
|
+
* @summary Check Is In Role
|
|
3321
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
1401
3322
|
* @param {*} [options] Override http request option.
|
|
1402
3323
|
* @throws {RequiredError}
|
|
1403
3324
|
*/
|
|
1404
|
-
|
|
1405
|
-
const localVarPath = `/
|
|
3325
|
+
checkIsInRole: async (isInRoleRequest?: IsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3326
|
+
const localVarPath = `/checkIsInRole`;
|
|
1406
3327
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1407
3328
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1408
3329
|
let baseOptions;
|
|
@@ -1424,7 +3345,7 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
|
|
|
1424
3345
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1425
3346
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1426
3347
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1427
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3348
|
+
localVarRequestOptions.data = serializeDataIfNeeded(isInRoleRequest, localVarRequestOptions, configuration)
|
|
1428
3349
|
|
|
1429
3350
|
return {
|
|
1430
3351
|
url: toPathString(localVarUrlObj),
|
|
@@ -1435,85 +3356,266 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
|
|
|
1435
3356
|
};
|
|
1436
3357
|
|
|
1437
3358
|
/**
|
|
1438
|
-
*
|
|
3359
|
+
* AuthorizationApi - functional programming interface
|
|
1439
3360
|
* @export
|
|
1440
3361
|
*/
|
|
1441
|
-
export const
|
|
1442
|
-
const localVarAxiosParamCreator =
|
|
3362
|
+
export const AuthorizationApiFp = function(configuration?: Configuration) {
|
|
3363
|
+
const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
|
|
1443
3364
|
return {
|
|
1444
3365
|
/**
|
|
1445
3366
|
* Authenticate and authorize a user to perform an action
|
|
1446
3367
|
* @summary Authenticate and authorize Request
|
|
1447
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
3368
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1448
3369
|
* @param {*} [options] Override http request option.
|
|
1449
3370
|
* @throws {RequiredError}
|
|
1450
3371
|
*/
|
|
1451
|
-
async authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
3372
|
+
async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
|
|
1452
3373
|
const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
|
|
1453
3374
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1454
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3375
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
|
|
3376
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3377
|
+
},
|
|
3378
|
+
/**
|
|
3379
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
3380
|
+
* @summary Authenticate and Check Is In Role
|
|
3381
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
3382
|
+
* @param {*} [options] Override http request option.
|
|
3383
|
+
* @throws {RequiredError}
|
|
3384
|
+
*/
|
|
3385
|
+
async authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>> {
|
|
3386
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options);
|
|
3387
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3388
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndCheckIsInRole']?.[localVarOperationServerIndex]?.url;
|
|
3389
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3390
|
+
},
|
|
3391
|
+
/**
|
|
3392
|
+
* Check if a user is authorized to perform an action
|
|
3393
|
+
* @summary Authorize Request
|
|
3394
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
3395
|
+
* @param {*} [options] Override http request option.
|
|
3396
|
+
* @throws {RequiredError}
|
|
3397
|
+
*/
|
|
3398
|
+
async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
|
|
3399
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
|
|
3400
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3401
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
|
|
3402
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3403
|
+
},
|
|
3404
|
+
/**
|
|
3405
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
3406
|
+
* @summary Authorize Batch Request
|
|
3407
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
3408
|
+
* @param {*} [options] Override http request option.
|
|
3409
|
+
* @throws {RequiredError}
|
|
3410
|
+
*/
|
|
3411
|
+
async authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>> {
|
|
3412
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.authorizeBatch(authorizationBatchRequest, options);
|
|
3413
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3414
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorizeBatch']?.[localVarOperationServerIndex]?.url;
|
|
3415
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3416
|
+
},
|
|
3417
|
+
/**
|
|
3418
|
+
* Check if a user is in any/all of the roles
|
|
3419
|
+
* @summary Check Is In Role
|
|
3420
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
3421
|
+
* @param {*} [options] Override http request option.
|
|
3422
|
+
* @throws {RequiredError}
|
|
3423
|
+
*/
|
|
3424
|
+
async checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>> {
|
|
3425
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkIsInRole(isInRoleRequest, options);
|
|
3426
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3427
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.checkIsInRole']?.[localVarOperationServerIndex]?.url;
|
|
1455
3428
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1456
3429
|
},
|
|
1457
3430
|
}
|
|
1458
3431
|
};
|
|
1459
3432
|
|
|
1460
3433
|
/**
|
|
1461
|
-
*
|
|
3434
|
+
* AuthorizationApi - factory interface
|
|
1462
3435
|
* @export
|
|
1463
3436
|
*/
|
|
1464
|
-
export const
|
|
1465
|
-
const localVarFp =
|
|
3437
|
+
export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3438
|
+
const localVarFp = AuthorizationApiFp(configuration)
|
|
1466
3439
|
return {
|
|
1467
3440
|
/**
|
|
1468
3441
|
* Authenticate and authorize a user to perform an action
|
|
1469
3442
|
* @summary Authenticate and authorize Request
|
|
1470
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
3443
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1471
3444
|
* @param {*} [options] Override http request option.
|
|
1472
3445
|
* @throws {RequiredError}
|
|
1473
3446
|
*/
|
|
1474
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
3447
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
|
|
1475
3448
|
return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
|
|
1476
3449
|
},
|
|
3450
|
+
/**
|
|
3451
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
3452
|
+
* @summary Authenticate and Check Is In Role
|
|
3453
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
3454
|
+
* @param {*} [options] Override http request option.
|
|
3455
|
+
* @throws {RequiredError}
|
|
3456
|
+
*/
|
|
3457
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse> {
|
|
3458
|
+
return localVarFp.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(axios, basePath));
|
|
3459
|
+
},
|
|
3460
|
+
/**
|
|
3461
|
+
* Check if a user is authorized to perform an action
|
|
3462
|
+
* @summary Authorize Request
|
|
3463
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
3464
|
+
* @param {*} [options] Override http request option.
|
|
3465
|
+
* @throws {RequiredError}
|
|
3466
|
+
*/
|
|
3467
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
|
|
3468
|
+
return localVarFp.authorize(authorizationRequest, options).then((request) => request(axios, basePath));
|
|
3469
|
+
},
|
|
3470
|
+
/**
|
|
3471
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
3472
|
+
* @summary Authorize Batch Request
|
|
3473
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
3474
|
+
* @param {*} [options] Override http request option.
|
|
3475
|
+
* @throws {RequiredError}
|
|
3476
|
+
*/
|
|
3477
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse> {
|
|
3478
|
+
return localVarFp.authorizeBatch(authorizationBatchRequest, options).then((request) => request(axios, basePath));
|
|
3479
|
+
},
|
|
3480
|
+
/**
|
|
3481
|
+
* Check if a user is in any/all of the roles
|
|
3482
|
+
* @summary Check Is In Role
|
|
3483
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
3484
|
+
* @param {*} [options] Override http request option.
|
|
3485
|
+
* @throws {RequiredError}
|
|
3486
|
+
*/
|
|
3487
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse> {
|
|
3488
|
+
return localVarFp.checkIsInRole(isInRoleRequest, options).then((request) => request(axios, basePath));
|
|
3489
|
+
},
|
|
1477
3490
|
};
|
|
1478
3491
|
};
|
|
1479
3492
|
|
|
1480
3493
|
/**
|
|
1481
|
-
*
|
|
3494
|
+
* AuthorizationApi - object-oriented interface
|
|
1482
3495
|
* @export
|
|
1483
|
-
* @class
|
|
3496
|
+
* @class AuthorizationApi
|
|
1484
3497
|
* @extends {BaseAPI}
|
|
1485
3498
|
*/
|
|
1486
|
-
export class
|
|
3499
|
+
export class AuthorizationApi extends BaseAPI {
|
|
1487
3500
|
/**
|
|
1488
3501
|
* Authenticate and authorize a user to perform an action
|
|
1489
3502
|
* @summary Authenticate and authorize Request
|
|
1490
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
3503
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1491
3504
|
* @param {*} [options] Override http request option.
|
|
1492
3505
|
* @throws {RequiredError}
|
|
1493
|
-
* @memberof
|
|
3506
|
+
* @memberof AuthorizationApi
|
|
1494
3507
|
*/
|
|
1495
|
-
public authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
1496
|
-
return
|
|
3508
|
+
public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
|
|
3509
|
+
return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3510
|
+
}
|
|
3511
|
+
|
|
3512
|
+
/**
|
|
3513
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
3514
|
+
* @summary Authenticate and Check Is In Role
|
|
3515
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
3516
|
+
* @param {*} [options] Override http request option.
|
|
3517
|
+
* @throws {RequiredError}
|
|
3518
|
+
* @memberof AuthorizationApi
|
|
3519
|
+
*/
|
|
3520
|
+
public authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) {
|
|
3521
|
+
return AuthorizationApiFp(this.configuration).authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3522
|
+
}
|
|
3523
|
+
|
|
3524
|
+
/**
|
|
3525
|
+
* Check if a user is authorized to perform an action
|
|
3526
|
+
* @summary Authorize Request
|
|
3527
|
+
* @param {AuthorizationRequest} [authorizationRequest]
|
|
3528
|
+
* @param {*} [options] Override http request option.
|
|
3529
|
+
* @throws {RequiredError}
|
|
3530
|
+
* @memberof AuthorizationApi
|
|
3531
|
+
*/
|
|
3532
|
+
public authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) {
|
|
3533
|
+
return AuthorizationApiFp(this.configuration).authorize(authorizationRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3534
|
+
}
|
|
3535
|
+
|
|
3536
|
+
/**
|
|
3537
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
3538
|
+
* @summary Authorize Batch Request
|
|
3539
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
3540
|
+
* @param {*} [options] Override http request option.
|
|
3541
|
+
* @throws {RequiredError}
|
|
3542
|
+
* @memberof AuthorizationApi
|
|
3543
|
+
*/
|
|
3544
|
+
public authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) {
|
|
3545
|
+
return AuthorizationApiFp(this.configuration).authorizeBatch(authorizationBatchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3546
|
+
}
|
|
3547
|
+
|
|
3548
|
+
/**
|
|
3549
|
+
* Check if a user is in any/all of the roles
|
|
3550
|
+
* @summary Check Is In Role
|
|
3551
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
3552
|
+
* @param {*} [options] Override http request option.
|
|
3553
|
+
* @throws {RequiredError}
|
|
3554
|
+
* @memberof AuthorizationApi
|
|
3555
|
+
*/
|
|
3556
|
+
public checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) {
|
|
3557
|
+
return AuthorizationApiFp(this.configuration).checkIsInRole(isInRoleRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1497
3558
|
}
|
|
1498
3559
|
}
|
|
1499
3560
|
|
|
1500
3561
|
|
|
1501
3562
|
|
|
1502
3563
|
/**
|
|
1503
|
-
*
|
|
3564
|
+
* AuthorizedEntitiesApi - axios parameter creator
|
|
1504
3565
|
* @export
|
|
1505
3566
|
*/
|
|
1506
|
-
export const
|
|
3567
|
+
export const AuthorizedEntitiesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1507
3568
|
return {
|
|
1508
3569
|
/**
|
|
1509
|
-
*
|
|
1510
|
-
* @summary
|
|
1511
|
-
* @param {
|
|
3570
|
+
* Get the authorized brands for a given org
|
|
3571
|
+
* @summary Get Authorized Brands
|
|
3572
|
+
* @param {string} orgId
|
|
3573
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
3574
|
+
* @param {*} [options] Override http request option.
|
|
3575
|
+
* @throws {RequiredError}
|
|
3576
|
+
*/
|
|
3577
|
+
getAuthorizedBrands: async (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3578
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3579
|
+
assertParamExists('getAuthorizedBrands', 'orgId', orgId)
|
|
3580
|
+
const localVarPath = `/orgs/{orgId}/getAuthorizedBrands`
|
|
3581
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
3582
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3583
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3584
|
+
let baseOptions;
|
|
3585
|
+
if (configuration) {
|
|
3586
|
+
baseOptions = configuration.baseOptions;
|
|
3587
|
+
}
|
|
3588
|
+
|
|
3589
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3590
|
+
const localVarHeaderParameter = {} as any;
|
|
3591
|
+
const localVarQueryParameter = {} as any;
|
|
3592
|
+
|
|
3593
|
+
// authentication ApiKeyAuth required
|
|
3594
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3595
|
+
|
|
3596
|
+
|
|
3597
|
+
|
|
3598
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3599
|
+
|
|
3600
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3601
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3602
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3603
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedBrandsRequest, localVarRequestOptions, configuration)
|
|
3604
|
+
|
|
3605
|
+
return {
|
|
3606
|
+
url: toPathString(localVarUrlObj),
|
|
3607
|
+
options: localVarRequestOptions,
|
|
3608
|
+
};
|
|
3609
|
+
},
|
|
3610
|
+
/**
|
|
3611
|
+
* Get the authorized orgs for a given principal
|
|
3612
|
+
* @summary Get Authorized Orgs
|
|
3613
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1512
3614
|
* @param {*} [options] Override http request option.
|
|
1513
3615
|
* @throws {RequiredError}
|
|
1514
3616
|
*/
|
|
1515
|
-
|
|
1516
|
-
const localVarPath = `/
|
|
3617
|
+
getAuthorizedOrgs: async (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3618
|
+
const localVarPath = `/getAuthorizedOrgs`;
|
|
1517
3619
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1518
3620
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1519
3621
|
let baseOptions;
|
|
@@ -1535,7 +3637,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1535
3637
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1536
3638
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1537
3639
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1538
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3640
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedOrgsRequest, localVarRequestOptions, configuration)
|
|
1539
3641
|
|
|
1540
3642
|
return {
|
|
1541
3643
|
url: toPathString(localVarUrlObj),
|
|
@@ -1543,14 +3645,18 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1543
3645
|
};
|
|
1544
3646
|
},
|
|
1545
3647
|
/**
|
|
1546
|
-
*
|
|
1547
|
-
* @summary
|
|
1548
|
-
* @param {
|
|
3648
|
+
* Get the authorized properties for a given org
|
|
3649
|
+
* @summary Get Authorized Properties
|
|
3650
|
+
* @param {string} orgId
|
|
3651
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
1549
3652
|
* @param {*} [options] Override http request option.
|
|
1550
3653
|
* @throws {RequiredError}
|
|
1551
3654
|
*/
|
|
1552
|
-
|
|
1553
|
-
|
|
3655
|
+
getAuthorizedProperties: async (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3656
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3657
|
+
assertParamExists('getAuthorizedProperties', 'orgId', orgId)
|
|
3658
|
+
const localVarPath = `/orgs/{orgId}/getAuthorizedProperties`
|
|
3659
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
1554
3660
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1555
3661
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1556
3662
|
let baseOptions;
|
|
@@ -1572,7 +3678,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1572
3678
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1573
3679
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1574
3680
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1575
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
3681
|
+
localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedPropertiesRequest, localVarRequestOptions, configuration)
|
|
1576
3682
|
|
|
1577
3683
|
return {
|
|
1578
3684
|
url: toPathString(localVarUrlObj),
|
|
@@ -1583,111 +3689,284 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1583
3689
|
};
|
|
1584
3690
|
|
|
1585
3691
|
/**
|
|
1586
|
-
*
|
|
3692
|
+
* AuthorizedEntitiesApi - functional programming interface
|
|
1587
3693
|
* @export
|
|
1588
3694
|
*/
|
|
1589
|
-
export const
|
|
1590
|
-
const localVarAxiosParamCreator =
|
|
3695
|
+
export const AuthorizedEntitiesApiFp = function(configuration?: Configuration) {
|
|
3696
|
+
const localVarAxiosParamCreator = AuthorizedEntitiesApiAxiosParamCreator(configuration)
|
|
1591
3697
|
return {
|
|
1592
3698
|
/**
|
|
1593
|
-
*
|
|
1594
|
-
* @summary
|
|
1595
|
-
* @param {
|
|
3699
|
+
* Get the authorized brands for a given org
|
|
3700
|
+
* @summary Get Authorized Brands
|
|
3701
|
+
* @param {string} orgId
|
|
3702
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1596
3703
|
* @param {*} [options] Override http request option.
|
|
1597
3704
|
* @throws {RequiredError}
|
|
1598
3705
|
*/
|
|
1599
|
-
async
|
|
1600
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3706
|
+
async getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>> {
|
|
3707
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options);
|
|
1601
3708
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1602
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3709
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedBrands']?.[localVarOperationServerIndex]?.url;
|
|
1603
3710
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1604
3711
|
},
|
|
1605
3712
|
/**
|
|
1606
|
-
*
|
|
1607
|
-
* @summary
|
|
1608
|
-
* @param {
|
|
3713
|
+
* Get the authorized orgs for a given principal
|
|
3714
|
+
* @summary Get Authorized Orgs
|
|
3715
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1609
3716
|
* @param {*} [options] Override http request option.
|
|
1610
3717
|
* @throws {RequiredError}
|
|
1611
3718
|
*/
|
|
1612
|
-
async
|
|
1613
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
3719
|
+
async getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>> {
|
|
3720
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedOrgs(getAuthorizedOrgsRequest, options);
|
|
1614
3721
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1615
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
3722
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedOrgs']?.[localVarOperationServerIndex]?.url;
|
|
3723
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3724
|
+
},
|
|
3725
|
+
/**
|
|
3726
|
+
* Get the authorized properties for a given org
|
|
3727
|
+
* @summary Get Authorized Properties
|
|
3728
|
+
* @param {string} orgId
|
|
3729
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3730
|
+
* @param {*} [options] Override http request option.
|
|
3731
|
+
* @throws {RequiredError}
|
|
3732
|
+
*/
|
|
3733
|
+
async getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>> {
|
|
3734
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options);
|
|
3735
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3736
|
+
const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedProperties']?.[localVarOperationServerIndex]?.url;
|
|
1616
3737
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1617
3738
|
},
|
|
1618
3739
|
}
|
|
1619
3740
|
};
|
|
1620
3741
|
|
|
1621
3742
|
/**
|
|
1622
|
-
*
|
|
3743
|
+
* AuthorizedEntitiesApi - factory interface
|
|
1623
3744
|
* @export
|
|
1624
3745
|
*/
|
|
1625
|
-
export const
|
|
1626
|
-
const localVarFp =
|
|
3746
|
+
export const AuthorizedEntitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3747
|
+
const localVarFp = AuthorizedEntitiesApiFp(configuration)
|
|
1627
3748
|
return {
|
|
1628
3749
|
/**
|
|
1629
|
-
*
|
|
1630
|
-
* @summary
|
|
1631
|
-
* @param {
|
|
3750
|
+
* Get the authorized brands for a given org
|
|
3751
|
+
* @summary Get Authorized Brands
|
|
3752
|
+
* @param {string} orgId
|
|
3753
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1632
3754
|
* @param {*} [options] Override http request option.
|
|
1633
3755
|
* @throws {RequiredError}
|
|
1634
3756
|
*/
|
|
1635
|
-
|
|
1636
|
-
return localVarFp.
|
|
3757
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse> {
|
|
3758
|
+
return localVarFp.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(axios, basePath));
|
|
1637
3759
|
},
|
|
1638
3760
|
/**
|
|
1639
|
-
*
|
|
1640
|
-
* @summary
|
|
1641
|
-
* @param {
|
|
3761
|
+
* Get the authorized orgs for a given principal
|
|
3762
|
+
* @summary Get Authorized Orgs
|
|
3763
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1642
3764
|
* @param {*} [options] Override http request option.
|
|
1643
3765
|
* @throws {RequiredError}
|
|
1644
3766
|
*/
|
|
1645
|
-
|
|
1646
|
-
return localVarFp.
|
|
3767
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse> {
|
|
3768
|
+
return localVarFp.getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(axios, basePath));
|
|
3769
|
+
},
|
|
3770
|
+
/**
|
|
3771
|
+
* Get the authorized properties for a given org
|
|
3772
|
+
* @summary Get Authorized Properties
|
|
3773
|
+
* @param {string} orgId
|
|
3774
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3775
|
+
* @param {*} [options] Override http request option.
|
|
3776
|
+
* @throws {RequiredError}
|
|
3777
|
+
*/
|
|
3778
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse> {
|
|
3779
|
+
return localVarFp.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(axios, basePath));
|
|
1647
3780
|
},
|
|
1648
3781
|
};
|
|
1649
3782
|
};
|
|
1650
3783
|
|
|
1651
3784
|
/**
|
|
1652
|
-
*
|
|
3785
|
+
* AuthorizedEntitiesApi - object-oriented interface
|
|
1653
3786
|
* @export
|
|
1654
|
-
* @class
|
|
3787
|
+
* @class AuthorizedEntitiesApi
|
|
1655
3788
|
* @extends {BaseAPI}
|
|
1656
3789
|
*/
|
|
1657
|
-
export class
|
|
3790
|
+
export class AuthorizedEntitiesApi extends BaseAPI {
|
|
1658
3791
|
/**
|
|
1659
|
-
*
|
|
1660
|
-
* @summary
|
|
1661
|
-
* @param {
|
|
3792
|
+
* Get the authorized brands for a given org
|
|
3793
|
+
* @summary Get Authorized Brands
|
|
3794
|
+
* @param {string} orgId
|
|
3795
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
1662
3796
|
* @param {*} [options] Override http request option.
|
|
1663
3797
|
* @throws {RequiredError}
|
|
1664
|
-
* @memberof
|
|
3798
|
+
* @memberof AuthorizedEntitiesApi
|
|
1665
3799
|
*/
|
|
1666
|
-
public
|
|
1667
|
-
return
|
|
3800
|
+
public getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) {
|
|
3801
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1668
3802
|
}
|
|
1669
3803
|
|
|
1670
3804
|
/**
|
|
1671
|
-
*
|
|
1672
|
-
* @summary
|
|
1673
|
-
* @param {
|
|
3805
|
+
* Get the authorized orgs for a given principal
|
|
3806
|
+
* @summary Get Authorized Orgs
|
|
3807
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
1674
3808
|
* @param {*} [options] Override http request option.
|
|
1675
3809
|
* @throws {RequiredError}
|
|
1676
|
-
* @memberof
|
|
3810
|
+
* @memberof AuthorizedEntitiesApi
|
|
1677
3811
|
*/
|
|
1678
|
-
public
|
|
1679
|
-
return
|
|
3812
|
+
public getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) {
|
|
3813
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3814
|
+
}
|
|
3815
|
+
|
|
3816
|
+
/**
|
|
3817
|
+
* Get the authorized properties for a given org
|
|
3818
|
+
* @summary Get Authorized Properties
|
|
3819
|
+
* @param {string} orgId
|
|
3820
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
3821
|
+
* @param {*} [options] Override http request option.
|
|
3822
|
+
* @throws {RequiredError}
|
|
3823
|
+
* @memberof AuthorizedEntitiesApi
|
|
3824
|
+
*/
|
|
3825
|
+
public getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) {
|
|
3826
|
+
return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1680
3827
|
}
|
|
1681
3828
|
}
|
|
1682
3829
|
|
|
1683
3830
|
|
|
1684
3831
|
|
|
1685
3832
|
/**
|
|
1686
|
-
*
|
|
3833
|
+
* ConfigurationDataApi - axios parameter creator
|
|
1687
3834
|
* @export
|
|
1688
3835
|
*/
|
|
1689
|
-
export const
|
|
3836
|
+
export const ConfigurationDataApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1690
3837
|
return {
|
|
3838
|
+
/**
|
|
3839
|
+
* List the available feature based roles
|
|
3840
|
+
* @summary List Feature Based Roles
|
|
3841
|
+
* @param {*} [options] Override http request option.
|
|
3842
|
+
* @throws {RequiredError}
|
|
3843
|
+
*/
|
|
3844
|
+
configListFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3845
|
+
const localVarPath = `/config/featureBasedRoles`;
|
|
3846
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3847
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3848
|
+
let baseOptions;
|
|
3849
|
+
if (configuration) {
|
|
3850
|
+
baseOptions = configuration.baseOptions;
|
|
3851
|
+
}
|
|
3852
|
+
|
|
3853
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3854
|
+
const localVarHeaderParameter = {} as any;
|
|
3855
|
+
const localVarQueryParameter = {} as any;
|
|
3856
|
+
|
|
3857
|
+
// authentication ApiKeyAuth required
|
|
3858
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
|
|
3862
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3863
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3864
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3865
|
+
|
|
3866
|
+
return {
|
|
3867
|
+
url: toPathString(localVarUrlObj),
|
|
3868
|
+
options: localVarRequestOptions,
|
|
3869
|
+
};
|
|
3870
|
+
},
|
|
3871
|
+
/**
|
|
3872
|
+
* List the available permissions
|
|
3873
|
+
* @summary List Permissions
|
|
3874
|
+
* @param {*} [options] Override http request option.
|
|
3875
|
+
* @throws {RequiredError}
|
|
3876
|
+
*/
|
|
3877
|
+
configListPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3878
|
+
const localVarPath = `/config/permissions`;
|
|
3879
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3880
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3881
|
+
let baseOptions;
|
|
3882
|
+
if (configuration) {
|
|
3883
|
+
baseOptions = configuration.baseOptions;
|
|
3884
|
+
}
|
|
3885
|
+
|
|
3886
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3887
|
+
const localVarHeaderParameter = {} as any;
|
|
3888
|
+
const localVarQueryParameter = {} as any;
|
|
3889
|
+
|
|
3890
|
+
// authentication ApiKeyAuth required
|
|
3891
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3892
|
+
|
|
3893
|
+
|
|
3894
|
+
|
|
3895
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3896
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3897
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3898
|
+
|
|
3899
|
+
return {
|
|
3900
|
+
url: toPathString(localVarUrlObj),
|
|
3901
|
+
options: localVarRequestOptions,
|
|
3902
|
+
};
|
|
3903
|
+
},
|
|
3904
|
+
/**
|
|
3905
|
+
* List the available roles
|
|
3906
|
+
* @summary List Roles
|
|
3907
|
+
* @param {*} [options] Override http request option.
|
|
3908
|
+
* @throws {RequiredError}
|
|
3909
|
+
*/
|
|
3910
|
+
configListRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3911
|
+
const localVarPath = `/config/roles`;
|
|
3912
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3913
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3914
|
+
let baseOptions;
|
|
3915
|
+
if (configuration) {
|
|
3916
|
+
baseOptions = configuration.baseOptions;
|
|
3917
|
+
}
|
|
3918
|
+
|
|
3919
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3920
|
+
const localVarHeaderParameter = {} as any;
|
|
3921
|
+
const localVarQueryParameter = {} as any;
|
|
3922
|
+
|
|
3923
|
+
// authentication ApiKeyAuth required
|
|
3924
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3925
|
+
|
|
3926
|
+
|
|
3927
|
+
|
|
3928
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3929
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3930
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3931
|
+
|
|
3932
|
+
return {
|
|
3933
|
+
url: toPathString(localVarUrlObj),
|
|
3934
|
+
options: localVarRequestOptions,
|
|
3935
|
+
};
|
|
3936
|
+
},
|
|
3937
|
+
/**
|
|
3938
|
+
* List the available feature based roles
|
|
3939
|
+
* @summary List Feature Based Roles
|
|
3940
|
+
* @param {*} [options] Override http request option.
|
|
3941
|
+
* @throws {RequiredError}
|
|
3942
|
+
*/
|
|
3943
|
+
listFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3944
|
+
const localVarPath = `/featureBasedRoles`;
|
|
3945
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3946
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3947
|
+
let baseOptions;
|
|
3948
|
+
if (configuration) {
|
|
3949
|
+
baseOptions = configuration.baseOptions;
|
|
3950
|
+
}
|
|
3951
|
+
|
|
3952
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3953
|
+
const localVarHeaderParameter = {} as any;
|
|
3954
|
+
const localVarQueryParameter = {} as any;
|
|
3955
|
+
|
|
3956
|
+
// authentication ApiKeyAuth required
|
|
3957
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3958
|
+
|
|
3959
|
+
|
|
3960
|
+
|
|
3961
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3962
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3963
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3964
|
+
|
|
3965
|
+
return {
|
|
3966
|
+
url: toPathString(localVarUrlObj),
|
|
3967
|
+
options: localVarRequestOptions,
|
|
3968
|
+
};
|
|
3969
|
+
},
|
|
1691
3970
|
/**
|
|
1692
3971
|
* List the available permissions
|
|
1693
3972
|
* @summary List Permissions
|
|
@@ -1712,6 +3991,39 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1712
3991
|
|
|
1713
3992
|
|
|
1714
3993
|
|
|
3994
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3995
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3996
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3997
|
+
|
|
3998
|
+
return {
|
|
3999
|
+
url: toPathString(localVarUrlObj),
|
|
4000
|
+
options: localVarRequestOptions,
|
|
4001
|
+
};
|
|
4002
|
+
},
|
|
4003
|
+
/**
|
|
4004
|
+
* List the available roles
|
|
4005
|
+
* @summary List Roles
|
|
4006
|
+
* @param {*} [options] Override http request option.
|
|
4007
|
+
* @throws {RequiredError}
|
|
4008
|
+
*/
|
|
4009
|
+
listRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4010
|
+
const localVarPath = `/roles`;
|
|
4011
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4012
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4013
|
+
let baseOptions;
|
|
4014
|
+
if (configuration) {
|
|
4015
|
+
baseOptions = configuration.baseOptions;
|
|
4016
|
+
}
|
|
4017
|
+
|
|
4018
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4019
|
+
const localVarHeaderParameter = {} as any;
|
|
4020
|
+
const localVarQueryParameter = {} as any;
|
|
4021
|
+
|
|
4022
|
+
// authentication ApiKeyAuth required
|
|
4023
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4024
|
+
|
|
4025
|
+
|
|
4026
|
+
|
|
1715
4027
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1716
4028
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1717
4029
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -1725,62 +4037,222 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1725
4037
|
};
|
|
1726
4038
|
|
|
1727
4039
|
/**
|
|
1728
|
-
*
|
|
4040
|
+
* ConfigurationDataApi - functional programming interface
|
|
1729
4041
|
* @export
|
|
1730
4042
|
*/
|
|
1731
|
-
export const
|
|
1732
|
-
const localVarAxiosParamCreator =
|
|
4043
|
+
export const ConfigurationDataApiFp = function(configuration?: Configuration) {
|
|
4044
|
+
const localVarAxiosParamCreator = ConfigurationDataApiAxiosParamCreator(configuration)
|
|
1733
4045
|
return {
|
|
4046
|
+
/**
|
|
4047
|
+
* List the available feature based roles
|
|
4048
|
+
* @summary List Feature Based Roles
|
|
4049
|
+
* @param {*} [options] Override http request option.
|
|
4050
|
+
* @throws {RequiredError}
|
|
4051
|
+
*/
|
|
4052
|
+
async configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
|
|
4053
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.configListFeatureBasedRoles(options);
|
|
4054
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4055
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
|
|
4056
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4057
|
+
},
|
|
4058
|
+
/**
|
|
4059
|
+
* List the available permissions
|
|
4060
|
+
* @summary List Permissions
|
|
4061
|
+
* @param {*} [options] Override http request option.
|
|
4062
|
+
* @throws {RequiredError}
|
|
4063
|
+
*/
|
|
4064
|
+
async configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
|
|
4065
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.configListPermissions(options);
|
|
4066
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4067
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListPermissions']?.[localVarOperationServerIndex]?.url;
|
|
4068
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4069
|
+
},
|
|
4070
|
+
/**
|
|
4071
|
+
* List the available roles
|
|
4072
|
+
* @summary List Roles
|
|
4073
|
+
* @param {*} [options] Override http request option.
|
|
4074
|
+
* @throws {RequiredError}
|
|
4075
|
+
*/
|
|
4076
|
+
async configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
|
|
4077
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.configListRoles(options);
|
|
4078
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4079
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListRoles']?.[localVarOperationServerIndex]?.url;
|
|
4080
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4081
|
+
},
|
|
4082
|
+
/**
|
|
4083
|
+
* List the available feature based roles
|
|
4084
|
+
* @summary List Feature Based Roles
|
|
4085
|
+
* @param {*} [options] Override http request option.
|
|
4086
|
+
* @throws {RequiredError}
|
|
4087
|
+
*/
|
|
4088
|
+
async listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
|
|
4089
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listFeatureBasedRoles(options);
|
|
4090
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4091
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
|
|
4092
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4093
|
+
},
|
|
1734
4094
|
/**
|
|
1735
4095
|
* List the available permissions
|
|
1736
4096
|
* @summary List Permissions
|
|
1737
4097
|
* @param {*} [options] Override http request option.
|
|
1738
4098
|
* @throws {RequiredError}
|
|
1739
4099
|
*/
|
|
1740
|
-
async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1741
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
|
|
4100
|
+
async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
|
|
4101
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
|
|
4102
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4103
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listPermissions']?.[localVarOperationServerIndex]?.url;
|
|
4104
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4105
|
+
},
|
|
4106
|
+
/**
|
|
4107
|
+
* List the available roles
|
|
4108
|
+
* @summary List Roles
|
|
4109
|
+
* @param {*} [options] Override http request option.
|
|
4110
|
+
* @throws {RequiredError}
|
|
4111
|
+
*/
|
|
4112
|
+
async listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
|
|
4113
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(options);
|
|
1742
4114
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1743
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
4115
|
+
const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listRoles']?.[localVarOperationServerIndex]?.url;
|
|
1744
4116
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1745
4117
|
},
|
|
1746
4118
|
}
|
|
1747
4119
|
};
|
|
1748
4120
|
|
|
1749
4121
|
/**
|
|
1750
|
-
*
|
|
4122
|
+
* ConfigurationDataApi - factory interface
|
|
1751
4123
|
* @export
|
|
1752
4124
|
*/
|
|
1753
|
-
export const
|
|
1754
|
-
const localVarFp =
|
|
4125
|
+
export const ConfigurationDataApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
4126
|
+
const localVarFp = ConfigurationDataApiFp(configuration)
|
|
1755
4127
|
return {
|
|
4128
|
+
/**
|
|
4129
|
+
* List the available feature based roles
|
|
4130
|
+
* @summary List Feature Based Roles
|
|
4131
|
+
* @param {*} [options] Override http request option.
|
|
4132
|
+
* @throws {RequiredError}
|
|
4133
|
+
*/
|
|
4134
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
|
|
4135
|
+
return localVarFp.configListFeatureBasedRoles(options).then((request) => request(axios, basePath));
|
|
4136
|
+
},
|
|
4137
|
+
/**
|
|
4138
|
+
* List the available permissions
|
|
4139
|
+
* @summary List Permissions
|
|
4140
|
+
* @param {*} [options] Override http request option.
|
|
4141
|
+
* @throws {RequiredError}
|
|
4142
|
+
*/
|
|
4143
|
+
configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
|
|
4144
|
+
return localVarFp.configListPermissions(options).then((request) => request(axios, basePath));
|
|
4145
|
+
},
|
|
4146
|
+
/**
|
|
4147
|
+
* List the available roles
|
|
4148
|
+
* @summary List Roles
|
|
4149
|
+
* @param {*} [options] Override http request option.
|
|
4150
|
+
* @throws {RequiredError}
|
|
4151
|
+
*/
|
|
4152
|
+
configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
|
|
4153
|
+
return localVarFp.configListRoles(options).then((request) => request(axios, basePath));
|
|
4154
|
+
},
|
|
4155
|
+
/**
|
|
4156
|
+
* List the available feature based roles
|
|
4157
|
+
* @summary List Feature Based Roles
|
|
4158
|
+
* @param {*} [options] Override http request option.
|
|
4159
|
+
* @throws {RequiredError}
|
|
4160
|
+
*/
|
|
4161
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
|
|
4162
|
+
return localVarFp.listFeatureBasedRoles(options).then((request) => request(axios, basePath));
|
|
4163
|
+
},
|
|
1756
4164
|
/**
|
|
1757
4165
|
* List the available permissions
|
|
1758
4166
|
* @summary List Permissions
|
|
1759
4167
|
* @param {*} [options] Override http request option.
|
|
1760
4168
|
* @throws {RequiredError}
|
|
1761
4169
|
*/
|
|
1762
|
-
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<
|
|
4170
|
+
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
|
|
1763
4171
|
return localVarFp.listPermissions(options).then((request) => request(axios, basePath));
|
|
1764
4172
|
},
|
|
4173
|
+
/**
|
|
4174
|
+
* List the available roles
|
|
4175
|
+
* @summary List Roles
|
|
4176
|
+
* @param {*} [options] Override http request option.
|
|
4177
|
+
* @throws {RequiredError}
|
|
4178
|
+
*/
|
|
4179
|
+
listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
|
|
4180
|
+
return localVarFp.listRoles(options).then((request) => request(axios, basePath));
|
|
4181
|
+
},
|
|
1765
4182
|
};
|
|
1766
4183
|
};
|
|
1767
4184
|
|
|
1768
4185
|
/**
|
|
1769
|
-
*
|
|
4186
|
+
* ConfigurationDataApi - object-oriented interface
|
|
1770
4187
|
* @export
|
|
1771
|
-
* @class
|
|
4188
|
+
* @class ConfigurationDataApi
|
|
1772
4189
|
* @extends {BaseAPI}
|
|
1773
4190
|
*/
|
|
1774
|
-
export class
|
|
4191
|
+
export class ConfigurationDataApi extends BaseAPI {
|
|
4192
|
+
/**
|
|
4193
|
+
* List the available feature based roles
|
|
4194
|
+
* @summary List Feature Based Roles
|
|
4195
|
+
* @param {*} [options] Override http request option.
|
|
4196
|
+
* @throws {RequiredError}
|
|
4197
|
+
* @memberof ConfigurationDataApi
|
|
4198
|
+
*/
|
|
4199
|
+
public configListFeatureBasedRoles(options?: RawAxiosRequestConfig) {
|
|
4200
|
+
return ConfigurationDataApiFp(this.configuration).configListFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
|
|
4201
|
+
}
|
|
4202
|
+
|
|
4203
|
+
/**
|
|
4204
|
+
* List the available permissions
|
|
4205
|
+
* @summary List Permissions
|
|
4206
|
+
* @param {*} [options] Override http request option.
|
|
4207
|
+
* @throws {RequiredError}
|
|
4208
|
+
* @memberof ConfigurationDataApi
|
|
4209
|
+
*/
|
|
4210
|
+
public configListPermissions(options?: RawAxiosRequestConfig) {
|
|
4211
|
+
return ConfigurationDataApiFp(this.configuration).configListPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
4212
|
+
}
|
|
4213
|
+
|
|
4214
|
+
/**
|
|
4215
|
+
* List the available roles
|
|
4216
|
+
* @summary List Roles
|
|
4217
|
+
* @param {*} [options] Override http request option.
|
|
4218
|
+
* @throws {RequiredError}
|
|
4219
|
+
* @memberof ConfigurationDataApi
|
|
4220
|
+
*/
|
|
4221
|
+
public configListRoles(options?: RawAxiosRequestConfig) {
|
|
4222
|
+
return ConfigurationDataApiFp(this.configuration).configListRoles(options).then((request) => request(this.axios, this.basePath));
|
|
4223
|
+
}
|
|
4224
|
+
|
|
4225
|
+
/**
|
|
4226
|
+
* List the available feature based roles
|
|
4227
|
+
* @summary List Feature Based Roles
|
|
4228
|
+
* @param {*} [options] Override http request option.
|
|
4229
|
+
* @throws {RequiredError}
|
|
4230
|
+
* @memberof ConfigurationDataApi
|
|
4231
|
+
*/
|
|
4232
|
+
public listFeatureBasedRoles(options?: RawAxiosRequestConfig) {
|
|
4233
|
+
return ConfigurationDataApiFp(this.configuration).listFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
|
|
4234
|
+
}
|
|
4235
|
+
|
|
1775
4236
|
/**
|
|
1776
4237
|
* List the available permissions
|
|
1777
4238
|
* @summary List Permissions
|
|
1778
4239
|
* @param {*} [options] Override http request option.
|
|
1779
4240
|
* @throws {RequiredError}
|
|
1780
|
-
* @memberof
|
|
4241
|
+
* @memberof ConfigurationDataApi
|
|
1781
4242
|
*/
|
|
1782
4243
|
public listPermissions(options?: RawAxiosRequestConfig) {
|
|
1783
|
-
return
|
|
4244
|
+
return ConfigurationDataApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
4245
|
+
}
|
|
4246
|
+
|
|
4247
|
+
/**
|
|
4248
|
+
* List the available roles
|
|
4249
|
+
* @summary List Roles
|
|
4250
|
+
* @param {*} [options] Override http request option.
|
|
4251
|
+
* @throws {RequiredError}
|
|
4252
|
+
* @memberof ConfigurationDataApi
|
|
4253
|
+
*/
|
|
4254
|
+
public listRoles(options?: RawAxiosRequestConfig) {
|
|
4255
|
+
return ConfigurationDataApiFp(this.configuration).listRoles(options).then((request) => request(this.axios, this.basePath));
|
|
1784
4256
|
}
|
|
1785
4257
|
}
|
|
1786
4258
|
|
|
@@ -1853,7 +4325,7 @@ export const RoleAssignmentApiAxiosParamCreator = function (configuration?: Conf
|
|
|
1853
4325
|
baseOptions = configuration.baseOptions;
|
|
1854
4326
|
}
|
|
1855
4327
|
|
|
1856
|
-
const localVarRequestOptions = { method: '
|
|
4328
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1857
4329
|
const localVarHeaderParameter = {} as any;
|
|
1858
4330
|
const localVarQueryParameter = {} as any;
|
|
1859
4331
|
|
|
@@ -2141,12 +4613,197 @@ export class RoleAssignmentApi extends BaseAPI {
|
|
|
2141
4613
|
|
|
2142
4614
|
|
|
2143
4615
|
|
|
4616
|
+
/**
|
|
4617
|
+
* UserManagementApi - axios parameter creator
|
|
4618
|
+
* @export
|
|
4619
|
+
*/
|
|
4620
|
+
export const UserManagementApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4621
|
+
return {
|
|
4622
|
+
/**
|
|
4623
|
+
* List the users in a given org
|
|
4624
|
+
* @summary List Users in Org
|
|
4625
|
+
* @param {string} orgId
|
|
4626
|
+
* @param {*} [options] Override http request option.
|
|
4627
|
+
* @throws {RequiredError}
|
|
4628
|
+
*/
|
|
4629
|
+
listUsersInOrg: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4630
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
4631
|
+
assertParamExists('listUsersInOrg', 'orgId', orgId)
|
|
4632
|
+
const localVarPath = `/orgs/{orgId}/users`
|
|
4633
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
4634
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4635
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4636
|
+
let baseOptions;
|
|
4637
|
+
if (configuration) {
|
|
4638
|
+
baseOptions = configuration.baseOptions;
|
|
4639
|
+
}
|
|
4640
|
+
|
|
4641
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4642
|
+
const localVarHeaderParameter = {} as any;
|
|
4643
|
+
const localVarQueryParameter = {} as any;
|
|
4644
|
+
|
|
4645
|
+
// authentication ApiKeyAuth required
|
|
4646
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4647
|
+
|
|
4648
|
+
|
|
4649
|
+
|
|
4650
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4651
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4652
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4653
|
+
|
|
4654
|
+
return {
|
|
4655
|
+
url: toPathString(localVarUrlObj),
|
|
4656
|
+
options: localVarRequestOptions,
|
|
4657
|
+
};
|
|
4658
|
+
},
|
|
4659
|
+
}
|
|
4660
|
+
};
|
|
4661
|
+
|
|
4662
|
+
/**
|
|
4663
|
+
* UserManagementApi - functional programming interface
|
|
4664
|
+
* @export
|
|
4665
|
+
*/
|
|
4666
|
+
export const UserManagementApiFp = function(configuration?: Configuration) {
|
|
4667
|
+
const localVarAxiosParamCreator = UserManagementApiAxiosParamCreator(configuration)
|
|
4668
|
+
return {
|
|
4669
|
+
/**
|
|
4670
|
+
* List the users in a given org
|
|
4671
|
+
* @summary List Users in Org
|
|
4672
|
+
* @param {string} orgId
|
|
4673
|
+
* @param {*} [options] Override http request option.
|
|
4674
|
+
* @throws {RequiredError}
|
|
4675
|
+
*/
|
|
4676
|
+
async listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>> {
|
|
4677
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listUsersInOrg(orgId, options);
|
|
4678
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4679
|
+
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.listUsersInOrg']?.[localVarOperationServerIndex]?.url;
|
|
4680
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4681
|
+
},
|
|
4682
|
+
}
|
|
4683
|
+
};
|
|
4684
|
+
|
|
4685
|
+
/**
|
|
4686
|
+
* UserManagementApi - factory interface
|
|
4687
|
+
* @export
|
|
4688
|
+
*/
|
|
4689
|
+
export const UserManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
4690
|
+
const localVarFp = UserManagementApiFp(configuration)
|
|
4691
|
+
return {
|
|
4692
|
+
/**
|
|
4693
|
+
* List the users in a given org
|
|
4694
|
+
* @summary List Users in Org
|
|
4695
|
+
* @param {string} orgId
|
|
4696
|
+
* @param {*} [options] Override http request option.
|
|
4697
|
+
* @throws {RequiredError}
|
|
4698
|
+
*/
|
|
4699
|
+
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse> {
|
|
4700
|
+
return localVarFp.listUsersInOrg(orgId, options).then((request) => request(axios, basePath));
|
|
4701
|
+
},
|
|
4702
|
+
};
|
|
4703
|
+
};
|
|
4704
|
+
|
|
4705
|
+
/**
|
|
4706
|
+
* UserManagementApi - object-oriented interface
|
|
4707
|
+
* @export
|
|
4708
|
+
* @class UserManagementApi
|
|
4709
|
+
* @extends {BaseAPI}
|
|
4710
|
+
*/
|
|
4711
|
+
export class UserManagementApi extends BaseAPI {
|
|
4712
|
+
/**
|
|
4713
|
+
* List the users in a given org
|
|
4714
|
+
* @summary List Users in Org
|
|
4715
|
+
* @param {string} orgId
|
|
4716
|
+
* @param {*} [options] Override http request option.
|
|
4717
|
+
* @throws {RequiredError}
|
|
4718
|
+
* @memberof UserManagementApi
|
|
4719
|
+
*/
|
|
4720
|
+
public listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig) {
|
|
4721
|
+
return UserManagementApiFp(this.configuration).listUsersInOrg(orgId, options).then((request) => request(this.axios, this.basePath));
|
|
4722
|
+
}
|
|
4723
|
+
}
|
|
4724
|
+
|
|
4725
|
+
|
|
4726
|
+
|
|
2144
4727
|
/**
|
|
2145
4728
|
* UserPermissionsApi - axios parameter creator
|
|
2146
4729
|
* @export
|
|
2147
4730
|
*/
|
|
2148
4731
|
export const UserPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2149
4732
|
return {
|
|
4733
|
+
/**
|
|
4734
|
+
* List the available permissions for the current user
|
|
4735
|
+
* @summary List Org Permissions
|
|
4736
|
+
* @param {string} orgId
|
|
4737
|
+
* @param {*} [options] Override http request option.
|
|
4738
|
+
* @throws {RequiredError}
|
|
4739
|
+
*/
|
|
4740
|
+
listOrgPermissions: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4741
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
4742
|
+
assertParamExists('listOrgPermissions', 'orgId', orgId)
|
|
4743
|
+
const localVarPath = `/orgs/{orgId}/permissions`
|
|
4744
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
4745
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4746
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4747
|
+
let baseOptions;
|
|
4748
|
+
if (configuration) {
|
|
4749
|
+
baseOptions = configuration.baseOptions;
|
|
4750
|
+
}
|
|
4751
|
+
|
|
4752
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4753
|
+
const localVarHeaderParameter = {} as any;
|
|
4754
|
+
const localVarQueryParameter = {} as any;
|
|
4755
|
+
|
|
4756
|
+
// authentication ApiKeyAuth required
|
|
4757
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4758
|
+
|
|
4759
|
+
|
|
4760
|
+
|
|
4761
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4762
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4763
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4764
|
+
|
|
4765
|
+
return {
|
|
4766
|
+
url: toPathString(localVarUrlObj),
|
|
4767
|
+
options: localVarRequestOptions,
|
|
4768
|
+
};
|
|
4769
|
+
},
|
|
4770
|
+
/**
|
|
4771
|
+
* List the available roles for the current user
|
|
4772
|
+
* @summary List Org Roles
|
|
4773
|
+
* @param {string} orgId
|
|
4774
|
+
* @param {*} [options] Override http request option.
|
|
4775
|
+
* @throws {RequiredError}
|
|
4776
|
+
*/
|
|
4777
|
+
listOrgRoles: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4778
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
4779
|
+
assertParamExists('listOrgRoles', 'orgId', orgId)
|
|
4780
|
+
const localVarPath = `/orgs/{orgId}/roles`
|
|
4781
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
4782
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4783
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4784
|
+
let baseOptions;
|
|
4785
|
+
if (configuration) {
|
|
4786
|
+
baseOptions = configuration.baseOptions;
|
|
4787
|
+
}
|
|
4788
|
+
|
|
4789
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4790
|
+
const localVarHeaderParameter = {} as any;
|
|
4791
|
+
const localVarQueryParameter = {} as any;
|
|
4792
|
+
|
|
4793
|
+
// authentication ApiKeyAuth required
|
|
4794
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4795
|
+
|
|
4796
|
+
|
|
4797
|
+
|
|
4798
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4799
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4800
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4801
|
+
|
|
4802
|
+
return {
|
|
4803
|
+
url: toPathString(localVarUrlObj),
|
|
4804
|
+
options: localVarRequestOptions,
|
|
4805
|
+
};
|
|
4806
|
+
},
|
|
2150
4807
|
/**
|
|
2151
4808
|
* List the available permissions for the current user
|
|
2152
4809
|
* @summary List Own Permissions
|
|
@@ -2235,6 +4892,32 @@ export const UserPermissionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
2235
4892
|
export const UserPermissionsApiFp = function(configuration?: Configuration) {
|
|
2236
4893
|
const localVarAxiosParamCreator = UserPermissionsApiAxiosParamCreator(configuration)
|
|
2237
4894
|
return {
|
|
4895
|
+
/**
|
|
4896
|
+
* List the available permissions for the current user
|
|
4897
|
+
* @summary List Org Permissions
|
|
4898
|
+
* @param {string} orgId
|
|
4899
|
+
* @param {*} [options] Override http request option.
|
|
4900
|
+
* @throws {RequiredError}
|
|
4901
|
+
*/
|
|
4902
|
+
async listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }>> {
|
|
4903
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgPermissions(orgId, options);
|
|
4904
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4905
|
+
const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgPermissions']?.[localVarOperationServerIndex]?.url;
|
|
4906
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4907
|
+
},
|
|
4908
|
+
/**
|
|
4909
|
+
* List the available roles for the current user
|
|
4910
|
+
* @summary List Org Roles
|
|
4911
|
+
* @param {string} orgId
|
|
4912
|
+
* @param {*} [options] Override http request option.
|
|
4913
|
+
* @throws {RequiredError}
|
|
4914
|
+
*/
|
|
4915
|
+
async listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }>> {
|
|
4916
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgRoles(orgId, options);
|
|
4917
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4918
|
+
const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgRoles']?.[localVarOperationServerIndex]?.url;
|
|
4919
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4920
|
+
},
|
|
2238
4921
|
/**
|
|
2239
4922
|
* List the available permissions for the current user
|
|
2240
4923
|
* @summary List Own Permissions
|
|
@@ -2272,6 +4955,26 @@ export const UserPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
2272
4955
|
export const UserPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2273
4956
|
const localVarFp = UserPermissionsApiFp(configuration)
|
|
2274
4957
|
return {
|
|
4958
|
+
/**
|
|
4959
|
+
* List the available permissions for the current user
|
|
4960
|
+
* @summary List Org Permissions
|
|
4961
|
+
* @param {string} orgId
|
|
4962
|
+
* @param {*} [options] Override http request option.
|
|
4963
|
+
* @throws {RequiredError}
|
|
4964
|
+
*/
|
|
4965
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }> {
|
|
4966
|
+
return localVarFp.listOrgPermissions(orgId, options).then((request) => request(axios, basePath));
|
|
4967
|
+
},
|
|
4968
|
+
/**
|
|
4969
|
+
* List the available roles for the current user
|
|
4970
|
+
* @summary List Org Roles
|
|
4971
|
+
* @param {string} orgId
|
|
4972
|
+
* @param {*} [options] Override http request option.
|
|
4973
|
+
* @throws {RequiredError}
|
|
4974
|
+
*/
|
|
4975
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }> {
|
|
4976
|
+
return localVarFp.listOrgRoles(orgId, options).then((request) => request(axios, basePath));
|
|
4977
|
+
},
|
|
2275
4978
|
/**
|
|
2276
4979
|
* List the available permissions for the current user
|
|
2277
4980
|
* @summary List Own Permissions
|
|
@@ -2303,6 +5006,30 @@ export const UserPermissionsApiFactory = function (configuration?: Configuration
|
|
|
2303
5006
|
* @extends {BaseAPI}
|
|
2304
5007
|
*/
|
|
2305
5008
|
export class UserPermissionsApi extends BaseAPI {
|
|
5009
|
+
/**
|
|
5010
|
+
* List the available permissions for the current user
|
|
5011
|
+
* @summary List Org Permissions
|
|
5012
|
+
* @param {string} orgId
|
|
5013
|
+
* @param {*} [options] Override http request option.
|
|
5014
|
+
* @throws {RequiredError}
|
|
5015
|
+
* @memberof UserPermissionsApi
|
|
5016
|
+
*/
|
|
5017
|
+
public listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig) {
|
|
5018
|
+
return UserPermissionsApiFp(this.configuration).listOrgPermissions(orgId, options).then((request) => request(this.axios, this.basePath));
|
|
5019
|
+
}
|
|
5020
|
+
|
|
5021
|
+
/**
|
|
5022
|
+
* List the available roles for the current user
|
|
5023
|
+
* @summary List Org Roles
|
|
5024
|
+
* @param {string} orgId
|
|
5025
|
+
* @param {*} [options] Override http request option.
|
|
5026
|
+
* @throws {RequiredError}
|
|
5027
|
+
* @memberof UserPermissionsApi
|
|
5028
|
+
*/
|
|
5029
|
+
public listOrgRoles(orgId: string, options?: RawAxiosRequestConfig) {
|
|
5030
|
+
return UserPermissionsApiFp(this.configuration).listOrgRoles(orgId, options).then((request) => request(this.axios, this.basePath));
|
|
5031
|
+
}
|
|
5032
|
+
|
|
2306
5033
|
/**
|
|
2307
5034
|
* List the available permissions for the current user
|
|
2308
5035
|
* @summary List Own Permissions
|