@flipdish/authorization 0.0.5-rc.1756734017 → 0.0.6-rc.1764848166
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 +164 -107
- package/api.ts +2701 -594
- package/base.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2073 -478
- package/dist/api.js +2413 -483
- package/dist/base.js +1 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ import { BaseAPI } from './base';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface AssignRoleRequestBody {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
*
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof AssignRoleRequestBody
|
|
26
26
|
*/
|
|
@@ -37,6 +37,12 @@ export interface AssignRoleRequestBody {
|
|
|
37
37
|
* @memberof AssignRoleRequestBody
|
|
38
38
|
*/
|
|
39
39
|
'principal': AuthorizationRequestPrincipal;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AssignRoleRequestBody
|
|
44
|
+
*/
|
|
45
|
+
'brandId': string;
|
|
40
46
|
}
|
|
41
47
|
export declare const AssignRoleRequestBodyRoleEnum: {
|
|
42
48
|
readonly OrgViewer: "OrgViewer";
|
|
@@ -134,11 +140,11 @@ export interface AssignRoleSuccessResponse {
|
|
|
134
140
|
export interface AuthenticateAndAuthorizeRequest {
|
|
135
141
|
/**
|
|
136
142
|
* Incoming request headers to be used for authentication
|
|
137
|
-
* @type {{ [key: string]:
|
|
143
|
+
* @type {{ [key: string]: string; }}
|
|
138
144
|
* @memberof AuthenticateAndAuthorizeRequest
|
|
139
145
|
*/
|
|
140
146
|
'headers': {
|
|
141
|
-
[key: string]:
|
|
147
|
+
[key: string]: string;
|
|
142
148
|
};
|
|
143
149
|
/**
|
|
144
150
|
*
|
|
@@ -161,10 +167,10 @@ export interface AuthenticateAndAuthorizeRequest {
|
|
|
161
167
|
export interface AuthenticateAndAuthorizeResponse {
|
|
162
168
|
/**
|
|
163
169
|
*
|
|
164
|
-
* @type {
|
|
170
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
165
171
|
* @memberof AuthenticateAndAuthorizeResponse
|
|
166
172
|
*/
|
|
167
|
-
'authentication':
|
|
173
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
168
174
|
/**
|
|
169
175
|
*
|
|
170
176
|
* @type {AuthorizationResponse}
|
|
@@ -175,30 +181,167 @@ export interface AuthenticateAndAuthorizeResponse {
|
|
|
175
181
|
/**
|
|
176
182
|
*
|
|
177
183
|
* @export
|
|
178
|
-
* @interface
|
|
184
|
+
* @interface AuthenticateAndCheckIsInRoleRequest
|
|
185
|
+
*/
|
|
186
|
+
export interface AuthenticateAndCheckIsInRoleRequest {
|
|
187
|
+
/**
|
|
188
|
+
* Incoming request headers to be used for authentication
|
|
189
|
+
* @type {{ [key: string]: string; }}
|
|
190
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
191
|
+
*/
|
|
192
|
+
'headers': {
|
|
193
|
+
[key: string]: string;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Array of roles to check if the principal is in
|
|
197
|
+
* @type {Array<string>}
|
|
198
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
199
|
+
*/
|
|
200
|
+
'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
|
|
201
|
+
/**
|
|
202
|
+
* How to check if the principal is in any/all of the roles
|
|
203
|
+
* @type {string}
|
|
204
|
+
* @memberof AuthenticateAndCheckIsInRoleRequest
|
|
205
|
+
*/
|
|
206
|
+
'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
|
|
207
|
+
}
|
|
208
|
+
export declare const AuthenticateAndCheckIsInRoleRequestRolesEnum: {
|
|
209
|
+
readonly Admin: "Admin";
|
|
210
|
+
readonly Factory: "Factory";
|
|
211
|
+
};
|
|
212
|
+
export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
|
|
213
|
+
export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: {
|
|
214
|
+
readonly Any: "any";
|
|
215
|
+
readonly All: "all";
|
|
216
|
+
};
|
|
217
|
+
export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
|
|
218
|
+
/**
|
|
219
|
+
* Response containing whether the principal is in any/all of the roles
|
|
220
|
+
* @export
|
|
221
|
+
* @interface AuthenticateAndCheckIsInRoleResponse
|
|
222
|
+
*/
|
|
223
|
+
export interface AuthenticateAndCheckIsInRoleResponse {
|
|
224
|
+
/**
|
|
225
|
+
*
|
|
226
|
+
* @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
|
|
227
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
228
|
+
*/
|
|
229
|
+
'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
|
|
230
|
+
/**
|
|
231
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
232
|
+
* @type {boolean}
|
|
233
|
+
* @memberof AuthenticateAndCheckIsInRoleResponse
|
|
234
|
+
*/
|
|
235
|
+
'authorized': boolean;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
*
|
|
239
|
+
* @export
|
|
240
|
+
* @interface AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
179
241
|
*/
|
|
180
|
-
export interface
|
|
242
|
+
export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
|
|
181
243
|
/**
|
|
182
244
|
*
|
|
183
245
|
* @type {AuthorizationRequestPrincipal}
|
|
184
|
-
* @memberof
|
|
246
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
185
247
|
*/
|
|
186
248
|
'principal': AuthorizationRequestPrincipal;
|
|
187
249
|
/**
|
|
188
250
|
* Whether the user is authenticated
|
|
189
251
|
* @type {boolean}
|
|
190
|
-
* @memberof
|
|
252
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
191
253
|
*/
|
|
192
254
|
'authenticated': boolean;
|
|
193
255
|
/**
|
|
194
256
|
* The reason for the authentication failure
|
|
195
257
|
* @type {string}
|
|
196
|
-
* @memberof
|
|
258
|
+
* @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
|
|
197
259
|
*/
|
|
198
260
|
'reason'?: string;
|
|
199
261
|
}
|
|
200
262
|
/**
|
|
201
|
-
*
|
|
263
|
+
*
|
|
264
|
+
* @export
|
|
265
|
+
* @interface AuthorizationBatchRequest
|
|
266
|
+
*/
|
|
267
|
+
export interface AuthorizationBatchRequest {
|
|
268
|
+
/**
|
|
269
|
+
*
|
|
270
|
+
* @type {AuthorizationRequestPrincipal}
|
|
271
|
+
* @memberof AuthorizationBatchRequest
|
|
272
|
+
*/
|
|
273
|
+
'principal': AuthorizationRequestPrincipal;
|
|
274
|
+
/**
|
|
275
|
+
*
|
|
276
|
+
* @type {Permissions}
|
|
277
|
+
* @memberof AuthorizationBatchRequest
|
|
278
|
+
*/
|
|
279
|
+
'action': Permissions;
|
|
280
|
+
/**
|
|
281
|
+
* Array of resources to check authorisation for
|
|
282
|
+
* @type {Array<AuthorizationRequestResource>}
|
|
283
|
+
* @memberof AuthorizationBatchRequest
|
|
284
|
+
*/
|
|
285
|
+
'resources': Array<AuthorizationRequestResource>;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
*
|
|
289
|
+
* @export
|
|
290
|
+
* @interface AuthorizationBatchResponse
|
|
291
|
+
*/
|
|
292
|
+
export interface AuthorizationBatchResponse {
|
|
293
|
+
/**
|
|
294
|
+
* Array of allowed resources
|
|
295
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
296
|
+
* @memberof AuthorizationBatchResponse
|
|
297
|
+
*/
|
|
298
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
299
|
+
/**
|
|
300
|
+
* Array of denied resources
|
|
301
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
302
|
+
* @memberof AuthorizationBatchResponse
|
|
303
|
+
*/
|
|
304
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
*
|
|
308
|
+
* @export
|
|
309
|
+
* @interface AuthorizationBatchResponseAllowedResourcesInner
|
|
310
|
+
*/
|
|
311
|
+
export interface AuthorizationBatchResponseAllowedResourcesInner {
|
|
312
|
+
/**
|
|
313
|
+
* The authorization decision
|
|
314
|
+
* @type {string}
|
|
315
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
316
|
+
*/
|
|
317
|
+
'decision': string;
|
|
318
|
+
/**
|
|
319
|
+
* Whether the action is allowed
|
|
320
|
+
* @type {boolean}
|
|
321
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
322
|
+
*/
|
|
323
|
+
'allowed': boolean;
|
|
324
|
+
/**
|
|
325
|
+
* The policy IDs that were used to make the decision
|
|
326
|
+
* @type {Array<string>}
|
|
327
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
328
|
+
*/
|
|
329
|
+
'policyIds': Array<string>;
|
|
330
|
+
/**
|
|
331
|
+
*
|
|
332
|
+
* @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
|
|
333
|
+
* @memberof AuthorizationBatchResponseAllowedResourcesInner
|
|
334
|
+
*/
|
|
335
|
+
'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* @type AuthorizationBatchResponseAllowedResourcesInnerResource
|
|
339
|
+
*
|
|
340
|
+
* @export
|
|
341
|
+
*/
|
|
342
|
+
export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
|
|
343
|
+
/**
|
|
344
|
+
* 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).
|
|
202
345
|
* @export
|
|
203
346
|
* @interface AuthorizationRequest
|
|
204
347
|
*/
|
|
@@ -407,254 +550,52 @@ export interface ErrorResponse {
|
|
|
407
550
|
'message': string;
|
|
408
551
|
}
|
|
409
552
|
/**
|
|
410
|
-
*
|
|
553
|
+
* Feature based role and its permissions
|
|
411
554
|
* @export
|
|
412
|
-
* @interface
|
|
555
|
+
* @interface FeatureBasedRole
|
|
413
556
|
*/
|
|
414
|
-
export interface
|
|
557
|
+
export interface FeatureBasedRole {
|
|
558
|
+
/**
|
|
559
|
+
* Name of the role
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof FeatureBasedRole
|
|
562
|
+
*/
|
|
563
|
+
'name': string;
|
|
415
564
|
/**
|
|
416
565
|
*
|
|
417
566
|
* @type {Permissions & Array<string>}
|
|
418
|
-
* @memberof
|
|
567
|
+
* @memberof FeatureBasedRole
|
|
419
568
|
*/
|
|
420
569
|
'permissions': Permissions & Array<string>;
|
|
421
570
|
}
|
|
422
571
|
/**
|
|
423
|
-
*
|
|
572
|
+
* 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.
|
|
424
573
|
* @export
|
|
425
|
-
* @interface
|
|
574
|
+
* @interface GetAuthorizedBrandsRequest
|
|
426
575
|
*/
|
|
427
|
-
export interface
|
|
576
|
+
export interface GetAuthorizedBrandsRequest {
|
|
428
577
|
/**
|
|
429
578
|
*
|
|
430
|
-
* @type {
|
|
431
|
-
* @memberof
|
|
432
|
-
*/
|
|
433
|
-
'principal': AuthorizationRequestPrincipal;
|
|
434
|
-
/**
|
|
435
|
-
*
|
|
436
|
-
* @type {AuthorizationRequestResource}
|
|
437
|
-
* @memberof GetPrincipalRolesRequestBody
|
|
438
|
-
*/
|
|
439
|
-
'resource'?: AuthorizationRequestResource;
|
|
440
|
-
}
|
|
441
|
-
/**
|
|
442
|
-
* Successful roles retrieval response
|
|
443
|
-
* @export
|
|
444
|
-
* @interface GetPrincipalRolesSuccessResponse
|
|
445
|
-
*/
|
|
446
|
-
export interface GetPrincipalRolesSuccessResponse {
|
|
447
|
-
/**
|
|
448
|
-
* List of roles assigned to the principal
|
|
449
|
-
* @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
|
|
450
|
-
* @memberof GetPrincipalRolesSuccessResponse
|
|
451
|
-
*/
|
|
452
|
-
'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
|
|
453
|
-
}
|
|
454
|
-
/**
|
|
455
|
-
*
|
|
456
|
-
* @export
|
|
457
|
-
* @interface GetPrincipalRolesSuccessResponseRolesInner
|
|
458
|
-
*/
|
|
459
|
-
export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
460
|
-
/**
|
|
461
|
-
* Policy ID
|
|
462
|
-
* @type {string}
|
|
463
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
464
|
-
*/
|
|
465
|
-
'policyId': string;
|
|
466
|
-
/**
|
|
467
|
-
* Role name
|
|
468
|
-
* @type {string}
|
|
469
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
470
|
-
*/
|
|
471
|
-
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum;
|
|
472
|
-
/**
|
|
473
|
-
* Date and time the role was assigned
|
|
474
|
-
* @type {string}
|
|
475
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
476
|
-
*/
|
|
477
|
-
'assignedAt': string;
|
|
478
|
-
/**
|
|
479
|
-
* User who assigned the role
|
|
480
|
-
* @type {string}
|
|
481
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
482
|
-
*/
|
|
483
|
-
'assignedBy': string;
|
|
484
|
-
/**
|
|
485
|
-
* Type of resource the role is assigned to
|
|
486
|
-
* @type {string}
|
|
487
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
488
|
-
*/
|
|
489
|
-
'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
490
|
-
/**
|
|
491
|
-
* Organization ID
|
|
492
|
-
* @type {string}
|
|
493
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
494
|
-
*/
|
|
495
|
-
'orgId'?: string;
|
|
496
|
-
/**
|
|
497
|
-
* Property ID
|
|
498
|
-
* @type {string}
|
|
499
|
-
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
579
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
580
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
500
581
|
*/
|
|
501
|
-
'
|
|
582
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
502
583
|
/**
|
|
503
|
-
*
|
|
504
|
-
* @type {string}
|
|
505
|
-
* @memberof
|
|
584
|
+
* Incoming request headers to be used for authentication
|
|
585
|
+
* @type {{ [key: string]: string; }}
|
|
586
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
506
587
|
*/
|
|
507
|
-
'
|
|
588
|
+
'headers'?: {
|
|
589
|
+
[key: string]: string;
|
|
590
|
+
};
|
|
508
591
|
/**
|
|
509
|
-
*
|
|
592
|
+
* The action to check authorisation for
|
|
510
593
|
* @type {string}
|
|
511
|
-
* @memberof
|
|
594
|
+
* @memberof GetAuthorizedBrandsRequest
|
|
512
595
|
*/
|
|
513
|
-
'
|
|
596
|
+
'action': GetAuthorizedBrandsRequestActionEnum;
|
|
514
597
|
}
|
|
515
|
-
export declare const
|
|
516
|
-
readonly OrgViewer: "OrgViewer";
|
|
517
|
-
readonly OrgManager: "OrgManager";
|
|
518
|
-
readonly OrgAdmin: "OrgAdmin";
|
|
519
|
-
readonly BrandViewer: "BrandViewer";
|
|
520
|
-
readonly BrandManager: "BrandManager";
|
|
521
|
-
readonly BrandAdmin: "BrandAdmin";
|
|
522
|
-
readonly StoreViewer: "StoreViewer";
|
|
523
|
-
readonly StoreEditor: "StoreEditor";
|
|
524
|
-
readonly StoreManager: "StoreManager";
|
|
525
|
-
readonly CustomerViewer: "CustomerViewer";
|
|
526
|
-
readonly CustomerManager: "CustomerManager";
|
|
527
|
-
readonly VoucherViewer: "VoucherViewer";
|
|
528
|
-
readonly VoucherEditor: "VoucherEditor";
|
|
529
|
-
readonly VoucherManager: "VoucherManager";
|
|
530
|
-
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
531
|
-
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
532
|
-
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
533
|
-
readonly ReportsViewer: "ReportsViewer";
|
|
534
|
-
readonly FinanceViewer: "FinanceViewer";
|
|
535
|
-
readonly FinanceManager: "FinanceManager";
|
|
536
|
-
readonly TeamViewer: "TeamViewer";
|
|
537
|
-
readonly TeamManager: "TeamManager";
|
|
538
|
-
readonly TeamAdmin: "TeamAdmin";
|
|
539
|
-
readonly TechViewer: "TechViewer";
|
|
540
|
-
readonly TechManager: "TechManager";
|
|
541
|
-
readonly AppStoreViewer: "AppStoreViewer";
|
|
542
|
-
readonly AppStoreManager: "AppStoreManager";
|
|
543
|
-
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
544
|
-
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
545
|
-
readonly SalesChannelManager: "SalesChannelManager";
|
|
546
|
-
readonly DeliveryViewer: "DeliveryViewer";
|
|
547
|
-
readonly DeliveryManager: "DeliveryManager";
|
|
548
|
-
readonly DriverManager: "DriverManager";
|
|
549
|
-
readonly AuditViewer: "AuditViewer";
|
|
550
|
-
readonly AuditManager: "AuditManager";
|
|
551
|
-
readonly AccountsViewer: "AccountsViewer";
|
|
552
|
-
readonly AccountsEditor: "AccountsEditor";
|
|
553
|
-
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
554
|
-
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
555
|
-
readonly PayrollViewer: "PayrollViewer";
|
|
556
|
-
readonly PayrollEditor: "PayrollEditor";
|
|
557
|
-
readonly PropertyViewer: "PropertyViewer";
|
|
558
|
-
readonly PropertyManager: "PropertyManager";
|
|
559
|
-
readonly PropertyAdmin: "PropertyAdmin";
|
|
560
|
-
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
561
|
-
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
562
|
-
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
563
|
-
readonly MenuViewer: "MenuViewer";
|
|
564
|
-
readonly MenuEditor: "MenuEditor";
|
|
565
|
-
readonly MenuManager: "MenuManager";
|
|
566
|
-
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
567
|
-
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
568
|
-
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
569
|
-
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
570
|
-
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
571
|
-
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
572
|
-
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
573
|
-
readonly OrderManager: "OrderManager";
|
|
574
|
-
readonly OrderEditor: "OrderEditor";
|
|
575
|
-
readonly OrderViewer: "OrderViewer";
|
|
576
|
-
readonly InventoryManager: "InventoryManager";
|
|
577
|
-
readonly InventoryEditor: "InventoryEditor";
|
|
578
|
-
readonly InventoryViewer: "InventoryViewer";
|
|
579
|
-
readonly PaymentManager: "PaymentManager";
|
|
580
|
-
readonly OnboardingManager: "OnboardingManager";
|
|
581
|
-
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
582
|
-
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
583
|
-
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
584
|
-
readonly IntegratorMisc: "IntegratorMisc";
|
|
585
|
-
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
586
|
-
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
587
|
-
readonly SupportMisc: "SupportMisc";
|
|
588
|
-
};
|
|
589
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum];
|
|
590
|
-
export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
|
|
591
|
-
readonly Property: "Property";
|
|
592
|
-
readonly Org: "Org";
|
|
593
|
-
readonly Brand: "Brand";
|
|
594
|
-
readonly SalesChannel: "SalesChannel";
|
|
595
|
-
};
|
|
596
|
-
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
597
|
-
/**
|
|
598
|
-
* Successful roles retrieval response
|
|
599
|
-
* @export
|
|
600
|
-
* @interface GetRolesSuccessResponse
|
|
601
|
-
*/
|
|
602
|
-
export interface GetRolesSuccessResponse {
|
|
603
|
-
/**
|
|
604
|
-
* List of roles available and their permissions
|
|
605
|
-
* @type {Array<RolesInner>}
|
|
606
|
-
* @memberof GetRolesSuccessResponse
|
|
607
|
-
*/
|
|
608
|
-
'roles': Array<RolesInner>;
|
|
609
|
-
}
|
|
610
|
-
/**
|
|
611
|
-
* Successful user permissions retrieval response
|
|
612
|
-
* @export
|
|
613
|
-
* @interface GetUserPermissionsSuccessResponse
|
|
614
|
-
*/
|
|
615
|
-
export interface GetUserPermissionsSuccessResponse {
|
|
616
|
-
/**
|
|
617
|
-
* Map of resource IDs to permissions
|
|
618
|
-
* @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
|
|
619
|
-
* @memberof GetUserPermissionsSuccessResponse
|
|
620
|
-
*/
|
|
621
|
-
'resources': {
|
|
622
|
-
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
623
|
-
};
|
|
624
|
-
}
|
|
625
|
-
/**
|
|
626
|
-
*
|
|
627
|
-
* @export
|
|
628
|
-
* @interface GetUserPermissionsSuccessResponseResourcesValue
|
|
629
|
-
*/
|
|
630
|
-
export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
631
|
-
/**
|
|
632
|
-
* Type of resource the permissions are assigned to
|
|
633
|
-
* @type {string}
|
|
634
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
635
|
-
*/
|
|
636
|
-
'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
|
|
637
|
-
/**
|
|
638
|
-
*
|
|
639
|
-
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
640
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
641
|
-
*/
|
|
642
|
-
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
643
|
-
/**
|
|
644
|
-
* List of permissions that are assigned to the user for the resource
|
|
645
|
-
* @type {Array<string>}
|
|
646
|
-
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
647
|
-
*/
|
|
648
|
-
'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
|
|
649
|
-
}
|
|
650
|
-
export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
|
|
651
|
-
readonly Property: "Property";
|
|
652
|
-
readonly Org: "Org";
|
|
653
|
-
readonly Brand: "Brand";
|
|
654
|
-
readonly SalesChannel: "SalesChannel";
|
|
655
|
-
};
|
|
656
|
-
export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
|
|
657
|
-
export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum: {
|
|
598
|
+
export declare const GetAuthorizedBrandsRequestActionEnum: {
|
|
658
599
|
readonly AnyAuditLogs: "AnyAuditLogs";
|
|
659
600
|
readonly ViewApp: "ViewApp";
|
|
660
601
|
readonly CreateApp: "CreateApp";
|
|
@@ -879,53 +820,59 @@ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsE
|
|
|
879
820
|
readonly CreateOrg: "CreateOrg";
|
|
880
821
|
readonly EditOrg: "EditOrg";
|
|
881
822
|
readonly ViewOrg: "ViewOrg";
|
|
823
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
824
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
825
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
826
|
+
readonly RoleFactory: "RoleFactory";
|
|
882
827
|
};
|
|
883
|
-
export type
|
|
884
|
-
/**
|
|
885
|
-
* ID of the resource the permissions are assigned to
|
|
886
|
-
* @export
|
|
887
|
-
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
888
|
-
*/
|
|
889
|
-
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
890
|
-
}
|
|
828
|
+
export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
|
|
891
829
|
/**
|
|
892
|
-
*
|
|
830
|
+
* Response containing the authorized brands
|
|
893
831
|
* @export
|
|
894
|
-
* @interface
|
|
832
|
+
* @interface GetAuthorizedBrandsResponse
|
|
895
833
|
*/
|
|
896
|
-
export interface
|
|
834
|
+
export interface GetAuthorizedBrandsResponse {
|
|
897
835
|
/**
|
|
898
|
-
*
|
|
899
|
-
* @type {
|
|
900
|
-
* @memberof
|
|
836
|
+
* Array of allowed resources
|
|
837
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
838
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
839
|
+
*/
|
|
840
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
841
|
+
/**
|
|
842
|
+
* Array of denied resources
|
|
843
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
844
|
+
* @memberof GetAuthorizedBrandsResponse
|
|
901
845
|
*/
|
|
902
|
-
'
|
|
846
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
903
847
|
}
|
|
904
848
|
/**
|
|
905
|
-
*
|
|
849
|
+
* 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.
|
|
906
850
|
* @export
|
|
907
|
-
* @interface
|
|
851
|
+
* @interface GetAuthorizedOrgsRequest
|
|
908
852
|
*/
|
|
909
|
-
export interface
|
|
853
|
+
export interface GetAuthorizedOrgsRequest {
|
|
910
854
|
/**
|
|
911
855
|
*
|
|
912
|
-
* @type {
|
|
913
|
-
* @memberof
|
|
856
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
857
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
914
858
|
*/
|
|
915
|
-
'
|
|
859
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
916
860
|
/**
|
|
917
|
-
*
|
|
861
|
+
* Incoming request headers to be used for authentication
|
|
862
|
+
* @type {{ [key: string]: string; }}
|
|
863
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
864
|
+
*/
|
|
865
|
+
'headers'?: {
|
|
866
|
+
[key: string]: string;
|
|
867
|
+
};
|
|
868
|
+
/**
|
|
869
|
+
* The action to check authorisation for
|
|
918
870
|
* @type {string}
|
|
919
|
-
* @memberof
|
|
871
|
+
* @memberof GetAuthorizedOrgsRequest
|
|
920
872
|
*/
|
|
921
|
-
'
|
|
873
|
+
'action': GetAuthorizedOrgsRequestActionEnum;
|
|
922
874
|
}
|
|
923
|
-
|
|
924
|
-
*
|
|
925
|
-
* @export
|
|
926
|
-
* @enum {string}
|
|
927
|
-
*/
|
|
928
|
-
export declare const Permissions: {
|
|
875
|
+
export declare const GetAuthorizedOrgsRequestActionEnum: {
|
|
929
876
|
readonly AnyAuditLogs: "AnyAuditLogs";
|
|
930
877
|
readonly ViewApp: "ViewApp";
|
|
931
878
|
readonly CreateApp: "CreateApp";
|
|
@@ -1150,227 +1097,1408 @@ export declare const Permissions: {
|
|
|
1150
1097
|
readonly CreateOrg: "CreateOrg";
|
|
1151
1098
|
readonly EditOrg: "EditOrg";
|
|
1152
1099
|
readonly ViewOrg: "ViewOrg";
|
|
1100
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
1101
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
1102
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
1103
|
+
readonly RoleFactory: "RoleFactory";
|
|
1153
1104
|
};
|
|
1154
|
-
export type
|
|
1105
|
+
export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
|
|
1155
1106
|
/**
|
|
1156
|
-
*
|
|
1107
|
+
* The principal to get authorized entities for
|
|
1157
1108
|
* @export
|
|
1158
|
-
* @interface
|
|
1109
|
+
* @interface GetAuthorizedOrgsRequestPrincipal
|
|
1159
1110
|
*/
|
|
1160
|
-
export interface
|
|
1111
|
+
export interface GetAuthorizedOrgsRequestPrincipal {
|
|
1161
1112
|
/**
|
|
1162
1113
|
*
|
|
1163
|
-
* @type {AuthorizationRequestPrincipal}
|
|
1164
|
-
* @memberof RevokeForbiddenRoleRequestBody
|
|
1165
|
-
*/
|
|
1166
|
-
'principal': AuthorizationRequestPrincipal;
|
|
1167
|
-
/**
|
|
1168
|
-
* Compensation role to revoke the forbidden role from
|
|
1169
1114
|
* @type {string}
|
|
1170
|
-
* @memberof
|
|
1115
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1171
1116
|
*/
|
|
1172
|
-
'
|
|
1173
|
-
}
|
|
1174
|
-
export declare const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum: {
|
|
1175
|
-
readonly OwnerCompensating: "OwnerCompensating";
|
|
1176
|
-
readonly PropertyOwnerCompensating: "PropertyOwnerCompensating";
|
|
1177
|
-
readonly ManagedOwnerCompensating: "ManagedOwnerCompensating";
|
|
1178
|
-
readonly IntegratorCompensating: "IntegratorCompensating";
|
|
1179
|
-
readonly PropertyManagerCompensating: "PropertyManagerCompensating";
|
|
1180
|
-
readonly FinanceManagerCompensating: "FinanceManagerCompensating";
|
|
1181
|
-
};
|
|
1182
|
-
export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
|
|
1183
|
-
/**
|
|
1184
|
-
* Details for revoking a role from a principal
|
|
1185
|
-
* @export
|
|
1186
|
-
* @interface RevokeRoleRequestBody
|
|
1187
|
-
*/
|
|
1188
|
-
export interface RevokeRoleRequestBody {
|
|
1117
|
+
'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
|
|
1189
1118
|
/**
|
|
1190
|
-
*
|
|
1119
|
+
*
|
|
1191
1120
|
* @type {string}
|
|
1192
|
-
* @memberof
|
|
1121
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1193
1122
|
*/
|
|
1194
|
-
'
|
|
1123
|
+
'id': string;
|
|
1195
1124
|
/**
|
|
1196
1125
|
*
|
|
1197
|
-
* @type {
|
|
1198
|
-
* @memberof
|
|
1126
|
+
* @type {string}
|
|
1127
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1199
1128
|
*/
|
|
1200
|
-
'
|
|
1129
|
+
'name'?: string;
|
|
1201
1130
|
/**
|
|
1202
1131
|
*
|
|
1203
|
-
* @type {
|
|
1204
|
-
* @memberof
|
|
1132
|
+
* @type {string}
|
|
1133
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1205
1134
|
*/
|
|
1206
|
-
'
|
|
1135
|
+
'email'?: string;
|
|
1207
1136
|
/**
|
|
1208
1137
|
*
|
|
1209
1138
|
* @type {string}
|
|
1210
|
-
* @memberof
|
|
1139
|
+
* @memberof GetAuthorizedOrgsRequestPrincipal
|
|
1211
1140
|
*/
|
|
1212
|
-
'
|
|
1141
|
+
'phone'?: string;
|
|
1213
1142
|
}
|
|
1214
|
-
export declare const
|
|
1215
|
-
readonly
|
|
1216
|
-
readonly
|
|
1217
|
-
readonly OrgAdmin: "OrgAdmin";
|
|
1218
|
-
readonly BrandViewer: "BrandViewer";
|
|
1219
|
-
readonly BrandManager: "BrandManager";
|
|
1220
|
-
readonly BrandAdmin: "BrandAdmin";
|
|
1221
|
-
readonly StoreViewer: "StoreViewer";
|
|
1222
|
-
readonly StoreEditor: "StoreEditor";
|
|
1223
|
-
readonly StoreManager: "StoreManager";
|
|
1224
|
-
readonly CustomerViewer: "CustomerViewer";
|
|
1225
|
-
readonly CustomerManager: "CustomerManager";
|
|
1226
|
-
readonly VoucherViewer: "VoucherViewer";
|
|
1227
|
-
readonly VoucherEditor: "VoucherEditor";
|
|
1228
|
-
readonly VoucherManager: "VoucherManager";
|
|
1229
|
-
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
1230
|
-
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
1231
|
-
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
1232
|
-
readonly ReportsViewer: "ReportsViewer";
|
|
1233
|
-
readonly FinanceViewer: "FinanceViewer";
|
|
1234
|
-
readonly FinanceManager: "FinanceManager";
|
|
1235
|
-
readonly TeamViewer: "TeamViewer";
|
|
1236
|
-
readonly TeamManager: "TeamManager";
|
|
1237
|
-
readonly TeamAdmin: "TeamAdmin";
|
|
1238
|
-
readonly TechViewer: "TechViewer";
|
|
1239
|
-
readonly TechManager: "TechManager";
|
|
1240
|
-
readonly AppStoreViewer: "AppStoreViewer";
|
|
1241
|
-
readonly AppStoreManager: "AppStoreManager";
|
|
1242
|
-
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
1243
|
-
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
1244
|
-
readonly SalesChannelManager: "SalesChannelManager";
|
|
1245
|
-
readonly DeliveryViewer: "DeliveryViewer";
|
|
1246
|
-
readonly DeliveryManager: "DeliveryManager";
|
|
1247
|
-
readonly DriverManager: "DriverManager";
|
|
1248
|
-
readonly AuditViewer: "AuditViewer";
|
|
1249
|
-
readonly AuditManager: "AuditManager";
|
|
1250
|
-
readonly AccountsViewer: "AccountsViewer";
|
|
1251
|
-
readonly AccountsEditor: "AccountsEditor";
|
|
1252
|
-
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
1253
|
-
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
1254
|
-
readonly PayrollViewer: "PayrollViewer";
|
|
1255
|
-
readonly PayrollEditor: "PayrollEditor";
|
|
1256
|
-
readonly PropertyViewer: "PropertyViewer";
|
|
1257
|
-
readonly PropertyManager: "PropertyManager";
|
|
1258
|
-
readonly PropertyAdmin: "PropertyAdmin";
|
|
1259
|
-
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
1260
|
-
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
1261
|
-
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
1262
|
-
readonly MenuViewer: "MenuViewer";
|
|
1263
|
-
readonly MenuEditor: "MenuEditor";
|
|
1264
|
-
readonly MenuManager: "MenuManager";
|
|
1265
|
-
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
1266
|
-
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
1267
|
-
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
1268
|
-
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
1269
|
-
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
1270
|
-
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
1271
|
-
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
1272
|
-
readonly OrderManager: "OrderManager";
|
|
1273
|
-
readonly OrderEditor: "OrderEditor";
|
|
1274
|
-
readonly OrderViewer: "OrderViewer";
|
|
1275
|
-
readonly InventoryManager: "InventoryManager";
|
|
1276
|
-
readonly InventoryEditor: "InventoryEditor";
|
|
1277
|
-
readonly InventoryViewer: "InventoryViewer";
|
|
1278
|
-
readonly PaymentManager: "PaymentManager";
|
|
1279
|
-
readonly OnboardingManager: "OnboardingManager";
|
|
1280
|
-
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
1281
|
-
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
1282
|
-
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
1283
|
-
readonly IntegratorMisc: "IntegratorMisc";
|
|
1284
|
-
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
1285
|
-
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
1286
|
-
readonly SupportMisc: "SupportMisc";
|
|
1143
|
+
export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: {
|
|
1144
|
+
readonly User: "User";
|
|
1145
|
+
readonly Automation: "Automation";
|
|
1287
1146
|
};
|
|
1288
|
-
export type
|
|
1289
|
-
/**
|
|
1290
|
-
* Successful role revocation response
|
|
1291
|
-
* @export
|
|
1292
|
-
* @interface RevokeRoleSuccessResponse
|
|
1293
|
-
*/
|
|
1294
|
-
export interface RevokeRoleSuccessResponse {
|
|
1295
|
-
/**
|
|
1296
|
-
* Confirmation message
|
|
1297
|
-
* @type {string}
|
|
1298
|
-
* @memberof RevokeRoleSuccessResponse
|
|
1299
|
-
*/
|
|
1300
|
-
'message': string;
|
|
1301
|
-
}
|
|
1147
|
+
export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
|
|
1302
1148
|
/**
|
|
1303
|
-
*
|
|
1149
|
+
* Response containing the authorized orgs
|
|
1304
1150
|
* @export
|
|
1305
|
-
* @interface
|
|
1151
|
+
* @interface GetAuthorizedOrgsResponse
|
|
1306
1152
|
*/
|
|
1307
|
-
export interface
|
|
1153
|
+
export interface GetAuthorizedOrgsResponse {
|
|
1308
1154
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
* @type {
|
|
1311
|
-
* @memberof
|
|
1155
|
+
* Array of allowed resources
|
|
1156
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1157
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1312
1158
|
*/
|
|
1313
|
-
'
|
|
1159
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1314
1160
|
/**
|
|
1315
|
-
*
|
|
1316
|
-
* @type {
|
|
1317
|
-
* @memberof
|
|
1161
|
+
* Array of denied resources
|
|
1162
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1163
|
+
* @memberof GetAuthorizedOrgsResponse
|
|
1318
1164
|
*/
|
|
1319
|
-
'
|
|
1165
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1320
1166
|
}
|
|
1321
1167
|
/**
|
|
1322
|
-
*
|
|
1168
|
+
* 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.
|
|
1323
1169
|
* @export
|
|
1324
|
-
* @interface
|
|
1170
|
+
* @interface GetAuthorizedPropertiesRequest
|
|
1325
1171
|
*/
|
|
1326
|
-
export interface
|
|
1172
|
+
export interface GetAuthorizedPropertiesRequest {
|
|
1327
1173
|
/**
|
|
1328
1174
|
*
|
|
1329
|
-
* @type {
|
|
1330
|
-
* @memberof
|
|
1175
|
+
* @type {GetAuthorizedOrgsRequestPrincipal}
|
|
1176
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1331
1177
|
*/
|
|
1332
|
-
'
|
|
1178
|
+
'principal'?: GetAuthorizedOrgsRequestPrincipal;
|
|
1333
1179
|
/**
|
|
1334
|
-
*
|
|
1335
|
-
* @type {string}
|
|
1336
|
-
* @memberof
|
|
1180
|
+
* Incoming request headers to be used for authentication
|
|
1181
|
+
* @type {{ [key: string]: string; }}
|
|
1182
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1337
1183
|
*/
|
|
1338
|
-
'
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
*
|
|
1342
|
-
* @export
|
|
1343
|
-
* @interface ValidationErrorsInnerPathInner
|
|
1344
|
-
*/
|
|
1345
|
-
export interface ValidationErrorsInnerPathInner {
|
|
1346
|
-
}
|
|
1347
|
-
/**
|
|
1348
|
-
* AuthenticationApi - axios parameter creator
|
|
1349
|
-
* @export
|
|
1350
|
-
*/
|
|
1351
|
-
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1184
|
+
'headers'?: {
|
|
1185
|
+
[key: string]: string;
|
|
1186
|
+
};
|
|
1352
1187
|
/**
|
|
1353
|
-
*
|
|
1354
|
-
* @
|
|
1355
|
-
* @
|
|
1356
|
-
* @param {*} [options] Override http request option.
|
|
1357
|
-
* @throws {RequiredError}
|
|
1188
|
+
* The action to check authorisation for
|
|
1189
|
+
* @type {string}
|
|
1190
|
+
* @memberof GetAuthorizedPropertiesRequest
|
|
1358
1191
|
*/
|
|
1359
|
-
|
|
1360
|
-
}
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1192
|
+
'action': GetAuthorizedPropertiesRequestActionEnum;
|
|
1193
|
+
}
|
|
1194
|
+
export declare const GetAuthorizedPropertiesRequestActionEnum: {
|
|
1195
|
+
readonly AnyAuditLogs: "AnyAuditLogs";
|
|
1196
|
+
readonly ViewApp: "ViewApp";
|
|
1197
|
+
readonly CreateApp: "CreateApp";
|
|
1198
|
+
readonly UpdateApp: "UpdateApp";
|
|
1199
|
+
readonly ViewAppName: "ViewAppName";
|
|
1200
|
+
readonly EditAppAssets: "EditAppAssets";
|
|
1201
|
+
readonly EditAppFeatures: "EditAppFeatures";
|
|
1202
|
+
readonly ViewTeammates: "ViewTeammates";
|
|
1203
|
+
readonly EditTeammates: "EditTeammates";
|
|
1204
|
+
readonly CreateTeammateOwner: "CreateTeammateOwner";
|
|
1205
|
+
readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
|
|
1206
|
+
readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
|
|
1207
|
+
readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
|
|
1208
|
+
readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
|
|
1209
|
+
readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
|
|
1210
|
+
readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
|
|
1211
|
+
readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
|
|
1212
|
+
readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
|
|
1213
|
+
readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
|
|
1214
|
+
readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
|
|
1215
|
+
readonly ViewApmConfigurations: "ViewApmConfigurations";
|
|
1216
|
+
readonly EditApmConfigurations: "EditApmConfigurations";
|
|
1217
|
+
readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
|
|
1218
|
+
readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
|
|
1219
|
+
readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
|
|
1220
|
+
readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
|
|
1221
|
+
readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
|
|
1222
|
+
readonly ViewDevelopersSettings: "ViewDevelopersSettings";
|
|
1223
|
+
readonly EditDevelopersSettings: "EditDevelopersSettings";
|
|
1224
|
+
readonly ViewOrders: "ViewOrders";
|
|
1225
|
+
readonly UpdateOrdersAccept: "UpdateOrdersAccept";
|
|
1226
|
+
readonly UpdateOrdersReject: "UpdateOrdersReject";
|
|
1227
|
+
readonly UpdateOrdersRefund: "UpdateOrdersRefund";
|
|
1228
|
+
readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
|
|
1229
|
+
readonly ViewStores: "ViewStores";
|
|
1230
|
+
readonly CreateStores: "CreateStores";
|
|
1231
|
+
readonly EditStores: "EditStores";
|
|
1232
|
+
readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
|
|
1233
|
+
readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
|
|
1234
|
+
readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
|
|
1235
|
+
readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
|
|
1236
|
+
readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
|
|
1237
|
+
readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
|
|
1238
|
+
readonly UpdateStoresName: "UpdateStoresName";
|
|
1239
|
+
readonly EditStoreKioskSettings: "EditStoreKioskSettings";
|
|
1240
|
+
readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
|
|
1241
|
+
readonly EditStoreNotifications: "EditStoreNotifications";
|
|
1242
|
+
readonly ArchiveStores: "ArchiveStores";
|
|
1243
|
+
readonly PublishStores: "PublishStores";
|
|
1244
|
+
readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
|
|
1245
|
+
readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
|
|
1246
|
+
readonly ViewStoreGroups: "ViewStoreGroups";
|
|
1247
|
+
readonly CreateStoreGroups: "CreateStoreGroups";
|
|
1248
|
+
readonly UpdateStoreGroups: "UpdateStoreGroups";
|
|
1249
|
+
readonly DeleteStoreGroups: "DeleteStoreGroups";
|
|
1250
|
+
readonly ViewDeliveryZones: "ViewDeliveryZones";
|
|
1251
|
+
readonly CreateDeliveryZones: "CreateDeliveryZones";
|
|
1252
|
+
readonly UpdateDeliveryZones: "UpdateDeliveryZones";
|
|
1253
|
+
readonly DeleteDeliveryZones: "DeleteDeliveryZones";
|
|
1254
|
+
readonly ViewMenu: "ViewMenu";
|
|
1255
|
+
readonly CreateMenu: "CreateMenu";
|
|
1256
|
+
readonly UpdateMenu: "UpdateMenu";
|
|
1257
|
+
readonly DeleteMenu: "DeleteMenu";
|
|
1258
|
+
readonly UpdateMenuLock: "UpdateMenuLock";
|
|
1259
|
+
readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
|
|
1260
|
+
readonly EditMenuImage: "EditMenuImage";
|
|
1261
|
+
readonly ViewVouchers: "ViewVouchers";
|
|
1262
|
+
readonly EditVouchers: "EditVouchers";
|
|
1263
|
+
readonly ViewWebsiteContent: "ViewWebsiteContent";
|
|
1264
|
+
readonly EditWebsiteContent: "EditWebsiteContent";
|
|
1265
|
+
readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
|
|
1266
|
+
readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
|
|
1267
|
+
readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
|
|
1268
|
+
readonly ViewBankAccounts: "ViewBankAccounts";
|
|
1269
|
+
readonly CreateBankAccounts: "CreateBankAccounts";
|
|
1270
|
+
readonly UpdateBankAccounts: "UpdateBankAccounts";
|
|
1271
|
+
readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
|
|
1272
|
+
readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
|
|
1273
|
+
readonly VerifyBankAccounts: "VerifyBankAccounts";
|
|
1274
|
+
readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
|
|
1275
|
+
readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
|
|
1276
|
+
readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
|
|
1277
|
+
readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
|
|
1278
|
+
readonly ViewHydraConfig: "ViewHydraConfig";
|
|
1279
|
+
readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
|
|
1280
|
+
readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
|
|
1281
|
+
readonly DeleteTerminal: "DeleteTerminal";
|
|
1282
|
+
readonly ViewKioskTelemetry: "ViewKioskTelemetry";
|
|
1283
|
+
readonly ViewCustomers: "ViewCustomers";
|
|
1284
|
+
readonly EditCustomers: "EditCustomers";
|
|
1285
|
+
readonly CreateCustomers: "CreateCustomers";
|
|
1286
|
+
readonly CreateCatalogElements: "CreateCatalogElements";
|
|
1287
|
+
readonly UpdateCatalogElements: "UpdateCatalogElements";
|
|
1288
|
+
readonly ViewCatalogElements: "ViewCatalogElements";
|
|
1289
|
+
readonly DeleteCatalogElements: "DeleteCatalogElements";
|
|
1290
|
+
readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
|
|
1291
|
+
readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
|
|
1292
|
+
readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
|
|
1293
|
+
readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
|
|
1294
|
+
readonly UpdateMetafields: "UpdateMetafields";
|
|
1295
|
+
readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
|
|
1296
|
+
readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
|
|
1297
|
+
readonly ViewAppStatistics: "ViewAppStatistics";
|
|
1298
|
+
readonly ViewApmStatistics: "ViewApmStatistics";
|
|
1299
|
+
readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
|
|
1300
|
+
readonly ViewCustomerStatistics: "ViewCustomerStatistics";
|
|
1301
|
+
readonly ViewLiveStatistics: "ViewLiveStatistics";
|
|
1302
|
+
readonly ViewOrderStatistics: "ViewOrderStatistics";
|
|
1303
|
+
readonly ViewSalesStatistics: "ViewSalesStatistics";
|
|
1304
|
+
readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
|
|
1305
|
+
readonly ViewVouchersStatistics: "ViewVouchersStatistics";
|
|
1306
|
+
readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
|
|
1307
|
+
readonly ViewApmAuditLogs: "ViewApmAuditLogs";
|
|
1308
|
+
readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
|
|
1309
|
+
readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
|
|
1310
|
+
readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
|
|
1311
|
+
readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
|
|
1312
|
+
readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
|
|
1313
|
+
readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
|
|
1314
|
+
readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
|
|
1315
|
+
readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
|
|
1316
|
+
readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
|
|
1317
|
+
readonly ViewAppAuditLogs: "ViewAppAuditLogs";
|
|
1318
|
+
readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
|
|
1319
|
+
readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
|
|
1320
|
+
readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
|
|
1321
|
+
readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
|
|
1322
|
+
readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
|
|
1323
|
+
readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
|
|
1324
|
+
readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
|
|
1325
|
+
readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
|
|
1326
|
+
readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
|
|
1327
|
+
readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
|
|
1328
|
+
readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
|
|
1329
|
+
readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
|
|
1330
|
+
readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
|
|
1331
|
+
readonly InviteDriverToApp: "InviteDriverToApp";
|
|
1332
|
+
readonly GetDriverForApp: "GetDriverForApp";
|
|
1333
|
+
readonly RemoveDriverFromApp: "RemoveDriverFromApp";
|
|
1334
|
+
readonly AssignDriverToOrder: "AssignDriverToOrder";
|
|
1335
|
+
readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
|
|
1336
|
+
readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
|
|
1337
|
+
readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
|
|
1338
|
+
readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
|
|
1339
|
+
readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
|
|
1340
|
+
readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
|
|
1341
|
+
readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
|
|
1342
|
+
readonly ViewPayouts: "ViewPayouts";
|
|
1343
|
+
readonly ViewChannels: "ViewChannels";
|
|
1344
|
+
readonly ViewOnboarding: "ViewOnboarding";
|
|
1345
|
+
readonly UpdateOnboarding: "UpdateOnboarding";
|
|
1346
|
+
readonly ViewClientDevices: "ViewClientDevices";
|
|
1347
|
+
readonly UpdateClientDevices: "UpdateClientDevices";
|
|
1348
|
+
readonly EnrollClientDevices: "EnrollClientDevices";
|
|
1349
|
+
readonly AssignClientDevices: "AssignClientDevices";
|
|
1350
|
+
readonly ViewClientAuditLogs: "ViewClientAuditLogs";
|
|
1351
|
+
readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
|
|
1352
|
+
readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
|
|
1353
|
+
readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
|
|
1354
|
+
readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
|
|
1355
|
+
readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
|
|
1356
|
+
readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
|
|
1357
|
+
readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
|
|
1358
|
+
readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
|
|
1359
|
+
readonly ViewSalesChannels: "ViewSalesChannels";
|
|
1360
|
+
readonly EditSalesChannels: "EditSalesChannels";
|
|
1361
|
+
readonly CreateSalesChannel: "CreateSalesChannel";
|
|
1362
|
+
readonly ArchiveSalesChannel: "ArchiveSalesChannel";
|
|
1363
|
+
readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
|
|
1364
|
+
readonly PublishSalesChannel: "PublishSalesChannel";
|
|
1365
|
+
readonly UnpublishSalesChannel: "UnpublishSalesChannel";
|
|
1366
|
+
readonly CloneSalesChannel: "CloneSalesChannel";
|
|
1367
|
+
readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
|
|
1368
|
+
readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
|
|
1369
|
+
readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
|
|
1370
|
+
readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
|
|
1371
|
+
readonly ViewSubscriptions: "ViewSubscriptions";
|
|
1372
|
+
readonly ViewInvoices: "ViewInvoices";
|
|
1373
|
+
readonly EditAccountsBills: "EditAccountsBills";
|
|
1374
|
+
readonly ViewAccountsBills: "ViewAccountsBills";
|
|
1375
|
+
readonly EditAccountsCategories: "EditAccountsCategories";
|
|
1376
|
+
readonly ViewAccountsCategories: "ViewAccountsCategories";
|
|
1377
|
+
readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
|
|
1378
|
+
readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
|
|
1379
|
+
readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
|
|
1380
|
+
readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
|
|
1381
|
+
readonly EditAccountsExpenses: "EditAccountsExpenses";
|
|
1382
|
+
readonly ViewAccountsExpenses: "ViewAccountsExpenses";
|
|
1383
|
+
readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
|
|
1384
|
+
readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
|
|
1385
|
+
readonly EditDocumentExplorer: "EditDocumentExplorer";
|
|
1386
|
+
readonly ViewDocumentExplorer: "ViewDocumentExplorer";
|
|
1387
|
+
readonly ViewInventoryReports: "ViewInventoryReports";
|
|
1388
|
+
readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
|
|
1389
|
+
readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
|
|
1390
|
+
readonly EditInventoryStockItems: "EditInventoryStockItems";
|
|
1391
|
+
readonly ViewInventoryStockItems: "ViewInventoryStockItems";
|
|
1392
|
+
readonly EditInventorySupplier: "EditInventorySupplier";
|
|
1393
|
+
readonly ViewInventorySupplier: "ViewInventorySupplier";
|
|
1394
|
+
readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
|
|
1395
|
+
readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
|
|
1396
|
+
readonly ViewPayrollReports: "ViewPayrollReports";
|
|
1397
|
+
readonly EditPayrollHoliday: "EditPayrollHoliday";
|
|
1398
|
+
readonly ViewPayrollHoliday: "ViewPayrollHoliday";
|
|
1399
|
+
readonly EditPayrollRota: "EditPayrollRota";
|
|
1400
|
+
readonly ViewPayrollRota: "ViewPayrollRota";
|
|
1401
|
+
readonly EditPayrollStaff: "EditPayrollStaff";
|
|
1402
|
+
readonly ViewPayrollStaff: "ViewPayrollStaff";
|
|
1403
|
+
readonly ViewSalesReports: "ViewSalesReports";
|
|
1404
|
+
readonly ViewCostReports: "ViewCostReports";
|
|
1405
|
+
readonly ViewMenuReports: "ViewMenuReports";
|
|
1406
|
+
readonly ViewBrand: "ViewBrand";
|
|
1407
|
+
readonly EditBrand: "EditBrand";
|
|
1408
|
+
readonly CreateBrand: "CreateBrand";
|
|
1409
|
+
readonly TransferBrand: "TransferBrand";
|
|
1410
|
+
readonly ViewProperty: "ViewProperty";
|
|
1411
|
+
readonly EditProperty: "EditProperty";
|
|
1412
|
+
readonly CreateProperty: "CreateProperty";
|
|
1413
|
+
readonly ArchiveProperty: "ArchiveProperty";
|
|
1414
|
+
readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
|
|
1415
|
+
readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
|
|
1416
|
+
readonly CreateOrg: "CreateOrg";
|
|
1417
|
+
readonly EditOrg: "EditOrg";
|
|
1418
|
+
readonly ViewOrg: "ViewOrg";
|
|
1419
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
1420
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
1421
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
1422
|
+
readonly RoleFactory: "RoleFactory";
|
|
1423
|
+
};
|
|
1424
|
+
export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
|
|
1425
|
+
/**
|
|
1426
|
+
* Response containing the authorized properties
|
|
1427
|
+
* @export
|
|
1428
|
+
* @interface GetAuthorizedPropertiesResponse
|
|
1429
|
+
*/
|
|
1430
|
+
export interface GetAuthorizedPropertiesResponse {
|
|
1431
|
+
/**
|
|
1432
|
+
* Array of allowed resources
|
|
1433
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1434
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1435
|
+
*/
|
|
1436
|
+
'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Array of denied resources
|
|
1439
|
+
* @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
|
|
1440
|
+
* @memberof GetAuthorizedPropertiesResponse
|
|
1441
|
+
*/
|
|
1442
|
+
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
1443
|
+
}
|
|
1444
|
+
/**
|
|
1445
|
+
* Details for getting roles for a principal
|
|
1446
|
+
* @export
|
|
1447
|
+
* @interface GetPrincipalRolesRequestBody
|
|
1448
|
+
*/
|
|
1449
|
+
export interface GetPrincipalRolesRequestBody {
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
* @type {AuthorizationRequestPrincipal}
|
|
1453
|
+
* @memberof GetPrincipalRolesRequestBody
|
|
1454
|
+
*/
|
|
1455
|
+
'principal': AuthorizationRequestPrincipal;
|
|
1456
|
+
/**
|
|
1457
|
+
*
|
|
1458
|
+
* @type {AuthorizationRequestResource}
|
|
1459
|
+
* @memberof GetPrincipalRolesRequestBody
|
|
1460
|
+
*/
|
|
1461
|
+
'resource'?: AuthorizationRequestResource;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* Successful roles retrieval response
|
|
1465
|
+
* @export
|
|
1466
|
+
* @interface GetPrincipalRolesSuccessResponse
|
|
1467
|
+
*/
|
|
1468
|
+
export interface GetPrincipalRolesSuccessResponse {
|
|
1469
|
+
/**
|
|
1470
|
+
* List of roles assigned to the principal
|
|
1471
|
+
* @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
|
|
1472
|
+
* @memberof GetPrincipalRolesSuccessResponse
|
|
1473
|
+
*/
|
|
1474
|
+
'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
|
|
1475
|
+
}
|
|
1476
|
+
/**
|
|
1477
|
+
*
|
|
1478
|
+
* @export
|
|
1479
|
+
* @interface GetPrincipalRolesSuccessResponseRolesInner
|
|
1480
|
+
*/
|
|
1481
|
+
export interface GetPrincipalRolesSuccessResponseRolesInner {
|
|
1482
|
+
/**
|
|
1483
|
+
* Policy ID
|
|
1484
|
+
* @type {string}
|
|
1485
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1486
|
+
*/
|
|
1487
|
+
'policyId': string;
|
|
1488
|
+
/**
|
|
1489
|
+
*
|
|
1490
|
+
* @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
|
|
1491
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1492
|
+
*/
|
|
1493
|
+
'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
|
|
1494
|
+
/**
|
|
1495
|
+
* Policy type
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1498
|
+
*/
|
|
1499
|
+
'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
|
|
1500
|
+
/**
|
|
1501
|
+
* Date and time the role was assigned
|
|
1502
|
+
* @type {string}
|
|
1503
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1504
|
+
*/
|
|
1505
|
+
'assignedAt': string;
|
|
1506
|
+
/**
|
|
1507
|
+
* User who assigned the role
|
|
1508
|
+
* @type {string}
|
|
1509
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1510
|
+
*/
|
|
1511
|
+
'assignedBy': string;
|
|
1512
|
+
/**
|
|
1513
|
+
* Type of resource the role is assigned to
|
|
1514
|
+
* @type {string}
|
|
1515
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1516
|
+
*/
|
|
1517
|
+
'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
|
|
1518
|
+
/**
|
|
1519
|
+
* Organization ID
|
|
1520
|
+
* @type {string}
|
|
1521
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1522
|
+
*/
|
|
1523
|
+
'orgId'?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Property ID
|
|
1526
|
+
* @type {string}
|
|
1527
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1528
|
+
*/
|
|
1529
|
+
'propertyId'?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Brand ID this role is scoped to
|
|
1532
|
+
* @type {string}
|
|
1533
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1534
|
+
*/
|
|
1535
|
+
'brandId'?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Sales channel ID this role is scoped to
|
|
1538
|
+
* @type {string}
|
|
1539
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1540
|
+
*/
|
|
1541
|
+
'salesChannelId'?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* Principal ID this role is assigned to
|
|
1544
|
+
* @type {string}
|
|
1545
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1546
|
+
*/
|
|
1547
|
+
'principalId': string;
|
|
1548
|
+
/**
|
|
1549
|
+
* Type of principal this role is assigned to
|
|
1550
|
+
* @type {string}
|
|
1551
|
+
* @memberof GetPrincipalRolesSuccessResponseRolesInner
|
|
1552
|
+
*/
|
|
1553
|
+
'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
|
|
1554
|
+
}
|
|
1555
|
+
export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
|
|
1556
|
+
readonly Main: "Main";
|
|
1557
|
+
readonly BrandOverride: "BrandOverride";
|
|
1558
|
+
readonly OrgOverride: "OrgOverride";
|
|
1559
|
+
readonly Forbidden: "Forbidden";
|
|
1560
|
+
readonly NamedRole: "NamedRole";
|
|
1561
|
+
};
|
|
1562
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
|
|
1563
|
+
export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
|
|
1564
|
+
readonly Property: "Property";
|
|
1565
|
+
readonly Org: "Org";
|
|
1566
|
+
readonly Brand: "Brand";
|
|
1567
|
+
readonly SalesChannel: "SalesChannel";
|
|
1568
|
+
};
|
|
1569
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
|
|
1570
|
+
export declare const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum: {
|
|
1571
|
+
readonly User: "User";
|
|
1572
|
+
readonly Automation: "Automation";
|
|
1573
|
+
};
|
|
1574
|
+
export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
|
|
1575
|
+
/**
|
|
1576
|
+
* Role name
|
|
1577
|
+
* @export
|
|
1578
|
+
* @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
|
|
1579
|
+
*/
|
|
1580
|
+
export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
|
|
1581
|
+
}
|
|
1582
|
+
/**
|
|
1583
|
+
* Successful user permissions retrieval response
|
|
1584
|
+
* @export
|
|
1585
|
+
* @interface GetUserPermissionsSuccessResponse
|
|
1586
|
+
*/
|
|
1587
|
+
export interface GetUserPermissionsSuccessResponse {
|
|
1588
|
+
/**
|
|
1589
|
+
* Map of resource IDs to permissions
|
|
1590
|
+
* @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
|
|
1591
|
+
* @memberof GetUserPermissionsSuccessResponse
|
|
1592
|
+
*/
|
|
1593
|
+
'resources': {
|
|
1594
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
1595
|
+
};
|
|
1596
|
+
}
|
|
1597
|
+
/**
|
|
1598
|
+
*
|
|
1599
|
+
* @export
|
|
1600
|
+
* @interface GetUserPermissionsSuccessResponseResourcesValue
|
|
1601
|
+
*/
|
|
1602
|
+
export interface GetUserPermissionsSuccessResponseResourcesValue {
|
|
1603
|
+
/**
|
|
1604
|
+
* Type of resource the permissions are assigned to
|
|
1605
|
+
* @type {string}
|
|
1606
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
1607
|
+
*/
|
|
1608
|
+
'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
|
|
1609
|
+
/**
|
|
1610
|
+
*
|
|
1611
|
+
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
1612
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
1613
|
+
*/
|
|
1614
|
+
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
1615
|
+
/**
|
|
1616
|
+
* List of permissions that are assigned to the user for the resource
|
|
1617
|
+
* @type {Array<string>}
|
|
1618
|
+
* @memberof GetUserPermissionsSuccessResponseResourcesValue
|
|
1619
|
+
*/
|
|
1620
|
+
'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
|
|
1621
|
+
}
|
|
1622
|
+
export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
|
|
1623
|
+
readonly Property: "Property";
|
|
1624
|
+
readonly Org: "Org";
|
|
1625
|
+
readonly Brand: "Brand";
|
|
1626
|
+
readonly SalesChannel: "SalesChannel";
|
|
1627
|
+
};
|
|
1628
|
+
export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
|
|
1629
|
+
export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum: {
|
|
1630
|
+
readonly AnyAuditLogs: "AnyAuditLogs";
|
|
1631
|
+
readonly ViewApp: "ViewApp";
|
|
1632
|
+
readonly CreateApp: "CreateApp";
|
|
1633
|
+
readonly UpdateApp: "UpdateApp";
|
|
1634
|
+
readonly ViewAppName: "ViewAppName";
|
|
1635
|
+
readonly EditAppAssets: "EditAppAssets";
|
|
1636
|
+
readonly EditAppFeatures: "EditAppFeatures";
|
|
1637
|
+
readonly ViewTeammates: "ViewTeammates";
|
|
1638
|
+
readonly EditTeammates: "EditTeammates";
|
|
1639
|
+
readonly CreateTeammateOwner: "CreateTeammateOwner";
|
|
1640
|
+
readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
|
|
1641
|
+
readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
|
|
1642
|
+
readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
|
|
1643
|
+
readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
|
|
1644
|
+
readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
|
|
1645
|
+
readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
|
|
1646
|
+
readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
|
|
1647
|
+
readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
|
|
1648
|
+
readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
|
|
1649
|
+
readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
|
|
1650
|
+
readonly ViewApmConfigurations: "ViewApmConfigurations";
|
|
1651
|
+
readonly EditApmConfigurations: "EditApmConfigurations";
|
|
1652
|
+
readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
|
|
1653
|
+
readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
|
|
1654
|
+
readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
|
|
1655
|
+
readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
|
|
1656
|
+
readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
|
|
1657
|
+
readonly ViewDevelopersSettings: "ViewDevelopersSettings";
|
|
1658
|
+
readonly EditDevelopersSettings: "EditDevelopersSettings";
|
|
1659
|
+
readonly ViewOrders: "ViewOrders";
|
|
1660
|
+
readonly UpdateOrdersAccept: "UpdateOrdersAccept";
|
|
1661
|
+
readonly UpdateOrdersReject: "UpdateOrdersReject";
|
|
1662
|
+
readonly UpdateOrdersRefund: "UpdateOrdersRefund";
|
|
1663
|
+
readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
|
|
1664
|
+
readonly ViewStores: "ViewStores";
|
|
1665
|
+
readonly CreateStores: "CreateStores";
|
|
1666
|
+
readonly EditStores: "EditStores";
|
|
1667
|
+
readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
|
|
1668
|
+
readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
|
|
1669
|
+
readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
|
|
1670
|
+
readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
|
|
1671
|
+
readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
|
|
1672
|
+
readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
|
|
1673
|
+
readonly UpdateStoresName: "UpdateStoresName";
|
|
1674
|
+
readonly EditStoreKioskSettings: "EditStoreKioskSettings";
|
|
1675
|
+
readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
|
|
1676
|
+
readonly EditStoreNotifications: "EditStoreNotifications";
|
|
1677
|
+
readonly ArchiveStores: "ArchiveStores";
|
|
1678
|
+
readonly PublishStores: "PublishStores";
|
|
1679
|
+
readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
|
|
1680
|
+
readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
|
|
1681
|
+
readonly ViewStoreGroups: "ViewStoreGroups";
|
|
1682
|
+
readonly CreateStoreGroups: "CreateStoreGroups";
|
|
1683
|
+
readonly UpdateStoreGroups: "UpdateStoreGroups";
|
|
1684
|
+
readonly DeleteStoreGroups: "DeleteStoreGroups";
|
|
1685
|
+
readonly ViewDeliveryZones: "ViewDeliveryZones";
|
|
1686
|
+
readonly CreateDeliveryZones: "CreateDeliveryZones";
|
|
1687
|
+
readonly UpdateDeliveryZones: "UpdateDeliveryZones";
|
|
1688
|
+
readonly DeleteDeliveryZones: "DeleteDeliveryZones";
|
|
1689
|
+
readonly ViewMenu: "ViewMenu";
|
|
1690
|
+
readonly CreateMenu: "CreateMenu";
|
|
1691
|
+
readonly UpdateMenu: "UpdateMenu";
|
|
1692
|
+
readonly DeleteMenu: "DeleteMenu";
|
|
1693
|
+
readonly UpdateMenuLock: "UpdateMenuLock";
|
|
1694
|
+
readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
|
|
1695
|
+
readonly EditMenuImage: "EditMenuImage";
|
|
1696
|
+
readonly ViewVouchers: "ViewVouchers";
|
|
1697
|
+
readonly EditVouchers: "EditVouchers";
|
|
1698
|
+
readonly ViewWebsiteContent: "ViewWebsiteContent";
|
|
1699
|
+
readonly EditWebsiteContent: "EditWebsiteContent";
|
|
1700
|
+
readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
|
|
1701
|
+
readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
|
|
1702
|
+
readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
|
|
1703
|
+
readonly ViewBankAccounts: "ViewBankAccounts";
|
|
1704
|
+
readonly CreateBankAccounts: "CreateBankAccounts";
|
|
1705
|
+
readonly UpdateBankAccounts: "UpdateBankAccounts";
|
|
1706
|
+
readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
|
|
1707
|
+
readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
|
|
1708
|
+
readonly VerifyBankAccounts: "VerifyBankAccounts";
|
|
1709
|
+
readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
|
|
1710
|
+
readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
|
|
1711
|
+
readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
|
|
1712
|
+
readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
|
|
1713
|
+
readonly ViewHydraConfig: "ViewHydraConfig";
|
|
1714
|
+
readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
|
|
1715
|
+
readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
|
|
1716
|
+
readonly DeleteTerminal: "DeleteTerminal";
|
|
1717
|
+
readonly ViewKioskTelemetry: "ViewKioskTelemetry";
|
|
1718
|
+
readonly ViewCustomers: "ViewCustomers";
|
|
1719
|
+
readonly EditCustomers: "EditCustomers";
|
|
1720
|
+
readonly CreateCustomers: "CreateCustomers";
|
|
1721
|
+
readonly CreateCatalogElements: "CreateCatalogElements";
|
|
1722
|
+
readonly UpdateCatalogElements: "UpdateCatalogElements";
|
|
1723
|
+
readonly ViewCatalogElements: "ViewCatalogElements";
|
|
1724
|
+
readonly DeleteCatalogElements: "DeleteCatalogElements";
|
|
1725
|
+
readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
|
|
1726
|
+
readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
|
|
1727
|
+
readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
|
|
1728
|
+
readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
|
|
1729
|
+
readonly UpdateMetafields: "UpdateMetafields";
|
|
1730
|
+
readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
|
|
1731
|
+
readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
|
|
1732
|
+
readonly ViewAppStatistics: "ViewAppStatistics";
|
|
1733
|
+
readonly ViewApmStatistics: "ViewApmStatistics";
|
|
1734
|
+
readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
|
|
1735
|
+
readonly ViewCustomerStatistics: "ViewCustomerStatistics";
|
|
1736
|
+
readonly ViewLiveStatistics: "ViewLiveStatistics";
|
|
1737
|
+
readonly ViewOrderStatistics: "ViewOrderStatistics";
|
|
1738
|
+
readonly ViewSalesStatistics: "ViewSalesStatistics";
|
|
1739
|
+
readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
|
|
1740
|
+
readonly ViewVouchersStatistics: "ViewVouchersStatistics";
|
|
1741
|
+
readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
|
|
1742
|
+
readonly ViewApmAuditLogs: "ViewApmAuditLogs";
|
|
1743
|
+
readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
|
|
1744
|
+
readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
|
|
1745
|
+
readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
|
|
1746
|
+
readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
|
|
1747
|
+
readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
|
|
1748
|
+
readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
|
|
1749
|
+
readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
|
|
1750
|
+
readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
|
|
1751
|
+
readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
|
|
1752
|
+
readonly ViewAppAuditLogs: "ViewAppAuditLogs";
|
|
1753
|
+
readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
|
|
1754
|
+
readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
|
|
1755
|
+
readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
|
|
1756
|
+
readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
|
|
1757
|
+
readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
|
|
1758
|
+
readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
|
|
1759
|
+
readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
|
|
1760
|
+
readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
|
|
1761
|
+
readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
|
|
1762
|
+
readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
|
|
1763
|
+
readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
|
|
1764
|
+
readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
|
|
1765
|
+
readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
|
|
1766
|
+
readonly InviteDriverToApp: "InviteDriverToApp";
|
|
1767
|
+
readonly GetDriverForApp: "GetDriverForApp";
|
|
1768
|
+
readonly RemoveDriverFromApp: "RemoveDriverFromApp";
|
|
1769
|
+
readonly AssignDriverToOrder: "AssignDriverToOrder";
|
|
1770
|
+
readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
|
|
1771
|
+
readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
|
|
1772
|
+
readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
|
|
1773
|
+
readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
|
|
1774
|
+
readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
|
|
1775
|
+
readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
|
|
1776
|
+
readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
|
|
1777
|
+
readonly ViewPayouts: "ViewPayouts";
|
|
1778
|
+
readonly ViewChannels: "ViewChannels";
|
|
1779
|
+
readonly ViewOnboarding: "ViewOnboarding";
|
|
1780
|
+
readonly UpdateOnboarding: "UpdateOnboarding";
|
|
1781
|
+
readonly ViewClientDevices: "ViewClientDevices";
|
|
1782
|
+
readonly UpdateClientDevices: "UpdateClientDevices";
|
|
1783
|
+
readonly EnrollClientDevices: "EnrollClientDevices";
|
|
1784
|
+
readonly AssignClientDevices: "AssignClientDevices";
|
|
1785
|
+
readonly ViewClientAuditLogs: "ViewClientAuditLogs";
|
|
1786
|
+
readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
|
|
1787
|
+
readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
|
|
1788
|
+
readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
|
|
1789
|
+
readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
|
|
1790
|
+
readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
|
|
1791
|
+
readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
|
|
1792
|
+
readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
|
|
1793
|
+
readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
|
|
1794
|
+
readonly ViewSalesChannels: "ViewSalesChannels";
|
|
1795
|
+
readonly EditSalesChannels: "EditSalesChannels";
|
|
1796
|
+
readonly CreateSalesChannel: "CreateSalesChannel";
|
|
1797
|
+
readonly ArchiveSalesChannel: "ArchiveSalesChannel";
|
|
1798
|
+
readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
|
|
1799
|
+
readonly PublishSalesChannel: "PublishSalesChannel";
|
|
1800
|
+
readonly UnpublishSalesChannel: "UnpublishSalesChannel";
|
|
1801
|
+
readonly CloneSalesChannel: "CloneSalesChannel";
|
|
1802
|
+
readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
|
|
1803
|
+
readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
|
|
1804
|
+
readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
|
|
1805
|
+
readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
|
|
1806
|
+
readonly ViewSubscriptions: "ViewSubscriptions";
|
|
1807
|
+
readonly ViewInvoices: "ViewInvoices";
|
|
1808
|
+
readonly EditAccountsBills: "EditAccountsBills";
|
|
1809
|
+
readonly ViewAccountsBills: "ViewAccountsBills";
|
|
1810
|
+
readonly EditAccountsCategories: "EditAccountsCategories";
|
|
1811
|
+
readonly ViewAccountsCategories: "ViewAccountsCategories";
|
|
1812
|
+
readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
|
|
1813
|
+
readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
|
|
1814
|
+
readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
|
|
1815
|
+
readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
|
|
1816
|
+
readonly EditAccountsExpenses: "EditAccountsExpenses";
|
|
1817
|
+
readonly ViewAccountsExpenses: "ViewAccountsExpenses";
|
|
1818
|
+
readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
|
|
1819
|
+
readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
|
|
1820
|
+
readonly EditDocumentExplorer: "EditDocumentExplorer";
|
|
1821
|
+
readonly ViewDocumentExplorer: "ViewDocumentExplorer";
|
|
1822
|
+
readonly ViewInventoryReports: "ViewInventoryReports";
|
|
1823
|
+
readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
|
|
1824
|
+
readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
|
|
1825
|
+
readonly EditInventoryStockItems: "EditInventoryStockItems";
|
|
1826
|
+
readonly ViewInventoryStockItems: "ViewInventoryStockItems";
|
|
1827
|
+
readonly EditInventorySupplier: "EditInventorySupplier";
|
|
1828
|
+
readonly ViewInventorySupplier: "ViewInventorySupplier";
|
|
1829
|
+
readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
|
|
1830
|
+
readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
|
|
1831
|
+
readonly ViewPayrollReports: "ViewPayrollReports";
|
|
1832
|
+
readonly EditPayrollHoliday: "EditPayrollHoliday";
|
|
1833
|
+
readonly ViewPayrollHoliday: "ViewPayrollHoliday";
|
|
1834
|
+
readonly EditPayrollRota: "EditPayrollRota";
|
|
1835
|
+
readonly ViewPayrollRota: "ViewPayrollRota";
|
|
1836
|
+
readonly EditPayrollStaff: "EditPayrollStaff";
|
|
1837
|
+
readonly ViewPayrollStaff: "ViewPayrollStaff";
|
|
1838
|
+
readonly ViewSalesReports: "ViewSalesReports";
|
|
1839
|
+
readonly ViewCostReports: "ViewCostReports";
|
|
1840
|
+
readonly ViewMenuReports: "ViewMenuReports";
|
|
1841
|
+
readonly ViewBrand: "ViewBrand";
|
|
1842
|
+
readonly EditBrand: "EditBrand";
|
|
1843
|
+
readonly CreateBrand: "CreateBrand";
|
|
1844
|
+
readonly TransferBrand: "TransferBrand";
|
|
1845
|
+
readonly ViewProperty: "ViewProperty";
|
|
1846
|
+
readonly EditProperty: "EditProperty";
|
|
1847
|
+
readonly CreateProperty: "CreateProperty";
|
|
1848
|
+
readonly ArchiveProperty: "ArchiveProperty";
|
|
1849
|
+
readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
|
|
1850
|
+
readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
|
|
1851
|
+
readonly CreateOrg: "CreateOrg";
|
|
1852
|
+
readonly EditOrg: "EditOrg";
|
|
1853
|
+
readonly ViewOrg: "ViewOrg";
|
|
1854
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
1855
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
1856
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
1857
|
+
readonly RoleFactory: "RoleFactory";
|
|
1858
|
+
};
|
|
1859
|
+
export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
|
|
1860
|
+
/**
|
|
1861
|
+
* ID of the resource the permissions are assigned to
|
|
1862
|
+
* @export
|
|
1863
|
+
* @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
|
|
1864
|
+
*/
|
|
1865
|
+
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
1866
|
+
}
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @export
|
|
1870
|
+
* @interface IsInRoleRequest
|
|
1871
|
+
*/
|
|
1872
|
+
export interface IsInRoleRequest {
|
|
1873
|
+
/**
|
|
1874
|
+
*
|
|
1875
|
+
* @type {AuthorizationRequestPrincipal}
|
|
1876
|
+
* @memberof IsInRoleRequest
|
|
1877
|
+
*/
|
|
1878
|
+
'principal': AuthorizationRequestPrincipal;
|
|
1879
|
+
/**
|
|
1880
|
+
* Array of roles to check if the principal is in
|
|
1881
|
+
* @type {Array<string>}
|
|
1882
|
+
* @memberof IsInRoleRequest
|
|
1883
|
+
*/
|
|
1884
|
+
'roles': Array<IsInRoleRequestRolesEnum>;
|
|
1885
|
+
/**
|
|
1886
|
+
* How to check if the principal is in any/all of the roles
|
|
1887
|
+
* @type {string}
|
|
1888
|
+
* @memberof IsInRoleRequest
|
|
1889
|
+
*/
|
|
1890
|
+
'checkMode'?: IsInRoleRequestCheckModeEnum;
|
|
1891
|
+
}
|
|
1892
|
+
export declare const IsInRoleRequestRolesEnum: {
|
|
1893
|
+
readonly Admin: "Admin";
|
|
1894
|
+
readonly Factory: "Factory";
|
|
1895
|
+
};
|
|
1896
|
+
export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
|
|
1897
|
+
export declare const IsInRoleRequestCheckModeEnum: {
|
|
1898
|
+
readonly Any: "any";
|
|
1899
|
+
readonly All: "all";
|
|
1900
|
+
};
|
|
1901
|
+
export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
|
|
1902
|
+
/**
|
|
1903
|
+
* Response containing whether the principal is in any/all of the roles
|
|
1904
|
+
* @export
|
|
1905
|
+
* @interface IsInRoleResponse
|
|
1906
|
+
*/
|
|
1907
|
+
export interface IsInRoleResponse {
|
|
1908
|
+
/**
|
|
1909
|
+
* result of the check - whether the principal is in any/all of the roles
|
|
1910
|
+
* @type {boolean}
|
|
1911
|
+
* @memberof IsInRoleResponse
|
|
1912
|
+
*/
|
|
1913
|
+
'authorized': boolean;
|
|
1914
|
+
}
|
|
1915
|
+
/**
|
|
1916
|
+
* Successful feature based roles retrieval response
|
|
1917
|
+
* @export
|
|
1918
|
+
* @interface ListFeatureBasedRolesSuccessResponse
|
|
1919
|
+
*/
|
|
1920
|
+
export interface ListFeatureBasedRolesSuccessResponse {
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @type {Array<FeatureBasedRole>}
|
|
1924
|
+
* @memberof ListFeatureBasedRolesSuccessResponse
|
|
1925
|
+
*/
|
|
1926
|
+
'roles': Array<FeatureBasedRole>;
|
|
1927
|
+
}
|
|
1928
|
+
/**
|
|
1929
|
+
*
|
|
1930
|
+
* @export
|
|
1931
|
+
* @interface ListOrgRolesSuccessResponseValueValue
|
|
1932
|
+
*/
|
|
1933
|
+
export interface ListOrgRolesSuccessResponseValueValue {
|
|
1934
|
+
/**
|
|
1935
|
+
* Type of resource the permissions are assigned to
|
|
1936
|
+
* @type {string}
|
|
1937
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1938
|
+
*/
|
|
1939
|
+
'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
|
|
1940
|
+
/**
|
|
1941
|
+
*
|
|
1942
|
+
* @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
|
|
1943
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1944
|
+
*/
|
|
1945
|
+
'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
|
|
1946
|
+
/**
|
|
1947
|
+
* List of roles that are assigned to the user for the resource
|
|
1948
|
+
* @type {Array<string>}
|
|
1949
|
+
* @memberof ListOrgRolesSuccessResponseValueValue
|
|
1950
|
+
*/
|
|
1951
|
+
'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
|
|
1952
|
+
}
|
|
1953
|
+
export declare const ListOrgRolesSuccessResponseValueValueResourceTypeEnum: {
|
|
1954
|
+
readonly Property: "Property";
|
|
1955
|
+
readonly Org: "Org";
|
|
1956
|
+
readonly Brand: "Brand";
|
|
1957
|
+
readonly SalesChannel: "SalesChannel";
|
|
1958
|
+
};
|
|
1959
|
+
export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
|
|
1960
|
+
export declare const ListOrgRolesSuccessResponseValueValueRolesEnum: {
|
|
1961
|
+
readonly OrgViewer: "OrgViewer";
|
|
1962
|
+
readonly OrgManager: "OrgManager";
|
|
1963
|
+
readonly OrgAdmin: "OrgAdmin";
|
|
1964
|
+
readonly BrandViewer: "BrandViewer";
|
|
1965
|
+
readonly BrandManager: "BrandManager";
|
|
1966
|
+
readonly BrandAdmin: "BrandAdmin";
|
|
1967
|
+
readonly StoreViewer: "StoreViewer";
|
|
1968
|
+
readonly StoreEditor: "StoreEditor";
|
|
1969
|
+
readonly StoreManager: "StoreManager";
|
|
1970
|
+
readonly CustomerViewer: "CustomerViewer";
|
|
1971
|
+
readonly CustomerManager: "CustomerManager";
|
|
1972
|
+
readonly VoucherViewer: "VoucherViewer";
|
|
1973
|
+
readonly VoucherEditor: "VoucherEditor";
|
|
1974
|
+
readonly VoucherManager: "VoucherManager";
|
|
1975
|
+
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
1976
|
+
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
1977
|
+
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
1978
|
+
readonly ReportsViewer: "ReportsViewer";
|
|
1979
|
+
readonly FinanceViewer: "FinanceViewer";
|
|
1980
|
+
readonly FinanceManager: "FinanceManager";
|
|
1981
|
+
readonly TeamViewer: "TeamViewer";
|
|
1982
|
+
readonly TeamManager: "TeamManager";
|
|
1983
|
+
readonly TeamAdmin: "TeamAdmin";
|
|
1984
|
+
readonly TechViewer: "TechViewer";
|
|
1985
|
+
readonly TechManager: "TechManager";
|
|
1986
|
+
readonly AppStoreViewer: "AppStoreViewer";
|
|
1987
|
+
readonly AppStoreManager: "AppStoreManager";
|
|
1988
|
+
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
1989
|
+
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
1990
|
+
readonly SalesChannelManager: "SalesChannelManager";
|
|
1991
|
+
readonly DeliveryViewer: "DeliveryViewer";
|
|
1992
|
+
readonly DeliveryManager: "DeliveryManager";
|
|
1993
|
+
readonly DriverManager: "DriverManager";
|
|
1994
|
+
readonly AuditViewer: "AuditViewer";
|
|
1995
|
+
readonly AuditManager: "AuditManager";
|
|
1996
|
+
readonly AccountsViewer: "AccountsViewer";
|
|
1997
|
+
readonly AccountsEditor: "AccountsEditor";
|
|
1998
|
+
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
1999
|
+
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
2000
|
+
readonly PayrollViewer: "PayrollViewer";
|
|
2001
|
+
readonly PayrollEditor: "PayrollEditor";
|
|
2002
|
+
readonly PropertyViewer: "PropertyViewer";
|
|
2003
|
+
readonly PropertyManager: "PropertyManager";
|
|
2004
|
+
readonly PropertyAdmin: "PropertyAdmin";
|
|
2005
|
+
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
2006
|
+
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
2007
|
+
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
2008
|
+
readonly MenuViewer: "MenuViewer";
|
|
2009
|
+
readonly MenuEditor: "MenuEditor";
|
|
2010
|
+
readonly MenuManager: "MenuManager";
|
|
2011
|
+
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
2012
|
+
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
2013
|
+
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
2014
|
+
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
2015
|
+
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
2016
|
+
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
2017
|
+
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
2018
|
+
readonly OrderManager: "OrderManager";
|
|
2019
|
+
readonly OrderEditor: "OrderEditor";
|
|
2020
|
+
readonly OrderViewer: "OrderViewer";
|
|
2021
|
+
readonly InventoryManager: "InventoryManager";
|
|
2022
|
+
readonly InventoryEditor: "InventoryEditor";
|
|
2023
|
+
readonly InventoryViewer: "InventoryViewer";
|
|
2024
|
+
readonly PaymentManager: "PaymentManager";
|
|
2025
|
+
readonly OnboardingManager: "OnboardingManager";
|
|
2026
|
+
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
2027
|
+
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
2028
|
+
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
2029
|
+
readonly IntegratorMisc: "IntegratorMisc";
|
|
2030
|
+
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
2031
|
+
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
2032
|
+
readonly SupportMisc: "SupportMisc";
|
|
2033
|
+
};
|
|
2034
|
+
export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
|
|
2035
|
+
/**
|
|
2036
|
+
* Successful permissions retrieval response
|
|
2037
|
+
* @export
|
|
2038
|
+
* @interface ListPermissionsSuccessResponse
|
|
2039
|
+
*/
|
|
2040
|
+
export interface ListPermissionsSuccessResponse {
|
|
2041
|
+
/**
|
|
2042
|
+
*
|
|
2043
|
+
* @type {Permissions & Array<string>}
|
|
2044
|
+
* @memberof ListPermissionsSuccessResponse
|
|
2045
|
+
*/
|
|
2046
|
+
'permissions': Permissions & Array<string>;
|
|
2047
|
+
}
|
|
2048
|
+
/**
|
|
2049
|
+
* Successful roles retrieval response
|
|
2050
|
+
* @export
|
|
2051
|
+
* @interface ListRolesSuccessResponse
|
|
2052
|
+
*/
|
|
2053
|
+
export interface ListRolesSuccessResponse {
|
|
2054
|
+
/**
|
|
2055
|
+
* List of named roles
|
|
2056
|
+
* @type {Array<string>}
|
|
2057
|
+
* @memberof ListRolesSuccessResponse
|
|
2058
|
+
*/
|
|
2059
|
+
'roles': Array<ListRolesSuccessResponseRolesEnum>;
|
|
2060
|
+
}
|
|
2061
|
+
export declare const ListRolesSuccessResponseRolesEnum: {
|
|
2062
|
+
readonly Admin: "Admin";
|
|
2063
|
+
readonly Factory: "Factory";
|
|
2064
|
+
};
|
|
2065
|
+
export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
|
|
2066
|
+
/**
|
|
2067
|
+
*
|
|
2068
|
+
* @export
|
|
2069
|
+
* @enum {string}
|
|
2070
|
+
*/
|
|
2071
|
+
export declare const Permissions: {
|
|
2072
|
+
readonly AnyAuditLogs: "AnyAuditLogs";
|
|
2073
|
+
readonly ViewApp: "ViewApp";
|
|
2074
|
+
readonly CreateApp: "CreateApp";
|
|
2075
|
+
readonly UpdateApp: "UpdateApp";
|
|
2076
|
+
readonly ViewAppName: "ViewAppName";
|
|
2077
|
+
readonly EditAppAssets: "EditAppAssets";
|
|
2078
|
+
readonly EditAppFeatures: "EditAppFeatures";
|
|
2079
|
+
readonly ViewTeammates: "ViewTeammates";
|
|
2080
|
+
readonly EditTeammates: "EditTeammates";
|
|
2081
|
+
readonly CreateTeammateOwner: "CreateTeammateOwner";
|
|
2082
|
+
readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
|
|
2083
|
+
readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
|
|
2084
|
+
readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
|
|
2085
|
+
readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
|
|
2086
|
+
readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
|
|
2087
|
+
readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
|
|
2088
|
+
readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
|
|
2089
|
+
readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
|
|
2090
|
+
readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
|
|
2091
|
+
readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
|
|
2092
|
+
readonly ViewApmConfigurations: "ViewApmConfigurations";
|
|
2093
|
+
readonly EditApmConfigurations: "EditApmConfigurations";
|
|
2094
|
+
readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
|
|
2095
|
+
readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
|
|
2096
|
+
readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
|
|
2097
|
+
readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
|
|
2098
|
+
readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
|
|
2099
|
+
readonly ViewDevelopersSettings: "ViewDevelopersSettings";
|
|
2100
|
+
readonly EditDevelopersSettings: "EditDevelopersSettings";
|
|
2101
|
+
readonly ViewOrders: "ViewOrders";
|
|
2102
|
+
readonly UpdateOrdersAccept: "UpdateOrdersAccept";
|
|
2103
|
+
readonly UpdateOrdersReject: "UpdateOrdersReject";
|
|
2104
|
+
readonly UpdateOrdersRefund: "UpdateOrdersRefund";
|
|
2105
|
+
readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
|
|
2106
|
+
readonly ViewStores: "ViewStores";
|
|
2107
|
+
readonly CreateStores: "CreateStores";
|
|
2108
|
+
readonly EditStores: "EditStores";
|
|
2109
|
+
readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
|
|
2110
|
+
readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
|
|
2111
|
+
readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
|
|
2112
|
+
readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
|
|
2113
|
+
readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
|
|
2114
|
+
readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
|
|
2115
|
+
readonly UpdateStoresName: "UpdateStoresName";
|
|
2116
|
+
readonly EditStoreKioskSettings: "EditStoreKioskSettings";
|
|
2117
|
+
readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
|
|
2118
|
+
readonly EditStoreNotifications: "EditStoreNotifications";
|
|
2119
|
+
readonly ArchiveStores: "ArchiveStores";
|
|
2120
|
+
readonly PublishStores: "PublishStores";
|
|
2121
|
+
readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
|
|
2122
|
+
readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
|
|
2123
|
+
readonly ViewStoreGroups: "ViewStoreGroups";
|
|
2124
|
+
readonly CreateStoreGroups: "CreateStoreGroups";
|
|
2125
|
+
readonly UpdateStoreGroups: "UpdateStoreGroups";
|
|
2126
|
+
readonly DeleteStoreGroups: "DeleteStoreGroups";
|
|
2127
|
+
readonly ViewDeliveryZones: "ViewDeliveryZones";
|
|
2128
|
+
readonly CreateDeliveryZones: "CreateDeliveryZones";
|
|
2129
|
+
readonly UpdateDeliveryZones: "UpdateDeliveryZones";
|
|
2130
|
+
readonly DeleteDeliveryZones: "DeleteDeliveryZones";
|
|
2131
|
+
readonly ViewMenu: "ViewMenu";
|
|
2132
|
+
readonly CreateMenu: "CreateMenu";
|
|
2133
|
+
readonly UpdateMenu: "UpdateMenu";
|
|
2134
|
+
readonly DeleteMenu: "DeleteMenu";
|
|
2135
|
+
readonly UpdateMenuLock: "UpdateMenuLock";
|
|
2136
|
+
readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
|
|
2137
|
+
readonly EditMenuImage: "EditMenuImage";
|
|
2138
|
+
readonly ViewVouchers: "ViewVouchers";
|
|
2139
|
+
readonly EditVouchers: "EditVouchers";
|
|
2140
|
+
readonly ViewWebsiteContent: "ViewWebsiteContent";
|
|
2141
|
+
readonly EditWebsiteContent: "EditWebsiteContent";
|
|
2142
|
+
readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
|
|
2143
|
+
readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
|
|
2144
|
+
readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
|
|
2145
|
+
readonly ViewBankAccounts: "ViewBankAccounts";
|
|
2146
|
+
readonly CreateBankAccounts: "CreateBankAccounts";
|
|
2147
|
+
readonly UpdateBankAccounts: "UpdateBankAccounts";
|
|
2148
|
+
readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
|
|
2149
|
+
readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
|
|
2150
|
+
readonly VerifyBankAccounts: "VerifyBankAccounts";
|
|
2151
|
+
readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
|
|
2152
|
+
readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
|
|
2153
|
+
readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
|
|
2154
|
+
readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
|
|
2155
|
+
readonly ViewHydraConfig: "ViewHydraConfig";
|
|
2156
|
+
readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
|
|
2157
|
+
readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
|
|
2158
|
+
readonly DeleteTerminal: "DeleteTerminal";
|
|
2159
|
+
readonly ViewKioskTelemetry: "ViewKioskTelemetry";
|
|
2160
|
+
readonly ViewCustomers: "ViewCustomers";
|
|
2161
|
+
readonly EditCustomers: "EditCustomers";
|
|
2162
|
+
readonly CreateCustomers: "CreateCustomers";
|
|
2163
|
+
readonly CreateCatalogElements: "CreateCatalogElements";
|
|
2164
|
+
readonly UpdateCatalogElements: "UpdateCatalogElements";
|
|
2165
|
+
readonly ViewCatalogElements: "ViewCatalogElements";
|
|
2166
|
+
readonly DeleteCatalogElements: "DeleteCatalogElements";
|
|
2167
|
+
readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
|
|
2168
|
+
readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
|
|
2169
|
+
readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
|
|
2170
|
+
readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
|
|
2171
|
+
readonly UpdateMetafields: "UpdateMetafields";
|
|
2172
|
+
readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
|
|
2173
|
+
readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
|
|
2174
|
+
readonly ViewAppStatistics: "ViewAppStatistics";
|
|
2175
|
+
readonly ViewApmStatistics: "ViewApmStatistics";
|
|
2176
|
+
readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
|
|
2177
|
+
readonly ViewCustomerStatistics: "ViewCustomerStatistics";
|
|
2178
|
+
readonly ViewLiveStatistics: "ViewLiveStatistics";
|
|
2179
|
+
readonly ViewOrderStatistics: "ViewOrderStatistics";
|
|
2180
|
+
readonly ViewSalesStatistics: "ViewSalesStatistics";
|
|
2181
|
+
readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
|
|
2182
|
+
readonly ViewVouchersStatistics: "ViewVouchersStatistics";
|
|
2183
|
+
readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
|
|
2184
|
+
readonly ViewApmAuditLogs: "ViewApmAuditLogs";
|
|
2185
|
+
readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
|
|
2186
|
+
readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
|
|
2187
|
+
readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
|
|
2188
|
+
readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
|
|
2189
|
+
readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
|
|
2190
|
+
readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
|
|
2191
|
+
readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
|
|
2192
|
+
readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
|
|
2193
|
+
readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
|
|
2194
|
+
readonly ViewAppAuditLogs: "ViewAppAuditLogs";
|
|
2195
|
+
readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
|
|
2196
|
+
readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
|
|
2197
|
+
readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
|
|
2198
|
+
readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
|
|
2199
|
+
readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
|
|
2200
|
+
readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
|
|
2201
|
+
readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
|
|
2202
|
+
readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
|
|
2203
|
+
readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
|
|
2204
|
+
readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
|
|
2205
|
+
readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
|
|
2206
|
+
readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
|
|
2207
|
+
readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
|
|
2208
|
+
readonly InviteDriverToApp: "InviteDriverToApp";
|
|
2209
|
+
readonly GetDriverForApp: "GetDriverForApp";
|
|
2210
|
+
readonly RemoveDriverFromApp: "RemoveDriverFromApp";
|
|
2211
|
+
readonly AssignDriverToOrder: "AssignDriverToOrder";
|
|
2212
|
+
readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
|
|
2213
|
+
readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
|
|
2214
|
+
readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
|
|
2215
|
+
readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
|
|
2216
|
+
readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
|
|
2217
|
+
readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
|
|
2218
|
+
readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
|
|
2219
|
+
readonly ViewPayouts: "ViewPayouts";
|
|
2220
|
+
readonly ViewChannels: "ViewChannels";
|
|
2221
|
+
readonly ViewOnboarding: "ViewOnboarding";
|
|
2222
|
+
readonly UpdateOnboarding: "UpdateOnboarding";
|
|
2223
|
+
readonly ViewClientDevices: "ViewClientDevices";
|
|
2224
|
+
readonly UpdateClientDevices: "UpdateClientDevices";
|
|
2225
|
+
readonly EnrollClientDevices: "EnrollClientDevices";
|
|
2226
|
+
readonly AssignClientDevices: "AssignClientDevices";
|
|
2227
|
+
readonly ViewClientAuditLogs: "ViewClientAuditLogs";
|
|
2228
|
+
readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
|
|
2229
|
+
readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
|
|
2230
|
+
readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
|
|
2231
|
+
readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
|
|
2232
|
+
readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
|
|
2233
|
+
readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
|
|
2234
|
+
readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
|
|
2235
|
+
readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
|
|
2236
|
+
readonly ViewSalesChannels: "ViewSalesChannels";
|
|
2237
|
+
readonly EditSalesChannels: "EditSalesChannels";
|
|
2238
|
+
readonly CreateSalesChannel: "CreateSalesChannel";
|
|
2239
|
+
readonly ArchiveSalesChannel: "ArchiveSalesChannel";
|
|
2240
|
+
readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
|
|
2241
|
+
readonly PublishSalesChannel: "PublishSalesChannel";
|
|
2242
|
+
readonly UnpublishSalesChannel: "UnpublishSalesChannel";
|
|
2243
|
+
readonly CloneSalesChannel: "CloneSalesChannel";
|
|
2244
|
+
readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
|
|
2245
|
+
readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
|
|
2246
|
+
readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
|
|
2247
|
+
readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
|
|
2248
|
+
readonly ViewSubscriptions: "ViewSubscriptions";
|
|
2249
|
+
readonly ViewInvoices: "ViewInvoices";
|
|
2250
|
+
readonly EditAccountsBills: "EditAccountsBills";
|
|
2251
|
+
readonly ViewAccountsBills: "ViewAccountsBills";
|
|
2252
|
+
readonly EditAccountsCategories: "EditAccountsCategories";
|
|
2253
|
+
readonly ViewAccountsCategories: "ViewAccountsCategories";
|
|
2254
|
+
readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
|
|
2255
|
+
readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
|
|
2256
|
+
readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
|
|
2257
|
+
readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
|
|
2258
|
+
readonly EditAccountsExpenses: "EditAccountsExpenses";
|
|
2259
|
+
readonly ViewAccountsExpenses: "ViewAccountsExpenses";
|
|
2260
|
+
readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
|
|
2261
|
+
readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
|
|
2262
|
+
readonly EditDocumentExplorer: "EditDocumentExplorer";
|
|
2263
|
+
readonly ViewDocumentExplorer: "ViewDocumentExplorer";
|
|
2264
|
+
readonly ViewInventoryReports: "ViewInventoryReports";
|
|
2265
|
+
readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
|
|
2266
|
+
readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
|
|
2267
|
+
readonly EditInventoryStockItems: "EditInventoryStockItems";
|
|
2268
|
+
readonly ViewInventoryStockItems: "ViewInventoryStockItems";
|
|
2269
|
+
readonly EditInventorySupplier: "EditInventorySupplier";
|
|
2270
|
+
readonly ViewInventorySupplier: "ViewInventorySupplier";
|
|
2271
|
+
readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
|
|
2272
|
+
readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
|
|
2273
|
+
readonly ViewPayrollReports: "ViewPayrollReports";
|
|
2274
|
+
readonly EditPayrollHoliday: "EditPayrollHoliday";
|
|
2275
|
+
readonly ViewPayrollHoliday: "ViewPayrollHoliday";
|
|
2276
|
+
readonly EditPayrollRota: "EditPayrollRota";
|
|
2277
|
+
readonly ViewPayrollRota: "ViewPayrollRota";
|
|
2278
|
+
readonly EditPayrollStaff: "EditPayrollStaff";
|
|
2279
|
+
readonly ViewPayrollStaff: "ViewPayrollStaff";
|
|
2280
|
+
readonly ViewSalesReports: "ViewSalesReports";
|
|
2281
|
+
readonly ViewCostReports: "ViewCostReports";
|
|
2282
|
+
readonly ViewMenuReports: "ViewMenuReports";
|
|
2283
|
+
readonly ViewBrand: "ViewBrand";
|
|
2284
|
+
readonly EditBrand: "EditBrand";
|
|
2285
|
+
readonly CreateBrand: "CreateBrand";
|
|
2286
|
+
readonly TransferBrand: "TransferBrand";
|
|
2287
|
+
readonly ViewProperty: "ViewProperty";
|
|
2288
|
+
readonly EditProperty: "EditProperty";
|
|
2289
|
+
readonly CreateProperty: "CreateProperty";
|
|
2290
|
+
readonly ArchiveProperty: "ArchiveProperty";
|
|
2291
|
+
readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
|
|
2292
|
+
readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
|
|
2293
|
+
readonly CreateOrg: "CreateOrg";
|
|
2294
|
+
readonly EditOrg: "EditOrg";
|
|
2295
|
+
readonly ViewOrg: "ViewOrg";
|
|
2296
|
+
readonly ViewWebhooks: "ViewWebhooks";
|
|
2297
|
+
readonly EditWebhooks: "EditWebhooks";
|
|
2298
|
+
readonly RoleAdmin: "RoleAdmin";
|
|
2299
|
+
readonly RoleFactory: "RoleFactory";
|
|
2300
|
+
};
|
|
2301
|
+
export type Permissions = typeof Permissions[keyof typeof Permissions];
|
|
2302
|
+
/**
|
|
2303
|
+
* Details for revoking a forbidden role from a principal
|
|
2304
|
+
* @export
|
|
2305
|
+
* @interface RevokeForbiddenRoleRequestBody
|
|
2306
|
+
*/
|
|
2307
|
+
export interface RevokeForbiddenRoleRequestBody {
|
|
2308
|
+
/**
|
|
2309
|
+
*
|
|
2310
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2311
|
+
* @memberof RevokeForbiddenRoleRequestBody
|
|
2312
|
+
*/
|
|
2313
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2314
|
+
/**
|
|
2315
|
+
* Compensation role to revoke the forbidden role from
|
|
2316
|
+
* @type {string}
|
|
2317
|
+
* @memberof RevokeForbiddenRoleRequestBody
|
|
2318
|
+
*/
|
|
2319
|
+
'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
|
|
2320
|
+
}
|
|
2321
|
+
export declare const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum: {
|
|
2322
|
+
readonly OwnerCompensating: "OwnerCompensating";
|
|
2323
|
+
readonly PropertyOwnerCompensating: "PropertyOwnerCompensating";
|
|
2324
|
+
readonly ManagedOwnerCompensating: "ManagedOwnerCompensating";
|
|
2325
|
+
readonly IntegratorCompensating: "IntegratorCompensating";
|
|
2326
|
+
readonly PropertyManagerCompensating: "PropertyManagerCompensating";
|
|
2327
|
+
readonly FinanceManagerCompensating: "FinanceManagerCompensating";
|
|
2328
|
+
};
|
|
2329
|
+
export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
|
|
2330
|
+
/**
|
|
2331
|
+
* Details for revoking a role from a principal
|
|
2332
|
+
* @export
|
|
2333
|
+
* @interface RevokeRoleRequestBody
|
|
2334
|
+
*/
|
|
2335
|
+
export interface RevokeRoleRequestBody {
|
|
2336
|
+
/**
|
|
2337
|
+
*
|
|
2338
|
+
* @type {string}
|
|
2339
|
+
* @memberof RevokeRoleRequestBody
|
|
2340
|
+
*/
|
|
2341
|
+
'role': RevokeRoleRequestBodyRoleEnum;
|
|
2342
|
+
/**
|
|
2343
|
+
*
|
|
2344
|
+
* @type {AuthorizationRequestResource}
|
|
2345
|
+
* @memberof RevokeRoleRequestBody
|
|
2346
|
+
*/
|
|
2347
|
+
'resource': AuthorizationRequestResource;
|
|
2348
|
+
/**
|
|
2349
|
+
*
|
|
2350
|
+
* @type {AuthorizationRequestPrincipal}
|
|
2351
|
+
* @memberof RevokeRoleRequestBody
|
|
2352
|
+
*/
|
|
2353
|
+
'principal': AuthorizationRequestPrincipal;
|
|
2354
|
+
/**
|
|
2355
|
+
*
|
|
2356
|
+
* @type {string}
|
|
2357
|
+
* @memberof RevokeRoleRequestBody
|
|
2358
|
+
*/
|
|
2359
|
+
'brandId': string;
|
|
2360
|
+
}
|
|
2361
|
+
export declare const RevokeRoleRequestBodyRoleEnum: {
|
|
2362
|
+
readonly OrgViewer: "OrgViewer";
|
|
2363
|
+
readonly OrgManager: "OrgManager";
|
|
2364
|
+
readonly OrgAdmin: "OrgAdmin";
|
|
2365
|
+
readonly BrandViewer: "BrandViewer";
|
|
2366
|
+
readonly BrandManager: "BrandManager";
|
|
2367
|
+
readonly BrandAdmin: "BrandAdmin";
|
|
2368
|
+
readonly StoreViewer: "StoreViewer";
|
|
2369
|
+
readonly StoreEditor: "StoreEditor";
|
|
2370
|
+
readonly StoreManager: "StoreManager";
|
|
2371
|
+
readonly CustomerViewer: "CustomerViewer";
|
|
2372
|
+
readonly CustomerManager: "CustomerManager";
|
|
2373
|
+
readonly VoucherViewer: "VoucherViewer";
|
|
2374
|
+
readonly VoucherEditor: "VoucherEditor";
|
|
2375
|
+
readonly VoucherManager: "VoucherManager";
|
|
2376
|
+
readonly VoucherCampaignManager: "VoucherCampaignManager";
|
|
2377
|
+
readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
|
|
2378
|
+
readonly AnalyticsViewer: "AnalyticsViewer";
|
|
2379
|
+
readonly ReportsViewer: "ReportsViewer";
|
|
2380
|
+
readonly FinanceViewer: "FinanceViewer";
|
|
2381
|
+
readonly FinanceManager: "FinanceManager";
|
|
2382
|
+
readonly TeamViewer: "TeamViewer";
|
|
2383
|
+
readonly TeamManager: "TeamManager";
|
|
2384
|
+
readonly TeamAdmin: "TeamAdmin";
|
|
2385
|
+
readonly TechViewer: "TechViewer";
|
|
2386
|
+
readonly TechManager: "TechManager";
|
|
2387
|
+
readonly AppStoreViewer: "AppStoreViewer";
|
|
2388
|
+
readonly AppStoreManager: "AppStoreManager";
|
|
2389
|
+
readonly SalesChannelViewer: "SalesChannelViewer";
|
|
2390
|
+
readonly SalesChannelEditor: "SalesChannelEditor";
|
|
2391
|
+
readonly SalesChannelManager: "SalesChannelManager";
|
|
2392
|
+
readonly DeliveryViewer: "DeliveryViewer";
|
|
2393
|
+
readonly DeliveryManager: "DeliveryManager";
|
|
2394
|
+
readonly DriverManager: "DriverManager";
|
|
2395
|
+
readonly AuditViewer: "AuditViewer";
|
|
2396
|
+
readonly AuditManager: "AuditManager";
|
|
2397
|
+
readonly AccountsViewer: "AccountsViewer";
|
|
2398
|
+
readonly AccountsEditor: "AccountsEditor";
|
|
2399
|
+
readonly DocumentExplorerViewer: "DocumentExplorerViewer";
|
|
2400
|
+
readonly DocumentExplorerEditor: "DocumentExplorerEditor";
|
|
2401
|
+
readonly PayrollViewer: "PayrollViewer";
|
|
2402
|
+
readonly PayrollEditor: "PayrollEditor";
|
|
2403
|
+
readonly PropertyViewer: "PropertyViewer";
|
|
2404
|
+
readonly PropertyManager: "PropertyManager";
|
|
2405
|
+
readonly PropertyAdmin: "PropertyAdmin";
|
|
2406
|
+
readonly WebsiteContentEditor: "WebsiteContentEditor";
|
|
2407
|
+
readonly WebsiteContentViewer: "WebsiteContentViewer";
|
|
2408
|
+
readonly WebsiteTechViewer: "WebsiteTechViewer";
|
|
2409
|
+
readonly MenuViewer: "MenuViewer";
|
|
2410
|
+
readonly MenuEditor: "MenuEditor";
|
|
2411
|
+
readonly MenuManager: "MenuManager";
|
|
2412
|
+
readonly MenuMetaFieldManager: "MenuMetaFieldManager";
|
|
2413
|
+
readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
|
|
2414
|
+
readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
|
|
2415
|
+
readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
|
|
2416
|
+
readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
|
|
2417
|
+
readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
|
|
2418
|
+
readonly OrderFulfillmentManager: "OrderFulfillmentManager";
|
|
2419
|
+
readonly OrderManager: "OrderManager";
|
|
2420
|
+
readonly OrderEditor: "OrderEditor";
|
|
2421
|
+
readonly OrderViewer: "OrderViewer";
|
|
2422
|
+
readonly InventoryManager: "InventoryManager";
|
|
2423
|
+
readonly InventoryEditor: "InventoryEditor";
|
|
2424
|
+
readonly InventoryViewer: "InventoryViewer";
|
|
2425
|
+
readonly PaymentManager: "PaymentManager";
|
|
2426
|
+
readonly OnboardingManager: "OnboardingManager";
|
|
2427
|
+
readonly FeatureFlagManager: "FeatureFlagManager";
|
|
2428
|
+
readonly PropertyOwnerMisc: "PropertyOwnerMisc";
|
|
2429
|
+
readonly ManagedOwnerMisc: "ManagedOwnerMisc";
|
|
2430
|
+
readonly IntegratorMisc: "IntegratorMisc";
|
|
2431
|
+
readonly PropertyManagerMisc: "PropertyManagerMisc";
|
|
2432
|
+
readonly FinanceManagerMisc: "FinanceManagerMisc";
|
|
2433
|
+
readonly SupportMisc: "SupportMisc";
|
|
2434
|
+
};
|
|
2435
|
+
export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
|
|
2436
|
+
/**
|
|
2437
|
+
* Successful role revocation response
|
|
2438
|
+
* @export
|
|
2439
|
+
* @interface RevokeRoleSuccessResponse
|
|
2440
|
+
*/
|
|
2441
|
+
export interface RevokeRoleSuccessResponse {
|
|
2442
|
+
/**
|
|
2443
|
+
* Confirmation message
|
|
2444
|
+
* @type {string}
|
|
2445
|
+
* @memberof RevokeRoleSuccessResponse
|
|
2446
|
+
*/
|
|
2447
|
+
'message': string;
|
|
2448
|
+
}
|
|
2449
|
+
/**
|
|
2450
|
+
*
|
|
2451
|
+
* @export
|
|
2452
|
+
* @interface ValidationErrorsInner
|
|
2453
|
+
*/
|
|
2454
|
+
export interface ValidationErrorsInner {
|
|
2455
|
+
/**
|
|
2456
|
+
*
|
|
2457
|
+
* @type {Array<ValidationErrorsInnerPathInner>}
|
|
2458
|
+
* @memberof ValidationErrorsInner
|
|
2459
|
+
*/
|
|
2460
|
+
'path'?: Array<ValidationErrorsInnerPathInner>;
|
|
2461
|
+
/**
|
|
2462
|
+
*
|
|
2463
|
+
* @type {string}
|
|
2464
|
+
* @memberof ValidationErrorsInner
|
|
2465
|
+
*/
|
|
2466
|
+
'message': string;
|
|
2467
|
+
}
|
|
2468
|
+
/**
|
|
2469
|
+
*
|
|
2470
|
+
* @export
|
|
2471
|
+
* @interface ValidationErrorsInnerPathInner
|
|
2472
|
+
*/
|
|
2473
|
+
export interface ValidationErrorsInnerPathInner {
|
|
2474
|
+
}
|
|
2475
|
+
/**
|
|
2476
|
+
* AuthenticationApi - axios parameter creator
|
|
2477
|
+
* @export
|
|
2478
|
+
*/
|
|
2479
|
+
export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2480
|
+
/**
|
|
2481
|
+
* Authenticate and authorize a user to perform an action
|
|
2482
|
+
* @summary Authenticate and authorize Request
|
|
2483
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2484
|
+
* @param {*} [options] Override http request option.
|
|
2485
|
+
* @throws {RequiredError}
|
|
2486
|
+
*/
|
|
2487
|
+
authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2488
|
+
};
|
|
2489
|
+
/**
|
|
2490
|
+
* AuthenticationApi - functional programming interface
|
|
2491
|
+
* @export
|
|
2492
|
+
*/
|
|
2493
|
+
export declare const AuthenticationApiFp: (configuration?: Configuration) => {
|
|
2494
|
+
/**
|
|
1367
2495
|
* Authenticate and authorize a user to perform an action
|
|
1368
2496
|
* @summary Authenticate and authorize Request
|
|
1369
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2497
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1370
2498
|
* @param {*} [options] Override http request option.
|
|
1371
2499
|
* @throws {RequiredError}
|
|
1372
2500
|
*/
|
|
1373
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
2501
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
|
|
1374
2502
|
};
|
|
1375
2503
|
/**
|
|
1376
2504
|
* AuthenticationApi - factory interface
|
|
@@ -1380,11 +2508,11 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
|
|
|
1380
2508
|
/**
|
|
1381
2509
|
* Authenticate and authorize a user to perform an action
|
|
1382
2510
|
* @summary Authenticate and authorize Request
|
|
1383
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2511
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1384
2512
|
* @param {*} [options] Override http request option.
|
|
1385
2513
|
* @throws {RequiredError}
|
|
1386
2514
|
*/
|
|
1387
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
2515
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
|
|
1388
2516
|
};
|
|
1389
2517
|
/**
|
|
1390
2518
|
* AuthenticationApi - object-oriented interface
|
|
@@ -1396,12 +2524,12 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
1396
2524
|
/**
|
|
1397
2525
|
* Authenticate and authorize a user to perform an action
|
|
1398
2526
|
* @summary Authenticate and authorize Request
|
|
1399
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2527
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
1400
2528
|
* @param {*} [options] Override http request option.
|
|
1401
2529
|
* @throws {RequiredError}
|
|
1402
2530
|
* @memberof AuthenticationApi
|
|
1403
2531
|
*/
|
|
1404
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest
|
|
2532
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
1405
2533
|
}
|
|
1406
2534
|
/**
|
|
1407
2535
|
* AuthorizationApi - axios parameter creator
|
|
@@ -1409,13 +2537,21 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
1409
2537
|
*/
|
|
1410
2538
|
export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1411
2539
|
/**
|
|
1412
|
-
* Authenticate and authorize a user to perform an action
|
|
1413
|
-
* @summary Authenticate and authorize Request
|
|
1414
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2540
|
+
* Authenticate and authorize a user to perform an action
|
|
2541
|
+
* @summary Authenticate and authorize Request
|
|
2542
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2543
|
+
* @param {*} [options] Override http request option.
|
|
2544
|
+
* @throws {RequiredError}
|
|
2545
|
+
*/
|
|
2546
|
+
authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2547
|
+
/**
|
|
2548
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
2549
|
+
* @summary Authenticate and Check Is In Role
|
|
2550
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1415
2551
|
* @param {*} [options] Override http request option.
|
|
1416
2552
|
* @throws {RequiredError}
|
|
1417
2553
|
*/
|
|
1418
|
-
|
|
2554
|
+
authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1419
2555
|
/**
|
|
1420
2556
|
* Check if a user is authorized to perform an action
|
|
1421
2557
|
* @summary Authorize Request
|
|
@@ -1424,6 +2560,22 @@ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configu
|
|
|
1424
2560
|
* @throws {RequiredError}
|
|
1425
2561
|
*/
|
|
1426
2562
|
authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2563
|
+
/**
|
|
2564
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
2565
|
+
* @summary Authorize Batch Request
|
|
2566
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
2567
|
+
* @param {*} [options] Override http request option.
|
|
2568
|
+
* @throws {RequiredError}
|
|
2569
|
+
*/
|
|
2570
|
+
authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2571
|
+
/**
|
|
2572
|
+
* Check if a user is in any/all of the roles
|
|
2573
|
+
* @summary Check Is In Role
|
|
2574
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
2575
|
+
* @param {*} [options] Override http request option.
|
|
2576
|
+
* @throws {RequiredError}
|
|
2577
|
+
*/
|
|
2578
|
+
checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1427
2579
|
};
|
|
1428
2580
|
/**
|
|
1429
2581
|
* AuthorizationApi - functional programming interface
|
|
@@ -1433,11 +2585,19 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
|
|
|
1433
2585
|
/**
|
|
1434
2586
|
* Authenticate and authorize a user to perform an action
|
|
1435
2587
|
* @summary Authenticate and authorize Request
|
|
1436
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2588
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2589
|
+
* @param {*} [options] Override http request option.
|
|
2590
|
+
* @throws {RequiredError}
|
|
2591
|
+
*/
|
|
2592
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
|
|
2593
|
+
/**
|
|
2594
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
2595
|
+
* @summary Authenticate and Check Is In Role
|
|
2596
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1437
2597
|
* @param {*} [options] Override http request option.
|
|
1438
2598
|
* @throws {RequiredError}
|
|
1439
2599
|
*/
|
|
1440
|
-
|
|
2600
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>>;
|
|
1441
2601
|
/**
|
|
1442
2602
|
* Check if a user is authorized to perform an action
|
|
1443
2603
|
* @summary Authorize Request
|
|
@@ -1446,6 +2606,22 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
|
|
|
1446
2606
|
* @throws {RequiredError}
|
|
1447
2607
|
*/
|
|
1448
2608
|
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
|
|
2609
|
+
/**
|
|
2610
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
2611
|
+
* @summary Authorize Batch Request
|
|
2612
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
2613
|
+
* @param {*} [options] Override http request option.
|
|
2614
|
+
* @throws {RequiredError}
|
|
2615
|
+
*/
|
|
2616
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>>;
|
|
2617
|
+
/**
|
|
2618
|
+
* Check if a user is in any/all of the roles
|
|
2619
|
+
* @summary Check Is In Role
|
|
2620
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
2621
|
+
* @param {*} [options] Override http request option.
|
|
2622
|
+
* @throws {RequiredError}
|
|
2623
|
+
*/
|
|
2624
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>>;
|
|
1449
2625
|
};
|
|
1450
2626
|
/**
|
|
1451
2627
|
* AuthorizationApi - factory interface
|
|
@@ -1455,11 +2631,19 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
|
|
|
1455
2631
|
/**
|
|
1456
2632
|
* Authenticate and authorize a user to perform an action
|
|
1457
2633
|
* @summary Authenticate and authorize Request
|
|
1458
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2634
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2635
|
+
* @param {*} [options] Override http request option.
|
|
2636
|
+
* @throws {RequiredError}
|
|
2637
|
+
*/
|
|
2638
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
|
|
2639
|
+
/**
|
|
2640
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
2641
|
+
* @summary Authenticate and Check Is In Role
|
|
2642
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1459
2643
|
* @param {*} [options] Override http request option.
|
|
1460
2644
|
* @throws {RequiredError}
|
|
1461
2645
|
*/
|
|
1462
|
-
|
|
2646
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse>;
|
|
1463
2647
|
/**
|
|
1464
2648
|
* Check if a user is authorized to perform an action
|
|
1465
2649
|
* @summary Authorize Request
|
|
@@ -1468,6 +2652,22 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
|
|
|
1468
2652
|
* @throws {RequiredError}
|
|
1469
2653
|
*/
|
|
1470
2654
|
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
|
|
2655
|
+
/**
|
|
2656
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
2657
|
+
* @summary Authorize Batch Request
|
|
2658
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
2659
|
+
* @param {*} [options] Override http request option.
|
|
2660
|
+
* @throws {RequiredError}
|
|
2661
|
+
*/
|
|
2662
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse>;
|
|
2663
|
+
/**
|
|
2664
|
+
* Check if a user is in any/all of the roles
|
|
2665
|
+
* @summary Check Is In Role
|
|
2666
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
2667
|
+
* @param {*} [options] Override http request option.
|
|
2668
|
+
* @throws {RequiredError}
|
|
2669
|
+
*/
|
|
2670
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse>;
|
|
1471
2671
|
};
|
|
1472
2672
|
/**
|
|
1473
2673
|
* AuthorizationApi - object-oriented interface
|
|
@@ -1479,12 +2679,21 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1479
2679
|
/**
|
|
1480
2680
|
* Authenticate and authorize a user to perform an action
|
|
1481
2681
|
* @summary Authenticate and authorize Request
|
|
1482
|
-
* @param {AuthenticateAndAuthorizeRequest}
|
|
2682
|
+
* @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
|
|
2683
|
+
* @param {*} [options] Override http request option.
|
|
2684
|
+
* @throws {RequiredError}
|
|
2685
|
+
* @memberof AuthorizationApi
|
|
2686
|
+
*/
|
|
2687
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
2688
|
+
/**
|
|
2689
|
+
* Authenticate and check if a user is in any/all of the roles
|
|
2690
|
+
* @summary Authenticate and Check Is In Role
|
|
2691
|
+
* @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
|
|
1483
2692
|
* @param {*} [options] Override http request option.
|
|
1484
2693
|
* @throws {RequiredError}
|
|
1485
2694
|
* @memberof AuthorizationApi
|
|
1486
2695
|
*/
|
|
1487
|
-
|
|
2696
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
|
|
1488
2697
|
/**
|
|
1489
2698
|
* Check if a user is authorized to perform an action
|
|
1490
2699
|
* @summary Authorize Request
|
|
@@ -1493,13 +2702,192 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1493
2702
|
* @throws {RequiredError}
|
|
1494
2703
|
* @memberof AuthorizationApi
|
|
1495
2704
|
*/
|
|
1496
|
-
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any>>;
|
|
2705
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}>>;
|
|
2706
|
+
/**
|
|
2707
|
+
* Check if a user is authorized to perform an action on multiple resources
|
|
2708
|
+
* @summary Authorize Batch Request
|
|
2709
|
+
* @param {AuthorizationBatchRequest} [authorizationBatchRequest]
|
|
2710
|
+
* @param {*} [options] Override http request option.
|
|
2711
|
+
* @throws {RequiredError}
|
|
2712
|
+
* @memberof AuthorizationApi
|
|
2713
|
+
*/
|
|
2714
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
|
|
2715
|
+
/**
|
|
2716
|
+
* Check if a user is in any/all of the roles
|
|
2717
|
+
* @summary Check Is In Role
|
|
2718
|
+
* @param {IsInRoleRequest} [isInRoleRequest]
|
|
2719
|
+
* @param {*} [options] Override http request option.
|
|
2720
|
+
* @throws {RequiredError}
|
|
2721
|
+
* @memberof AuthorizationApi
|
|
2722
|
+
*/
|
|
2723
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
|
|
2724
|
+
}
|
|
2725
|
+
/**
|
|
2726
|
+
* AuthorizedEntitiesApi - axios parameter creator
|
|
2727
|
+
* @export
|
|
2728
|
+
*/
|
|
2729
|
+
export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2730
|
+
/**
|
|
2731
|
+
* Get the authorized brands for a given org
|
|
2732
|
+
* @summary Get Authorized Brands
|
|
2733
|
+
* @param {string} orgId
|
|
2734
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2735
|
+
* @param {*} [options] Override http request option.
|
|
2736
|
+
* @throws {RequiredError}
|
|
2737
|
+
*/
|
|
2738
|
+
getAuthorizedBrands: (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2739
|
+
/**
|
|
2740
|
+
* Get the authorized orgs for a given principal
|
|
2741
|
+
* @summary Get Authorized Orgs
|
|
2742
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
2743
|
+
* @param {*} [options] Override http request option.
|
|
2744
|
+
* @throws {RequiredError}
|
|
2745
|
+
*/
|
|
2746
|
+
getAuthorizedOrgs: (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2747
|
+
/**
|
|
2748
|
+
* Get the authorized properties for a given org
|
|
2749
|
+
* @summary Get Authorized Properties
|
|
2750
|
+
* @param {string} orgId
|
|
2751
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
2752
|
+
* @param {*} [options] Override http request option.
|
|
2753
|
+
* @throws {RequiredError}
|
|
2754
|
+
*/
|
|
2755
|
+
getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2756
|
+
};
|
|
2757
|
+
/**
|
|
2758
|
+
* AuthorizedEntitiesApi - functional programming interface
|
|
2759
|
+
* @export
|
|
2760
|
+
*/
|
|
2761
|
+
export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => {
|
|
2762
|
+
/**
|
|
2763
|
+
* Get the authorized brands for a given org
|
|
2764
|
+
* @summary Get Authorized Brands
|
|
2765
|
+
* @param {string} orgId
|
|
2766
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2767
|
+
* @param {*} [options] Override http request option.
|
|
2768
|
+
* @throws {RequiredError}
|
|
2769
|
+
*/
|
|
2770
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>>;
|
|
2771
|
+
/**
|
|
2772
|
+
* Get the authorized orgs for a given principal
|
|
2773
|
+
* @summary Get Authorized Orgs
|
|
2774
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
2775
|
+
* @param {*} [options] Override http request option.
|
|
2776
|
+
* @throws {RequiredError}
|
|
2777
|
+
*/
|
|
2778
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>>;
|
|
2779
|
+
/**
|
|
2780
|
+
* Get the authorized properties for a given org
|
|
2781
|
+
* @summary Get Authorized Properties
|
|
2782
|
+
* @param {string} orgId
|
|
2783
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
2784
|
+
* @param {*} [options] Override http request option.
|
|
2785
|
+
* @throws {RequiredError}
|
|
2786
|
+
*/
|
|
2787
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>>;
|
|
2788
|
+
};
|
|
2789
|
+
/**
|
|
2790
|
+
* AuthorizedEntitiesApi - factory interface
|
|
2791
|
+
* @export
|
|
2792
|
+
*/
|
|
2793
|
+
export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2794
|
+
/**
|
|
2795
|
+
* Get the authorized brands for a given org
|
|
2796
|
+
* @summary Get Authorized Brands
|
|
2797
|
+
* @param {string} orgId
|
|
2798
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2799
|
+
* @param {*} [options] Override http request option.
|
|
2800
|
+
* @throws {RequiredError}
|
|
2801
|
+
*/
|
|
2802
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse>;
|
|
2803
|
+
/**
|
|
2804
|
+
* Get the authorized orgs for a given principal
|
|
2805
|
+
* @summary Get Authorized Orgs
|
|
2806
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
2807
|
+
* @param {*} [options] Override http request option.
|
|
2808
|
+
* @throws {RequiredError}
|
|
2809
|
+
*/
|
|
2810
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse>;
|
|
2811
|
+
/**
|
|
2812
|
+
* Get the authorized properties for a given org
|
|
2813
|
+
* @summary Get Authorized Properties
|
|
2814
|
+
* @param {string} orgId
|
|
2815
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
2816
|
+
* @param {*} [options] Override http request option.
|
|
2817
|
+
* @throws {RequiredError}
|
|
2818
|
+
*/
|
|
2819
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse>;
|
|
2820
|
+
};
|
|
2821
|
+
/**
|
|
2822
|
+
* AuthorizedEntitiesApi - object-oriented interface
|
|
2823
|
+
* @export
|
|
2824
|
+
* @class AuthorizedEntitiesApi
|
|
2825
|
+
* @extends {BaseAPI}
|
|
2826
|
+
*/
|
|
2827
|
+
export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
2828
|
+
/**
|
|
2829
|
+
* Get the authorized brands for a given org
|
|
2830
|
+
* @summary Get Authorized Brands
|
|
2831
|
+
* @param {string} orgId
|
|
2832
|
+
* @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
|
|
2833
|
+
* @param {*} [options] Override http request option.
|
|
2834
|
+
* @throws {RequiredError}
|
|
2835
|
+
* @memberof AuthorizedEntitiesApi
|
|
2836
|
+
*/
|
|
2837
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}>>;
|
|
2838
|
+
/**
|
|
2839
|
+
* Get the authorized orgs for a given principal
|
|
2840
|
+
* @summary Get Authorized Orgs
|
|
2841
|
+
* @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
|
|
2842
|
+
* @param {*} [options] Override http request option.
|
|
2843
|
+
* @throws {RequiredError}
|
|
2844
|
+
* @memberof AuthorizedEntitiesApi
|
|
2845
|
+
*/
|
|
2846
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}>>;
|
|
2847
|
+
/**
|
|
2848
|
+
* Get the authorized properties for a given org
|
|
2849
|
+
* @summary Get Authorized Properties
|
|
2850
|
+
* @param {string} orgId
|
|
2851
|
+
* @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
|
|
2852
|
+
* @param {*} [options] Override http request option.
|
|
2853
|
+
* @throws {RequiredError}
|
|
2854
|
+
* @memberof AuthorizedEntitiesApi
|
|
2855
|
+
*/
|
|
2856
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
|
|
1497
2857
|
}
|
|
1498
2858
|
/**
|
|
1499
|
-
*
|
|
2859
|
+
* ConfigurationDataApi - axios parameter creator
|
|
1500
2860
|
* @export
|
|
1501
2861
|
*/
|
|
1502
|
-
export declare const
|
|
2862
|
+
export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2863
|
+
/**
|
|
2864
|
+
* List the available feature based roles
|
|
2865
|
+
* @summary List Feature Based Roles
|
|
2866
|
+
* @param {*} [options] Override http request option.
|
|
2867
|
+
* @throws {RequiredError}
|
|
2868
|
+
*/
|
|
2869
|
+
configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2870
|
+
/**
|
|
2871
|
+
* List the available permissions
|
|
2872
|
+
* @summary List Permissions
|
|
2873
|
+
* @param {*} [options] Override http request option.
|
|
2874
|
+
* @throws {RequiredError}
|
|
2875
|
+
*/
|
|
2876
|
+
configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2877
|
+
/**
|
|
2878
|
+
* List the available roles
|
|
2879
|
+
* @summary List Roles
|
|
2880
|
+
* @param {*} [options] Override http request option.
|
|
2881
|
+
* @throws {RequiredError}
|
|
2882
|
+
*/
|
|
2883
|
+
configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2884
|
+
/**
|
|
2885
|
+
* List the available feature based roles
|
|
2886
|
+
* @summary List Feature Based Roles
|
|
2887
|
+
* @param {*} [options] Override http request option.
|
|
2888
|
+
* @throws {RequiredError}
|
|
2889
|
+
*/
|
|
2890
|
+
listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1503
2891
|
/**
|
|
1504
2892
|
* List the available permissions
|
|
1505
2893
|
* @summary List Permissions
|
|
@@ -1507,48 +2895,165 @@ export declare const PermissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
1507
2895
|
* @throws {RequiredError}
|
|
1508
2896
|
*/
|
|
1509
2897
|
listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2898
|
+
/**
|
|
2899
|
+
* List the available roles
|
|
2900
|
+
* @summary List Roles
|
|
2901
|
+
* @param {*} [options] Override http request option.
|
|
2902
|
+
* @throws {RequiredError}
|
|
2903
|
+
*/
|
|
2904
|
+
listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1510
2905
|
};
|
|
1511
2906
|
/**
|
|
1512
|
-
*
|
|
2907
|
+
* ConfigurationDataApi - functional programming interface
|
|
1513
2908
|
* @export
|
|
1514
2909
|
*/
|
|
1515
|
-
export declare const
|
|
2910
|
+
export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
|
|
2911
|
+
/**
|
|
2912
|
+
* List the available feature based roles
|
|
2913
|
+
* @summary List Feature Based Roles
|
|
2914
|
+
* @param {*} [options] Override http request option.
|
|
2915
|
+
* @throws {RequiredError}
|
|
2916
|
+
*/
|
|
2917
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
2918
|
+
/**
|
|
2919
|
+
* List the available permissions
|
|
2920
|
+
* @summary List Permissions
|
|
2921
|
+
* @param {*} [options] Override http request option.
|
|
2922
|
+
* @throws {RequiredError}
|
|
2923
|
+
*/
|
|
2924
|
+
configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
|
|
2925
|
+
/**
|
|
2926
|
+
* List the available roles
|
|
2927
|
+
* @summary List Roles
|
|
2928
|
+
* @param {*} [options] Override http request option.
|
|
2929
|
+
* @throws {RequiredError}
|
|
2930
|
+
*/
|
|
2931
|
+
configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
|
|
2932
|
+
/**
|
|
2933
|
+
* List the available feature based roles
|
|
2934
|
+
* @summary List Feature Based Roles
|
|
2935
|
+
* @param {*} [options] Override http request option.
|
|
2936
|
+
* @throws {RequiredError}
|
|
2937
|
+
*/
|
|
2938
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
|
|
1516
2939
|
/**
|
|
1517
2940
|
* List the available permissions
|
|
1518
2941
|
* @summary List Permissions
|
|
1519
2942
|
* @param {*} [options] Override http request option.
|
|
1520
2943
|
* @throws {RequiredError}
|
|
1521
2944
|
*/
|
|
1522
|
-
listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2945
|
+
listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
|
|
2946
|
+
/**
|
|
2947
|
+
* List the available roles
|
|
2948
|
+
* @summary List Roles
|
|
2949
|
+
* @param {*} [options] Override http request option.
|
|
2950
|
+
* @throws {RequiredError}
|
|
2951
|
+
*/
|
|
2952
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
|
|
1523
2953
|
};
|
|
1524
2954
|
/**
|
|
1525
|
-
*
|
|
2955
|
+
* ConfigurationDataApi - factory interface
|
|
1526
2956
|
* @export
|
|
1527
2957
|
*/
|
|
1528
|
-
export declare const
|
|
2958
|
+
export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2959
|
+
/**
|
|
2960
|
+
* List the available feature based roles
|
|
2961
|
+
* @summary List Feature Based Roles
|
|
2962
|
+
* @param {*} [options] Override http request option.
|
|
2963
|
+
* @throws {RequiredError}
|
|
2964
|
+
*/
|
|
2965
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
2966
|
+
/**
|
|
2967
|
+
* List the available permissions
|
|
2968
|
+
* @summary List Permissions
|
|
2969
|
+
* @param {*} [options] Override http request option.
|
|
2970
|
+
* @throws {RequiredError}
|
|
2971
|
+
*/
|
|
2972
|
+
configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
|
|
2973
|
+
/**
|
|
2974
|
+
* List the available roles
|
|
2975
|
+
* @summary List Roles
|
|
2976
|
+
* @param {*} [options] Override http request option.
|
|
2977
|
+
* @throws {RequiredError}
|
|
2978
|
+
*/
|
|
2979
|
+
configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
|
|
2980
|
+
/**
|
|
2981
|
+
* List the available feature based roles
|
|
2982
|
+
* @summary List Feature Based Roles
|
|
2983
|
+
* @param {*} [options] Override http request option.
|
|
2984
|
+
* @throws {RequiredError}
|
|
2985
|
+
*/
|
|
2986
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
|
|
1529
2987
|
/**
|
|
1530
2988
|
* List the available permissions
|
|
1531
2989
|
* @summary List Permissions
|
|
1532
2990
|
* @param {*} [options] Override http request option.
|
|
1533
2991
|
* @throws {RequiredError}
|
|
1534
2992
|
*/
|
|
1535
|
-
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<
|
|
2993
|
+
listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
|
|
2994
|
+
/**
|
|
2995
|
+
* List the available roles
|
|
2996
|
+
* @summary List Roles
|
|
2997
|
+
* @param {*} [options] Override http request option.
|
|
2998
|
+
* @throws {RequiredError}
|
|
2999
|
+
*/
|
|
3000
|
+
listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
|
|
1536
3001
|
};
|
|
1537
3002
|
/**
|
|
1538
|
-
*
|
|
3003
|
+
* ConfigurationDataApi - object-oriented interface
|
|
1539
3004
|
* @export
|
|
1540
|
-
* @class
|
|
3005
|
+
* @class ConfigurationDataApi
|
|
1541
3006
|
* @extends {BaseAPI}
|
|
1542
3007
|
*/
|
|
1543
|
-
export declare class
|
|
3008
|
+
export declare class ConfigurationDataApi extends BaseAPI {
|
|
3009
|
+
/**
|
|
3010
|
+
* List the available feature based roles
|
|
3011
|
+
* @summary List Feature Based Roles
|
|
3012
|
+
* @param {*} [options] Override http request option.
|
|
3013
|
+
* @throws {RequiredError}
|
|
3014
|
+
* @memberof ConfigurationDataApi
|
|
3015
|
+
*/
|
|
3016
|
+
configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
1544
3017
|
/**
|
|
1545
3018
|
* List the available permissions
|
|
1546
3019
|
* @summary List Permissions
|
|
1547
3020
|
* @param {*} [options] Override http request option.
|
|
1548
3021
|
* @throws {RequiredError}
|
|
1549
|
-
* @memberof
|
|
3022
|
+
* @memberof ConfigurationDataApi
|
|
1550
3023
|
*/
|
|
1551
|
-
|
|
3024
|
+
configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
3025
|
+
/**
|
|
3026
|
+
* List the available roles
|
|
3027
|
+
* @summary List Roles
|
|
3028
|
+
* @param {*} [options] Override http request option.
|
|
3029
|
+
* @throws {RequiredError}
|
|
3030
|
+
* @memberof ConfigurationDataApi
|
|
3031
|
+
*/
|
|
3032
|
+
configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
3033
|
+
/**
|
|
3034
|
+
* List the available feature based roles
|
|
3035
|
+
* @summary List Feature Based Roles
|
|
3036
|
+
* @param {*} [options] Override http request option.
|
|
3037
|
+
* @throws {RequiredError}
|
|
3038
|
+
* @memberof ConfigurationDataApi
|
|
3039
|
+
*/
|
|
3040
|
+
listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
|
|
3041
|
+
/**
|
|
3042
|
+
* List the available permissions
|
|
3043
|
+
* @summary List Permissions
|
|
3044
|
+
* @param {*} [options] Override http request option.
|
|
3045
|
+
* @throws {RequiredError}
|
|
3046
|
+
* @memberof ConfigurationDataApi
|
|
3047
|
+
*/
|
|
3048
|
+
listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
3049
|
+
/**
|
|
3050
|
+
* List the available roles
|
|
3051
|
+
* @summary List Roles
|
|
3052
|
+
* @param {*} [options] Override http request option.
|
|
3053
|
+
* @throws {RequiredError}
|
|
3054
|
+
* @memberof ConfigurationDataApi
|
|
3055
|
+
*/
|
|
3056
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
1552
3057
|
}
|
|
1553
3058
|
/**
|
|
1554
3059
|
* RoleAssignmentApi - axios parameter creator
|
|
@@ -1692,7 +3197,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1692
3197
|
* @throws {RequiredError}
|
|
1693
3198
|
* @memberof RoleAssignmentApi
|
|
1694
3199
|
*/
|
|
1695
|
-
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any>>;
|
|
3200
|
+
assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any, {}>>;
|
|
1696
3201
|
/**
|
|
1697
3202
|
* Get the active roles for a given principal
|
|
1698
3203
|
* @summary Get Principal Roles
|
|
@@ -1702,7 +3207,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1702
3207
|
* @throws {RequiredError}
|
|
1703
3208
|
* @memberof RoleAssignmentApi
|
|
1704
3209
|
*/
|
|
1705
|
-
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any>>;
|
|
3210
|
+
getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
|
|
1706
3211
|
/**
|
|
1707
3212
|
* Revokes a forbidden role from a given principal (user, group, etc.)
|
|
1708
3213
|
* @summary Revoke Forbidden Role from Principal
|
|
@@ -1712,7 +3217,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1712
3217
|
* @throws {RequiredError}
|
|
1713
3218
|
* @memberof RoleAssignmentApi
|
|
1714
3219
|
*/
|
|
1715
|
-
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
|
|
3220
|
+
revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
1716
3221
|
/**
|
|
1717
3222
|
* Revokes a specified role from a given principal (user, group, etc.)
|
|
1718
3223
|
* @summary Revoke Role from Principal
|
|
@@ -1722,13 +3227,29 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
1722
3227
|
* @throws {RequiredError}
|
|
1723
3228
|
* @memberof RoleAssignmentApi
|
|
1724
3229
|
*/
|
|
1725
|
-
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
|
|
3230
|
+
revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
|
|
1726
3231
|
}
|
|
1727
3232
|
/**
|
|
1728
3233
|
* UserPermissionsApi - axios parameter creator
|
|
1729
3234
|
* @export
|
|
1730
3235
|
*/
|
|
1731
3236
|
export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3237
|
+
/**
|
|
3238
|
+
* List the available permissions for the current user
|
|
3239
|
+
* @summary List Org Permissions
|
|
3240
|
+
* @param {string} orgId
|
|
3241
|
+
* @param {*} [options] Override http request option.
|
|
3242
|
+
* @throws {RequiredError}
|
|
3243
|
+
*/
|
|
3244
|
+
listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3245
|
+
/**
|
|
3246
|
+
* List the available roles for the current user
|
|
3247
|
+
* @summary List Org Roles
|
|
3248
|
+
* @param {string} orgId
|
|
3249
|
+
* @param {*} [options] Override http request option.
|
|
3250
|
+
* @throws {RequiredError}
|
|
3251
|
+
*/
|
|
3252
|
+
listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1732
3253
|
/**
|
|
1733
3254
|
* List the available permissions for the current user
|
|
1734
3255
|
* @summary List Own Permissions
|
|
@@ -1752,6 +3273,30 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
1752
3273
|
* @export
|
|
1753
3274
|
*/
|
|
1754
3275
|
export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
3276
|
+
/**
|
|
3277
|
+
* List the available permissions for the current user
|
|
3278
|
+
* @summary List Org Permissions
|
|
3279
|
+
* @param {string} orgId
|
|
3280
|
+
* @param {*} [options] Override http request option.
|
|
3281
|
+
* @throws {RequiredError}
|
|
3282
|
+
*/
|
|
3283
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3284
|
+
[key: string]: {
|
|
3285
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3286
|
+
};
|
|
3287
|
+
}>>;
|
|
3288
|
+
/**
|
|
3289
|
+
* List the available roles for the current user
|
|
3290
|
+
* @summary List Org Roles
|
|
3291
|
+
* @param {string} orgId
|
|
3292
|
+
* @param {*} [options] Override http request option.
|
|
3293
|
+
* @throws {RequiredError}
|
|
3294
|
+
*/
|
|
3295
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3296
|
+
[key: string]: {
|
|
3297
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
3298
|
+
};
|
|
3299
|
+
}>>;
|
|
1755
3300
|
/**
|
|
1756
3301
|
* List the available permissions for the current user
|
|
1757
3302
|
* @summary List Own Permissions
|
|
@@ -1775,6 +3320,30 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
|
|
|
1775
3320
|
* @export
|
|
1776
3321
|
*/
|
|
1777
3322
|
export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3323
|
+
/**
|
|
3324
|
+
* List the available permissions for the current user
|
|
3325
|
+
* @summary List Org Permissions
|
|
3326
|
+
* @param {string} orgId
|
|
3327
|
+
* @param {*} [options] Override http request option.
|
|
3328
|
+
* @throws {RequiredError}
|
|
3329
|
+
*/
|
|
3330
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
3331
|
+
[key: string]: {
|
|
3332
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3333
|
+
};
|
|
3334
|
+
}>;
|
|
3335
|
+
/**
|
|
3336
|
+
* List the available roles for the current user
|
|
3337
|
+
* @summary List Org Roles
|
|
3338
|
+
* @param {string} orgId
|
|
3339
|
+
* @param {*} [options] Override http request option.
|
|
3340
|
+
* @throws {RequiredError}
|
|
3341
|
+
*/
|
|
3342
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
3343
|
+
[key: string]: {
|
|
3344
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
3345
|
+
};
|
|
3346
|
+
}>;
|
|
1778
3347
|
/**
|
|
1779
3348
|
* List the available permissions for the current user
|
|
1780
3349
|
* @summary List Own Permissions
|
|
@@ -1800,6 +3369,32 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
|
|
|
1800
3369
|
* @extends {BaseAPI}
|
|
1801
3370
|
*/
|
|
1802
3371
|
export declare class UserPermissionsApi extends BaseAPI {
|
|
3372
|
+
/**
|
|
3373
|
+
* List the available permissions for the current user
|
|
3374
|
+
* @summary List Org Permissions
|
|
3375
|
+
* @param {string} orgId
|
|
3376
|
+
* @param {*} [options] Override http request option.
|
|
3377
|
+
* @throws {RequiredError}
|
|
3378
|
+
* @memberof UserPermissionsApi
|
|
3379
|
+
*/
|
|
3380
|
+
listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
3381
|
+
[key: string]: {
|
|
3382
|
+
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
3383
|
+
};
|
|
3384
|
+
}, any, {}>>;
|
|
3385
|
+
/**
|
|
3386
|
+
* List the available roles for the current user
|
|
3387
|
+
* @summary List Org Roles
|
|
3388
|
+
* @param {string} orgId
|
|
3389
|
+
* @param {*} [options] Override http request option.
|
|
3390
|
+
* @throws {RequiredError}
|
|
3391
|
+
* @memberof UserPermissionsApi
|
|
3392
|
+
*/
|
|
3393
|
+
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
3394
|
+
[key: string]: {
|
|
3395
|
+
[key: string]: ListOrgRolesSuccessResponseValueValue;
|
|
3396
|
+
};
|
|
3397
|
+
}, any, {}>>;
|
|
1803
3398
|
/**
|
|
1804
3399
|
* List the available permissions for the current user
|
|
1805
3400
|
* @summary List Own Permissions
|
|
@@ -1808,7 +3403,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1808
3403
|
* @throws {RequiredError}
|
|
1809
3404
|
* @memberof UserPermissionsApi
|
|
1810
3405
|
*/
|
|
1811
|
-
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
|
|
3406
|
+
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
1812
3407
|
/**
|
|
1813
3408
|
* List the available permissions for a given user
|
|
1814
3409
|
* @summary List User Permissions
|
|
@@ -1818,5 +3413,5 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
1818
3413
|
* @throws {RequiredError}
|
|
1819
3414
|
* @memberof UserPermissionsApi
|
|
1820
3415
|
*/
|
|
1821
|
-
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
|
|
3416
|
+
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
1822
3417
|
}
|