@flipdish/authorization 0.0.2-rc.1756733622

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 ADDED
@@ -0,0 +1,1959 @@
1
+ /**
2
+ * Authorization API
3
+ * Authorization API
4
+ *
5
+ * The version of the OpenAPI document: 0.0.1
6
+ * Contact: support@flipdish.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ * Details for assigning a role to a principal
18
+ * @export
19
+ * @interface AssignRoleRequestBody
20
+ */
21
+ export interface AssignRoleRequestBody {
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
24
+ * @type {string}
25
+ * @memberof AssignRoleRequestBody
26
+ */
27
+ 'role': AssignRoleRequestBodyRoleEnum;
28
+ /**
29
+ *
30
+ * @type {AuthorizationRequestResource}
31
+ * @memberof AssignRoleRequestBody
32
+ */
33
+ 'resource': AuthorizationRequestResource;
34
+ /**
35
+ *
36
+ * @type {AuthorizationRequestPrincipal}
37
+ * @memberof AssignRoleRequestBody
38
+ */
39
+ 'principal': AuthorizationRequestPrincipal;
40
+ }
41
+ export declare const AssignRoleRequestBodyRoleEnum: {
42
+ readonly OrgViewer: "OrgViewer";
43
+ readonly OrgManager: "OrgManager";
44
+ readonly OrgAdmin: "OrgAdmin";
45
+ readonly BrandViewer: "BrandViewer";
46
+ readonly BrandManager: "BrandManager";
47
+ readonly BrandAdmin: "BrandAdmin";
48
+ readonly StoreViewer: "StoreViewer";
49
+ readonly StoreEditor: "StoreEditor";
50
+ readonly StoreManager: "StoreManager";
51
+ readonly CustomerViewer: "CustomerViewer";
52
+ readonly CustomerManager: "CustomerManager";
53
+ readonly VoucherViewer: "VoucherViewer";
54
+ readonly VoucherEditor: "VoucherEditor";
55
+ readonly VoucherManager: "VoucherManager";
56
+ readonly VoucherCampaignManager: "VoucherCampaignManager";
57
+ readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
58
+ readonly AnalyticsViewer: "AnalyticsViewer";
59
+ readonly ReportsViewer: "ReportsViewer";
60
+ readonly FinanceViewer: "FinanceViewer";
61
+ readonly FinanceManager: "FinanceManager";
62
+ readonly TeamViewer: "TeamViewer";
63
+ readonly TeamManager: "TeamManager";
64
+ readonly TeamAdmin: "TeamAdmin";
65
+ readonly TechViewer: "TechViewer";
66
+ readonly TechManager: "TechManager";
67
+ readonly AppStoreViewer: "AppStoreViewer";
68
+ readonly AppStoreManager: "AppStoreManager";
69
+ readonly SalesChannelViewer: "SalesChannelViewer";
70
+ readonly SalesChannelEditor: "SalesChannelEditor";
71
+ readonly SalesChannelManager: "SalesChannelManager";
72
+ readonly DeliveryViewer: "DeliveryViewer";
73
+ readonly DeliveryManager: "DeliveryManager";
74
+ readonly DriverManager: "DriverManager";
75
+ readonly AuditViewer: "AuditViewer";
76
+ readonly AuditManager: "AuditManager";
77
+ readonly AccountsViewer: "AccountsViewer";
78
+ readonly AccountsEditor: "AccountsEditor";
79
+ readonly DocumentExplorerViewer: "DocumentExplorerViewer";
80
+ readonly DocumentExplorerEditor: "DocumentExplorerEditor";
81
+ readonly PayrollViewer: "PayrollViewer";
82
+ readonly PayrollEditor: "PayrollEditor";
83
+ readonly PropertyViewer: "PropertyViewer";
84
+ readonly PropertyManager: "PropertyManager";
85
+ readonly PropertyAdmin: "PropertyAdmin";
86
+ readonly WebsiteContentEditor: "WebsiteContentEditor";
87
+ readonly WebsiteContentViewer: "WebsiteContentViewer";
88
+ readonly WebsiteTechViewer: "WebsiteTechViewer";
89
+ readonly MenuViewer: "MenuViewer";
90
+ readonly MenuEditor: "MenuEditor";
91
+ readonly MenuManager: "MenuManager";
92
+ readonly MenuMetaFieldManager: "MenuMetaFieldManager";
93
+ readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
94
+ readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
95
+ readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
96
+ readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
97
+ readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
98
+ readonly OrderFulfillmentManager: "OrderFulfillmentManager";
99
+ readonly OrderManager: "OrderManager";
100
+ readonly OrderEditor: "OrderEditor";
101
+ readonly OrderViewer: "OrderViewer";
102
+ readonly InventoryManager: "InventoryManager";
103
+ readonly InventoryEditor: "InventoryEditor";
104
+ readonly InventoryViewer: "InventoryViewer";
105
+ readonly PaymentManager: "PaymentManager";
106
+ readonly OnboardingManager: "OnboardingManager";
107
+ readonly FeatureFlagManager: "FeatureFlagManager";
108
+ readonly PropertyOwnerMisc: "PropertyOwnerMisc";
109
+ readonly ManagedOwnerMisc: "ManagedOwnerMisc";
110
+ readonly IntegratorMisc: "IntegratorMisc";
111
+ readonly PropertyManagerMisc: "PropertyManagerMisc";
112
+ readonly FinanceManagerMisc: "FinanceManagerMisc";
113
+ readonly SupportMisc: "SupportMisc";
114
+ };
115
+ export type AssignRoleRequestBodyRoleEnum = typeof AssignRoleRequestBodyRoleEnum[keyof typeof AssignRoleRequestBodyRoleEnum];
116
+ /**
117
+ * Successful role assignment response
118
+ * @export
119
+ * @interface AssignRoleSuccessResponse
120
+ */
121
+ export interface AssignRoleSuccessResponse {
122
+ /**
123
+ * Confirmation message
124
+ * @type {string}
125
+ * @memberof AssignRoleSuccessResponse
126
+ */
127
+ 'message': string;
128
+ }
129
+ /**
130
+ * 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.
131
+ * @export
132
+ * @interface AuthenticateAndAuthorizeRequest
133
+ */
134
+ export interface AuthenticateAndAuthorizeRequest {
135
+ /**
136
+ * Incoming request headers to be used for authentication
137
+ * @type {{ [key: string]: any; }}
138
+ * @memberof AuthenticateAndAuthorizeRequest
139
+ */
140
+ 'headers': {
141
+ [key: string]: any;
142
+ };
143
+ /**
144
+ *
145
+ * @type {AuthorizationRequestAction}
146
+ * @memberof AuthenticateAndAuthorizeRequest
147
+ */
148
+ 'action': AuthorizationRequestAction;
149
+ /**
150
+ *
151
+ * @type {AuthorizationRequestResource}
152
+ * @memberof AuthenticateAndAuthorizeRequest
153
+ */
154
+ 'resource'?: AuthorizationRequestResource;
155
+ }
156
+ /**
157
+ * Response containing the authentication and authorization decision
158
+ * @export
159
+ * @interface AuthenticateAndAuthorizeResponse
160
+ */
161
+ export interface AuthenticateAndAuthorizeResponse {
162
+ /**
163
+ *
164
+ * @type {AuthenticateAndAuthorizeResponseAuthentication}
165
+ * @memberof AuthenticateAndAuthorizeResponse
166
+ */
167
+ 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
168
+ /**
169
+ *
170
+ * @type {AuthorizationResponse}
171
+ * @memberof AuthenticateAndAuthorizeResponse
172
+ */
173
+ 'authorization'?: AuthorizationResponse;
174
+ }
175
+ /**
176
+ *
177
+ * @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
236
+ */
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;
262
+ /**
263
+ *
264
+ * @type {string}
265
+ * @memberof AuthorizationRequestPrincipal
266
+ */
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 {
285
+ /**
286
+ *
287
+ * @type {string}
288
+ * @memberof AuthorizationRequestResourceOneOf
289
+ */
290
+ 'type': AuthorizationRequestResourceOneOfTypeEnum;
291
+ /**
292
+ *
293
+ * @type {string}
294
+ * @memberof AuthorizationRequestResourceOneOf
295
+ */
296
+ 'id': string;
297
+ }
298
+ export declare const AuthorizationRequestResourceOneOfTypeEnum: {
299
+ readonly Property: "Property";
300
+ };
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";
323
+ };
324
+ export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
325
+ /**
326
+ *
327
+ * @export
328
+ * @interface AuthorizationRequestResourceOneOf2
329
+ */
330
+ export interface AuthorizationRequestResourceOneOf2 {
331
+ /**
332
+ *
333
+ * @type {string}
334
+ * @memberof AuthorizationRequestResourceOneOf2
335
+ */
336
+ 'type': AuthorizationRequestResourceOneOf2TypeEnum;
337
+ /**
338
+ *
339
+ * @type {string}
340
+ * @memberof AuthorizationRequestResourceOneOf2
341
+ */
342
+ 'id': string;
343
+ }
344
+ export declare const AuthorizationRequestResourceOneOf2TypeEnum: {
345
+ readonly Brand: "Brand";
346
+ };
347
+ export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
348
+ /**
349
+ *
350
+ * @export
351
+ * @interface AuthorizationRequestResourceOneOf3
352
+ */
353
+ export interface AuthorizationRequestResourceOneOf3 {
354
+ /**
355
+ *
356
+ * @type {string}
357
+ * @memberof AuthorizationRequestResourceOneOf3
358
+ */
359
+ 'type': AuthorizationRequestResourceOneOf3TypeEnum;
360
+ /**
361
+ *
362
+ * @type {string}
363
+ * @memberof AuthorizationRequestResourceOneOf3
364
+ */
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 {
377
+ /**
378
+ * Whether the action is allowed
379
+ * @type {boolean}
380
+ * @memberof AuthorizationResponse
381
+ */
382
+ 'allowed': boolean;
383
+ /**
384
+ * The authorization decision
385
+ * @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
393
+ */
394
+ 'policyIds': Array<string>;
395
+ }
396
+ /**
397
+ *
398
+ * @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
426
+ */
427
+ export interface GetPrincipalRolesRequestBody {
428
+ /**
429
+ *
430
+ * @type {AuthorizationRequestPrincipal}
431
+ * @memberof GetPrincipalRolesRequestBody
432
+ */
433
+ 'principal': AuthorizationRequestPrincipal;
434
+ /**
435
+ *
436
+ * @type {AuthorizationRequestResource}
437
+ * @memberof GetPrincipalRolesRequestBody
438
+ */
439
+ 'resource'?: AuthorizationRequestResource;
440
+ }
441
+ /**
442
+ * Successful roles retrieval response
443
+ * @export
444
+ * @interface GetPrincipalRolesSuccessResponse
445
+ */
446
+ export interface GetPrincipalRolesSuccessResponse {
447
+ /**
448
+ * List of roles assigned to the principal
449
+ * @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
450
+ * @memberof GetPrincipalRolesSuccessResponse
451
+ */
452
+ 'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
453
+ }
454
+ /**
455
+ *
456
+ * @export
457
+ * @interface GetPrincipalRolesSuccessResponseRolesInner
458
+ */
459
+ export interface GetPrincipalRolesSuccessResponseRolesInner {
460
+ /**
461
+ * Policy ID
462
+ * @type {string}
463
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
464
+ */
465
+ 'policyId': string;
466
+ /**
467
+ * Role name
468
+ * @type {string}
469
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
470
+ */
471
+ 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum;
472
+ /**
473
+ * Date and time the role was assigned
474
+ * @type {string}
475
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
476
+ */
477
+ 'assignedAt': string;
478
+ /**
479
+ * User who assigned the role
480
+ * @type {string}
481
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
482
+ */
483
+ 'assignedBy': string;
484
+ /**
485
+ * Type of resource the role is assigned to
486
+ * @type {string}
487
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
488
+ */
489
+ 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
490
+ /**
491
+ * Organization ID
492
+ * @type {string}
493
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
494
+ */
495
+ 'orgId'?: string;
496
+ /**
497
+ * Property ID
498
+ * @type {string}
499
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
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>;
609
+ }
610
+ /**
611
+ * Successful user permissions retrieval response
612
+ * @export
613
+ * @interface GetUserPermissionsSuccessResponse
614
+ */
615
+ export interface GetUserPermissionsSuccessResponse {
616
+ /**
617
+ * Map of resource IDs to permissions
618
+ * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
619
+ * @memberof GetUserPermissionsSuccessResponse
620
+ */
621
+ 'resources': {
622
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
623
+ };
624
+ }
625
+ /**
626
+ *
627
+ * @export
628
+ * @interface GetUserPermissionsSuccessResponseResourcesValue
629
+ */
630
+ export interface GetUserPermissionsSuccessResponseResourcesValue {
631
+ /**
632
+ * Type of resource the permissions are assigned to
633
+ * @type {string}
634
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
635
+ */
636
+ 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
637
+ /**
638
+ *
639
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
640
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
641
+ */
642
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
643
+ /**
644
+ * List of permissions that are assigned to the user for the resource
645
+ * @type {Array<string>}
646
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
647
+ */
648
+ 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
649
+ }
650
+ export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: {
651
+ readonly Property: "Property";
652
+ readonly Org: "Org";
653
+ readonly Brand: "Brand";
654
+ readonly SalesChannel: "SalesChannel";
655
+ };
656
+ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
657
+ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum: {
658
+ readonly AnyAuditLogs: "AnyAuditLogs";
659
+ readonly ViewApp: "ViewApp";
660
+ readonly CreateApp: "CreateApp";
661
+ readonly UpdateApp: "UpdateApp";
662
+ readonly ViewAppName: "ViewAppName";
663
+ readonly EditAppAssets: "EditAppAssets";
664
+ readonly EditAppFeatures: "EditAppFeatures";
665
+ readonly ViewTeammates: "ViewTeammates";
666
+ readonly EditTeammates: "EditTeammates";
667
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
668
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
669
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
670
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
671
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
672
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
673
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
674
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
675
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
676
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
677
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
678
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
679
+ readonly EditApmConfigurations: "EditApmConfigurations";
680
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
681
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
682
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
683
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
684
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
685
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
686
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
687
+ readonly ViewOrders: "ViewOrders";
688
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
689
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
690
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
691
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
692
+ readonly ViewStores: "ViewStores";
693
+ readonly CreateStores: "CreateStores";
694
+ readonly EditStores: "EditStores";
695
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
696
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
697
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
698
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
699
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
700
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
701
+ readonly UpdateStoresName: "UpdateStoresName";
702
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
703
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
704
+ readonly EditStoreNotifications: "EditStoreNotifications";
705
+ readonly ArchiveStores: "ArchiveStores";
706
+ readonly PublishStores: "PublishStores";
707
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
708
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
709
+ readonly ViewStoreGroups: "ViewStoreGroups";
710
+ readonly CreateStoreGroups: "CreateStoreGroups";
711
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
712
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
713
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
714
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
715
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
716
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
717
+ readonly ViewMenu: "ViewMenu";
718
+ readonly CreateMenu: "CreateMenu";
719
+ readonly UpdateMenu: "UpdateMenu";
720
+ readonly DeleteMenu: "DeleteMenu";
721
+ readonly UpdateMenuLock: "UpdateMenuLock";
722
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
723
+ readonly EditMenuImage: "EditMenuImage";
724
+ readonly ViewVouchers: "ViewVouchers";
725
+ readonly EditVouchers: "EditVouchers";
726
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
727
+ readonly EditWebsiteContent: "EditWebsiteContent";
728
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
729
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
730
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
731
+ readonly ViewBankAccounts: "ViewBankAccounts";
732
+ readonly CreateBankAccounts: "CreateBankAccounts";
733
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
734
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
735
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
736
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
737
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
738
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
739
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
740
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
741
+ readonly ViewHydraConfig: "ViewHydraConfig";
742
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
743
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
744
+ readonly DeleteTerminal: "DeleteTerminal";
745
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
746
+ readonly ViewCustomers: "ViewCustomers";
747
+ readonly EditCustomers: "EditCustomers";
748
+ readonly CreateCustomers: "CreateCustomers";
749
+ readonly CreateCatalogElements: "CreateCatalogElements";
750
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
751
+ readonly ViewCatalogElements: "ViewCatalogElements";
752
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
753
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
754
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
755
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
756
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
757
+ readonly UpdateMetafields: "UpdateMetafields";
758
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
759
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
760
+ readonly ViewAppStatistics: "ViewAppStatistics";
761
+ readonly ViewApmStatistics: "ViewApmStatistics";
762
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
763
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
764
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
765
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
766
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
767
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
768
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
769
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
770
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
771
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
772
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
773
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
774
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
775
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
776
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
777
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
778
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
779
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
780
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
781
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
782
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
783
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
784
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
785
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
786
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
787
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
788
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
789
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
790
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
791
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
792
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
793
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
794
+ readonly InviteDriverToApp: "InviteDriverToApp";
795
+ readonly GetDriverForApp: "GetDriverForApp";
796
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
797
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
798
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
799
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
800
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
801
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
802
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
803
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
804
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
805
+ readonly ViewPayouts: "ViewPayouts";
806
+ readonly ViewChannels: "ViewChannels";
807
+ readonly ViewOnboarding: "ViewOnboarding";
808
+ readonly UpdateOnboarding: "UpdateOnboarding";
809
+ readonly ViewClientDevices: "ViewClientDevices";
810
+ readonly UpdateClientDevices: "UpdateClientDevices";
811
+ readonly EnrollClientDevices: "EnrollClientDevices";
812
+ readonly AssignClientDevices: "AssignClientDevices";
813
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
814
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
815
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
816
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
817
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
818
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
819
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
820
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
821
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
822
+ readonly ViewSalesChannels: "ViewSalesChannels";
823
+ readonly EditSalesChannels: "EditSalesChannels";
824
+ readonly CreateSalesChannel: "CreateSalesChannel";
825
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
826
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
827
+ readonly PublishSalesChannel: "PublishSalesChannel";
828
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
829
+ readonly CloneSalesChannel: "CloneSalesChannel";
830
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
831
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
832
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
833
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
834
+ readonly ViewSubscriptions: "ViewSubscriptions";
835
+ readonly ViewInvoices: "ViewInvoices";
836
+ readonly EditAccountsBills: "EditAccountsBills";
837
+ readonly ViewAccountsBills: "ViewAccountsBills";
838
+ readonly EditAccountsCategories: "EditAccountsCategories";
839
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
840
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
841
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
842
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
843
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
844
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
845
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
846
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
847
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
848
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
849
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
850
+ readonly ViewInventoryReports: "ViewInventoryReports";
851
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
852
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
853
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
854
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
855
+ readonly EditInventorySupplier: "EditInventorySupplier";
856
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
857
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
858
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
859
+ readonly ViewPayrollReports: "ViewPayrollReports";
860
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
861
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
862
+ readonly EditPayrollRota: "EditPayrollRota";
863
+ readonly ViewPayrollRota: "ViewPayrollRota";
864
+ readonly EditPayrollStaff: "EditPayrollStaff";
865
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
866
+ readonly ViewSalesReports: "ViewSalesReports";
867
+ readonly ViewCostReports: "ViewCostReports";
868
+ readonly ViewMenuReports: "ViewMenuReports";
869
+ readonly ViewBrand: "ViewBrand";
870
+ readonly EditBrand: "EditBrand";
871
+ readonly CreateBrand: "CreateBrand";
872
+ readonly TransferBrand: "TransferBrand";
873
+ readonly ViewProperty: "ViewProperty";
874
+ readonly EditProperty: "EditProperty";
875
+ readonly CreateProperty: "CreateProperty";
876
+ readonly ArchiveProperty: "ArchiveProperty";
877
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
878
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
879
+ readonly CreateOrg: "CreateOrg";
880
+ readonly EditOrg: "EditOrg";
881
+ readonly ViewOrg: "ViewOrg";
882
+ };
883
+ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
884
+ /**
885
+ * ID of the resource the permissions are assigned to
886
+ * @export
887
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
888
+ */
889
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
890
+ }
891
+ /**
892
+ *
893
+ * @export
894
+ * @interface OrgPathParam
895
+ */
896
+ export interface OrgPathParam {
897
+ /**
898
+ *
899
+ * @type {string}
900
+ * @memberof OrgPathParam
901
+ */
902
+ 'orgId': string;
903
+ }
904
+ /**
905
+ *
906
+ * @export
907
+ * @interface PathParams
908
+ */
909
+ export interface PathParams {
910
+ /**
911
+ *
912
+ * @type {string}
913
+ * @memberof PathParams
914
+ */
915
+ 'orgId': string;
916
+ /**
917
+ *
918
+ * @type {string}
919
+ * @memberof PathParams
920
+ */
921
+ 'userId': string;
922
+ }
923
+ /**
924
+ *
925
+ * @export
926
+ * @enum {string}
927
+ */
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";
952
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
953
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
954
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
955
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
956
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
957
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
958
+ readonly ViewOrders: "ViewOrders";
959
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
960
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
961
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
962
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
963
+ readonly ViewStores: "ViewStores";
964
+ readonly CreateStores: "CreateStores";
965
+ readonly EditStores: "EditStores";
966
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
967
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
968
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
969
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
970
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
971
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
972
+ readonly UpdateStoresName: "UpdateStoresName";
973
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
974
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
975
+ readonly EditStoreNotifications: "EditStoreNotifications";
976
+ readonly ArchiveStores: "ArchiveStores";
977
+ readonly PublishStores: "PublishStores";
978
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
979
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
980
+ readonly ViewStoreGroups: "ViewStoreGroups";
981
+ readonly CreateStoreGroups: "CreateStoreGroups";
982
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
983
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
984
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
985
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
986
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
987
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
988
+ readonly ViewMenu: "ViewMenu";
989
+ readonly CreateMenu: "CreateMenu";
990
+ readonly UpdateMenu: "UpdateMenu";
991
+ readonly DeleteMenu: "DeleteMenu";
992
+ readonly UpdateMenuLock: "UpdateMenuLock";
993
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
994
+ readonly EditMenuImage: "EditMenuImage";
995
+ readonly ViewVouchers: "ViewVouchers";
996
+ readonly EditVouchers: "EditVouchers";
997
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
998
+ readonly EditWebsiteContent: "EditWebsiteContent";
999
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1000
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1001
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1002
+ readonly ViewBankAccounts: "ViewBankAccounts";
1003
+ readonly CreateBankAccounts: "CreateBankAccounts";
1004
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1005
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1006
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1007
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1008
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1009
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1010
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1011
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1012
+ readonly ViewHydraConfig: "ViewHydraConfig";
1013
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1014
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1015
+ readonly DeleteTerminal: "DeleteTerminal";
1016
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1017
+ readonly ViewCustomers: "ViewCustomers";
1018
+ readonly EditCustomers: "EditCustomers";
1019
+ readonly CreateCustomers: "CreateCustomers";
1020
+ readonly CreateCatalogElements: "CreateCatalogElements";
1021
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1022
+ readonly ViewCatalogElements: "ViewCatalogElements";
1023
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1024
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1025
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1026
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1027
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1028
+ readonly UpdateMetafields: "UpdateMetafields";
1029
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1030
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1031
+ readonly ViewAppStatistics: "ViewAppStatistics";
1032
+ readonly ViewApmStatistics: "ViewApmStatistics";
1033
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1034
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1035
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1036
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1037
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1038
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1039
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1040
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1041
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1042
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1043
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1044
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1045
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1046
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1047
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1048
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1049
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1050
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1051
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1052
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1053
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1054
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1055
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1056
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1057
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1058
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1059
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1060
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1061
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1062
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1063
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1064
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1065
+ readonly InviteDriverToApp: "InviteDriverToApp";
1066
+ readonly GetDriverForApp: "GetDriverForApp";
1067
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1068
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1069
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1070
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1071
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1072
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1073
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1074
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1075
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1076
+ readonly ViewPayouts: "ViewPayouts";
1077
+ readonly ViewChannels: "ViewChannels";
1078
+ readonly ViewOnboarding: "ViewOnboarding";
1079
+ readonly UpdateOnboarding: "UpdateOnboarding";
1080
+ readonly ViewClientDevices: "ViewClientDevices";
1081
+ readonly UpdateClientDevices: "UpdateClientDevices";
1082
+ readonly EnrollClientDevices: "EnrollClientDevices";
1083
+ readonly AssignClientDevices: "AssignClientDevices";
1084
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1085
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1086
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1087
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1088
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1089
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1090
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1091
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1092
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1093
+ readonly ViewSalesChannels: "ViewSalesChannels";
1094
+ readonly EditSalesChannels: "EditSalesChannels";
1095
+ readonly CreateSalesChannel: "CreateSalesChannel";
1096
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1097
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1098
+ readonly PublishSalesChannel: "PublishSalesChannel";
1099
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1100
+ readonly CloneSalesChannel: "CloneSalesChannel";
1101
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1102
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1103
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1104
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1105
+ readonly ViewSubscriptions: "ViewSubscriptions";
1106
+ readonly ViewInvoices: "ViewInvoices";
1107
+ readonly EditAccountsBills: "EditAccountsBills";
1108
+ readonly ViewAccountsBills: "ViewAccountsBills";
1109
+ readonly EditAccountsCategories: "EditAccountsCategories";
1110
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1111
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1112
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1113
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1114
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1115
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1116
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1117
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1118
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1119
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1120
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1121
+ readonly ViewInventoryReports: "ViewInventoryReports";
1122
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1123
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1124
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1125
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1126
+ readonly EditInventorySupplier: "EditInventorySupplier";
1127
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1128
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1129
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1130
+ readonly ViewPayrollReports: "ViewPayrollReports";
1131
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1132
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1133
+ readonly EditPayrollRota: "EditPayrollRota";
1134
+ readonly ViewPayrollRota: "ViewPayrollRota";
1135
+ readonly EditPayrollStaff: "EditPayrollStaff";
1136
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1137
+ readonly ViewSalesReports: "ViewSalesReports";
1138
+ readonly ViewCostReports: "ViewCostReports";
1139
+ readonly ViewMenuReports: "ViewMenuReports";
1140
+ readonly ViewBrand: "ViewBrand";
1141
+ readonly EditBrand: "EditBrand";
1142
+ readonly CreateBrand: "CreateBrand";
1143
+ readonly TransferBrand: "TransferBrand";
1144
+ readonly ViewProperty: "ViewProperty";
1145
+ readonly EditProperty: "EditProperty";
1146
+ readonly CreateProperty: "CreateProperty";
1147
+ readonly ArchiveProperty: "ArchiveProperty";
1148
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1149
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1150
+ readonly CreateOrg: "CreateOrg";
1151
+ readonly EditOrg: "EditOrg";
1152
+ readonly ViewOrg: "ViewOrg";
1153
+ };
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];
1183
+ /**
1184
+ * Details for revoking a role from a principal
1185
+ * @export
1186
+ * @interface RevokeRoleRequestBody
1187
+ */
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;
1195
+ /**
1196
+ *
1197
+ * @type {AuthorizationRequestResource}
1198
+ * @memberof RevokeRoleRequestBody
1199
+ */
1200
+ 'resource': AuthorizationRequestResource;
1201
+ /**
1202
+ *
1203
+ * @type {AuthorizationRequestPrincipal}
1204
+ * @memberof RevokeRoleRequestBody
1205
+ */
1206
+ 'principal': AuthorizationRequestPrincipal;
1207
+ /**
1208
+ *
1209
+ * @type {string}
1210
+ * @memberof RevokeRoleRequestBody
1211
+ */
1212
+ 'brandId': string;
1213
+ }
1214
+ export declare const RevokeRoleRequestBodyRoleEnum: {
1215
+ readonly OrgViewer: "OrgViewer";
1216
+ readonly OrgManager: "OrgManager";
1217
+ readonly OrgAdmin: "OrgAdmin";
1218
+ readonly BrandViewer: "BrandViewer";
1219
+ readonly BrandManager: "BrandManager";
1220
+ readonly BrandAdmin: "BrandAdmin";
1221
+ readonly StoreViewer: "StoreViewer";
1222
+ readonly StoreEditor: "StoreEditor";
1223
+ readonly StoreManager: "StoreManager";
1224
+ readonly CustomerViewer: "CustomerViewer";
1225
+ readonly CustomerManager: "CustomerManager";
1226
+ readonly VoucherViewer: "VoucherViewer";
1227
+ readonly VoucherEditor: "VoucherEditor";
1228
+ readonly VoucherManager: "VoucherManager";
1229
+ readonly VoucherCampaignManager: "VoucherCampaignManager";
1230
+ readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
1231
+ readonly AnalyticsViewer: "AnalyticsViewer";
1232
+ readonly ReportsViewer: "ReportsViewer";
1233
+ readonly FinanceViewer: "FinanceViewer";
1234
+ readonly FinanceManager: "FinanceManager";
1235
+ readonly TeamViewer: "TeamViewer";
1236
+ readonly TeamManager: "TeamManager";
1237
+ readonly TeamAdmin: "TeamAdmin";
1238
+ readonly TechViewer: "TechViewer";
1239
+ readonly TechManager: "TechManager";
1240
+ readonly AppStoreViewer: "AppStoreViewer";
1241
+ readonly AppStoreManager: "AppStoreManager";
1242
+ readonly SalesChannelViewer: "SalesChannelViewer";
1243
+ readonly SalesChannelEditor: "SalesChannelEditor";
1244
+ readonly SalesChannelManager: "SalesChannelManager";
1245
+ readonly DeliveryViewer: "DeliveryViewer";
1246
+ readonly DeliveryManager: "DeliveryManager";
1247
+ readonly DriverManager: "DriverManager";
1248
+ readonly AuditViewer: "AuditViewer";
1249
+ readonly AuditManager: "AuditManager";
1250
+ readonly AccountsViewer: "AccountsViewer";
1251
+ readonly AccountsEditor: "AccountsEditor";
1252
+ readonly DocumentExplorerViewer: "DocumentExplorerViewer";
1253
+ readonly DocumentExplorerEditor: "DocumentExplorerEditor";
1254
+ readonly PayrollViewer: "PayrollViewer";
1255
+ readonly PayrollEditor: "PayrollEditor";
1256
+ readonly PropertyViewer: "PropertyViewer";
1257
+ readonly PropertyManager: "PropertyManager";
1258
+ readonly PropertyAdmin: "PropertyAdmin";
1259
+ readonly WebsiteContentEditor: "WebsiteContentEditor";
1260
+ readonly WebsiteContentViewer: "WebsiteContentViewer";
1261
+ readonly WebsiteTechViewer: "WebsiteTechViewer";
1262
+ readonly MenuViewer: "MenuViewer";
1263
+ readonly MenuEditor: "MenuEditor";
1264
+ readonly MenuManager: "MenuManager";
1265
+ readonly MenuMetaFieldManager: "MenuMetaFieldManager";
1266
+ readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
1267
+ readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
1268
+ readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
1269
+ readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
1270
+ readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
1271
+ readonly OrderFulfillmentManager: "OrderFulfillmentManager";
1272
+ readonly OrderManager: "OrderManager";
1273
+ readonly OrderEditor: "OrderEditor";
1274
+ readonly OrderViewer: "OrderViewer";
1275
+ readonly InventoryManager: "InventoryManager";
1276
+ readonly InventoryEditor: "InventoryEditor";
1277
+ readonly InventoryViewer: "InventoryViewer";
1278
+ readonly PaymentManager: "PaymentManager";
1279
+ readonly OnboardingManager: "OnboardingManager";
1280
+ readonly FeatureFlagManager: "FeatureFlagManager";
1281
+ readonly PropertyOwnerMisc: "PropertyOwnerMisc";
1282
+ readonly ManagedOwnerMisc: "ManagedOwnerMisc";
1283
+ readonly IntegratorMisc: "IntegratorMisc";
1284
+ readonly PropertyManagerMisc: "PropertyManagerMisc";
1285
+ readonly FinanceManagerMisc: "FinanceManagerMisc";
1286
+ readonly SupportMisc: "SupportMisc";
1287
+ };
1288
+ export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
1289
+ /**
1290
+ * Successful role revocation response
1291
+ * @export
1292
+ * @interface RevokeRoleSuccessResponse
1293
+ */
1294
+ export interface RevokeRoleSuccessResponse {
1295
+ /**
1296
+ * Confirmation message
1297
+ * @type {string}
1298
+ * @memberof RevokeRoleSuccessResponse
1299
+ */
1300
+ 'message': string;
1301
+ }
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
1318
+ */
1319
+ 'permissions': Permissions & Array<string>;
1320
+ }
1321
+ /**
1322
+ *
1323
+ * @export
1324
+ * @interface ValidationErrorsInner
1325
+ */
1326
+ export interface ValidationErrorsInner {
1327
+ /**
1328
+ *
1329
+ * @type {Array<ValidationErrorsInnerPathInner>}
1330
+ * @memberof ValidationErrorsInner
1331
+ */
1332
+ 'path'?: Array<ValidationErrorsInnerPathInner>;
1333
+ /**
1334
+ *
1335
+ * @type {string}
1336
+ * @memberof ValidationErrorsInner
1337
+ */
1338
+ 'message': string;
1339
+ }
1340
+ /**
1341
+ *
1342
+ * @export
1343
+ * @interface ValidationErrorsInnerPathInner
1344
+ */
1345
+ export interface ValidationErrorsInnerPathInner {
1346
+ }
1347
+ /**
1348
+ * AuthenticationApi - axios parameter creator
1349
+ * @export
1350
+ */
1351
+ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
1352
+ /**
1353
+ * Authenticate and authorize a user to perform an action
1354
+ * @summary Authenticate and authorize Request
1355
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1356
+ * @param {*} [options] Override http request option.
1357
+ * @throws {RequiredError}
1358
+ */
1359
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1360
+ };
1361
+ /**
1362
+ * AuthenticationApi - functional programming interface
1363
+ * @export
1364
+ */
1365
+ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
1366
+ /**
1367
+ * Authenticate and authorize a user to perform an action
1368
+ * @summary Authenticate and authorize Request
1369
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1370
+ * @param {*} [options] Override http request option.
1371
+ * @throws {RequiredError}
1372
+ */
1373
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
1374
+ };
1375
+ /**
1376
+ * AuthenticationApi - factory interface
1377
+ * @export
1378
+ */
1379
+ export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1380
+ /**
1381
+ * Authenticate and authorize a user to perform an action
1382
+ * @summary Authenticate and authorize Request
1383
+ * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ */
1387
+ authenticateAndAuthorize(requestParameters?: AuthenticationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
1388
+ };
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
+ /**
1403
+ * AuthenticationApi - object-oriented interface
1404
+ * @export
1405
+ * @class AuthenticationApi
1406
+ * @extends {BaseAPI}
1407
+ */
1408
+ export declare class AuthenticationApi extends BaseAPI {
1409
+ /**
1410
+ * Authenticate and authorize a user to perform an action
1411
+ * @summary Authenticate and authorize Request
1412
+ * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1413
+ * @param {*} [options] Override http request option.
1414
+ * @throws {RequiredError}
1415
+ * @memberof AuthenticationApi
1416
+ */
1417
+ authenticateAndAuthorize(requestParameters?: AuthenticationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
1418
+ }
1419
+ /**
1420
+ * AuthorizationApi - axios parameter creator
1421
+ * @export
1422
+ */
1423
+ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
1424
+ /**
1425
+ * Authenticate and authorize a user to perform an action
1426
+ * @summary Authenticate and authorize Request
1427
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1428
+ * @param {*} [options] Override http request option.
1429
+ * @throws {RequiredError}
1430
+ */
1431
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1432
+ /**
1433
+ * Check if a user is authorized to perform an action
1434
+ * @summary Authorize Request
1435
+ * @param {AuthorizationRequest} [authorizationRequest]
1436
+ * @param {*} [options] Override http request option.
1437
+ * @throws {RequiredError}
1438
+ */
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) => {
1446
+ /**
1447
+ * Authenticate and authorize a user to perform an action
1448
+ * @summary Authenticate and authorize Request
1449
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1450
+ * @param {*} [options] Override http request option.
1451
+ * @throws {RequiredError}
1452
+ */
1453
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
1454
+ /**
1455
+ * Check if a user is authorized to perform an action
1456
+ * @summary Authorize Request
1457
+ * @param {AuthorizationRequest} [authorizationRequest]
1458
+ * @param {*} [options] Override http request option.
1459
+ * @throws {RequiredError}
1460
+ */
1461
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
1462
+ };
1463
+ /**
1464
+ * AuthorizationApi - factory interface
1465
+ * @export
1466
+ */
1467
+ export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1468
+ /**
1469
+ * Authenticate and authorize a user to perform an action
1470
+ * @summary Authenticate and authorize Request
1471
+ * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1472
+ * @param {*} [options] Override http request option.
1473
+ * @throws {RequiredError}
1474
+ */
1475
+ authenticateAndAuthorize(requestParameters?: AuthorizationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
1476
+ /**
1477
+ * Check if a user is authorized to perform an action
1478
+ * @summary Authorize Request
1479
+ * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
1480
+ * @param {*} [options] Override http request option.
1481
+ * @throws {RequiredError}
1482
+ */
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 {
1491
+ /**
1492
+ *
1493
+ * @type {AuthenticateAndAuthorizeRequest}
1494
+ * @memberof AuthorizationApiAuthenticateAndAuthorize
1495
+ */
1496
+ readonly authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest;
1497
+ }
1498
+ /**
1499
+ * Request parameters for authorize operation in AuthorizationApi.
1500
+ * @export
1501
+ * @interface AuthorizationApiAuthorizeRequest
1502
+ */
1503
+ export interface AuthorizationApiAuthorizeRequest {
1504
+ /**
1505
+ *
1506
+ * @type {AuthorizationRequest}
1507
+ * @memberof AuthorizationApiAuthorize
1508
+ */
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 {
1518
+ /**
1519
+ * Authenticate and authorize a user to perform an action
1520
+ * @summary Authenticate and authorize Request
1521
+ * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1522
+ * @param {*} [options] Override http request option.
1523
+ * @throws {RequiredError}
1524
+ * @memberof AuthorizationApi
1525
+ */
1526
+ authenticateAndAuthorize(requestParameters?: AuthorizationApiAuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
1527
+ /**
1528
+ * Check if a user is authorized to perform an action
1529
+ * @summary Authorize Request
1530
+ * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
1531
+ * @param {*} [options] Override http request option.
1532
+ * @throws {RequiredError}
1533
+ * @memberof AuthorizationApi
1534
+ */
1535
+ authorize(requestParameters?: AuthorizationApiAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any>>;
1536
+ }
1537
+ /**
1538
+ * PermissionsApi - axios parameter creator
1539
+ * @export
1540
+ */
1541
+ export declare const PermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
1542
+ /**
1543
+ * List the available permissions
1544
+ * @summary List Permissions
1545
+ * @param {*} [options] Override http request option.
1546
+ * @throws {RequiredError}
1547
+ */
1548
+ listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1549
+ };
1550
+ /**
1551
+ * PermissionsApi - functional programming interface
1552
+ * @export
1553
+ */
1554
+ export declare const PermissionsApiFp: (configuration?: Configuration) => {
1555
+ /**
1556
+ * List the available permissions
1557
+ * @summary List Permissions
1558
+ * @param {*} [options] Override http request option.
1559
+ * @throws {RequiredError}
1560
+ */
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) => {
1568
+ /**
1569
+ * List the available permissions
1570
+ * @summary List Permissions
1571
+ * @param {*} [options] Override http request option.
1572
+ * @throws {RequiredError}
1573
+ */
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 {
1583
+ /**
1584
+ * List the available permissions
1585
+ * @summary List Permissions
1586
+ * @param {*} [options] Override http request option.
1587
+ * @throws {RequiredError}
1588
+ * @memberof PermissionsApi
1589
+ */
1590
+ listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPermissionsSuccessResponse, any>>;
1591
+ }
1592
+ /**
1593
+ * RoleAssignmentApi - axios parameter creator
1594
+ * @export
1595
+ */
1596
+ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Configuration) => {
1597
+ /**
1598
+ * Assigns a specified role to a given principal (user, group, etc.)
1599
+ * @summary Assign Role to Principal
1600
+ * @param {string} orgId
1601
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
1602
+ * @param {*} [options] Override http request option.
1603
+ * @throws {RequiredError}
1604
+ */
1605
+ assignRoleToPrincipal: (orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1606
+ /**
1607
+ * Get the active roles for a given principal
1608
+ * @summary Get Principal Roles
1609
+ * @param {string} orgId
1610
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
1611
+ * @param {*} [options] Override http request option.
1612
+ * @throws {RequiredError}
1613
+ */
1614
+ getPrincipalRoles: (orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1615
+ /**
1616
+ * Revokes a forbidden role from a given principal (user, group, etc.)
1617
+ * @summary Revoke Forbidden Role from Principal
1618
+ * @param {string} orgId
1619
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
1620
+ * @param {*} [options] Override http request option.
1621
+ * @throws {RequiredError}
1622
+ */
1623
+ revokeForbiddenRoleFromPrincipal: (orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1624
+ /**
1625
+ * Revokes a specified role from a given principal (user, group, etc.)
1626
+ * @summary Revoke Role from Principal
1627
+ * @param {string} orgId
1628
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
1629
+ * @param {*} [options] Override http request option.
1630
+ * @throws {RequiredError}
1631
+ */
1632
+ revokeRoleFromPrincipal: (orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1633
+ };
1634
+ /**
1635
+ * RoleAssignmentApi - functional programming interface
1636
+ * @export
1637
+ */
1638
+ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
1639
+ /**
1640
+ * Assigns a specified role to a given principal (user, group, etc.)
1641
+ * @summary Assign Role to Principal
1642
+ * @param {string} orgId
1643
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
1644
+ * @param {*} [options] Override http request option.
1645
+ * @throws {RequiredError}
1646
+ */
1647
+ assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignRoleSuccessResponse>>;
1648
+ /**
1649
+ * Get the active roles for a given principal
1650
+ * @summary Get Principal Roles
1651
+ * @param {string} orgId
1652
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
1653
+ * @param {*} [options] Override http request option.
1654
+ * @throws {RequiredError}
1655
+ */
1656
+ getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrincipalRolesSuccessResponse>>;
1657
+ /**
1658
+ * Revokes a forbidden role from a given principal (user, group, etc.)
1659
+ * @summary Revoke Forbidden Role from Principal
1660
+ * @param {string} orgId
1661
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
1662
+ * @param {*} [options] Override http request option.
1663
+ * @throws {RequiredError}
1664
+ */
1665
+ revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>>;
1666
+ /**
1667
+ * Revokes a specified role from a given principal (user, group, etc.)
1668
+ * @summary Revoke Role from Principal
1669
+ * @param {string} orgId
1670
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
1671
+ * @param {*} [options] Override http request option.
1672
+ * @throws {RequiredError}
1673
+ */
1674
+ revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>>;
1675
+ };
1676
+ /**
1677
+ * RoleAssignmentApi - factory interface
1678
+ * @export
1679
+ */
1680
+ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1681
+ /**
1682
+ * Assigns a specified role to a given principal (user, group, etc.)
1683
+ * @summary Assign Role to Principal
1684
+ * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
1685
+ * @param {*} [options] Override http request option.
1686
+ * @throws {RequiredError}
1687
+ */
1688
+ assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<AssignRoleSuccessResponse>;
1689
+ /**
1690
+ * Get the active roles for a given principal
1691
+ * @summary Get Principal Roles
1692
+ * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
1693
+ * @param {*} [options] Override http request option.
1694
+ * @throws {RequiredError}
1695
+ */
1696
+ getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse>;
1697
+ /**
1698
+ * Revokes a forbidden role from a given principal (user, group, etc.)
1699
+ * @summary Revoke Forbidden Role from Principal
1700
+ * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
1701
+ * @param {*} [options] Override http request option.
1702
+ * @throws {RequiredError}
1703
+ */
1704
+ revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
1705
+ /**
1706
+ * Revokes a specified role from a given principal (user, group, etc.)
1707
+ * @summary Revoke Role from Principal
1708
+ * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
1709
+ * @param {*} [options] Override http request option.
1710
+ * @throws {RequiredError}
1711
+ */
1712
+ revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
1713
+ };
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
+ /**
1791
+ * RoleAssignmentApi - object-oriented interface
1792
+ * @export
1793
+ * @class RoleAssignmentApi
1794
+ * @extends {BaseAPI}
1795
+ */
1796
+ export declare class RoleAssignmentApi extends BaseAPI {
1797
+ /**
1798
+ * Assigns a specified role to a given principal (user, group, etc.)
1799
+ * @summary Assign Role to Principal
1800
+ * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
1801
+ * @param {*} [options] Override http request option.
1802
+ * @throws {RequiredError}
1803
+ * @memberof RoleAssignmentApi
1804
+ */
1805
+ assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any>>;
1806
+ /**
1807
+ * Get the active roles for a given principal
1808
+ * @summary Get Principal Roles
1809
+ * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
1810
+ * @param {*} [options] Override http request option.
1811
+ * @throws {RequiredError}
1812
+ * @memberof RoleAssignmentApi
1813
+ */
1814
+ getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any>>;
1815
+ /**
1816
+ * Revokes a forbidden role from a given principal (user, group, etc.)
1817
+ * @summary Revoke Forbidden Role from Principal
1818
+ * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
1819
+ * @param {*} [options] Override http request option.
1820
+ * @throws {RequiredError}
1821
+ * @memberof RoleAssignmentApi
1822
+ */
1823
+ revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
1824
+ /**
1825
+ * Revokes a specified role from a given principal (user, group, etc.)
1826
+ * @summary Revoke Role from Principal
1827
+ * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
1828
+ * @param {*} [options] Override http request option.
1829
+ * @throws {RequiredError}
1830
+ * @memberof RoleAssignmentApi
1831
+ */
1832
+ revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
1833
+ }
1834
+ /**
1835
+ * UserPermissionsApi - axios parameter creator
1836
+ * @export
1837
+ */
1838
+ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
1839
+ /**
1840
+ * List the available permissions for the current user
1841
+ * @summary List Own Permissions
1842
+ * @param {string} orgId
1843
+ * @param {*} [options] Override http request option.
1844
+ * @throws {RequiredError}
1845
+ */
1846
+ listOwnPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1847
+ /**
1848
+ * List the available permissions for a given user
1849
+ * @summary List User Permissions
1850
+ * @param {string} orgId
1851
+ * @param {string} userId
1852
+ * @param {*} [options] Override http request option.
1853
+ * @throws {RequiredError}
1854
+ */
1855
+ listUserPermissions: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1856
+ };
1857
+ /**
1858
+ * UserPermissionsApi - functional programming interface
1859
+ * @export
1860
+ */
1861
+ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
1862
+ /**
1863
+ * List the available permissions for the current user
1864
+ * @summary List Own Permissions
1865
+ * @param {string} orgId
1866
+ * @param {*} [options] Override http request option.
1867
+ * @throws {RequiredError}
1868
+ */
1869
+ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
1870
+ /**
1871
+ * List the available permissions for a given user
1872
+ * @summary List User Permissions
1873
+ * @param {string} orgId
1874
+ * @param {string} userId
1875
+ * @param {*} [options] Override http request option.
1876
+ * @throws {RequiredError}
1877
+ */
1878
+ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>>;
1879
+ };
1880
+ /**
1881
+ * UserPermissionsApi - factory interface
1882
+ * @export
1883
+ */
1884
+ export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1885
+ /**
1886
+ * List the available permissions for the current user
1887
+ * @summary List Own Permissions
1888
+ * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
1889
+ * @param {*} [options] Override http request option.
1890
+ * @throws {RequiredError}
1891
+ */
1892
+ listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse>;
1893
+ /**
1894
+ * List the available permissions for a given user
1895
+ * @summary List User Permissions
1896
+ * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
1897
+ * @param {*} [options] Override http request option.
1898
+ * @throws {RequiredError}
1899
+ */
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 {
1921
+ /**
1922
+ *
1923
+ * @type {string}
1924
+ * @memberof UserPermissionsApiListUserPermissions
1925
+ */
1926
+ readonly orgId: string;
1927
+ /**
1928
+ *
1929
+ * @type {string}
1930
+ * @memberof UserPermissionsApiListUserPermissions
1931
+ */
1932
+ readonly userId: string;
1933
+ }
1934
+ /**
1935
+ * UserPermissionsApi - object-oriented interface
1936
+ * @export
1937
+ * @class UserPermissionsApi
1938
+ * @extends {BaseAPI}
1939
+ */
1940
+ export declare class UserPermissionsApi extends BaseAPI {
1941
+ /**
1942
+ * List the available permissions for the current user
1943
+ * @summary List Own Permissions
1944
+ * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
1945
+ * @param {*} [options] Override http request option.
1946
+ * @throws {RequiredError}
1947
+ * @memberof UserPermissionsApi
1948
+ */
1949
+ listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
1950
+ /**
1951
+ * List the available permissions for a given user
1952
+ * @summary List User Permissions
1953
+ * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
1954
+ * @param {*} [options] Override http request option.
1955
+ * @throws {RequiredError}
1956
+ * @memberof UserPermissionsApi
1957
+ */
1958
+ listUserPermissions(requestParameters: UserPermissionsApiListUserPermissionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
1959
+ }