@flipdish/authorization 0.0.2-rc.1756733622 → 0.0.2-rc.1766090571

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -20,7 +20,7 @@ import { BaseAPI } from './base';
20
20
  */
21
21
  export interface AssignRoleRequestBody {
22
22
  /**
23
- * Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
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]: any; }}
143
+ * @type {{ [key: string]: string; }}
138
144
  * @memberof AuthenticateAndAuthorizeRequest
139
145
  */
140
146
  'headers': {
141
- [key: string]: any;
147
+ [key: string]: string;
142
148
  };
143
149
  /**
144
150
  *
@@ -152,7 +158,18 @@ export interface AuthenticateAndAuthorizeRequest {
152
158
  * @memberof AuthenticateAndAuthorizeRequest
153
159
  */
154
160
  'resource'?: AuthorizationRequestResource;
161
+ /**
162
+ * How to check authorisation - any or all of the actions must be allowed
163
+ * @type {string}
164
+ * @memberof AuthenticateAndAuthorizeRequest
165
+ */
166
+ 'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
155
167
  }
168
+ export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: {
169
+ readonly Any: "any";
170
+ readonly All: "all";
171
+ };
172
+ export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
156
173
  /**
157
174
  * Response containing the authentication and authorization decision
158
175
  * @export
@@ -161,10 +178,10 @@ export interface AuthenticateAndAuthorizeRequest {
161
178
  export interface AuthenticateAndAuthorizeResponse {
162
179
  /**
163
180
  *
164
- * @type {AuthenticateAndAuthorizeResponseAuthentication}
181
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
165
182
  * @memberof AuthenticateAndAuthorizeResponse
166
183
  */
167
- 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
184
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
168
185
  /**
169
186
  *
170
187
  * @type {AuthorizationResponse}
@@ -175,486 +192,110 @@ export interface AuthenticateAndAuthorizeResponse {
175
192
  /**
176
193
  *
177
194
  * @export
178
- * @interface AuthenticateAndAuthorizeResponseAuthentication
179
- */
180
- export interface AuthenticateAndAuthorizeResponseAuthentication {
181
- /**
182
- *
183
- * @type {AuthorizationRequestPrincipal}
184
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
185
- */
186
- 'principal': AuthorizationRequestPrincipal;
187
- /**
188
- * Whether the user is authenticated
189
- * @type {boolean}
190
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
191
- */
192
- 'authenticated': boolean;
193
- /**
194
- * The reason for the authentication failure
195
- * @type {string}
196
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
197
- */
198
- 'reason'?: string;
199
- }
200
- /**
201
- * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
202
- * @export
203
- * @interface AuthorizationRequest
204
- */
205
- export interface AuthorizationRequest {
206
- /**
207
- *
208
- * @type {AuthorizationRequestPrincipal}
209
- * @memberof AuthorizationRequest
210
- */
211
- 'principal': AuthorizationRequestPrincipal;
212
- /**
213
- *
214
- * @type {AuthorizationRequestAction}
215
- * @memberof AuthorizationRequest
216
- */
217
- 'action': AuthorizationRequestAction;
218
- /**
219
- *
220
- * @type {AuthorizationRequestResource}
221
- * @memberof AuthorizationRequest
222
- */
223
- 'resource'?: AuthorizationRequestResource;
224
- }
225
- /**
226
- *
227
- * @export
228
- * @interface AuthorizationRequestAction
229
- */
230
- export interface AuthorizationRequestAction {
231
- }
232
- /**
233
- *
234
- * @export
235
- * @interface AuthorizationRequestPrincipal
195
+ * @interface AuthenticateAndCheckIsInRoleRequest
236
196
  */
237
- export interface AuthorizationRequestPrincipal {
238
- /**
239
- *
240
- * @type {string}
241
- * @memberof AuthorizationRequestPrincipal
242
- */
243
- 'type': AuthorizationRequestPrincipalTypeEnum;
244
- /**
245
- *
246
- * @type {string}
247
- * @memberof AuthorizationRequestPrincipal
248
- */
249
- 'id': string;
250
- /**
251
- *
252
- * @type {string}
253
- * @memberof AuthorizationRequestPrincipal
254
- */
255
- 'name'?: string;
256
- /**
257
- *
258
- * @type {string}
259
- * @memberof AuthorizationRequestPrincipal
260
- */
261
- 'email'?: string;
197
+ export interface AuthenticateAndCheckIsInRoleRequest {
262
198
  /**
263
- *
264
- * @type {string}
265
- * @memberof AuthorizationRequestPrincipal
199
+ * Incoming request headers to be used for authentication
200
+ * @type {{ [key: string]: string; }}
201
+ * @memberof AuthenticateAndCheckIsInRoleRequest
266
202
  */
267
- 'phone'?: string;
268
- }
269
- export declare const AuthorizationRequestPrincipalTypeEnum: {
270
- readonly User: "User";
271
- readonly Automation: "Automation";
272
- };
273
- export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
274
- /**
275
- * @type AuthorizationRequestResource
276
- * @export
277
- */
278
- export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
279
- /**
280
- *
281
- * @export
282
- * @interface AuthorizationRequestResourceOneOf
283
- */
284
- export interface AuthorizationRequestResourceOneOf {
203
+ 'headers': {
204
+ [key: string]: string;
205
+ };
285
206
  /**
286
- *
287
- * @type {string}
288
- * @memberof AuthorizationRequestResourceOneOf
207
+ * Array of roles to check if the principal is in
208
+ * @type {Array<string>}
209
+ * @memberof AuthenticateAndCheckIsInRoleRequest
289
210
  */
290
- 'type': AuthorizationRequestResourceOneOfTypeEnum;
211
+ 'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
291
212
  /**
292
213
  *
293
214
  * @type {string}
294
- * @memberof AuthorizationRequestResourceOneOf
215
+ * @memberof AuthenticateAndCheckIsInRoleRequest
295
216
  */
296
- 'id': string;
217
+ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
297
218
  }
298
- export declare const AuthorizationRequestResourceOneOfTypeEnum: {
299
- readonly Property: "Property";
219
+ export declare const AuthenticateAndCheckIsInRoleRequestRolesEnum: {
220
+ readonly Admin: "Admin";
221
+ readonly Factory: "Factory";
300
222
  };
301
- export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
302
- /**
303
- *
304
- * @export
305
- * @interface AuthorizationRequestResourceOneOf1
306
- */
307
- export interface AuthorizationRequestResourceOneOf1 {
308
- /**
309
- *
310
- * @type {string}
311
- * @memberof AuthorizationRequestResourceOneOf1
312
- */
313
- 'type': AuthorizationRequestResourceOneOf1TypeEnum;
314
- /**
315
- *
316
- * @type {string}
317
- * @memberof AuthorizationRequestResourceOneOf1
318
- */
319
- 'id': string;
320
- }
321
- export declare const AuthorizationRequestResourceOneOf1TypeEnum: {
322
- readonly Org: "Org";
223
+ export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
224
+ export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: {
225
+ readonly Any: "any";
226
+ readonly All: "all";
323
227
  };
324
- export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
228
+ export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
325
229
  /**
326
- *
230
+ * Response containing whether the principal is in any/all of the roles
327
231
  * @export
328
- * @interface AuthorizationRequestResourceOneOf2
232
+ * @interface AuthenticateAndCheckIsInRoleResponse
329
233
  */
330
- export interface AuthorizationRequestResourceOneOf2 {
234
+ export interface AuthenticateAndCheckIsInRoleResponse {
331
235
  /**
332
236
  *
333
- * @type {string}
334
- * @memberof AuthorizationRequestResourceOneOf2
237
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
238
+ * @memberof AuthenticateAndCheckIsInRoleResponse
335
239
  */
336
- 'type': AuthorizationRequestResourceOneOf2TypeEnum;
240
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
337
241
  /**
338
- *
339
- * @type {string}
340
- * @memberof AuthorizationRequestResourceOneOf2
242
+ * result of the check - whether the principal is in any/all of the roles
243
+ * @type {boolean}
244
+ * @memberof AuthenticateAndCheckIsInRoleResponse
341
245
  */
342
- 'id': string;
246
+ 'authorized': boolean;
343
247
  }
344
- export declare const AuthorizationRequestResourceOneOf2TypeEnum: {
345
- readonly Brand: "Brand";
346
- };
347
- export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
348
248
  /**
349
249
  *
350
250
  * @export
351
- * @interface AuthorizationRequestResourceOneOf3
251
+ * @interface AuthenticateAndCheckIsInRoleResponseAuthentication
352
252
  */
353
- export interface AuthorizationRequestResourceOneOf3 {
354
- /**
355
- *
356
- * @type {string}
357
- * @memberof AuthorizationRequestResourceOneOf3
358
- */
359
- 'type': AuthorizationRequestResourceOneOf3TypeEnum;
253
+ export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
360
254
  /**
361
255
  *
362
- * @type {string}
363
- * @memberof AuthorizationRequestResourceOneOf3
256
+ * @type {AuthorizationRequestPrincipal}
257
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
364
258
  */
365
- 'id': string;
366
- }
367
- export declare const AuthorizationRequestResourceOneOf3TypeEnum: {
368
- readonly SalesChannel: "SalesChannel";
369
- };
370
- export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
371
- /**
372
- * Response containing the authorization decision
373
- * @export
374
- * @interface AuthorizationResponse
375
- */
376
- export interface AuthorizationResponse {
259
+ 'principal': AuthorizationRequestPrincipal;
377
260
  /**
378
- * Whether the action is allowed
261
+ * Whether the user is authenticated
379
262
  * @type {boolean}
380
- * @memberof AuthorizationResponse
263
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
381
264
  */
382
- 'allowed': boolean;
265
+ 'authenticated': boolean;
383
266
  /**
384
- * The authorization decision
267
+ * The reason for the authentication failure
385
268
  * @type {string}
386
- * @memberof AuthorizationResponse
387
- */
388
- 'decision': string;
389
- /**
390
- * The policy IDs that were used to make the decision
391
- * @type {Array<string>}
392
- * @memberof AuthorizationResponse
269
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
393
270
  */
394
- 'policyIds': Array<string>;
271
+ 'reason'?: string;
395
272
  }
396
273
  /**
397
274
  *
398
275
  * @export
399
- * @interface ErrorResponse
400
- */
401
- export interface ErrorResponse {
402
- /**
403
- *
404
- * @type {string}
405
- * @memberof ErrorResponse
406
- */
407
- 'message': string;
408
- }
409
- /**
410
- * Successful permissions retrieval response
411
- * @export
412
- * @interface GetPermissionsSuccessResponse
413
- */
414
- export interface GetPermissionsSuccessResponse {
415
- /**
416
- *
417
- * @type {Permissions & Array<string>}
418
- * @memberof GetPermissionsSuccessResponse
419
- */
420
- 'permissions': Permissions & Array<string>;
421
- }
422
- /**
423
- * Details for getting roles for a principal
424
- * @export
425
- * @interface GetPrincipalRolesRequestBody
276
+ * @interface AuthorizationBatchRequest
426
277
  */
427
- export interface GetPrincipalRolesRequestBody {
278
+ export interface AuthorizationBatchRequest {
428
279
  /**
429
280
  *
430
281
  * @type {AuthorizationRequestPrincipal}
431
- * @memberof GetPrincipalRolesRequestBody
282
+ * @memberof AuthorizationBatchRequest
432
283
  */
433
284
  'principal': AuthorizationRequestPrincipal;
434
285
  /**
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
286
+ * The action to check authorisation for
462
287
  * @type {string}
463
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
288
+ * @memberof AuthorizationBatchRequest
464
289
  */
465
- 'policyId': string;
290
+ 'action': AuthorizationBatchRequestActionEnum;
466
291
  /**
467
- * Role name
468
- * @type {string}
469
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
292
+ * Array of resources to check authorisation for
293
+ * @type {Array<AuthorizationRequestResource>}
294
+ * @memberof AuthorizationBatchRequest
470
295
  */
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
500
- */
501
- 'propertyId'?: string;
502
- /**
503
- * Brand ID this role is scoped to
504
- * @type {string}
505
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
506
- */
507
- 'brandId'?: string;
508
- /**
509
- * Sales channel ID this role is scoped to
510
- * @type {string}
511
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
512
- */
513
- 'salesChannelId'?: string;
514
- }
515
- export declare const GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum: {
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>;
296
+ 'resources': Array<AuthorizationRequestResource>;
609
297
  }
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: {
298
+ export declare const AuthorizationBatchRequestActionEnum: {
658
299
  readonly AnyAuditLogs: "AnyAuditLogs";
659
300
  readonly ViewApp: "ViewApp";
660
301
  readonly CreateApp: "CreateApp";
@@ -879,76 +520,331 @@ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsE
879
520
  readonly CreateOrg: "CreateOrg";
880
521
  readonly EditOrg: "EditOrg";
881
522
  readonly ViewOrg: "ViewOrg";
523
+ readonly ViewWebhooks: "ViewWebhooks";
524
+ readonly EditWebhooks: "EditWebhooks";
525
+ readonly RoleAdmin: "RoleAdmin";
526
+ readonly RoleFactory: "RoleFactory";
882
527
  };
883
- export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
528
+ export type AuthorizationBatchRequestActionEnum = typeof AuthorizationBatchRequestActionEnum[keyof typeof AuthorizationBatchRequestActionEnum];
884
529
  /**
885
- * ID of the resource the permissions are assigned to
530
+ *
886
531
  * @export
887
- * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
532
+ * @interface AuthorizationBatchResponse
888
533
  */
889
- export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
534
+ export interface AuthorizationBatchResponse {
535
+ /**
536
+ * Array of allowed resources
537
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
538
+ * @memberof AuthorizationBatchResponse
539
+ */
540
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
541
+ /**
542
+ * Array of denied resources
543
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
544
+ * @memberof AuthorizationBatchResponse
545
+ */
546
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
890
547
  }
891
548
  /**
892
549
  *
893
550
  * @export
894
- * @interface OrgPathParam
551
+ * @interface AuthorizationBatchResponseAllowedResourcesInner
895
552
  */
896
- export interface OrgPathParam {
553
+ export interface AuthorizationBatchResponseAllowedResourcesInner {
897
554
  /**
898
- *
555
+ * The authorization decision
899
556
  * @type {string}
900
- * @memberof OrgPathParam
557
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
901
558
  */
902
- 'orgId': string;
559
+ 'decision': string;
560
+ /**
561
+ * Whether the action is allowed
562
+ * @type {boolean}
563
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
564
+ */
565
+ 'allowed': boolean;
566
+ /**
567
+ * The policy IDs that were used to make the decision
568
+ * @type {Array<string>}
569
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
570
+ */
571
+ 'policyIds': Array<string>;
572
+ /**
573
+ *
574
+ * @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
575
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
576
+ */
577
+ 'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
903
578
  }
904
579
  /**
905
- *
580
+ * @type AuthorizationBatchResponseAllowedResourcesInnerResource
581
+ * Resource that the action was checked for
582
+ * @export
583
+ */
584
+ export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
585
+ /**
586
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on the checkMode - any or all of the permissions must be allowed).
906
587
  * @export
907
- * @interface PathParams
588
+ * @interface AuthorizationRequest
908
589
  */
909
- export interface PathParams {
590
+ export interface AuthorizationRequest {
910
591
  /**
911
592
  *
912
- * @type {string}
913
- * @memberof PathParams
593
+ * @type {AuthorizationRequestPrincipal}
594
+ * @memberof AuthorizationRequest
914
595
  */
915
- 'orgId': string;
596
+ 'principal': AuthorizationRequestPrincipal;
597
+ /**
598
+ *
599
+ * @type {AuthorizationRequestAction}
600
+ * @memberof AuthorizationRequest
601
+ */
602
+ 'action': AuthorizationRequestAction;
916
603
  /**
917
604
  *
605
+ * @type {AuthorizationRequestResource}
606
+ * @memberof AuthorizationRequest
607
+ */
608
+ 'resource'?: AuthorizationRequestResource;
609
+ /**
610
+ * How to check authorisation - any or all of the actions must be allowed
918
611
  * @type {string}
919
- * @memberof PathParams
612
+ * @memberof AuthorizationRequest
920
613
  */
921
- 'userId': string;
614
+ 'checkMode'?: AuthorizationRequestCheckModeEnum;
615
+ }
616
+ export declare const AuthorizationRequestCheckModeEnum: {
617
+ readonly Any: "any";
618
+ readonly All: "all";
619
+ };
620
+ export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
621
+ /**
622
+ * Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
623
+ * @export
624
+ * @interface AuthorizationRequestAction
625
+ */
626
+ export interface AuthorizationRequestAction {
922
627
  }
923
628
  /**
924
629
  *
925
630
  * @export
926
- * @enum {string}
631
+ * @interface AuthorizationRequestPrincipal
927
632
  */
928
- export declare const Permissions: {
929
- readonly AnyAuditLogs: "AnyAuditLogs";
930
- readonly ViewApp: "ViewApp";
931
- readonly CreateApp: "CreateApp";
932
- readonly UpdateApp: "UpdateApp";
933
- readonly ViewAppName: "ViewAppName";
934
- readonly EditAppAssets: "EditAppAssets";
935
- readonly EditAppFeatures: "EditAppFeatures";
936
- readonly ViewTeammates: "ViewTeammates";
937
- readonly EditTeammates: "EditTeammates";
938
- readonly CreateTeammateOwner: "CreateTeammateOwner";
939
- readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
940
- readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
941
- readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
942
- readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
943
- readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
944
- readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
945
- readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
946
- readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
947
- readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
948
- readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
949
- readonly ViewApmConfigurations: "ViewApmConfigurations";
950
- readonly EditApmConfigurations: "EditApmConfigurations";
951
- readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
633
+ export interface AuthorizationRequestPrincipal {
634
+ /**
635
+ *
636
+ * @type {string}
637
+ * @memberof AuthorizationRequestPrincipal
638
+ */
639
+ 'type': AuthorizationRequestPrincipalTypeEnum;
640
+ /**
641
+ *
642
+ * @type {string}
643
+ * @memberof AuthorizationRequestPrincipal
644
+ */
645
+ 'id': string;
646
+ /**
647
+ *
648
+ * @type {string}
649
+ * @memberof AuthorizationRequestPrincipal
650
+ */
651
+ 'name'?: string;
652
+ /**
653
+ *
654
+ * @type {string}
655
+ * @memberof AuthorizationRequestPrincipal
656
+ */
657
+ 'email'?: string;
658
+ /**
659
+ *
660
+ * @type {string}
661
+ * @memberof AuthorizationRequestPrincipal
662
+ */
663
+ 'phone'?: string;
664
+ }
665
+ export declare const AuthorizationRequestPrincipalTypeEnum: {
666
+ readonly User: "User";
667
+ readonly Automation: "Automation";
668
+ };
669
+ export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
670
+ /**
671
+ * @type AuthorizationRequestResource
672
+ * @export
673
+ */
674
+ export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
675
+ /**
676
+ *
677
+ * @export
678
+ * @interface AuthorizationRequestResourceOneOf
679
+ */
680
+ export interface AuthorizationRequestResourceOneOf {
681
+ /**
682
+ *
683
+ * @type {string}
684
+ * @memberof AuthorizationRequestResourceOneOf
685
+ */
686
+ 'type': AuthorizationRequestResourceOneOfTypeEnum;
687
+ /**
688
+ *
689
+ * @type {string}
690
+ * @memberof AuthorizationRequestResourceOneOf
691
+ */
692
+ 'id': string;
693
+ }
694
+ export declare const AuthorizationRequestResourceOneOfTypeEnum: {
695
+ readonly Property: "Property";
696
+ };
697
+ export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
698
+ /**
699
+ *
700
+ * @export
701
+ * @interface AuthorizationRequestResourceOneOf1
702
+ */
703
+ export interface AuthorizationRequestResourceOneOf1 {
704
+ /**
705
+ *
706
+ * @type {string}
707
+ * @memberof AuthorizationRequestResourceOneOf1
708
+ */
709
+ 'type': AuthorizationRequestResourceOneOf1TypeEnum;
710
+ /**
711
+ *
712
+ * @type {string}
713
+ * @memberof AuthorizationRequestResourceOneOf1
714
+ */
715
+ 'id': string;
716
+ }
717
+ export declare const AuthorizationRequestResourceOneOf1TypeEnum: {
718
+ readonly Org: "Org";
719
+ };
720
+ export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
721
+ /**
722
+ *
723
+ * @export
724
+ * @interface AuthorizationRequestResourceOneOf2
725
+ */
726
+ export interface AuthorizationRequestResourceOneOf2 {
727
+ /**
728
+ *
729
+ * @type {string}
730
+ * @memberof AuthorizationRequestResourceOneOf2
731
+ */
732
+ 'type': AuthorizationRequestResourceOneOf2TypeEnum;
733
+ /**
734
+ *
735
+ * @type {string}
736
+ * @memberof AuthorizationRequestResourceOneOf2
737
+ */
738
+ 'id': string;
739
+ }
740
+ export declare const AuthorizationRequestResourceOneOf2TypeEnum: {
741
+ readonly Brand: "Brand";
742
+ };
743
+ export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
744
+ /**
745
+ *
746
+ * @export
747
+ * @interface AuthorizationRequestResourceOneOf3
748
+ */
749
+ export interface AuthorizationRequestResourceOneOf3 {
750
+ /**
751
+ *
752
+ * @type {string}
753
+ * @memberof AuthorizationRequestResourceOneOf3
754
+ */
755
+ 'type': AuthorizationRequestResourceOneOf3TypeEnum;
756
+ /**
757
+ *
758
+ * @type {string}
759
+ * @memberof AuthorizationRequestResourceOneOf3
760
+ */
761
+ 'id': string;
762
+ }
763
+ export declare const AuthorizationRequestResourceOneOf3TypeEnum: {
764
+ readonly SalesChannel: "SalesChannel";
765
+ };
766
+ export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
767
+ /**
768
+ * Response containing the authorization decision
769
+ * @export
770
+ * @interface AuthorizationResponse
771
+ */
772
+ export interface AuthorizationResponse {
773
+ /**
774
+ * Whether the action is allowed
775
+ * @type {boolean}
776
+ * @memberof AuthorizationResponse
777
+ */
778
+ 'allowed': boolean;
779
+ /**
780
+ * The authorization decision
781
+ * @type {string}
782
+ * @memberof AuthorizationResponse
783
+ */
784
+ 'decision': string;
785
+ /**
786
+ * The policy IDs that were used to make the decision
787
+ * @type {Array<string>}
788
+ * @memberof AuthorizationResponse
789
+ */
790
+ 'policyIds': Array<string>;
791
+ }
792
+ /**
793
+ *
794
+ * @export
795
+ * @interface ErrorResponse
796
+ */
797
+ export interface ErrorResponse {
798
+ /**
799
+ *
800
+ * @type {string}
801
+ * @memberof ErrorResponse
802
+ */
803
+ 'message': string;
804
+ }
805
+ /**
806
+ * Feature based role and its permissions
807
+ * @export
808
+ * @interface FeatureBasedRole
809
+ */
810
+ export interface FeatureBasedRole {
811
+ /**
812
+ * Name of the role
813
+ * @type {string}
814
+ * @memberof FeatureBasedRole
815
+ */
816
+ 'name': string;
817
+ /**
818
+ * List of permissions
819
+ * @type {Array<string>}
820
+ * @memberof FeatureBasedRole
821
+ */
822
+ 'permissions': Array<FeatureBasedRolePermissionsEnum>;
823
+ }
824
+ export declare const FeatureBasedRolePermissionsEnum: {
825
+ readonly AnyAuditLogs: "AnyAuditLogs";
826
+ readonly ViewApp: "ViewApp";
827
+ readonly CreateApp: "CreateApp";
828
+ readonly UpdateApp: "UpdateApp";
829
+ readonly ViewAppName: "ViewAppName";
830
+ readonly EditAppAssets: "EditAppAssets";
831
+ readonly EditAppFeatures: "EditAppFeatures";
832
+ readonly ViewTeammates: "ViewTeammates";
833
+ readonly EditTeammates: "EditTeammates";
834
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
835
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
836
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
837
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
838
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
839
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
840
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
841
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
842
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
843
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
844
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
845
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
846
+ readonly EditApmConfigurations: "EditApmConfigurations";
847
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
952
848
  readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
953
849
  readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
954
850
  readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
@@ -1150,68 +1046,1817 @@ export declare const Permissions: {
1150
1046
  readonly CreateOrg: "CreateOrg";
1151
1047
  readonly EditOrg: "EditOrg";
1152
1048
  readonly ViewOrg: "ViewOrg";
1049
+ readonly ViewWebhooks: "ViewWebhooks";
1050
+ readonly EditWebhooks: "EditWebhooks";
1051
+ readonly RoleAdmin: "RoleAdmin";
1052
+ readonly RoleFactory: "RoleFactory";
1153
1053
  };
1154
- export type Permissions = typeof Permissions[keyof typeof Permissions];
1155
- /**
1156
- * Details for revoking a forbidden role from a principal
1157
- * @export
1158
- * @interface RevokeForbiddenRoleRequestBody
1159
- */
1160
- export interface RevokeForbiddenRoleRequestBody {
1161
- /**
1162
- *
1163
- * @type {AuthorizationRequestPrincipal}
1164
- * @memberof RevokeForbiddenRoleRequestBody
1165
- */
1166
- 'principal': AuthorizationRequestPrincipal;
1167
- /**
1168
- * Compensation role to revoke the forbidden role from
1169
- * @type {string}
1170
- * @memberof RevokeForbiddenRoleRequestBody
1171
- */
1172
- 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
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];
1054
+ export type FeatureBasedRolePermissionsEnum = typeof FeatureBasedRolePermissionsEnum[keyof typeof FeatureBasedRolePermissionsEnum];
1183
1055
  /**
1184
- * Details for revoking a role from a principal
1056
+ * 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.
1185
1057
  * @export
1186
- * @interface RevokeRoleRequestBody
1058
+ * @interface GetAuthorizedBrandsRequest
1187
1059
  */
1188
- export interface RevokeRoleRequestBody {
1189
- /**
1190
- * Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
1191
- * @type {string}
1192
- * @memberof RevokeRoleRequestBody
1193
- */
1194
- 'role': RevokeRoleRequestBodyRoleEnum;
1060
+ export interface GetAuthorizedBrandsRequest {
1195
1061
  /**
1196
1062
  *
1197
- * @type {AuthorizationRequestResource}
1198
- * @memberof RevokeRoleRequestBody
1063
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1064
+ * @memberof GetAuthorizedBrandsRequest
1199
1065
  */
1200
- 'resource': AuthorizationRequestResource;
1066
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1201
1067
  /**
1202
- *
1203
- * @type {AuthorizationRequestPrincipal}
1204
- * @memberof RevokeRoleRequestBody
1068
+ * Incoming request headers to be used for authentication
1069
+ * @type {{ [key: string]: string; }}
1070
+ * @memberof GetAuthorizedBrandsRequest
1205
1071
  */
1206
- 'principal': AuthorizationRequestPrincipal;
1072
+ 'headers'?: {
1073
+ [key: string]: string;
1074
+ };
1207
1075
  /**
1208
- *
1076
+ * The action to check authorisation for
1209
1077
  * @type {string}
1210
- * @memberof RevokeRoleRequestBody
1078
+ * @memberof GetAuthorizedBrandsRequest
1211
1079
  */
1212
- 'brandId': string;
1080
+ 'action': GetAuthorizedBrandsRequestActionEnum;
1213
1081
  }
1214
- export declare const RevokeRoleRequestBodyRoleEnum: {
1082
+ export declare const GetAuthorizedBrandsRequestActionEnum: {
1083
+ readonly AnyAuditLogs: "AnyAuditLogs";
1084
+ readonly ViewApp: "ViewApp";
1085
+ readonly CreateApp: "CreateApp";
1086
+ readonly UpdateApp: "UpdateApp";
1087
+ readonly ViewAppName: "ViewAppName";
1088
+ readonly EditAppAssets: "EditAppAssets";
1089
+ readonly EditAppFeatures: "EditAppFeatures";
1090
+ readonly ViewTeammates: "ViewTeammates";
1091
+ readonly EditTeammates: "EditTeammates";
1092
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1093
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1094
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1095
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1096
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1097
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1098
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1099
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1100
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1101
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1102
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1103
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1104
+ readonly EditApmConfigurations: "EditApmConfigurations";
1105
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1106
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1107
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1108
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1109
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1110
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1111
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1112
+ readonly ViewOrders: "ViewOrders";
1113
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1114
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1115
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1116
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1117
+ readonly ViewStores: "ViewStores";
1118
+ readonly CreateStores: "CreateStores";
1119
+ readonly EditStores: "EditStores";
1120
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1121
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1122
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1123
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1124
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1125
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1126
+ readonly UpdateStoresName: "UpdateStoresName";
1127
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1128
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1129
+ readonly EditStoreNotifications: "EditStoreNotifications";
1130
+ readonly ArchiveStores: "ArchiveStores";
1131
+ readonly PublishStores: "PublishStores";
1132
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1133
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1134
+ readonly ViewStoreGroups: "ViewStoreGroups";
1135
+ readonly CreateStoreGroups: "CreateStoreGroups";
1136
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1137
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1138
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1139
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1140
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1141
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1142
+ readonly ViewMenu: "ViewMenu";
1143
+ readonly CreateMenu: "CreateMenu";
1144
+ readonly UpdateMenu: "UpdateMenu";
1145
+ readonly DeleteMenu: "DeleteMenu";
1146
+ readonly UpdateMenuLock: "UpdateMenuLock";
1147
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1148
+ readonly EditMenuImage: "EditMenuImage";
1149
+ readonly ViewVouchers: "ViewVouchers";
1150
+ readonly EditVouchers: "EditVouchers";
1151
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1152
+ readonly EditWebsiteContent: "EditWebsiteContent";
1153
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1154
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1155
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1156
+ readonly ViewBankAccounts: "ViewBankAccounts";
1157
+ readonly CreateBankAccounts: "CreateBankAccounts";
1158
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1159
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1160
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1161
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1162
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1163
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1164
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1165
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1166
+ readonly ViewHydraConfig: "ViewHydraConfig";
1167
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1168
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1169
+ readonly DeleteTerminal: "DeleteTerminal";
1170
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1171
+ readonly ViewCustomers: "ViewCustomers";
1172
+ readonly EditCustomers: "EditCustomers";
1173
+ readonly CreateCustomers: "CreateCustomers";
1174
+ readonly CreateCatalogElements: "CreateCatalogElements";
1175
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1176
+ readonly ViewCatalogElements: "ViewCatalogElements";
1177
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1178
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1179
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1180
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1181
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1182
+ readonly UpdateMetafields: "UpdateMetafields";
1183
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1184
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1185
+ readonly ViewAppStatistics: "ViewAppStatistics";
1186
+ readonly ViewApmStatistics: "ViewApmStatistics";
1187
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1188
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1189
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1190
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1191
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1192
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1193
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1194
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1195
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1196
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1197
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1198
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1199
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1200
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1201
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1202
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1203
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1204
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1205
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1206
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1207
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1208
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1209
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1210
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1211
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1212
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1213
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1214
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1215
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1216
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1217
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1218
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1219
+ readonly InviteDriverToApp: "InviteDriverToApp";
1220
+ readonly GetDriverForApp: "GetDriverForApp";
1221
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1222
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1223
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1224
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1225
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1226
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1227
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1228
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1229
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1230
+ readonly ViewPayouts: "ViewPayouts";
1231
+ readonly ViewChannels: "ViewChannels";
1232
+ readonly ViewOnboarding: "ViewOnboarding";
1233
+ readonly UpdateOnboarding: "UpdateOnboarding";
1234
+ readonly ViewClientDevices: "ViewClientDevices";
1235
+ readonly UpdateClientDevices: "UpdateClientDevices";
1236
+ readonly EnrollClientDevices: "EnrollClientDevices";
1237
+ readonly AssignClientDevices: "AssignClientDevices";
1238
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1239
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1240
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1241
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1242
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1243
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1244
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1245
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1246
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1247
+ readonly ViewSalesChannels: "ViewSalesChannels";
1248
+ readonly EditSalesChannels: "EditSalesChannels";
1249
+ readonly CreateSalesChannel: "CreateSalesChannel";
1250
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1251
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1252
+ readonly PublishSalesChannel: "PublishSalesChannel";
1253
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1254
+ readonly CloneSalesChannel: "CloneSalesChannel";
1255
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1256
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1257
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1258
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1259
+ readonly ViewSubscriptions: "ViewSubscriptions";
1260
+ readonly ViewInvoices: "ViewInvoices";
1261
+ readonly EditAccountsBills: "EditAccountsBills";
1262
+ readonly ViewAccountsBills: "ViewAccountsBills";
1263
+ readonly EditAccountsCategories: "EditAccountsCategories";
1264
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1265
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1266
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1267
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1268
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1269
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1270
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1271
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1272
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1273
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1274
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1275
+ readonly ViewInventoryReports: "ViewInventoryReports";
1276
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1277
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1278
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1279
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1280
+ readonly EditInventorySupplier: "EditInventorySupplier";
1281
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1282
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1283
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1284
+ readonly ViewPayrollReports: "ViewPayrollReports";
1285
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1286
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1287
+ readonly EditPayrollRota: "EditPayrollRota";
1288
+ readonly ViewPayrollRota: "ViewPayrollRota";
1289
+ readonly EditPayrollStaff: "EditPayrollStaff";
1290
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1291
+ readonly ViewSalesReports: "ViewSalesReports";
1292
+ readonly ViewCostReports: "ViewCostReports";
1293
+ readonly ViewMenuReports: "ViewMenuReports";
1294
+ readonly ViewBrand: "ViewBrand";
1295
+ readonly EditBrand: "EditBrand";
1296
+ readonly CreateBrand: "CreateBrand";
1297
+ readonly TransferBrand: "TransferBrand";
1298
+ readonly ViewProperty: "ViewProperty";
1299
+ readonly EditProperty: "EditProperty";
1300
+ readonly CreateProperty: "CreateProperty";
1301
+ readonly ArchiveProperty: "ArchiveProperty";
1302
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1303
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1304
+ readonly CreateOrg: "CreateOrg";
1305
+ readonly EditOrg: "EditOrg";
1306
+ readonly ViewOrg: "ViewOrg";
1307
+ readonly ViewWebhooks: "ViewWebhooks";
1308
+ readonly EditWebhooks: "EditWebhooks";
1309
+ readonly RoleAdmin: "RoleAdmin";
1310
+ readonly RoleFactory: "RoleFactory";
1311
+ };
1312
+ export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
1313
+ /**
1314
+ * Response containing the authorized brands
1315
+ * @export
1316
+ * @interface GetAuthorizedBrandsResponse
1317
+ */
1318
+ export interface GetAuthorizedBrandsResponse {
1319
+ /**
1320
+ * Array of allowed resources
1321
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1322
+ * @memberof GetAuthorizedBrandsResponse
1323
+ */
1324
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1325
+ /**
1326
+ * Array of denied resources
1327
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1328
+ * @memberof GetAuthorizedBrandsResponse
1329
+ */
1330
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1331
+ }
1332
+ /**
1333
+ * 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.
1334
+ * @export
1335
+ * @interface GetAuthorizedOrgsRequest
1336
+ */
1337
+ export interface GetAuthorizedOrgsRequest {
1338
+ /**
1339
+ *
1340
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1341
+ * @memberof GetAuthorizedOrgsRequest
1342
+ */
1343
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1344
+ /**
1345
+ * Incoming request headers to be used for authentication
1346
+ * @type {{ [key: string]: string; }}
1347
+ * @memberof GetAuthorizedOrgsRequest
1348
+ */
1349
+ 'headers'?: {
1350
+ [key: string]: string;
1351
+ };
1352
+ /**
1353
+ * The action to check authorisation for
1354
+ * @type {string}
1355
+ * @memberof GetAuthorizedOrgsRequest
1356
+ */
1357
+ 'action': GetAuthorizedOrgsRequestActionEnum;
1358
+ }
1359
+ export declare const GetAuthorizedOrgsRequestActionEnum: {
1360
+ readonly AnyAuditLogs: "AnyAuditLogs";
1361
+ readonly ViewApp: "ViewApp";
1362
+ readonly CreateApp: "CreateApp";
1363
+ readonly UpdateApp: "UpdateApp";
1364
+ readonly ViewAppName: "ViewAppName";
1365
+ readonly EditAppAssets: "EditAppAssets";
1366
+ readonly EditAppFeatures: "EditAppFeatures";
1367
+ readonly ViewTeammates: "ViewTeammates";
1368
+ readonly EditTeammates: "EditTeammates";
1369
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1370
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1371
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1372
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1373
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1374
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1375
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1376
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1377
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1378
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1379
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1380
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1381
+ readonly EditApmConfigurations: "EditApmConfigurations";
1382
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1383
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1384
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1385
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1386
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1387
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1388
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1389
+ readonly ViewOrders: "ViewOrders";
1390
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1391
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1392
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1393
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1394
+ readonly ViewStores: "ViewStores";
1395
+ readonly CreateStores: "CreateStores";
1396
+ readonly EditStores: "EditStores";
1397
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1398
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1399
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1400
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1401
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1402
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1403
+ readonly UpdateStoresName: "UpdateStoresName";
1404
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1405
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1406
+ readonly EditStoreNotifications: "EditStoreNotifications";
1407
+ readonly ArchiveStores: "ArchiveStores";
1408
+ readonly PublishStores: "PublishStores";
1409
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1410
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1411
+ readonly ViewStoreGroups: "ViewStoreGroups";
1412
+ readonly CreateStoreGroups: "CreateStoreGroups";
1413
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1414
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1415
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1416
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1417
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1418
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1419
+ readonly ViewMenu: "ViewMenu";
1420
+ readonly CreateMenu: "CreateMenu";
1421
+ readonly UpdateMenu: "UpdateMenu";
1422
+ readonly DeleteMenu: "DeleteMenu";
1423
+ readonly UpdateMenuLock: "UpdateMenuLock";
1424
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1425
+ readonly EditMenuImage: "EditMenuImage";
1426
+ readonly ViewVouchers: "ViewVouchers";
1427
+ readonly EditVouchers: "EditVouchers";
1428
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1429
+ readonly EditWebsiteContent: "EditWebsiteContent";
1430
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1431
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1432
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1433
+ readonly ViewBankAccounts: "ViewBankAccounts";
1434
+ readonly CreateBankAccounts: "CreateBankAccounts";
1435
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1436
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1437
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1438
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1439
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1440
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1441
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1442
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1443
+ readonly ViewHydraConfig: "ViewHydraConfig";
1444
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1445
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1446
+ readonly DeleteTerminal: "DeleteTerminal";
1447
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1448
+ readonly ViewCustomers: "ViewCustomers";
1449
+ readonly EditCustomers: "EditCustomers";
1450
+ readonly CreateCustomers: "CreateCustomers";
1451
+ readonly CreateCatalogElements: "CreateCatalogElements";
1452
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1453
+ readonly ViewCatalogElements: "ViewCatalogElements";
1454
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1455
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1456
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1457
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1458
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1459
+ readonly UpdateMetafields: "UpdateMetafields";
1460
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1461
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1462
+ readonly ViewAppStatistics: "ViewAppStatistics";
1463
+ readonly ViewApmStatistics: "ViewApmStatistics";
1464
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1465
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1466
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1467
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1468
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1469
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1470
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1471
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1472
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1473
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1474
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1475
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1476
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1477
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1478
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1479
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1480
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1481
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1482
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1483
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1484
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1485
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1486
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1487
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1488
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1489
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1490
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1491
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1492
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1493
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1494
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1495
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1496
+ readonly InviteDriverToApp: "InviteDriverToApp";
1497
+ readonly GetDriverForApp: "GetDriverForApp";
1498
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1499
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1500
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1501
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1502
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1503
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1504
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1505
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1506
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1507
+ readonly ViewPayouts: "ViewPayouts";
1508
+ readonly ViewChannels: "ViewChannels";
1509
+ readonly ViewOnboarding: "ViewOnboarding";
1510
+ readonly UpdateOnboarding: "UpdateOnboarding";
1511
+ readonly ViewClientDevices: "ViewClientDevices";
1512
+ readonly UpdateClientDevices: "UpdateClientDevices";
1513
+ readonly EnrollClientDevices: "EnrollClientDevices";
1514
+ readonly AssignClientDevices: "AssignClientDevices";
1515
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1516
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1517
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1518
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1519
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1520
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1521
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1522
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1523
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1524
+ readonly ViewSalesChannels: "ViewSalesChannels";
1525
+ readonly EditSalesChannels: "EditSalesChannels";
1526
+ readonly CreateSalesChannel: "CreateSalesChannel";
1527
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1528
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1529
+ readonly PublishSalesChannel: "PublishSalesChannel";
1530
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1531
+ readonly CloneSalesChannel: "CloneSalesChannel";
1532
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1533
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1534
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1535
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1536
+ readonly ViewSubscriptions: "ViewSubscriptions";
1537
+ readonly ViewInvoices: "ViewInvoices";
1538
+ readonly EditAccountsBills: "EditAccountsBills";
1539
+ readonly ViewAccountsBills: "ViewAccountsBills";
1540
+ readonly EditAccountsCategories: "EditAccountsCategories";
1541
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1542
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1543
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1544
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1545
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1546
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1547
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1548
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1549
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1550
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1551
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1552
+ readonly ViewInventoryReports: "ViewInventoryReports";
1553
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1554
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1555
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1556
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1557
+ readonly EditInventorySupplier: "EditInventorySupplier";
1558
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1559
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1560
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1561
+ readonly ViewPayrollReports: "ViewPayrollReports";
1562
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1563
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1564
+ readonly EditPayrollRota: "EditPayrollRota";
1565
+ readonly ViewPayrollRota: "ViewPayrollRota";
1566
+ readonly EditPayrollStaff: "EditPayrollStaff";
1567
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1568
+ readonly ViewSalesReports: "ViewSalesReports";
1569
+ readonly ViewCostReports: "ViewCostReports";
1570
+ readonly ViewMenuReports: "ViewMenuReports";
1571
+ readonly ViewBrand: "ViewBrand";
1572
+ readonly EditBrand: "EditBrand";
1573
+ readonly CreateBrand: "CreateBrand";
1574
+ readonly TransferBrand: "TransferBrand";
1575
+ readonly ViewProperty: "ViewProperty";
1576
+ readonly EditProperty: "EditProperty";
1577
+ readonly CreateProperty: "CreateProperty";
1578
+ readonly ArchiveProperty: "ArchiveProperty";
1579
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1580
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1581
+ readonly CreateOrg: "CreateOrg";
1582
+ readonly EditOrg: "EditOrg";
1583
+ readonly ViewOrg: "ViewOrg";
1584
+ readonly ViewWebhooks: "ViewWebhooks";
1585
+ readonly EditWebhooks: "EditWebhooks";
1586
+ readonly RoleAdmin: "RoleAdmin";
1587
+ readonly RoleFactory: "RoleFactory";
1588
+ };
1589
+ export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
1590
+ /**
1591
+ * The principal to get authorized entities for
1592
+ * @export
1593
+ * @interface GetAuthorizedOrgsRequestPrincipal
1594
+ */
1595
+ export interface GetAuthorizedOrgsRequestPrincipal {
1596
+ /**
1597
+ *
1598
+ * @type {string}
1599
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1600
+ */
1601
+ 'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
1602
+ /**
1603
+ *
1604
+ * @type {string}
1605
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1606
+ */
1607
+ 'id': string;
1608
+ /**
1609
+ *
1610
+ * @type {string}
1611
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1612
+ */
1613
+ 'name'?: string;
1614
+ /**
1615
+ *
1616
+ * @type {string}
1617
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1618
+ */
1619
+ 'email'?: string;
1620
+ /**
1621
+ *
1622
+ * @type {string}
1623
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1624
+ */
1625
+ 'phone'?: string;
1626
+ }
1627
+ export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: {
1628
+ readonly User: "User";
1629
+ readonly Automation: "Automation";
1630
+ };
1631
+ export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
1632
+ /**
1633
+ * Response containing the authorized orgs
1634
+ * @export
1635
+ * @interface GetAuthorizedOrgsResponse
1636
+ */
1637
+ export interface GetAuthorizedOrgsResponse {
1638
+ /**
1639
+ * Array of allowed resources
1640
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1641
+ * @memberof GetAuthorizedOrgsResponse
1642
+ */
1643
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1644
+ /**
1645
+ * Array of denied resources
1646
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1647
+ * @memberof GetAuthorizedOrgsResponse
1648
+ */
1649
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1650
+ }
1651
+ /**
1652
+ * 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.
1653
+ * @export
1654
+ * @interface GetAuthorizedPropertiesRequest
1655
+ */
1656
+ export interface GetAuthorizedPropertiesRequest {
1657
+ /**
1658
+ *
1659
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1660
+ * @memberof GetAuthorizedPropertiesRequest
1661
+ */
1662
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1663
+ /**
1664
+ * Incoming request headers to be used for authentication
1665
+ * @type {{ [key: string]: string; }}
1666
+ * @memberof GetAuthorizedPropertiesRequest
1667
+ */
1668
+ 'headers'?: {
1669
+ [key: string]: string;
1670
+ };
1671
+ /**
1672
+ * The action to check authorisation for
1673
+ * @type {string}
1674
+ * @memberof GetAuthorizedPropertiesRequest
1675
+ */
1676
+ 'action': GetAuthorizedPropertiesRequestActionEnum;
1677
+ }
1678
+ export declare const GetAuthorizedPropertiesRequestActionEnum: {
1679
+ readonly AnyAuditLogs: "AnyAuditLogs";
1680
+ readonly ViewApp: "ViewApp";
1681
+ readonly CreateApp: "CreateApp";
1682
+ readonly UpdateApp: "UpdateApp";
1683
+ readonly ViewAppName: "ViewAppName";
1684
+ readonly EditAppAssets: "EditAppAssets";
1685
+ readonly EditAppFeatures: "EditAppFeatures";
1686
+ readonly ViewTeammates: "ViewTeammates";
1687
+ readonly EditTeammates: "EditTeammates";
1688
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1689
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1690
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1691
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1692
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1693
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1694
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1695
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1696
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1697
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1698
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1699
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1700
+ readonly EditApmConfigurations: "EditApmConfigurations";
1701
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1702
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1703
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1704
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1705
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1706
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1707
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1708
+ readonly ViewOrders: "ViewOrders";
1709
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1710
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1711
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1712
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1713
+ readonly ViewStores: "ViewStores";
1714
+ readonly CreateStores: "CreateStores";
1715
+ readonly EditStores: "EditStores";
1716
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1717
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1718
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1719
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1720
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1721
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1722
+ readonly UpdateStoresName: "UpdateStoresName";
1723
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1724
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1725
+ readonly EditStoreNotifications: "EditStoreNotifications";
1726
+ readonly ArchiveStores: "ArchiveStores";
1727
+ readonly PublishStores: "PublishStores";
1728
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1729
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1730
+ readonly ViewStoreGroups: "ViewStoreGroups";
1731
+ readonly CreateStoreGroups: "CreateStoreGroups";
1732
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1733
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1734
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1735
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1736
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1737
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1738
+ readonly ViewMenu: "ViewMenu";
1739
+ readonly CreateMenu: "CreateMenu";
1740
+ readonly UpdateMenu: "UpdateMenu";
1741
+ readonly DeleteMenu: "DeleteMenu";
1742
+ readonly UpdateMenuLock: "UpdateMenuLock";
1743
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1744
+ readonly EditMenuImage: "EditMenuImage";
1745
+ readonly ViewVouchers: "ViewVouchers";
1746
+ readonly EditVouchers: "EditVouchers";
1747
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1748
+ readonly EditWebsiteContent: "EditWebsiteContent";
1749
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1750
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1751
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1752
+ readonly ViewBankAccounts: "ViewBankAccounts";
1753
+ readonly CreateBankAccounts: "CreateBankAccounts";
1754
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1755
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1756
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1757
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1758
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1759
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1760
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1761
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1762
+ readonly ViewHydraConfig: "ViewHydraConfig";
1763
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1764
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1765
+ readonly DeleteTerminal: "DeleteTerminal";
1766
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1767
+ readonly ViewCustomers: "ViewCustomers";
1768
+ readonly EditCustomers: "EditCustomers";
1769
+ readonly CreateCustomers: "CreateCustomers";
1770
+ readonly CreateCatalogElements: "CreateCatalogElements";
1771
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1772
+ readonly ViewCatalogElements: "ViewCatalogElements";
1773
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1774
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1775
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1776
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1777
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1778
+ readonly UpdateMetafields: "UpdateMetafields";
1779
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1780
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1781
+ readonly ViewAppStatistics: "ViewAppStatistics";
1782
+ readonly ViewApmStatistics: "ViewApmStatistics";
1783
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1784
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1785
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1786
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1787
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1788
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1789
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1790
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1791
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1792
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1793
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1794
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1795
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1796
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1797
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1798
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1799
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1800
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1801
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1802
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1803
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1804
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1805
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1806
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1807
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1808
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1809
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1810
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1811
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1812
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1813
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1814
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1815
+ readonly InviteDriverToApp: "InviteDriverToApp";
1816
+ readonly GetDriverForApp: "GetDriverForApp";
1817
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1818
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1819
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1820
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1821
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1822
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1823
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1824
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1825
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1826
+ readonly ViewPayouts: "ViewPayouts";
1827
+ readonly ViewChannels: "ViewChannels";
1828
+ readonly ViewOnboarding: "ViewOnboarding";
1829
+ readonly UpdateOnboarding: "UpdateOnboarding";
1830
+ readonly ViewClientDevices: "ViewClientDevices";
1831
+ readonly UpdateClientDevices: "UpdateClientDevices";
1832
+ readonly EnrollClientDevices: "EnrollClientDevices";
1833
+ readonly AssignClientDevices: "AssignClientDevices";
1834
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1835
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1836
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1837
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1838
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1839
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1840
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1841
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1842
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1843
+ readonly ViewSalesChannels: "ViewSalesChannels";
1844
+ readonly EditSalesChannels: "EditSalesChannels";
1845
+ readonly CreateSalesChannel: "CreateSalesChannel";
1846
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1847
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1848
+ readonly PublishSalesChannel: "PublishSalesChannel";
1849
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1850
+ readonly CloneSalesChannel: "CloneSalesChannel";
1851
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1852
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1853
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1854
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1855
+ readonly ViewSubscriptions: "ViewSubscriptions";
1856
+ readonly ViewInvoices: "ViewInvoices";
1857
+ readonly EditAccountsBills: "EditAccountsBills";
1858
+ readonly ViewAccountsBills: "ViewAccountsBills";
1859
+ readonly EditAccountsCategories: "EditAccountsCategories";
1860
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1861
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1862
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1863
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1864
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1865
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1866
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1867
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1868
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1869
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1870
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1871
+ readonly ViewInventoryReports: "ViewInventoryReports";
1872
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1873
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1874
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1875
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1876
+ readonly EditInventorySupplier: "EditInventorySupplier";
1877
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1878
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1879
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1880
+ readonly ViewPayrollReports: "ViewPayrollReports";
1881
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1882
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1883
+ readonly EditPayrollRota: "EditPayrollRota";
1884
+ readonly ViewPayrollRota: "ViewPayrollRota";
1885
+ readonly EditPayrollStaff: "EditPayrollStaff";
1886
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1887
+ readonly ViewSalesReports: "ViewSalesReports";
1888
+ readonly ViewCostReports: "ViewCostReports";
1889
+ readonly ViewMenuReports: "ViewMenuReports";
1890
+ readonly ViewBrand: "ViewBrand";
1891
+ readonly EditBrand: "EditBrand";
1892
+ readonly CreateBrand: "CreateBrand";
1893
+ readonly TransferBrand: "TransferBrand";
1894
+ readonly ViewProperty: "ViewProperty";
1895
+ readonly EditProperty: "EditProperty";
1896
+ readonly CreateProperty: "CreateProperty";
1897
+ readonly ArchiveProperty: "ArchiveProperty";
1898
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1899
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1900
+ readonly CreateOrg: "CreateOrg";
1901
+ readonly EditOrg: "EditOrg";
1902
+ readonly ViewOrg: "ViewOrg";
1903
+ readonly ViewWebhooks: "ViewWebhooks";
1904
+ readonly EditWebhooks: "EditWebhooks";
1905
+ readonly RoleAdmin: "RoleAdmin";
1906
+ readonly RoleFactory: "RoleFactory";
1907
+ };
1908
+ export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
1909
+ /**
1910
+ * Response containing the authorized properties
1911
+ * @export
1912
+ * @interface GetAuthorizedPropertiesResponse
1913
+ */
1914
+ export interface GetAuthorizedPropertiesResponse {
1915
+ /**
1916
+ * Array of allowed resources
1917
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1918
+ * @memberof GetAuthorizedPropertiesResponse
1919
+ */
1920
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1921
+ /**
1922
+ * Array of denied resources
1923
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1924
+ * @memberof GetAuthorizedPropertiesResponse
1925
+ */
1926
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1927
+ }
1928
+ /**
1929
+ * Details for getting roles for a principal
1930
+ * @export
1931
+ * @interface GetPrincipalRolesRequestBody
1932
+ */
1933
+ export interface GetPrincipalRolesRequestBody {
1934
+ /**
1935
+ *
1936
+ * @type {AuthorizationRequestPrincipal}
1937
+ * @memberof GetPrincipalRolesRequestBody
1938
+ */
1939
+ 'principal': AuthorizationRequestPrincipal;
1940
+ /**
1941
+ *
1942
+ * @type {AuthorizationRequestResource}
1943
+ * @memberof GetPrincipalRolesRequestBody
1944
+ */
1945
+ 'resource'?: AuthorizationRequestResource;
1946
+ }
1947
+ /**
1948
+ * Successful roles retrieval response
1949
+ * @export
1950
+ * @interface GetPrincipalRolesSuccessResponse
1951
+ */
1952
+ export interface GetPrincipalRolesSuccessResponse {
1953
+ /**
1954
+ * List of roles assigned to the principal
1955
+ * @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
1956
+ * @memberof GetPrincipalRolesSuccessResponse
1957
+ */
1958
+ 'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
1959
+ }
1960
+ /**
1961
+ *
1962
+ * @export
1963
+ * @interface GetPrincipalRolesSuccessResponseRolesInner
1964
+ */
1965
+ export interface GetPrincipalRolesSuccessResponseRolesInner {
1966
+ /**
1967
+ * Policy ID
1968
+ * @type {string}
1969
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1970
+ */
1971
+ 'policyId': string;
1972
+ /**
1973
+ *
1974
+ * @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
1975
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1976
+ */
1977
+ 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
1978
+ /**
1979
+ * Policy type
1980
+ * @type {string}
1981
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1982
+ */
1983
+ 'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
1984
+ /**
1985
+ * Date and time the role was assigned
1986
+ * @type {string}
1987
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1988
+ */
1989
+ 'assignedAt': string;
1990
+ /**
1991
+ * User who assigned the role
1992
+ * @type {string}
1993
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1994
+ */
1995
+ 'assignedBy': string;
1996
+ /**
1997
+ * Type of resource the role is assigned to
1998
+ * @type {string}
1999
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2000
+ */
2001
+ 'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
2002
+ /**
2003
+ * Organization ID
2004
+ * @type {string}
2005
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2006
+ */
2007
+ 'orgId'?: string;
2008
+ /**
2009
+ * Property ID
2010
+ * @type {string}
2011
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2012
+ */
2013
+ 'propertyId'?: string;
2014
+ /**
2015
+ * Brand ID this role is scoped to
2016
+ * @type {string}
2017
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2018
+ */
2019
+ 'brandId'?: string;
2020
+ /**
2021
+ * Sales channel ID this role is scoped to
2022
+ * @type {string}
2023
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2024
+ */
2025
+ 'salesChannelId'?: string;
2026
+ /**
2027
+ * Principal ID this role is assigned to
2028
+ * @type {string}
2029
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2030
+ */
2031
+ 'principalId': string;
2032
+ /**
2033
+ * Type of principal this role is assigned to
2034
+ * @type {string}
2035
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2036
+ */
2037
+ 'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
2038
+ }
2039
+ export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
2040
+ readonly Main: "Main";
2041
+ readonly BrandOverride: "BrandOverride";
2042
+ readonly OrgOverride: "OrgOverride";
2043
+ readonly Forbidden: "Forbidden";
2044
+ readonly NamedRole: "NamedRole";
2045
+ };
2046
+ export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
2047
+ export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
2048
+ readonly Property: "Property";
2049
+ readonly Org: "Org";
2050
+ readonly Brand: "Brand";
2051
+ readonly SalesChannel: "SalesChannel";
2052
+ };
2053
+ export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
2054
+ export declare const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum: {
2055
+ readonly User: "User";
2056
+ readonly Automation: "Automation";
2057
+ };
2058
+ export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
2059
+ /**
2060
+ * Role name
2061
+ * @export
2062
+ * @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
2063
+ */
2064
+ export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
2065
+ }
2066
+ /**
2067
+ * Successful user permissions retrieval response
2068
+ * @export
2069
+ * @interface GetUserPermissionsSuccessResponse
2070
+ */
2071
+ export interface GetUserPermissionsSuccessResponse {
2072
+ /**
2073
+ * Map of resource IDs to permissions
2074
+ * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
2075
+ * @memberof GetUserPermissionsSuccessResponse
2076
+ */
2077
+ 'resources': {
2078
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
2079
+ };
2080
+ }
2081
+ /**
2082
+ *
2083
+ * @export
2084
+ * @interface GetUserPermissionsSuccessResponseResourcesValue
2085
+ */
2086
+ export interface GetUserPermissionsSuccessResponseResourcesValue {
2087
+ /**
2088
+ * Type of resource the permissions are assigned to
2089
+ * @type {string}
2090
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
2091
+ */
2092
+ 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
2093
+ /**
2094
+ *
2095
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
2096
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
2097
+ */
2098
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
2099
+ /**
2100
+ * List of permissions that are assigned to the user for the resource
2101
+ * @type {Array<string>}
2102
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
2103
+ */
2104
+ 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
2105
+ }
2106
+ export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
2107
+ readonly Property: "Property";
2108
+ readonly Org: "Org";
2109
+ readonly Brand: "Brand";
2110
+ readonly SalesChannel: "SalesChannel";
2111
+ };
2112
+ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
2113
+ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum: {
2114
+ readonly AnyAuditLogs: "AnyAuditLogs";
2115
+ readonly ViewApp: "ViewApp";
2116
+ readonly CreateApp: "CreateApp";
2117
+ readonly UpdateApp: "UpdateApp";
2118
+ readonly ViewAppName: "ViewAppName";
2119
+ readonly EditAppAssets: "EditAppAssets";
2120
+ readonly EditAppFeatures: "EditAppFeatures";
2121
+ readonly ViewTeammates: "ViewTeammates";
2122
+ readonly EditTeammates: "EditTeammates";
2123
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
2124
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
2125
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
2126
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
2127
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
2128
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
2129
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
2130
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
2131
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
2132
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
2133
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
2134
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
2135
+ readonly EditApmConfigurations: "EditApmConfigurations";
2136
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
2137
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
2138
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
2139
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
2140
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
2141
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
2142
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
2143
+ readonly ViewOrders: "ViewOrders";
2144
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
2145
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
2146
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
2147
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
2148
+ readonly ViewStores: "ViewStores";
2149
+ readonly CreateStores: "CreateStores";
2150
+ readonly EditStores: "EditStores";
2151
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
2152
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
2153
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
2154
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
2155
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
2156
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
2157
+ readonly UpdateStoresName: "UpdateStoresName";
2158
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
2159
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
2160
+ readonly EditStoreNotifications: "EditStoreNotifications";
2161
+ readonly ArchiveStores: "ArchiveStores";
2162
+ readonly PublishStores: "PublishStores";
2163
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
2164
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
2165
+ readonly ViewStoreGroups: "ViewStoreGroups";
2166
+ readonly CreateStoreGroups: "CreateStoreGroups";
2167
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
2168
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
2169
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
2170
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
2171
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
2172
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
2173
+ readonly ViewMenu: "ViewMenu";
2174
+ readonly CreateMenu: "CreateMenu";
2175
+ readonly UpdateMenu: "UpdateMenu";
2176
+ readonly DeleteMenu: "DeleteMenu";
2177
+ readonly UpdateMenuLock: "UpdateMenuLock";
2178
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
2179
+ readonly EditMenuImage: "EditMenuImage";
2180
+ readonly ViewVouchers: "ViewVouchers";
2181
+ readonly EditVouchers: "EditVouchers";
2182
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
2183
+ readonly EditWebsiteContent: "EditWebsiteContent";
2184
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
2185
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
2186
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
2187
+ readonly ViewBankAccounts: "ViewBankAccounts";
2188
+ readonly CreateBankAccounts: "CreateBankAccounts";
2189
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
2190
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
2191
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
2192
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
2193
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
2194
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
2195
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
2196
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
2197
+ readonly ViewHydraConfig: "ViewHydraConfig";
2198
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
2199
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
2200
+ readonly DeleteTerminal: "DeleteTerminal";
2201
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
2202
+ readonly ViewCustomers: "ViewCustomers";
2203
+ readonly EditCustomers: "EditCustomers";
2204
+ readonly CreateCustomers: "CreateCustomers";
2205
+ readonly CreateCatalogElements: "CreateCatalogElements";
2206
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
2207
+ readonly ViewCatalogElements: "ViewCatalogElements";
2208
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
2209
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
2210
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
2211
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
2212
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
2213
+ readonly UpdateMetafields: "UpdateMetafields";
2214
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
2215
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
2216
+ readonly ViewAppStatistics: "ViewAppStatistics";
2217
+ readonly ViewApmStatistics: "ViewApmStatistics";
2218
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
2219
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
2220
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
2221
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
2222
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
2223
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
2224
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
2225
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
2226
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
2227
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
2228
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
2229
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
2230
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
2231
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
2232
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
2233
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
2234
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
2235
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
2236
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
2237
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
2238
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
2239
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
2240
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
2241
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
2242
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
2243
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
2244
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
2245
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
2246
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
2247
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
2248
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
2249
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
2250
+ readonly InviteDriverToApp: "InviteDriverToApp";
2251
+ readonly GetDriverForApp: "GetDriverForApp";
2252
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
2253
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
2254
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
2255
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
2256
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
2257
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
2258
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
2259
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
2260
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
2261
+ readonly ViewPayouts: "ViewPayouts";
2262
+ readonly ViewChannels: "ViewChannels";
2263
+ readonly ViewOnboarding: "ViewOnboarding";
2264
+ readonly UpdateOnboarding: "UpdateOnboarding";
2265
+ readonly ViewClientDevices: "ViewClientDevices";
2266
+ readonly UpdateClientDevices: "UpdateClientDevices";
2267
+ readonly EnrollClientDevices: "EnrollClientDevices";
2268
+ readonly AssignClientDevices: "AssignClientDevices";
2269
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
2270
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
2271
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
2272
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
2273
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
2274
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
2275
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
2276
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
2277
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
2278
+ readonly ViewSalesChannels: "ViewSalesChannels";
2279
+ readonly EditSalesChannels: "EditSalesChannels";
2280
+ readonly CreateSalesChannel: "CreateSalesChannel";
2281
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
2282
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
2283
+ readonly PublishSalesChannel: "PublishSalesChannel";
2284
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
2285
+ readonly CloneSalesChannel: "CloneSalesChannel";
2286
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
2287
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
2288
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
2289
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
2290
+ readonly ViewSubscriptions: "ViewSubscriptions";
2291
+ readonly ViewInvoices: "ViewInvoices";
2292
+ readonly EditAccountsBills: "EditAccountsBills";
2293
+ readonly ViewAccountsBills: "ViewAccountsBills";
2294
+ readonly EditAccountsCategories: "EditAccountsCategories";
2295
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
2296
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
2297
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
2298
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
2299
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
2300
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
2301
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
2302
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
2303
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
2304
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
2305
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
2306
+ readonly ViewInventoryReports: "ViewInventoryReports";
2307
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
2308
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
2309
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
2310
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
2311
+ readonly EditInventorySupplier: "EditInventorySupplier";
2312
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
2313
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
2314
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
2315
+ readonly ViewPayrollReports: "ViewPayrollReports";
2316
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
2317
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
2318
+ readonly EditPayrollRota: "EditPayrollRota";
2319
+ readonly ViewPayrollRota: "ViewPayrollRota";
2320
+ readonly EditPayrollStaff: "EditPayrollStaff";
2321
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
2322
+ readonly ViewSalesReports: "ViewSalesReports";
2323
+ readonly ViewCostReports: "ViewCostReports";
2324
+ readonly ViewMenuReports: "ViewMenuReports";
2325
+ readonly ViewBrand: "ViewBrand";
2326
+ readonly EditBrand: "EditBrand";
2327
+ readonly CreateBrand: "CreateBrand";
2328
+ readonly TransferBrand: "TransferBrand";
2329
+ readonly ViewProperty: "ViewProperty";
2330
+ readonly EditProperty: "EditProperty";
2331
+ readonly CreateProperty: "CreateProperty";
2332
+ readonly ArchiveProperty: "ArchiveProperty";
2333
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
2334
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
2335
+ readonly CreateOrg: "CreateOrg";
2336
+ readonly EditOrg: "EditOrg";
2337
+ readonly ViewOrg: "ViewOrg";
2338
+ readonly ViewWebhooks: "ViewWebhooks";
2339
+ readonly EditWebhooks: "EditWebhooks";
2340
+ readonly RoleAdmin: "RoleAdmin";
2341
+ readonly RoleFactory: "RoleFactory";
2342
+ };
2343
+ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
2344
+ /**
2345
+ * ID of the resource the permissions are assigned to
2346
+ * @export
2347
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
2348
+ */
2349
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
2350
+ }
2351
+ /**
2352
+ *
2353
+ * @export
2354
+ * @interface IsInRoleRequest
2355
+ */
2356
+ export interface IsInRoleRequest {
2357
+ /**
2358
+ *
2359
+ * @type {AuthorizationRequestPrincipal}
2360
+ * @memberof IsInRoleRequest
2361
+ */
2362
+ 'principal': AuthorizationRequestPrincipal;
2363
+ /**
2364
+ * Array of roles to check if the principal is in
2365
+ * @type {Array<string>}
2366
+ * @memberof IsInRoleRequest
2367
+ */
2368
+ 'roles': Array<IsInRoleRequestRolesEnum>;
2369
+ /**
2370
+ * How to check authorisation - any or all of the actions must be allowed
2371
+ * @type {string}
2372
+ * @memberof IsInRoleRequest
2373
+ */
2374
+ 'checkMode'?: IsInRoleRequestCheckModeEnum;
2375
+ }
2376
+ export declare const IsInRoleRequestRolesEnum: {
2377
+ readonly Admin: "Admin";
2378
+ readonly Factory: "Factory";
2379
+ };
2380
+ export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
2381
+ export declare const IsInRoleRequestCheckModeEnum: {
2382
+ readonly Any: "any";
2383
+ readonly All: "all";
2384
+ };
2385
+ export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
2386
+ /**
2387
+ * Response containing whether the principal is in any/all of the roles
2388
+ * @export
2389
+ * @interface IsInRoleResponse
2390
+ */
2391
+ export interface IsInRoleResponse {
2392
+ /**
2393
+ * result of the check - whether the principal is in any/all of the roles
2394
+ * @type {boolean}
2395
+ * @memberof IsInRoleResponse
2396
+ */
2397
+ 'authorized': boolean;
2398
+ }
2399
+ /**
2400
+ * Successful feature based roles retrieval response
2401
+ * @export
2402
+ * @interface ListFeatureBasedRolesSuccessResponse
2403
+ */
2404
+ export interface ListFeatureBasedRolesSuccessResponse {
2405
+ /**
2406
+ *
2407
+ * @type {Array<FeatureBasedRole>}
2408
+ * @memberof ListFeatureBasedRolesSuccessResponse
2409
+ */
2410
+ 'roles': Array<FeatureBasedRole>;
2411
+ }
2412
+ /**
2413
+ *
2414
+ * @export
2415
+ * @interface ListOrgRolesSuccessResponseValueValue
2416
+ */
2417
+ export interface ListOrgRolesSuccessResponseValueValue {
2418
+ /**
2419
+ * Type of resource the permissions are assigned to
2420
+ * @type {string}
2421
+ * @memberof ListOrgRolesSuccessResponseValueValue
2422
+ */
2423
+ 'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
2424
+ /**
2425
+ *
2426
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
2427
+ * @memberof ListOrgRolesSuccessResponseValueValue
2428
+ */
2429
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
2430
+ /**
2431
+ * List of roles that are assigned to the user for the resource
2432
+ * @type {Array<string>}
2433
+ * @memberof ListOrgRolesSuccessResponseValueValue
2434
+ */
2435
+ 'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
2436
+ }
2437
+ export declare const ListOrgRolesSuccessResponseValueValueResourceTypeEnum: {
2438
+ readonly Property: "Property";
2439
+ readonly Org: "Org";
2440
+ readonly Brand: "Brand";
2441
+ readonly SalesChannel: "SalesChannel";
2442
+ };
2443
+ export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
2444
+ export declare const ListOrgRolesSuccessResponseValueValueRolesEnum: {
2445
+ readonly OrgViewer: "OrgViewer";
2446
+ readonly OrgManager: "OrgManager";
2447
+ readonly OrgAdmin: "OrgAdmin";
2448
+ readonly BrandViewer: "BrandViewer";
2449
+ readonly BrandManager: "BrandManager";
2450
+ readonly BrandAdmin: "BrandAdmin";
2451
+ readonly StoreViewer: "StoreViewer";
2452
+ readonly StoreEditor: "StoreEditor";
2453
+ readonly StoreManager: "StoreManager";
2454
+ readonly CustomerViewer: "CustomerViewer";
2455
+ readonly CustomerManager: "CustomerManager";
2456
+ readonly VoucherViewer: "VoucherViewer";
2457
+ readonly VoucherEditor: "VoucherEditor";
2458
+ readonly VoucherManager: "VoucherManager";
2459
+ readonly VoucherCampaignManager: "VoucherCampaignManager";
2460
+ readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
2461
+ readonly AnalyticsViewer: "AnalyticsViewer";
2462
+ readonly ReportsViewer: "ReportsViewer";
2463
+ readonly FinanceViewer: "FinanceViewer";
2464
+ readonly FinanceManager: "FinanceManager";
2465
+ readonly TeamViewer: "TeamViewer";
2466
+ readonly TeamManager: "TeamManager";
2467
+ readonly TeamAdmin: "TeamAdmin";
2468
+ readonly TechViewer: "TechViewer";
2469
+ readonly TechManager: "TechManager";
2470
+ readonly AppStoreViewer: "AppStoreViewer";
2471
+ readonly AppStoreManager: "AppStoreManager";
2472
+ readonly SalesChannelViewer: "SalesChannelViewer";
2473
+ readonly SalesChannelEditor: "SalesChannelEditor";
2474
+ readonly SalesChannelManager: "SalesChannelManager";
2475
+ readonly DeliveryViewer: "DeliveryViewer";
2476
+ readonly DeliveryManager: "DeliveryManager";
2477
+ readonly DriverManager: "DriverManager";
2478
+ readonly AuditViewer: "AuditViewer";
2479
+ readonly AuditManager: "AuditManager";
2480
+ readonly AccountsViewer: "AccountsViewer";
2481
+ readonly AccountsEditor: "AccountsEditor";
2482
+ readonly DocumentExplorerViewer: "DocumentExplorerViewer";
2483
+ readonly DocumentExplorerEditor: "DocumentExplorerEditor";
2484
+ readonly PayrollViewer: "PayrollViewer";
2485
+ readonly PayrollEditor: "PayrollEditor";
2486
+ readonly PropertyViewer: "PropertyViewer";
2487
+ readonly PropertyManager: "PropertyManager";
2488
+ readonly PropertyAdmin: "PropertyAdmin";
2489
+ readonly WebsiteContentEditor: "WebsiteContentEditor";
2490
+ readonly WebsiteContentViewer: "WebsiteContentViewer";
2491
+ readonly WebsiteTechViewer: "WebsiteTechViewer";
2492
+ readonly MenuViewer: "MenuViewer";
2493
+ readonly MenuEditor: "MenuEditor";
2494
+ readonly MenuManager: "MenuManager";
2495
+ readonly MenuMetaFieldManager: "MenuMetaFieldManager";
2496
+ readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
2497
+ readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
2498
+ readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
2499
+ readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
2500
+ readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
2501
+ readonly OrderFulfillmentManager: "OrderFulfillmentManager";
2502
+ readonly OrderManager: "OrderManager";
2503
+ readonly OrderEditor: "OrderEditor";
2504
+ readonly OrderViewer: "OrderViewer";
2505
+ readonly InventoryManager: "InventoryManager";
2506
+ readonly InventoryEditor: "InventoryEditor";
2507
+ readonly InventoryViewer: "InventoryViewer";
2508
+ readonly PaymentManager: "PaymentManager";
2509
+ readonly OnboardingManager: "OnboardingManager";
2510
+ readonly FeatureFlagManager: "FeatureFlagManager";
2511
+ readonly PropertyOwnerMisc: "PropertyOwnerMisc";
2512
+ readonly ManagedOwnerMisc: "ManagedOwnerMisc";
2513
+ readonly IntegratorMisc: "IntegratorMisc";
2514
+ readonly PropertyManagerMisc: "PropertyManagerMisc";
2515
+ readonly FinanceManagerMisc: "FinanceManagerMisc";
2516
+ readonly SupportMisc: "SupportMisc";
2517
+ };
2518
+ export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
2519
+ /**
2520
+ * Successful permissions retrieval response
2521
+ * @export
2522
+ * @interface ListPermissionsSuccessResponse
2523
+ */
2524
+ export interface ListPermissionsSuccessResponse {
2525
+ /**
2526
+ * List of permissions
2527
+ * @type {Array<string>}
2528
+ * @memberof ListPermissionsSuccessResponse
2529
+ */
2530
+ 'permissions': Array<ListPermissionsSuccessResponsePermissionsEnum>;
2531
+ }
2532
+ export declare const ListPermissionsSuccessResponsePermissionsEnum: {
2533
+ readonly AnyAuditLogs: "AnyAuditLogs";
2534
+ readonly ViewApp: "ViewApp";
2535
+ readonly CreateApp: "CreateApp";
2536
+ readonly UpdateApp: "UpdateApp";
2537
+ readonly ViewAppName: "ViewAppName";
2538
+ readonly EditAppAssets: "EditAppAssets";
2539
+ readonly EditAppFeatures: "EditAppFeatures";
2540
+ readonly ViewTeammates: "ViewTeammates";
2541
+ readonly EditTeammates: "EditTeammates";
2542
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
2543
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
2544
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
2545
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
2546
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
2547
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
2548
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
2549
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
2550
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
2551
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
2552
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
2553
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
2554
+ readonly EditApmConfigurations: "EditApmConfigurations";
2555
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
2556
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
2557
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
2558
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
2559
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
2560
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
2561
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
2562
+ readonly ViewOrders: "ViewOrders";
2563
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
2564
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
2565
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
2566
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
2567
+ readonly ViewStores: "ViewStores";
2568
+ readonly CreateStores: "CreateStores";
2569
+ readonly EditStores: "EditStores";
2570
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
2571
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
2572
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
2573
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
2574
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
2575
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
2576
+ readonly UpdateStoresName: "UpdateStoresName";
2577
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
2578
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
2579
+ readonly EditStoreNotifications: "EditStoreNotifications";
2580
+ readonly ArchiveStores: "ArchiveStores";
2581
+ readonly PublishStores: "PublishStores";
2582
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
2583
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
2584
+ readonly ViewStoreGroups: "ViewStoreGroups";
2585
+ readonly CreateStoreGroups: "CreateStoreGroups";
2586
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
2587
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
2588
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
2589
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
2590
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
2591
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
2592
+ readonly ViewMenu: "ViewMenu";
2593
+ readonly CreateMenu: "CreateMenu";
2594
+ readonly UpdateMenu: "UpdateMenu";
2595
+ readonly DeleteMenu: "DeleteMenu";
2596
+ readonly UpdateMenuLock: "UpdateMenuLock";
2597
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
2598
+ readonly EditMenuImage: "EditMenuImage";
2599
+ readonly ViewVouchers: "ViewVouchers";
2600
+ readonly EditVouchers: "EditVouchers";
2601
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
2602
+ readonly EditWebsiteContent: "EditWebsiteContent";
2603
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
2604
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
2605
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
2606
+ readonly ViewBankAccounts: "ViewBankAccounts";
2607
+ readonly CreateBankAccounts: "CreateBankAccounts";
2608
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
2609
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
2610
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
2611
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
2612
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
2613
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
2614
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
2615
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
2616
+ readonly ViewHydraConfig: "ViewHydraConfig";
2617
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
2618
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
2619
+ readonly DeleteTerminal: "DeleteTerminal";
2620
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
2621
+ readonly ViewCustomers: "ViewCustomers";
2622
+ readonly EditCustomers: "EditCustomers";
2623
+ readonly CreateCustomers: "CreateCustomers";
2624
+ readonly CreateCatalogElements: "CreateCatalogElements";
2625
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
2626
+ readonly ViewCatalogElements: "ViewCatalogElements";
2627
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
2628
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
2629
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
2630
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
2631
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
2632
+ readonly UpdateMetafields: "UpdateMetafields";
2633
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
2634
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
2635
+ readonly ViewAppStatistics: "ViewAppStatistics";
2636
+ readonly ViewApmStatistics: "ViewApmStatistics";
2637
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
2638
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
2639
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
2640
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
2641
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
2642
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
2643
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
2644
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
2645
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
2646
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
2647
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
2648
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
2649
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
2650
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
2651
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
2652
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
2653
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
2654
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
2655
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
2656
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
2657
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
2658
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
2659
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
2660
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
2661
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
2662
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
2663
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
2664
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
2665
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
2666
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
2667
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
2668
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
2669
+ readonly InviteDriverToApp: "InviteDriverToApp";
2670
+ readonly GetDriverForApp: "GetDriverForApp";
2671
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
2672
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
2673
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
2674
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
2675
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
2676
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
2677
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
2678
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
2679
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
2680
+ readonly ViewPayouts: "ViewPayouts";
2681
+ readonly ViewChannels: "ViewChannels";
2682
+ readonly ViewOnboarding: "ViewOnboarding";
2683
+ readonly UpdateOnboarding: "UpdateOnboarding";
2684
+ readonly ViewClientDevices: "ViewClientDevices";
2685
+ readonly UpdateClientDevices: "UpdateClientDevices";
2686
+ readonly EnrollClientDevices: "EnrollClientDevices";
2687
+ readonly AssignClientDevices: "AssignClientDevices";
2688
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
2689
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
2690
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
2691
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
2692
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
2693
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
2694
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
2695
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
2696
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
2697
+ readonly ViewSalesChannels: "ViewSalesChannels";
2698
+ readonly EditSalesChannels: "EditSalesChannels";
2699
+ readonly CreateSalesChannel: "CreateSalesChannel";
2700
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
2701
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
2702
+ readonly PublishSalesChannel: "PublishSalesChannel";
2703
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
2704
+ readonly CloneSalesChannel: "CloneSalesChannel";
2705
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
2706
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
2707
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
2708
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
2709
+ readonly ViewSubscriptions: "ViewSubscriptions";
2710
+ readonly ViewInvoices: "ViewInvoices";
2711
+ readonly EditAccountsBills: "EditAccountsBills";
2712
+ readonly ViewAccountsBills: "ViewAccountsBills";
2713
+ readonly EditAccountsCategories: "EditAccountsCategories";
2714
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
2715
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
2716
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
2717
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
2718
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
2719
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
2720
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
2721
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
2722
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
2723
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
2724
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
2725
+ readonly ViewInventoryReports: "ViewInventoryReports";
2726
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
2727
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
2728
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
2729
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
2730
+ readonly EditInventorySupplier: "EditInventorySupplier";
2731
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
2732
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
2733
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
2734
+ readonly ViewPayrollReports: "ViewPayrollReports";
2735
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
2736
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
2737
+ readonly EditPayrollRota: "EditPayrollRota";
2738
+ readonly ViewPayrollRota: "ViewPayrollRota";
2739
+ readonly EditPayrollStaff: "EditPayrollStaff";
2740
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
2741
+ readonly ViewSalesReports: "ViewSalesReports";
2742
+ readonly ViewCostReports: "ViewCostReports";
2743
+ readonly ViewMenuReports: "ViewMenuReports";
2744
+ readonly ViewBrand: "ViewBrand";
2745
+ readonly EditBrand: "EditBrand";
2746
+ readonly CreateBrand: "CreateBrand";
2747
+ readonly TransferBrand: "TransferBrand";
2748
+ readonly ViewProperty: "ViewProperty";
2749
+ readonly EditProperty: "EditProperty";
2750
+ readonly CreateProperty: "CreateProperty";
2751
+ readonly ArchiveProperty: "ArchiveProperty";
2752
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
2753
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
2754
+ readonly CreateOrg: "CreateOrg";
2755
+ readonly EditOrg: "EditOrg";
2756
+ readonly ViewOrg: "ViewOrg";
2757
+ readonly ViewWebhooks: "ViewWebhooks";
2758
+ readonly EditWebhooks: "EditWebhooks";
2759
+ readonly RoleAdmin: "RoleAdmin";
2760
+ readonly RoleFactory: "RoleFactory";
2761
+ };
2762
+ export type ListPermissionsSuccessResponsePermissionsEnum = typeof ListPermissionsSuccessResponsePermissionsEnum[keyof typeof ListPermissionsSuccessResponsePermissionsEnum];
2763
+ /**
2764
+ * Successful roles retrieval response
2765
+ * @export
2766
+ * @interface ListRolesSuccessResponse
2767
+ */
2768
+ export interface ListRolesSuccessResponse {
2769
+ /**
2770
+ * List of named roles
2771
+ * @type {Array<string>}
2772
+ * @memberof ListRolesSuccessResponse
2773
+ */
2774
+ 'roles': Array<ListRolesSuccessResponseRolesEnum>;
2775
+ }
2776
+ export declare const ListRolesSuccessResponseRolesEnum: {
2777
+ readonly Admin: "Admin";
2778
+ readonly Factory: "Factory";
2779
+ };
2780
+ export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
2781
+ /**
2782
+ * Principals in org
2783
+ * @export
2784
+ * @interface PrincipalsInOrgResponse
2785
+ */
2786
+ export interface PrincipalsInOrgResponse {
2787
+ /**
2788
+ *
2789
+ * @type {string}
2790
+ * @memberof PrincipalsInOrgResponse
2791
+ */
2792
+ 'orgId': string;
2793
+ /**
2794
+ * List of principals in org
2795
+ * @type {Array<AuthorizationRequestPrincipal>}
2796
+ * @memberof PrincipalsInOrgResponse
2797
+ */
2798
+ 'principals': Array<AuthorizationRequestPrincipal>;
2799
+ }
2800
+ /**
2801
+ * Details for revoking a forbidden role from a principal
2802
+ * @export
2803
+ * @interface RevokeForbiddenRoleRequestBody
2804
+ */
2805
+ export interface RevokeForbiddenRoleRequestBody {
2806
+ /**
2807
+ *
2808
+ * @type {AuthorizationRequestPrincipal}
2809
+ * @memberof RevokeForbiddenRoleRequestBody
2810
+ */
2811
+ 'principal': AuthorizationRequestPrincipal;
2812
+ /**
2813
+ * Compensation role to revoke the forbidden role from
2814
+ * @type {string}
2815
+ * @memberof RevokeForbiddenRoleRequestBody
2816
+ */
2817
+ 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
2818
+ }
2819
+ export declare const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum: {
2820
+ readonly OwnerCompensating: "OwnerCompensating";
2821
+ readonly PropertyOwnerCompensating: "PropertyOwnerCompensating";
2822
+ readonly ManagedOwnerCompensating: "ManagedOwnerCompensating";
2823
+ readonly IntegratorCompensating: "IntegratorCompensating";
2824
+ readonly PropertyManagerCompensating: "PropertyManagerCompensating";
2825
+ readonly FinanceManagerCompensating: "FinanceManagerCompensating";
2826
+ };
2827
+ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
2828
+ /**
2829
+ * Details for revoking a role from a principal
2830
+ * @export
2831
+ * @interface RevokeRoleRequestBody
2832
+ */
2833
+ export interface RevokeRoleRequestBody {
2834
+ /**
2835
+ *
2836
+ * @type {string}
2837
+ * @memberof RevokeRoleRequestBody
2838
+ */
2839
+ 'role': RevokeRoleRequestBodyRoleEnum;
2840
+ /**
2841
+ *
2842
+ * @type {AuthorizationRequestResource}
2843
+ * @memberof RevokeRoleRequestBody
2844
+ */
2845
+ 'resource': AuthorizationRequestResource;
2846
+ /**
2847
+ *
2848
+ * @type {AuthorizationRequestPrincipal}
2849
+ * @memberof RevokeRoleRequestBody
2850
+ */
2851
+ 'principal': AuthorizationRequestPrincipal;
2852
+ /**
2853
+ *
2854
+ * @type {string}
2855
+ * @memberof RevokeRoleRequestBody
2856
+ */
2857
+ 'brandId': string;
2858
+ }
2859
+ export declare const RevokeRoleRequestBodyRoleEnum: {
1215
2860
  readonly OrgViewer: "OrgViewer";
1216
2861
  readonly OrgManager: "OrgManager";
1217
2862
  readonly OrgAdmin: "OrgAdmin";
@@ -1295,28 +2940,9 @@ export interface RevokeRoleSuccessResponse {
1295
2940
  /**
1296
2941
  * Confirmation message
1297
2942
  * @type {string}
1298
- * @memberof RevokeRoleSuccessResponse
1299
- */
1300
- 'message': string;
1301
- }
1302
- /**
1303
- *
1304
- * @export
1305
- * @interface RolesInner
1306
- */
1307
- export interface RolesInner {
1308
- /**
1309
- * Name of the role
1310
- * @type {string}
1311
- * @memberof RolesInner
1312
- */
1313
- 'name': string;
1314
- /**
1315
- *
1316
- * @type {Permissions & Array<string>}
1317
- * @memberof RolesInner
2943
+ * @memberof RevokeRoleSuccessResponse
1318
2944
  */
1319
- 'permissions': Permissions & Array<string>;
2945
+ 'message': string;
1320
2946
  }
1321
2947
  /**
1322
2948
  *
@@ -1352,11 +2978,11 @@ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Config
1352
2978
  /**
1353
2979
  * Authenticate and authorize a user to perform an action
1354
2980
  * @summary Authenticate and authorize Request
1355
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
2981
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1356
2982
  * @param {*} [options] Override http request option.
1357
2983
  * @throws {RequiredError}
1358
2984
  */
1359
- authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2985
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1360
2986
  };
1361
2987
  /**
1362
2988
  * AuthenticationApi - functional programming interface
@@ -1366,11 +2992,11 @@ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
1366
2992
  /**
1367
2993
  * Authenticate and authorize a user to perform an action
1368
2994
  * @summary Authenticate and authorize Request
1369
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
2995
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1370
2996
  * @param {*} [options] Override http request option.
1371
2997
  * @throws {RequiredError}
1372
2998
  */
1373
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
2999
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
1374
3000
  };
1375
3001
  /**
1376
3002
  * AuthenticationApi - factory interface
@@ -1380,25 +3006,12 @@ export declare const AuthenticationApiFactory: (configuration?: Configuration, b
1380
3006
  /**
1381
3007
  * Authenticate and authorize a user to perform an action
1382
3008
  * @summary Authenticate and authorize Request
1383
- * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
3009
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1384
3010
  * @param {*} [options] Override http request option.
1385
3011
  * @throws {RequiredError}
1386
3012
  */
1387
- authenticateAndAuthorize(requestParameters?: AuthenticationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3013
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
1388
3014
  };
1389
- /**
1390
- * Request parameters for authenticateAndAuthorize operation in AuthenticationApi.
1391
- * @export
1392
- * @interface AuthenticationApiAuthenticateAndAuthorizeRequest
1393
- */
1394
- export interface AuthenticationApiAuthenticateAndAuthorizeRequest {
1395
- /**
1396
- *
1397
- * @type {AuthenticateAndAuthorizeRequest}
1398
- * @memberof AuthenticationApiAuthenticateAndAuthorize
1399
- */
1400
- readonly authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest;
1401
- }
1402
3015
  /**
1403
3016
  * AuthenticationApi - object-oriented interface
1404
3017
  * @export
@@ -1409,12 +3022,12 @@ export declare class AuthenticationApi extends BaseAPI {
1409
3022
  /**
1410
3023
  * Authenticate and authorize a user to perform an action
1411
3024
  * @summary Authenticate and authorize Request
1412
- * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
3025
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1413
3026
  * @param {*} [options] Override http request option.
1414
3027
  * @throws {RequiredError}
1415
3028
  * @memberof AuthenticationApi
1416
3029
  */
1417
- authenticateAndAuthorize(requestParameters?: AuthenticationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
3030
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
1418
3031
  }
1419
3032
  /**
1420
3033
  * AuthorizationApi - axios parameter creator
@@ -1422,172 +3035,523 @@ export declare class AuthenticationApi extends BaseAPI {
1422
3035
  */
1423
3036
  export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
1424
3037
  /**
1425
- * Authenticate and authorize a user to perform an action
1426
- * @summary Authenticate and authorize Request
1427
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3038
+ * Authenticate and authorize a user to perform an action
3039
+ * @summary Authenticate and authorize Request
3040
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3041
+ * @param {*} [options] Override http request option.
3042
+ * @throws {RequiredError}
3043
+ */
3044
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3045
+ /**
3046
+ * Authenticate and check if a user is in any/all of the roles
3047
+ * @summary Authenticate and Check Is In Role
3048
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3049
+ * @param {*} [options] Override http request option.
3050
+ * @throws {RequiredError}
3051
+ */
3052
+ authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3053
+ /**
3054
+ * Check if a user is authorized to perform an action
3055
+ * @summary Authorize Request
3056
+ * @param {AuthorizationRequest} [authorizationRequest]
3057
+ * @param {*} [options] Override http request option.
3058
+ * @throws {RequiredError}
3059
+ */
3060
+ authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3061
+ /**
3062
+ * Check if a user is authorized to perform an action on multiple resources
3063
+ * @summary Authorize Batch Request
3064
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3065
+ * @param {*} [options] Override http request option.
3066
+ * @throws {RequiredError}
3067
+ */
3068
+ authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3069
+ /**
3070
+ * Check if a user is in any/all of the roles
3071
+ * @summary Check Is In Role
3072
+ * @param {IsInRoleRequest} [isInRoleRequest]
3073
+ * @param {*} [options] Override http request option.
3074
+ * @throws {RequiredError}
3075
+ */
3076
+ checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3077
+ };
3078
+ /**
3079
+ * AuthorizationApi - functional programming interface
3080
+ * @export
3081
+ */
3082
+ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
3083
+ /**
3084
+ * Authenticate and authorize a user to perform an action
3085
+ * @summary Authenticate and authorize Request
3086
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3087
+ * @param {*} [options] Override http request option.
3088
+ * @throws {RequiredError}
3089
+ */
3090
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3091
+ /**
3092
+ * Authenticate and check if a user is in any/all of the roles
3093
+ * @summary Authenticate and Check Is In Role
3094
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3095
+ * @param {*} [options] Override http request option.
3096
+ * @throws {RequiredError}
3097
+ */
3098
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>>;
3099
+ /**
3100
+ * Check if a user is authorized to perform an action
3101
+ * @summary Authorize Request
3102
+ * @param {AuthorizationRequest} [authorizationRequest]
3103
+ * @param {*} [options] Override http request option.
3104
+ * @throws {RequiredError}
3105
+ */
3106
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
3107
+ /**
3108
+ * Check if a user is authorized to perform an action on multiple resources
3109
+ * @summary Authorize Batch Request
3110
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3111
+ * @param {*} [options] Override http request option.
3112
+ * @throws {RequiredError}
3113
+ */
3114
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>>;
3115
+ /**
3116
+ * Check if a user is in any/all of the roles
3117
+ * @summary Check Is In Role
3118
+ * @param {IsInRoleRequest} [isInRoleRequest]
3119
+ * @param {*} [options] Override http request option.
3120
+ * @throws {RequiredError}
3121
+ */
3122
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>>;
3123
+ };
3124
+ /**
3125
+ * AuthorizationApi - factory interface
3126
+ * @export
3127
+ */
3128
+ export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3129
+ /**
3130
+ * Authenticate and authorize a user to perform an action
3131
+ * @summary Authenticate and authorize Request
3132
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3133
+ * @param {*} [options] Override http request option.
3134
+ * @throws {RequiredError}
3135
+ */
3136
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3137
+ /**
3138
+ * Authenticate and check if a user is in any/all of the roles
3139
+ * @summary Authenticate and Check Is In Role
3140
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3141
+ * @param {*} [options] Override http request option.
3142
+ * @throws {RequiredError}
3143
+ */
3144
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse>;
3145
+ /**
3146
+ * Check if a user is authorized to perform an action
3147
+ * @summary Authorize Request
3148
+ * @param {AuthorizationRequest} [authorizationRequest]
3149
+ * @param {*} [options] Override http request option.
3150
+ * @throws {RequiredError}
3151
+ */
3152
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
3153
+ /**
3154
+ * Check if a user is authorized to perform an action on multiple resources
3155
+ * @summary Authorize Batch Request
3156
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3157
+ * @param {*} [options] Override http request option.
3158
+ * @throws {RequiredError}
3159
+ */
3160
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse>;
3161
+ /**
3162
+ * Check if a user is in any/all of the roles
3163
+ * @summary Check Is In Role
3164
+ * @param {IsInRoleRequest} [isInRoleRequest]
3165
+ * @param {*} [options] Override http request option.
3166
+ * @throws {RequiredError}
3167
+ */
3168
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse>;
3169
+ };
3170
+ /**
3171
+ * AuthorizationApi - object-oriented interface
3172
+ * @export
3173
+ * @class AuthorizationApi
3174
+ * @extends {BaseAPI}
3175
+ */
3176
+ export declare class AuthorizationApi extends BaseAPI {
3177
+ /**
3178
+ * Authenticate and authorize a user to perform an action
3179
+ * @summary Authenticate and authorize Request
3180
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3181
+ * @param {*} [options] Override http request option.
3182
+ * @throws {RequiredError}
3183
+ * @memberof AuthorizationApi
3184
+ */
3185
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
3186
+ /**
3187
+ * Authenticate and check if a user is in any/all of the roles
3188
+ * @summary Authenticate and Check Is In Role
3189
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3190
+ * @param {*} [options] Override http request option.
3191
+ * @throws {RequiredError}
3192
+ * @memberof AuthorizationApi
3193
+ */
3194
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
3195
+ /**
3196
+ * Check if a user is authorized to perform an action
3197
+ * @summary Authorize Request
3198
+ * @param {AuthorizationRequest} [authorizationRequest]
3199
+ * @param {*} [options] Override http request option.
3200
+ * @throws {RequiredError}
3201
+ * @memberof AuthorizationApi
3202
+ */
3203
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}>>;
3204
+ /**
3205
+ * Check if a user is authorized to perform an action on multiple resources
3206
+ * @summary Authorize Batch Request
3207
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3208
+ * @param {*} [options] Override http request option.
3209
+ * @throws {RequiredError}
3210
+ * @memberof AuthorizationApi
3211
+ */
3212
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
3213
+ /**
3214
+ * Check if a user is in any/all of the roles
3215
+ * @summary Check Is In Role
3216
+ * @param {IsInRoleRequest} [isInRoleRequest]
3217
+ * @param {*} [options] Override http request option.
3218
+ * @throws {RequiredError}
3219
+ * @memberof AuthorizationApi
3220
+ */
3221
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
3222
+ }
3223
+ /**
3224
+ * AuthorizedEntitiesApi - axios parameter creator
3225
+ * @export
3226
+ */
3227
+ export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
3228
+ /**
3229
+ * Get the authorized brands for a given org
3230
+ * @summary Get Authorized Brands
3231
+ * @param {string} orgId
3232
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3233
+ * @param {*} [options] Override http request option.
3234
+ * @throws {RequiredError}
3235
+ */
3236
+ getAuthorizedBrands: (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3237
+ /**
3238
+ * Get the authorized orgs for a given principal
3239
+ * @summary Get Authorized Orgs
3240
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3241
+ * @param {*} [options] Override http request option.
3242
+ * @throws {RequiredError}
3243
+ */
3244
+ getAuthorizedOrgs: (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3245
+ /**
3246
+ * Get the authorized properties for a given org
3247
+ * @summary Get Authorized Properties
3248
+ * @param {string} orgId
3249
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3250
+ * @param {*} [options] Override http request option.
3251
+ * @throws {RequiredError}
3252
+ */
3253
+ getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3254
+ };
3255
+ /**
3256
+ * AuthorizedEntitiesApi - functional programming interface
3257
+ * @export
3258
+ */
3259
+ export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => {
3260
+ /**
3261
+ * Get the authorized brands for a given org
3262
+ * @summary Get Authorized Brands
3263
+ * @param {string} orgId
3264
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3265
+ * @param {*} [options] Override http request option.
3266
+ * @throws {RequiredError}
3267
+ */
3268
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>>;
3269
+ /**
3270
+ * Get the authorized orgs for a given principal
3271
+ * @summary Get Authorized Orgs
3272
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3273
+ * @param {*} [options] Override http request option.
3274
+ * @throws {RequiredError}
3275
+ */
3276
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>>;
3277
+ /**
3278
+ * Get the authorized properties for a given org
3279
+ * @summary Get Authorized Properties
3280
+ * @param {string} orgId
3281
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3282
+ * @param {*} [options] Override http request option.
3283
+ * @throws {RequiredError}
3284
+ */
3285
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>>;
3286
+ };
3287
+ /**
3288
+ * AuthorizedEntitiesApi - factory interface
3289
+ * @export
3290
+ */
3291
+ export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3292
+ /**
3293
+ * Get the authorized brands for a given org
3294
+ * @summary Get Authorized Brands
3295
+ * @param {string} orgId
3296
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3297
+ * @param {*} [options] Override http request option.
3298
+ * @throws {RequiredError}
3299
+ */
3300
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse>;
3301
+ /**
3302
+ * Get the authorized orgs for a given principal
3303
+ * @summary Get Authorized Orgs
3304
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3305
+ * @param {*} [options] Override http request option.
3306
+ * @throws {RequiredError}
3307
+ */
3308
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse>;
3309
+ /**
3310
+ * Get the authorized properties for a given org
3311
+ * @summary Get Authorized Properties
3312
+ * @param {string} orgId
3313
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3314
+ * @param {*} [options] Override http request option.
3315
+ * @throws {RequiredError}
3316
+ */
3317
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse>;
3318
+ };
3319
+ /**
3320
+ * AuthorizedEntitiesApi - object-oriented interface
3321
+ * @export
3322
+ * @class AuthorizedEntitiesApi
3323
+ * @extends {BaseAPI}
3324
+ */
3325
+ export declare class AuthorizedEntitiesApi extends BaseAPI {
3326
+ /**
3327
+ * Get the authorized brands for a given org
3328
+ * @summary Get Authorized Brands
3329
+ * @param {string} orgId
3330
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3331
+ * @param {*} [options] Override http request option.
3332
+ * @throws {RequiredError}
3333
+ * @memberof AuthorizedEntitiesApi
3334
+ */
3335
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}>>;
3336
+ /**
3337
+ * Get the authorized orgs for a given principal
3338
+ * @summary Get Authorized Orgs
3339
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3340
+ * @param {*} [options] Override http request option.
3341
+ * @throws {RequiredError}
3342
+ * @memberof AuthorizedEntitiesApi
3343
+ */
3344
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}>>;
3345
+ /**
3346
+ * Get the authorized properties for a given org
3347
+ * @summary Get Authorized Properties
3348
+ * @param {string} orgId
3349
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3350
+ * @param {*} [options] Override http request option.
3351
+ * @throws {RequiredError}
3352
+ * @memberof AuthorizedEntitiesApi
3353
+ */
3354
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
3355
+ }
3356
+ /**
3357
+ * ConfigurationDataApi - axios parameter creator
3358
+ * @export
3359
+ */
3360
+ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
3361
+ /**
3362
+ * List the available feature based roles
3363
+ * @summary List Feature Based Roles
3364
+ * @param {*} [options] Override http request option.
3365
+ * @throws {RequiredError}
3366
+ */
3367
+ configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3368
+ /**
3369
+ * List the available permissions
3370
+ * @summary List Permissions
3371
+ * @param {*} [options] Override http request option.
3372
+ * @throws {RequiredError}
3373
+ */
3374
+ configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3375
+ /**
3376
+ * List the available roles
3377
+ * @summary List Roles
3378
+ * @param {*} [options] Override http request option.
3379
+ * @throws {RequiredError}
3380
+ */
3381
+ configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3382
+ /**
3383
+ * List the available feature based roles
3384
+ * @summary List Feature Based Roles
3385
+ * @param {*} [options] Override http request option.
3386
+ * @throws {RequiredError}
3387
+ */
3388
+ listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3389
+ /**
3390
+ * List the available permissions
3391
+ * @summary List Permissions
3392
+ * @param {*} [options] Override http request option.
3393
+ * @throws {RequiredError}
3394
+ */
3395
+ listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3396
+ /**
3397
+ * List the available roles
3398
+ * @summary List Roles
3399
+ * @param {*} [options] Override http request option.
3400
+ * @throws {RequiredError}
3401
+ */
3402
+ listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3403
+ };
3404
+ /**
3405
+ * ConfigurationDataApi - functional programming interface
3406
+ * @export
3407
+ */
3408
+ export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
3409
+ /**
3410
+ * List the available feature based roles
3411
+ * @summary List Feature Based Roles
3412
+ * @param {*} [options] Override http request option.
3413
+ * @throws {RequiredError}
3414
+ */
3415
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
3416
+ /**
3417
+ * List the available permissions
3418
+ * @summary List Permissions
3419
+ * @param {*} [options] Override http request option.
3420
+ * @throws {RequiredError}
3421
+ */
3422
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
3423
+ /**
3424
+ * List the available roles
3425
+ * @summary List Roles
1428
3426
  * @param {*} [options] Override http request option.
1429
3427
  * @throws {RequiredError}
1430
3428
  */
1431
- authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3429
+ configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
1432
3430
  /**
1433
- * Check if a user is authorized to perform an action
1434
- * @summary Authorize Request
1435
- * @param {AuthorizationRequest} [authorizationRequest]
3431
+ * List the available feature based roles
3432
+ * @summary List Feature Based Roles
1436
3433
  * @param {*} [options] Override http request option.
1437
3434
  * @throws {RequiredError}
1438
3435
  */
1439
- authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1440
- };
1441
- /**
1442
- * AuthorizationApi - functional programming interface
1443
- * @export
1444
- */
1445
- export declare const AuthorizationApiFp: (configuration?: Configuration) => {
3436
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
1446
3437
  /**
1447
- * Authenticate and authorize a user to perform an action
1448
- * @summary Authenticate and authorize Request
1449
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3438
+ * List the available permissions
3439
+ * @summary List Permissions
1450
3440
  * @param {*} [options] Override http request option.
1451
3441
  * @throws {RequiredError}
1452
3442
  */
1453
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3443
+ listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
1454
3444
  /**
1455
- * Check if a user is authorized to perform an action
1456
- * @summary Authorize Request
1457
- * @param {AuthorizationRequest} [authorizationRequest]
3445
+ * List the available roles
3446
+ * @summary List Roles
1458
3447
  * @param {*} [options] Override http request option.
1459
3448
  * @throws {RequiredError}
1460
3449
  */
1461
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
3450
+ listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
1462
3451
  };
1463
3452
  /**
1464
- * AuthorizationApi - factory interface
3453
+ * ConfigurationDataApi - factory interface
1465
3454
  * @export
1466
3455
  */
1467
- export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3456
+ export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1468
3457
  /**
1469
- * Authenticate and authorize a user to perform an action
1470
- * @summary Authenticate and authorize Request
1471
- * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
3458
+ * List the available feature based roles
3459
+ * @summary List Feature Based Roles
1472
3460
  * @param {*} [options] Override http request option.
1473
3461
  * @throws {RequiredError}
1474
3462
  */
1475
- authenticateAndAuthorize(requestParameters?: AuthorizationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3463
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
1476
3464
  /**
1477
- * Check if a user is authorized to perform an action
1478
- * @summary Authorize Request
1479
- * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
3465
+ * List the available permissions
3466
+ * @summary List Permissions
1480
3467
  * @param {*} [options] Override http request option.
1481
3468
  * @throws {RequiredError}
1482
3469
  */
1483
- authorize(requestParameters?: AuthorizationApiAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
1484
- };
1485
- /**
1486
- * Request parameters for authenticateAndAuthorize operation in AuthorizationApi.
1487
- * @export
1488
- * @interface AuthorizationApiAuthenticateAndAuthorizeRequest
1489
- */
1490
- export interface AuthorizationApiAuthenticateAndAuthorizeRequest {
3470
+ configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
1491
3471
  /**
1492
- *
1493
- * @type {AuthenticateAndAuthorizeRequest}
1494
- * @memberof AuthorizationApiAuthenticateAndAuthorize
3472
+ * List the available roles
3473
+ * @summary List Roles
3474
+ * @param {*} [options] Override http request option.
3475
+ * @throws {RequiredError}
1495
3476
  */
1496
- readonly authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest;
1497
- }
1498
- /**
1499
- * Request parameters for authorize operation in AuthorizationApi.
1500
- * @export
1501
- * @interface AuthorizationApiAuthorizeRequest
1502
- */
1503
- export interface AuthorizationApiAuthorizeRequest {
3477
+ configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
1504
3478
  /**
1505
- *
1506
- * @type {AuthorizationRequest}
1507
- * @memberof AuthorizationApiAuthorize
3479
+ * List the available feature based roles
3480
+ * @summary List Feature Based Roles
3481
+ * @param {*} [options] Override http request option.
3482
+ * @throws {RequiredError}
1508
3483
  */
1509
- readonly authorizationRequest?: AuthorizationRequest;
1510
- }
1511
- /**
1512
- * AuthorizationApi - object-oriented interface
1513
- * @export
1514
- * @class AuthorizationApi
1515
- * @extends {BaseAPI}
1516
- */
1517
- export declare class AuthorizationApi extends BaseAPI {
3484
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
1518
3485
  /**
1519
- * Authenticate and authorize a user to perform an action
1520
- * @summary Authenticate and authorize Request
1521
- * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
3486
+ * List the available permissions
3487
+ * @summary List Permissions
1522
3488
  * @param {*} [options] Override http request option.
1523
3489
  * @throws {RequiredError}
1524
- * @memberof AuthorizationApi
1525
3490
  */
1526
- authenticateAndAuthorize(requestParameters?: AuthorizationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
3491
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
1527
3492
  /**
1528
- * Check if a user is authorized to perform an action
1529
- * @summary Authorize Request
1530
- * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
3493
+ * List the available roles
3494
+ * @summary List Roles
1531
3495
  * @param {*} [options] Override http request option.
1532
3496
  * @throws {RequiredError}
1533
- * @memberof AuthorizationApi
1534
3497
  */
1535
- authorize(requestParameters?: AuthorizationApiAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any>>;
1536
- }
3498
+ listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
3499
+ };
1537
3500
  /**
1538
- * PermissionsApi - axios parameter creator
3501
+ * ConfigurationDataApi - object-oriented interface
1539
3502
  * @export
3503
+ * @class ConfigurationDataApi
3504
+ * @extends {BaseAPI}
1540
3505
  */
1541
- export declare const PermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
3506
+ export declare class ConfigurationDataApi extends BaseAPI {
1542
3507
  /**
1543
- * List the available permissions
1544
- * @summary List Permissions
3508
+ * List the available feature based roles
3509
+ * @summary List Feature Based Roles
1545
3510
  * @param {*} [options] Override http request option.
1546
3511
  * @throws {RequiredError}
3512
+ * @memberof ConfigurationDataApi
1547
3513
  */
1548
- listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1549
- };
1550
- /**
1551
- * PermissionsApi - functional programming interface
1552
- * @export
1553
- */
1554
- export declare const PermissionsApiFp: (configuration?: Configuration) => {
3514
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
1555
3515
  /**
1556
3516
  * List the available permissions
1557
3517
  * @summary List Permissions
1558
3518
  * @param {*} [options] Override http request option.
1559
3519
  * @throws {RequiredError}
3520
+ * @memberof ConfigurationDataApi
1560
3521
  */
1561
- listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>>;
1562
- };
1563
- /**
1564
- * PermissionsApi - factory interface
1565
- * @export
1566
- */
1567
- export declare const PermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3522
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
1568
3523
  /**
1569
- * List the available permissions
1570
- * @summary List Permissions
3524
+ * List the available roles
3525
+ * @summary List Roles
1571
3526
  * @param {*} [options] Override http request option.
1572
3527
  * @throws {RequiredError}
3528
+ * @memberof ConfigurationDataApi
1573
3529
  */
1574
- listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse>;
1575
- };
1576
- /**
1577
- * PermissionsApi - object-oriented interface
1578
- * @export
1579
- * @class PermissionsApi
1580
- * @extends {BaseAPI}
1581
- */
1582
- export declare class PermissionsApi extends BaseAPI {
3530
+ configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
3531
+ /**
3532
+ * List the available feature based roles
3533
+ * @summary List Feature Based Roles
3534
+ * @param {*} [options] Override http request option.
3535
+ * @throws {RequiredError}
3536
+ * @memberof ConfigurationDataApi
3537
+ */
3538
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
1583
3539
  /**
1584
3540
  * List the available permissions
1585
3541
  * @summary List Permissions
1586
3542
  * @param {*} [options] Override http request option.
1587
3543
  * @throws {RequiredError}
1588
- * @memberof PermissionsApi
3544
+ * @memberof ConfigurationDataApi
3545
+ */
3546
+ listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
3547
+ /**
3548
+ * List the available roles
3549
+ * @summary List Roles
3550
+ * @param {*} [options] Override http request option.
3551
+ * @throws {RequiredError}
3552
+ * @memberof ConfigurationDataApi
1589
3553
  */
1590
- listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPermissionsSuccessResponse, any>>;
3554
+ listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
1591
3555
  }
1592
3556
  /**
1593
3557
  * RoleAssignmentApi - axios parameter creator
@@ -1681,112 +3645,40 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
1681
3645
  /**
1682
3646
  * Assigns a specified role to a given principal (user, group, etc.)
1683
3647
  * @summary Assign Role to Principal
1684
- * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
3648
+ * @param {string} orgId
3649
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
1685
3650
  * @param {*} [options] Override http request option.
1686
3651
  * @throws {RequiredError}
1687
3652
  */
1688
- assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<AssignRoleSuccessResponse>;
3653
+ assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<AssignRoleSuccessResponse>;
1689
3654
  /**
1690
3655
  * Get the active roles for a given principal
1691
3656
  * @summary Get Principal Roles
1692
- * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
3657
+ * @param {string} orgId
3658
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
1693
3659
  * @param {*} [options] Override http request option.
1694
3660
  * @throws {RequiredError}
1695
3661
  */
1696
- getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse>;
3662
+ getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse>;
1697
3663
  /**
1698
3664
  * Revokes a forbidden role from a given principal (user, group, etc.)
1699
3665
  * @summary Revoke Forbidden Role from Principal
1700
- * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
3666
+ * @param {string} orgId
3667
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
1701
3668
  * @param {*} [options] Override http request option.
1702
3669
  * @throws {RequiredError}
1703
3670
  */
1704
- revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
3671
+ revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
1705
3672
  /**
1706
3673
  * Revokes a specified role from a given principal (user, group, etc.)
1707
3674
  * @summary Revoke Role from Principal
1708
- * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
3675
+ * @param {string} orgId
3676
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
1709
3677
  * @param {*} [options] Override http request option.
1710
3678
  * @throws {RequiredError}
1711
3679
  */
1712
- revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
3680
+ revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
1713
3681
  };
1714
- /**
1715
- * Request parameters for assignRoleToPrincipal operation in RoleAssignmentApi.
1716
- * @export
1717
- * @interface RoleAssignmentApiAssignRoleToPrincipalRequest
1718
- */
1719
- export interface RoleAssignmentApiAssignRoleToPrincipalRequest {
1720
- /**
1721
- *
1722
- * @type {string}
1723
- * @memberof RoleAssignmentApiAssignRoleToPrincipal
1724
- */
1725
- readonly orgId: string;
1726
- /**
1727
- *
1728
- * @type {AssignRoleRequestBody}
1729
- * @memberof RoleAssignmentApiAssignRoleToPrincipal
1730
- */
1731
- readonly assignRoleRequestBody?: AssignRoleRequestBody;
1732
- }
1733
- /**
1734
- * Request parameters for getPrincipalRoles operation in RoleAssignmentApi.
1735
- * @export
1736
- * @interface RoleAssignmentApiGetPrincipalRolesRequest
1737
- */
1738
- export interface RoleAssignmentApiGetPrincipalRolesRequest {
1739
- /**
1740
- *
1741
- * @type {string}
1742
- * @memberof RoleAssignmentApiGetPrincipalRoles
1743
- */
1744
- readonly orgId: string;
1745
- /**
1746
- *
1747
- * @type {GetPrincipalRolesRequestBody}
1748
- * @memberof RoleAssignmentApiGetPrincipalRoles
1749
- */
1750
- readonly getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody;
1751
- }
1752
- /**
1753
- * Request parameters for revokeForbiddenRoleFromPrincipal operation in RoleAssignmentApi.
1754
- * @export
1755
- * @interface RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest
1756
- */
1757
- export interface RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest {
1758
- /**
1759
- *
1760
- * @type {string}
1761
- * @memberof RoleAssignmentApiRevokeForbiddenRoleFromPrincipal
1762
- */
1763
- readonly orgId: string;
1764
- /**
1765
- *
1766
- * @type {RevokeForbiddenRoleRequestBody}
1767
- * @memberof RoleAssignmentApiRevokeForbiddenRoleFromPrincipal
1768
- */
1769
- readonly revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody;
1770
- }
1771
- /**
1772
- * Request parameters for revokeRoleFromPrincipal operation in RoleAssignmentApi.
1773
- * @export
1774
- * @interface RoleAssignmentApiRevokeRoleFromPrincipalRequest
1775
- */
1776
- export interface RoleAssignmentApiRevokeRoleFromPrincipalRequest {
1777
- /**
1778
- *
1779
- * @type {string}
1780
- * @memberof RoleAssignmentApiRevokeRoleFromPrincipal
1781
- */
1782
- readonly orgId: string;
1783
- /**
1784
- *
1785
- * @type {RevokeRoleRequestBody}
1786
- * @memberof RoleAssignmentApiRevokeRoleFromPrincipal
1787
- */
1788
- readonly revokeRoleRequestBody?: RevokeRoleRequestBody;
1789
- }
1790
3682
  /**
1791
3683
  * RoleAssignmentApi - object-oriented interface
1792
3684
  * @export
@@ -1797,45 +3689,124 @@ export declare class RoleAssignmentApi extends BaseAPI {
1797
3689
  /**
1798
3690
  * Assigns a specified role to a given principal (user, group, etc.)
1799
3691
  * @summary Assign Role to Principal
1800
- * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
3692
+ * @param {string} orgId
3693
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
1801
3694
  * @param {*} [options] Override http request option.
1802
3695
  * @throws {RequiredError}
1803
3696
  * @memberof RoleAssignmentApi
1804
3697
  */
1805
- assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any>>;
3698
+ assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any, {}>>;
1806
3699
  /**
1807
3700
  * Get the active roles for a given principal
1808
3701
  * @summary Get Principal Roles
1809
- * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
3702
+ * @param {string} orgId
3703
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
1810
3704
  * @param {*} [options] Override http request option.
1811
3705
  * @throws {RequiredError}
1812
3706
  * @memberof RoleAssignmentApi
1813
3707
  */
1814
- getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any>>;
3708
+ getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
1815
3709
  /**
1816
3710
  * Revokes a forbidden role from a given principal (user, group, etc.)
1817
3711
  * @summary Revoke Forbidden Role from Principal
1818
- * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
3712
+ * @param {string} orgId
3713
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
1819
3714
  * @param {*} [options] Override http request option.
1820
3715
  * @throws {RequiredError}
1821
3716
  * @memberof RoleAssignmentApi
1822
3717
  */
1823
- revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
3718
+ revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
1824
3719
  /**
1825
3720
  * Revokes a specified role from a given principal (user, group, etc.)
1826
3721
  * @summary Revoke Role from Principal
1827
- * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
3722
+ * @param {string} orgId
3723
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
1828
3724
  * @param {*} [options] Override http request option.
1829
3725
  * @throws {RequiredError}
1830
3726
  * @memberof RoleAssignmentApi
1831
3727
  */
1832
- revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
3728
+ revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
3729
+ }
3730
+ /**
3731
+ * UserManagementApi - axios parameter creator
3732
+ * @export
3733
+ */
3734
+ export declare const UserManagementApiAxiosParamCreator: (configuration?: Configuration) => {
3735
+ /**
3736
+ * List the users in a given org
3737
+ * @summary List Users in Org
3738
+ * @param {string} orgId
3739
+ * @param {*} [options] Override http request option.
3740
+ * @throws {RequiredError}
3741
+ */
3742
+ listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3743
+ };
3744
+ /**
3745
+ * UserManagementApi - functional programming interface
3746
+ * @export
3747
+ */
3748
+ export declare const UserManagementApiFp: (configuration?: Configuration) => {
3749
+ /**
3750
+ * List the users in a given org
3751
+ * @summary List Users in Org
3752
+ * @param {string} orgId
3753
+ * @param {*} [options] Override http request option.
3754
+ * @throws {RequiredError}
3755
+ */
3756
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
3757
+ };
3758
+ /**
3759
+ * UserManagementApi - factory interface
3760
+ * @export
3761
+ */
3762
+ export declare const UserManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3763
+ /**
3764
+ * List the users in a given org
3765
+ * @summary List Users in Org
3766
+ * @param {string} orgId
3767
+ * @param {*} [options] Override http request option.
3768
+ * @throws {RequiredError}
3769
+ */
3770
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
3771
+ };
3772
+ /**
3773
+ * UserManagementApi - object-oriented interface
3774
+ * @export
3775
+ * @class UserManagementApi
3776
+ * @extends {BaseAPI}
3777
+ */
3778
+ export declare class UserManagementApi extends BaseAPI {
3779
+ /**
3780
+ * List the users in a given org
3781
+ * @summary List Users in Org
3782
+ * @param {string} orgId
3783
+ * @param {*} [options] Override http request option.
3784
+ * @throws {RequiredError}
3785
+ * @memberof UserManagementApi
3786
+ */
3787
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
1833
3788
  }
1834
3789
  /**
1835
3790
  * UserPermissionsApi - axios parameter creator
1836
3791
  * @export
1837
3792
  */
1838
3793
  export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
3794
+ /**
3795
+ * List the available permissions for the current user
3796
+ * @summary List Org Permissions
3797
+ * @param {string} orgId
3798
+ * @param {*} [options] Override http request option.
3799
+ * @throws {RequiredError}
3800
+ */
3801
+ listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3802
+ /**
3803
+ * List the available roles for the current user
3804
+ * @summary List Org Roles
3805
+ * @param {string} orgId
3806
+ * @param {*} [options] Override http request option.
3807
+ * @throws {RequiredError}
3808
+ */
3809
+ listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1839
3810
  /**
1840
3811
  * List the available permissions for the current user
1841
3812
  * @summary List Own Permissions
@@ -1859,6 +3830,30 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
1859
3830
  * @export
1860
3831
  */
1861
3832
  export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
3833
+ /**
3834
+ * List the available permissions for the current user
3835
+ * @summary List Org Permissions
3836
+ * @param {string} orgId
3837
+ * @param {*} [options] Override http request option.
3838
+ * @throws {RequiredError}
3839
+ */
3840
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
3841
+ [key: string]: {
3842
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3843
+ };
3844
+ }>>;
3845
+ /**
3846
+ * List the available roles for the current user
3847
+ * @summary List Org Roles
3848
+ * @param {string} orgId
3849
+ * @param {*} [options] Override http request option.
3850
+ * @throws {RequiredError}
3851
+ */
3852
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
3853
+ [key: string]: {
3854
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3855
+ };
3856
+ }>>;
1862
3857
  /**
1863
3858
  * List the available permissions for the current user
1864
3859
  * @summary List Own Permissions
@@ -1884,53 +3879,46 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
1884
3879
  export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1885
3880
  /**
1886
3881
  * List the available permissions for the current user
1887
- * @summary List Own Permissions
1888
- * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
3882
+ * @summary List Org Permissions
3883
+ * @param {string} orgId
1889
3884
  * @param {*} [options] Override http request option.
1890
3885
  * @throws {RequiredError}
1891
3886
  */
1892
- listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
3887
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
3888
+ [key: string]: {
3889
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3890
+ };
3891
+ }>;
1893
3892
  /**
1894
- * List the available permissions for a given user
1895
- * @summary List User Permissions
1896
- * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
3893
+ * List the available roles for the current user
3894
+ * @summary List Org Roles
3895
+ * @param {string} orgId
1897
3896
  * @param {*} [options] Override http request option.
1898
3897
  * @throws {RequiredError}
1899
3898
  */
1900
- listUserPermissions(requestParameters: UserPermissionsApiListUserPermissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
1901
- };
1902
- /**
1903
- * Request parameters for listOwnPermissions operation in UserPermissionsApi.
1904
- * @export
1905
- * @interface UserPermissionsApiListOwnPermissionsRequest
1906
- */
1907
- export interface UserPermissionsApiListOwnPermissionsRequest {
1908
- /**
1909
- *
1910
- * @type {string}
1911
- * @memberof UserPermissionsApiListOwnPermissions
1912
- */
1913
- readonly orgId: string;
1914
- }
1915
- /**
1916
- * Request parameters for listUserPermissions operation in UserPermissionsApi.
1917
- * @export
1918
- * @interface UserPermissionsApiListUserPermissionsRequest
1919
- */
1920
- export interface UserPermissionsApiListUserPermissionsRequest {
3899
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
3900
+ [key: string]: {
3901
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3902
+ };
3903
+ }>;
1921
3904
  /**
1922
- *
1923
- * @type {string}
1924
- * @memberof UserPermissionsApiListUserPermissions
3905
+ * List the available permissions for the current user
3906
+ * @summary List Own Permissions
3907
+ * @param {string} orgId
3908
+ * @param {*} [options] Override http request option.
3909
+ * @throws {RequiredError}
1925
3910
  */
1926
- readonly orgId: string;
3911
+ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
1927
3912
  /**
1928
- *
1929
- * @type {string}
1930
- * @memberof UserPermissionsApiListUserPermissions
3913
+ * List the available permissions for a given user
3914
+ * @summary List User Permissions
3915
+ * @param {string} orgId
3916
+ * @param {string} userId
3917
+ * @param {*} [options] Override http request option.
3918
+ * @throws {RequiredError}
1931
3919
  */
1932
- readonly userId: string;
1933
- }
3920
+ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
3921
+ };
1934
3922
  /**
1935
3923
  * UserPermissionsApi - object-oriented interface
1936
3924
  * @export
@@ -1938,22 +3926,49 @@ export interface UserPermissionsApiListUserPermissionsRequest {
1938
3926
  * @extends {BaseAPI}
1939
3927
  */
1940
3928
  export declare class UserPermissionsApi extends BaseAPI {
3929
+ /**
3930
+ * List the available permissions for the current user
3931
+ * @summary List Org Permissions
3932
+ * @param {string} orgId
3933
+ * @param {*} [options] Override http request option.
3934
+ * @throws {RequiredError}
3935
+ * @memberof UserPermissionsApi
3936
+ */
3937
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
3938
+ [key: string]: {
3939
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3940
+ };
3941
+ }, any, {}>>;
3942
+ /**
3943
+ * List the available roles for the current user
3944
+ * @summary List Org Roles
3945
+ * @param {string} orgId
3946
+ * @param {*} [options] Override http request option.
3947
+ * @throws {RequiredError}
3948
+ * @memberof UserPermissionsApi
3949
+ */
3950
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
3951
+ [key: string]: {
3952
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3953
+ };
3954
+ }, any, {}>>;
1941
3955
  /**
1942
3956
  * List the available permissions for the current user
1943
3957
  * @summary List Own Permissions
1944
- * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
3958
+ * @param {string} orgId
1945
3959
  * @param {*} [options] Override http request option.
1946
3960
  * @throws {RequiredError}
1947
3961
  * @memberof UserPermissionsApi
1948
3962
  */
1949
- listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
3963
+ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
1950
3964
  /**
1951
3965
  * List the available permissions for a given user
1952
3966
  * @summary List User Permissions
1953
- * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
3967
+ * @param {string} orgId
3968
+ * @param {string} userId
1954
3969
  * @param {*} [options] Override http request option.
1955
3970
  * @throws {RequiredError}
1956
3971
  * @memberof UserPermissionsApi
1957
3972
  */
1958
- listUserPermissions(requestParameters: UserPermissionsApiListUserPermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
3973
+ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
1959
3974
  }