@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/api.ts ADDED
@@ -0,0 +1,2484 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Authorization API
5
+ * Authorization API
6
+ *
7
+ * The version of the OpenAPI document: 0.0.1
8
+ * Contact: support@flipdish.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from './configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
22
+ import type { RequestArgs } from './base';
23
+ // @ts-ignore
24
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
+
26
+ /**
27
+ * Details for assigning a role to a principal
28
+ * @export
29
+ * @interface AssignRoleRequestBody
30
+ */
31
+ export interface AssignRoleRequestBody {
32
+ /**
33
+ * 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
34
+ * @type {string}
35
+ * @memberof AssignRoleRequestBody
36
+ */
37
+ 'role': AssignRoleRequestBodyRoleEnum;
38
+ /**
39
+ *
40
+ * @type {AuthorizationRequestResource}
41
+ * @memberof AssignRoleRequestBody
42
+ */
43
+ 'resource': AuthorizationRequestResource;
44
+ /**
45
+ *
46
+ * @type {AuthorizationRequestPrincipal}
47
+ * @memberof AssignRoleRequestBody
48
+ */
49
+ 'principal': AuthorizationRequestPrincipal;
50
+ }
51
+
52
+ export const AssignRoleRequestBodyRoleEnum = {
53
+ OrgViewer: 'OrgViewer',
54
+ OrgManager: 'OrgManager',
55
+ OrgAdmin: 'OrgAdmin',
56
+ BrandViewer: 'BrandViewer',
57
+ BrandManager: 'BrandManager',
58
+ BrandAdmin: 'BrandAdmin',
59
+ StoreViewer: 'StoreViewer',
60
+ StoreEditor: 'StoreEditor',
61
+ StoreManager: 'StoreManager',
62
+ CustomerViewer: 'CustomerViewer',
63
+ CustomerManager: 'CustomerManager',
64
+ VoucherViewer: 'VoucherViewer',
65
+ VoucherEditor: 'VoucherEditor',
66
+ VoucherManager: 'VoucherManager',
67
+ VoucherCampaignManager: 'VoucherCampaignManager',
68
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
69
+ AnalyticsViewer: 'AnalyticsViewer',
70
+ ReportsViewer: 'ReportsViewer',
71
+ FinanceViewer: 'FinanceViewer',
72
+ FinanceManager: 'FinanceManager',
73
+ TeamViewer: 'TeamViewer',
74
+ TeamManager: 'TeamManager',
75
+ TeamAdmin: 'TeamAdmin',
76
+ TechViewer: 'TechViewer',
77
+ TechManager: 'TechManager',
78
+ AppStoreViewer: 'AppStoreViewer',
79
+ AppStoreManager: 'AppStoreManager',
80
+ SalesChannelViewer: 'SalesChannelViewer',
81
+ SalesChannelEditor: 'SalesChannelEditor',
82
+ SalesChannelManager: 'SalesChannelManager',
83
+ DeliveryViewer: 'DeliveryViewer',
84
+ DeliveryManager: 'DeliveryManager',
85
+ DriverManager: 'DriverManager',
86
+ AuditViewer: 'AuditViewer',
87
+ AuditManager: 'AuditManager',
88
+ AccountsViewer: 'AccountsViewer',
89
+ AccountsEditor: 'AccountsEditor',
90
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
91
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
92
+ PayrollViewer: 'PayrollViewer',
93
+ PayrollEditor: 'PayrollEditor',
94
+ PropertyViewer: 'PropertyViewer',
95
+ PropertyManager: 'PropertyManager',
96
+ PropertyAdmin: 'PropertyAdmin',
97
+ WebsiteContentEditor: 'WebsiteContentEditor',
98
+ WebsiteContentViewer: 'WebsiteContentViewer',
99
+ WebsiteTechViewer: 'WebsiteTechViewer',
100
+ MenuViewer: 'MenuViewer',
101
+ MenuEditor: 'MenuEditor',
102
+ MenuManager: 'MenuManager',
103
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
104
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
105
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
106
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
107
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
108
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
109
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
110
+ OrderManager: 'OrderManager',
111
+ OrderEditor: 'OrderEditor',
112
+ OrderViewer: 'OrderViewer',
113
+ InventoryManager: 'InventoryManager',
114
+ InventoryEditor: 'InventoryEditor',
115
+ InventoryViewer: 'InventoryViewer',
116
+ PaymentManager: 'PaymentManager',
117
+ OnboardingManager: 'OnboardingManager',
118
+ FeatureFlagManager: 'FeatureFlagManager',
119
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
120
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
121
+ IntegratorMisc: 'IntegratorMisc',
122
+ PropertyManagerMisc: 'PropertyManagerMisc',
123
+ FinanceManagerMisc: 'FinanceManagerMisc',
124
+ SupportMisc: 'SupportMisc'
125
+ } as const;
126
+
127
+ export type AssignRoleRequestBodyRoleEnum = typeof AssignRoleRequestBodyRoleEnum[keyof typeof AssignRoleRequestBodyRoleEnum];
128
+
129
+ /**
130
+ * Successful role assignment response
131
+ * @export
132
+ * @interface AssignRoleSuccessResponse
133
+ */
134
+ export interface AssignRoleSuccessResponse {
135
+ /**
136
+ * Confirmation message
137
+ * @type {string}
138
+ * @memberof AssignRoleSuccessResponse
139
+ */
140
+ 'message': string;
141
+ }
142
+ /**
143
+ * 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.
144
+ * @export
145
+ * @interface AuthenticateAndAuthorizeRequest
146
+ */
147
+ export interface AuthenticateAndAuthorizeRequest {
148
+ /**
149
+ * Incoming request headers to be used for authentication
150
+ * @type {{ [key: string]: any; }}
151
+ * @memberof AuthenticateAndAuthorizeRequest
152
+ */
153
+ 'headers': { [key: string]: any; };
154
+ /**
155
+ *
156
+ * @type {AuthorizationRequestAction}
157
+ * @memberof AuthenticateAndAuthorizeRequest
158
+ */
159
+ 'action': AuthorizationRequestAction;
160
+ /**
161
+ *
162
+ * @type {AuthorizationRequestResource}
163
+ * @memberof AuthenticateAndAuthorizeRequest
164
+ */
165
+ 'resource'?: AuthorizationRequestResource;
166
+ }
167
+ /**
168
+ * Response containing the authentication and authorization decision
169
+ * @export
170
+ * @interface AuthenticateAndAuthorizeResponse
171
+ */
172
+ export interface AuthenticateAndAuthorizeResponse {
173
+ /**
174
+ *
175
+ * @type {AuthenticateAndAuthorizeResponseAuthentication}
176
+ * @memberof AuthenticateAndAuthorizeResponse
177
+ */
178
+ 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
179
+ /**
180
+ *
181
+ * @type {AuthorizationResponse}
182
+ * @memberof AuthenticateAndAuthorizeResponse
183
+ */
184
+ 'authorization'?: AuthorizationResponse;
185
+ }
186
+ /**
187
+ *
188
+ * @export
189
+ * @interface AuthenticateAndAuthorizeResponseAuthentication
190
+ */
191
+ export interface AuthenticateAndAuthorizeResponseAuthentication {
192
+ /**
193
+ *
194
+ * @type {AuthorizationRequestPrincipal}
195
+ * @memberof AuthenticateAndAuthorizeResponseAuthentication
196
+ */
197
+ 'principal': AuthorizationRequestPrincipal;
198
+ /**
199
+ * Whether the user is authenticated
200
+ * @type {boolean}
201
+ * @memberof AuthenticateAndAuthorizeResponseAuthentication
202
+ */
203
+ 'authenticated': boolean;
204
+ /**
205
+ * The reason for the authentication failure
206
+ * @type {string}
207
+ * @memberof AuthenticateAndAuthorizeResponseAuthentication
208
+ */
209
+ 'reason'?: string;
210
+ }
211
+ /**
212
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
213
+ * @export
214
+ * @interface AuthorizationRequest
215
+ */
216
+ export interface AuthorizationRequest {
217
+ /**
218
+ *
219
+ * @type {AuthorizationRequestPrincipal}
220
+ * @memberof AuthorizationRequest
221
+ */
222
+ 'principal': AuthorizationRequestPrincipal;
223
+ /**
224
+ *
225
+ * @type {AuthorizationRequestAction}
226
+ * @memberof AuthorizationRequest
227
+ */
228
+ 'action': AuthorizationRequestAction;
229
+ /**
230
+ *
231
+ * @type {AuthorizationRequestResource}
232
+ * @memberof AuthorizationRequest
233
+ */
234
+ 'resource'?: AuthorizationRequestResource;
235
+ }
236
+ /**
237
+ *
238
+ * @export
239
+ * @interface AuthorizationRequestAction
240
+ */
241
+ export interface AuthorizationRequestAction {
242
+ }
243
+ /**
244
+ *
245
+ * @export
246
+ * @interface AuthorizationRequestPrincipal
247
+ */
248
+ export interface AuthorizationRequestPrincipal {
249
+ /**
250
+ *
251
+ * @type {string}
252
+ * @memberof AuthorizationRequestPrincipal
253
+ */
254
+ 'type': AuthorizationRequestPrincipalTypeEnum;
255
+ /**
256
+ *
257
+ * @type {string}
258
+ * @memberof AuthorizationRequestPrincipal
259
+ */
260
+ 'id': string;
261
+ /**
262
+ *
263
+ * @type {string}
264
+ * @memberof AuthorizationRequestPrincipal
265
+ */
266
+ 'name'?: string;
267
+ /**
268
+ *
269
+ * @type {string}
270
+ * @memberof AuthorizationRequestPrincipal
271
+ */
272
+ 'email'?: string;
273
+ /**
274
+ *
275
+ * @type {string}
276
+ * @memberof AuthorizationRequestPrincipal
277
+ */
278
+ 'phone'?: string;
279
+ }
280
+
281
+ export const AuthorizationRequestPrincipalTypeEnum = {
282
+ User: 'User',
283
+ Automation: 'Automation'
284
+ } as const;
285
+
286
+ export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
287
+
288
+ /**
289
+ * @type AuthorizationRequestResource
290
+ * @export
291
+ */
292
+ export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
293
+
294
+ /**
295
+ *
296
+ * @export
297
+ * @interface AuthorizationRequestResourceOneOf
298
+ */
299
+ export interface AuthorizationRequestResourceOneOf {
300
+ /**
301
+ *
302
+ * @type {string}
303
+ * @memberof AuthorizationRequestResourceOneOf
304
+ */
305
+ 'type': AuthorizationRequestResourceOneOfTypeEnum;
306
+ /**
307
+ *
308
+ * @type {string}
309
+ * @memberof AuthorizationRequestResourceOneOf
310
+ */
311
+ 'id': string;
312
+ }
313
+
314
+ export const AuthorizationRequestResourceOneOfTypeEnum = {
315
+ Property: 'Property'
316
+ } as const;
317
+
318
+ export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
319
+
320
+ /**
321
+ *
322
+ * @export
323
+ * @interface AuthorizationRequestResourceOneOf1
324
+ */
325
+ export interface AuthorizationRequestResourceOneOf1 {
326
+ /**
327
+ *
328
+ * @type {string}
329
+ * @memberof AuthorizationRequestResourceOneOf1
330
+ */
331
+ 'type': AuthorizationRequestResourceOneOf1TypeEnum;
332
+ /**
333
+ *
334
+ * @type {string}
335
+ * @memberof AuthorizationRequestResourceOneOf1
336
+ */
337
+ 'id': string;
338
+ }
339
+
340
+ export const AuthorizationRequestResourceOneOf1TypeEnum = {
341
+ Org: 'Org'
342
+ } as const;
343
+
344
+ export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
345
+
346
+ /**
347
+ *
348
+ * @export
349
+ * @interface AuthorizationRequestResourceOneOf2
350
+ */
351
+ export interface AuthorizationRequestResourceOneOf2 {
352
+ /**
353
+ *
354
+ * @type {string}
355
+ * @memberof AuthorizationRequestResourceOneOf2
356
+ */
357
+ 'type': AuthorizationRequestResourceOneOf2TypeEnum;
358
+ /**
359
+ *
360
+ * @type {string}
361
+ * @memberof AuthorizationRequestResourceOneOf2
362
+ */
363
+ 'id': string;
364
+ }
365
+
366
+ export const AuthorizationRequestResourceOneOf2TypeEnum = {
367
+ Brand: 'Brand'
368
+ } as const;
369
+
370
+ export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
371
+
372
+ /**
373
+ *
374
+ * @export
375
+ * @interface AuthorizationRequestResourceOneOf3
376
+ */
377
+ export interface AuthorizationRequestResourceOneOf3 {
378
+ /**
379
+ *
380
+ * @type {string}
381
+ * @memberof AuthorizationRequestResourceOneOf3
382
+ */
383
+ 'type': AuthorizationRequestResourceOneOf3TypeEnum;
384
+ /**
385
+ *
386
+ * @type {string}
387
+ * @memberof AuthorizationRequestResourceOneOf3
388
+ */
389
+ 'id': string;
390
+ }
391
+
392
+ export const AuthorizationRequestResourceOneOf3TypeEnum = {
393
+ SalesChannel: 'SalesChannel'
394
+ } as const;
395
+
396
+ export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
397
+
398
+ /**
399
+ * Response containing the authorization decision
400
+ * @export
401
+ * @interface AuthorizationResponse
402
+ */
403
+ export interface AuthorizationResponse {
404
+ /**
405
+ * Whether the action is allowed
406
+ * @type {boolean}
407
+ * @memberof AuthorizationResponse
408
+ */
409
+ 'allowed': boolean;
410
+ /**
411
+ * The authorization decision
412
+ * @type {string}
413
+ * @memberof AuthorizationResponse
414
+ */
415
+ 'decision': string;
416
+ /**
417
+ * The policy IDs that were used to make the decision
418
+ * @type {Array<string>}
419
+ * @memberof AuthorizationResponse
420
+ */
421
+ 'policyIds': Array<string>;
422
+ }
423
+ /**
424
+ *
425
+ * @export
426
+ * @interface ErrorResponse
427
+ */
428
+ export interface ErrorResponse {
429
+ /**
430
+ *
431
+ * @type {string}
432
+ * @memberof ErrorResponse
433
+ */
434
+ 'message': string;
435
+ }
436
+ /**
437
+ * Successful permissions retrieval response
438
+ * @export
439
+ * @interface GetPermissionsSuccessResponse
440
+ */
441
+ export interface GetPermissionsSuccessResponse {
442
+ /**
443
+ *
444
+ * @type {Permissions & Array<string>}
445
+ * @memberof GetPermissionsSuccessResponse
446
+ */
447
+ 'permissions': Permissions & Array<string>;
448
+ }
449
+ /**
450
+ * Details for getting roles for a principal
451
+ * @export
452
+ * @interface GetPrincipalRolesRequestBody
453
+ */
454
+ export interface GetPrincipalRolesRequestBody {
455
+ /**
456
+ *
457
+ * @type {AuthorizationRequestPrincipal}
458
+ * @memberof GetPrincipalRolesRequestBody
459
+ */
460
+ 'principal': AuthorizationRequestPrincipal;
461
+ /**
462
+ *
463
+ * @type {AuthorizationRequestResource}
464
+ * @memberof GetPrincipalRolesRequestBody
465
+ */
466
+ 'resource'?: AuthorizationRequestResource;
467
+ }
468
+ /**
469
+ * Successful roles retrieval response
470
+ * @export
471
+ * @interface GetPrincipalRolesSuccessResponse
472
+ */
473
+ export interface GetPrincipalRolesSuccessResponse {
474
+ /**
475
+ * List of roles assigned to the principal
476
+ * @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
477
+ * @memberof GetPrincipalRolesSuccessResponse
478
+ */
479
+ 'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
480
+ }
481
+ /**
482
+ *
483
+ * @export
484
+ * @interface GetPrincipalRolesSuccessResponseRolesInner
485
+ */
486
+ export interface GetPrincipalRolesSuccessResponseRolesInner {
487
+ /**
488
+ * Policy ID
489
+ * @type {string}
490
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
491
+ */
492
+ 'policyId': string;
493
+ /**
494
+ * Role name
495
+ * @type {string}
496
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
497
+ */
498
+ 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum;
499
+ /**
500
+ * Date and time the role was assigned
501
+ * @type {string}
502
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
503
+ */
504
+ 'assignedAt': string;
505
+ /**
506
+ * User who assigned the role
507
+ * @type {string}
508
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
509
+ */
510
+ 'assignedBy': string;
511
+ /**
512
+ * Type of resource the role is assigned to
513
+ * @type {string}
514
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
515
+ */
516
+ 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
517
+ /**
518
+ * Organization ID
519
+ * @type {string}
520
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
521
+ */
522
+ 'orgId'?: string;
523
+ /**
524
+ * Property ID
525
+ * @type {string}
526
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
527
+ */
528
+ 'propertyId'?: string;
529
+ /**
530
+ * Brand ID this role is scoped to
531
+ * @type {string}
532
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
533
+ */
534
+ 'brandId'?: string;
535
+ /**
536
+ * Sales channel ID this role is scoped to
537
+ * @type {string}
538
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
539
+ */
540
+ 'salesChannelId'?: string;
541
+ }
542
+
543
+ export const GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = {
544
+ OrgViewer: 'OrgViewer',
545
+ OrgManager: 'OrgManager',
546
+ OrgAdmin: 'OrgAdmin',
547
+ BrandViewer: 'BrandViewer',
548
+ BrandManager: 'BrandManager',
549
+ BrandAdmin: 'BrandAdmin',
550
+ StoreViewer: 'StoreViewer',
551
+ StoreEditor: 'StoreEditor',
552
+ StoreManager: 'StoreManager',
553
+ CustomerViewer: 'CustomerViewer',
554
+ CustomerManager: 'CustomerManager',
555
+ VoucherViewer: 'VoucherViewer',
556
+ VoucherEditor: 'VoucherEditor',
557
+ VoucherManager: 'VoucherManager',
558
+ VoucherCampaignManager: 'VoucherCampaignManager',
559
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
560
+ AnalyticsViewer: 'AnalyticsViewer',
561
+ ReportsViewer: 'ReportsViewer',
562
+ FinanceViewer: 'FinanceViewer',
563
+ FinanceManager: 'FinanceManager',
564
+ TeamViewer: 'TeamViewer',
565
+ TeamManager: 'TeamManager',
566
+ TeamAdmin: 'TeamAdmin',
567
+ TechViewer: 'TechViewer',
568
+ TechManager: 'TechManager',
569
+ AppStoreViewer: 'AppStoreViewer',
570
+ AppStoreManager: 'AppStoreManager',
571
+ SalesChannelViewer: 'SalesChannelViewer',
572
+ SalesChannelEditor: 'SalesChannelEditor',
573
+ SalesChannelManager: 'SalesChannelManager',
574
+ DeliveryViewer: 'DeliveryViewer',
575
+ DeliveryManager: 'DeliveryManager',
576
+ DriverManager: 'DriverManager',
577
+ AuditViewer: 'AuditViewer',
578
+ AuditManager: 'AuditManager',
579
+ AccountsViewer: 'AccountsViewer',
580
+ AccountsEditor: 'AccountsEditor',
581
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
582
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
583
+ PayrollViewer: 'PayrollViewer',
584
+ PayrollEditor: 'PayrollEditor',
585
+ PropertyViewer: 'PropertyViewer',
586
+ PropertyManager: 'PropertyManager',
587
+ PropertyAdmin: 'PropertyAdmin',
588
+ WebsiteContentEditor: 'WebsiteContentEditor',
589
+ WebsiteContentViewer: 'WebsiteContentViewer',
590
+ WebsiteTechViewer: 'WebsiteTechViewer',
591
+ MenuViewer: 'MenuViewer',
592
+ MenuEditor: 'MenuEditor',
593
+ MenuManager: 'MenuManager',
594
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
595
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
596
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
597
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
598
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
599
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
600
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
601
+ OrderManager: 'OrderManager',
602
+ OrderEditor: 'OrderEditor',
603
+ OrderViewer: 'OrderViewer',
604
+ InventoryManager: 'InventoryManager',
605
+ InventoryEditor: 'InventoryEditor',
606
+ InventoryViewer: 'InventoryViewer',
607
+ PaymentManager: 'PaymentManager',
608
+ OnboardingManager: 'OnboardingManager',
609
+ FeatureFlagManager: 'FeatureFlagManager',
610
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
611
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
612
+ IntegratorMisc: 'IntegratorMisc',
613
+ PropertyManagerMisc: 'PropertyManagerMisc',
614
+ FinanceManagerMisc: 'FinanceManagerMisc',
615
+ SupportMisc: 'SupportMisc'
616
+ } as const;
617
+
618
+ export type GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum];
619
+ export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
620
+ Property: 'Property',
621
+ Org: 'Org',
622
+ Brand: 'Brand',
623
+ SalesChannel: 'SalesChannel'
624
+ } as const;
625
+
626
+ export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
627
+
628
+ /**
629
+ * Successful roles retrieval response
630
+ * @export
631
+ * @interface GetRolesSuccessResponse
632
+ */
633
+ export interface GetRolesSuccessResponse {
634
+ /**
635
+ * List of roles available and their permissions
636
+ * @type {Array<RolesInner>}
637
+ * @memberof GetRolesSuccessResponse
638
+ */
639
+ 'roles': Array<RolesInner>;
640
+ }
641
+ /**
642
+ * Successful user permissions retrieval response
643
+ * @export
644
+ * @interface GetUserPermissionsSuccessResponse
645
+ */
646
+ export interface GetUserPermissionsSuccessResponse {
647
+ /**
648
+ * Map of resource IDs to permissions
649
+ * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
650
+ * @memberof GetUserPermissionsSuccessResponse
651
+ */
652
+ 'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; };
653
+ }
654
+ /**
655
+ *
656
+ * @export
657
+ * @interface GetUserPermissionsSuccessResponseResourcesValue
658
+ */
659
+ export interface GetUserPermissionsSuccessResponseResourcesValue {
660
+ /**
661
+ * Type of resource the permissions are assigned to
662
+ * @type {string}
663
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
664
+ */
665
+ 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
666
+ /**
667
+ *
668
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
669
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
670
+ */
671
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
672
+ /**
673
+ * List of permissions that are assigned to the user for the resource
674
+ * @type {Array<string>}
675
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
676
+ */
677
+ 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
678
+ }
679
+
680
+ export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
681
+ Property: 'Property',
682
+ Org: 'Org',
683
+ Brand: 'Brand',
684
+ SalesChannel: 'SalesChannel'
685
+ } as const;
686
+
687
+ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
688
+ export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
689
+ AnyAuditLogs: 'AnyAuditLogs',
690
+ ViewApp: 'ViewApp',
691
+ CreateApp: 'CreateApp',
692
+ UpdateApp: 'UpdateApp',
693
+ ViewAppName: 'ViewAppName',
694
+ EditAppAssets: 'EditAppAssets',
695
+ EditAppFeatures: 'EditAppFeatures',
696
+ ViewTeammates: 'ViewTeammates',
697
+ EditTeammates: 'EditTeammates',
698
+ CreateTeammateOwner: 'CreateTeammateOwner',
699
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
700
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
701
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
702
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
703
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
704
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
705
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
706
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
707
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
708
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
709
+ ViewApmConfigurations: 'ViewApmConfigurations',
710
+ EditApmConfigurations: 'EditApmConfigurations',
711
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
712
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
713
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
714
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
715
+ StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
716
+ ViewDevelopersSettings: 'ViewDevelopersSettings',
717
+ EditDevelopersSettings: 'EditDevelopersSettings',
718
+ ViewOrders: 'ViewOrders',
719
+ UpdateOrdersAccept: 'UpdateOrdersAccept',
720
+ UpdateOrdersReject: 'UpdateOrdersReject',
721
+ UpdateOrdersRefund: 'UpdateOrdersRefund',
722
+ UpdateOrdersDispatch: 'UpdateOrdersDispatch',
723
+ ViewStores: 'ViewStores',
724
+ CreateStores: 'CreateStores',
725
+ EditStores: 'EditStores',
726
+ ViewStoresOpeningHours: 'ViewStoresOpeningHours',
727
+ UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
728
+ UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
729
+ ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
730
+ EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
731
+ EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
732
+ UpdateStoresName: 'UpdateStoresName',
733
+ EditStoreKioskSettings: 'EditStoreKioskSettings',
734
+ EditStoreOrderCapacity: 'EditStoreOrderCapacity',
735
+ EditStoreNotifications: 'EditStoreNotifications',
736
+ ArchiveStores: 'ArchiveStores',
737
+ PublishStores: 'PublishStores',
738
+ UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
739
+ UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
740
+ ViewStoreGroups: 'ViewStoreGroups',
741
+ CreateStoreGroups: 'CreateStoreGroups',
742
+ UpdateStoreGroups: 'UpdateStoreGroups',
743
+ DeleteStoreGroups: 'DeleteStoreGroups',
744
+ ViewDeliveryZones: 'ViewDeliveryZones',
745
+ CreateDeliveryZones: 'CreateDeliveryZones',
746
+ UpdateDeliveryZones: 'UpdateDeliveryZones',
747
+ DeleteDeliveryZones: 'DeleteDeliveryZones',
748
+ ViewMenu: 'ViewMenu',
749
+ CreateMenu: 'CreateMenu',
750
+ UpdateMenu: 'UpdateMenu',
751
+ DeleteMenu: 'DeleteMenu',
752
+ UpdateMenuLock: 'UpdateMenuLock',
753
+ UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
754
+ EditMenuImage: 'EditMenuImage',
755
+ ViewVouchers: 'ViewVouchers',
756
+ EditVouchers: 'EditVouchers',
757
+ ViewWebsiteContent: 'ViewWebsiteContent',
758
+ EditWebsiteContent: 'EditWebsiteContent',
759
+ ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
760
+ ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
761
+ ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
762
+ ViewBankAccounts: 'ViewBankAccounts',
763
+ CreateBankAccounts: 'CreateBankAccounts',
764
+ UpdateBankAccounts: 'UpdateBankAccounts',
765
+ UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
766
+ ViewAssignedBankAccount: 'ViewAssignedBankAccount',
767
+ VerifyBankAccounts: 'VerifyBankAccounts',
768
+ ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
769
+ EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
770
+ EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
771
+ EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
772
+ ViewHydraConfig: 'ViewHydraConfig',
773
+ UpdateHydraConfigManage: 'UpdateHydraConfigManage',
774
+ InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
775
+ DeleteTerminal: 'DeleteTerminal',
776
+ ViewKioskTelemetry: 'ViewKioskTelemetry',
777
+ ViewCustomers: 'ViewCustomers',
778
+ EditCustomers: 'EditCustomers',
779
+ CreateCustomers: 'CreateCustomers',
780
+ CreateCatalogElements: 'CreateCatalogElements',
781
+ UpdateCatalogElements: 'UpdateCatalogElements',
782
+ ViewCatalogElements: 'ViewCatalogElements',
783
+ DeleteCatalogElements: 'DeleteCatalogElements',
784
+ ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
785
+ CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
786
+ UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
787
+ DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
788
+ UpdateMetafields: 'UpdateMetafields',
789
+ ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
790
+ PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
791
+ ViewAppStatistics: 'ViewAppStatistics',
792
+ ViewApmStatistics: 'ViewApmStatistics',
793
+ ViewCampaignsStatistics: 'ViewCampaignsStatistics',
794
+ ViewCustomerStatistics: 'ViewCustomerStatistics',
795
+ ViewLiveStatistics: 'ViewLiveStatistics',
796
+ ViewOrderStatistics: 'ViewOrderStatistics',
797
+ ViewSalesStatistics: 'ViewSalesStatistics',
798
+ ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
799
+ ViewVouchersStatistics: 'ViewVouchersStatistics',
800
+ DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
801
+ ViewApmAuditLogs: 'ViewApmAuditLogs',
802
+ ViewStoreAuditLogs: 'ViewStoreAuditLogs',
803
+ ViewMenuAuditLogs: 'ViewMenuAuditLogs',
804
+ ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
805
+ ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
806
+ ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
807
+ ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
808
+ ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
809
+ ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
810
+ ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
811
+ ViewAppAuditLogs: 'ViewAppAuditLogs',
812
+ ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
813
+ ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
814
+ ViewHydraAuditLogs: 'ViewHydraAuditLogs',
815
+ ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
816
+ ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
817
+ ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
818
+ ViewExternalAuditLogs: 'ViewExternalAuditLogs',
819
+ CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
820
+ ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
821
+ ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
822
+ ViewChannelAuditLogs: 'ViewChannelAuditLogs',
823
+ ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
824
+ SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
825
+ InviteDriverToApp: 'InviteDriverToApp',
826
+ GetDriverForApp: 'GetDriverForApp',
827
+ RemoveDriverFromApp: 'RemoveDriverFromApp',
828
+ AssignDriverToOrder: 'AssignDriverToOrder',
829
+ UnassignDriverFromOrder: 'UnassignDriverFromOrder',
830
+ UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
831
+ UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
832
+ ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
833
+ CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
834
+ UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
835
+ DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
836
+ ViewPayouts: 'ViewPayouts',
837
+ ViewChannels: 'ViewChannels',
838
+ ViewOnboarding: 'ViewOnboarding',
839
+ UpdateOnboarding: 'UpdateOnboarding',
840
+ ViewClientDevices: 'ViewClientDevices',
841
+ UpdateClientDevices: 'UpdateClientDevices',
842
+ EnrollClientDevices: 'EnrollClientDevices',
843
+ AssignClientDevices: 'AssignClientDevices',
844
+ ViewClientAuditLogs: 'ViewClientAuditLogs',
845
+ CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
846
+ ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
847
+ UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
848
+ DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
849
+ UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
850
+ CreateAppStoreSubscription: 'CreateAppStoreSubscription',
851
+ UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
852
+ DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
853
+ ViewSalesChannels: 'ViewSalesChannels',
854
+ EditSalesChannels: 'EditSalesChannels',
855
+ CreateSalesChannel: 'CreateSalesChannel',
856
+ ArchiveSalesChannel: 'ArchiveSalesChannel',
857
+ UnarchiveSalesChannel: 'UnarchiveSalesChannel',
858
+ PublishSalesChannel: 'PublishSalesChannel',
859
+ UnpublishSalesChannel: 'UnpublishSalesChannel',
860
+ CloneSalesChannel: 'CloneSalesChannel',
861
+ ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
862
+ CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
863
+ UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
864
+ UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
865
+ ViewSubscriptions: 'ViewSubscriptions',
866
+ ViewInvoices: 'ViewInvoices',
867
+ EditAccountsBills: 'EditAccountsBills',
868
+ ViewAccountsBills: 'ViewAccountsBills',
869
+ EditAccountsCategories: 'EditAccountsCategories',
870
+ ViewAccountsCategories: 'ViewAccountsCategories',
871
+ EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
872
+ ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
873
+ EditAccountsCreditBooks: 'EditAccountsCreditBooks',
874
+ ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
875
+ EditAccountsExpenses: 'EditAccountsExpenses',
876
+ ViewAccountsExpenses: 'ViewAccountsExpenses',
877
+ EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
878
+ ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
879
+ EditDocumentExplorer: 'EditDocumentExplorer',
880
+ ViewDocumentExplorer: 'ViewDocumentExplorer',
881
+ ViewInventoryReports: 'ViewInventoryReports',
882
+ EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
883
+ ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
884
+ EditInventoryStockItems: 'EditInventoryStockItems',
885
+ ViewInventoryStockItems: 'ViewInventoryStockItems',
886
+ EditInventorySupplier: 'EditInventorySupplier',
887
+ ViewInventorySupplier: 'ViewInventorySupplier',
888
+ EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
889
+ ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
890
+ ViewPayrollReports: 'ViewPayrollReports',
891
+ EditPayrollHoliday: 'EditPayrollHoliday',
892
+ ViewPayrollHoliday: 'ViewPayrollHoliday',
893
+ EditPayrollRota: 'EditPayrollRota',
894
+ ViewPayrollRota: 'ViewPayrollRota',
895
+ EditPayrollStaff: 'EditPayrollStaff',
896
+ ViewPayrollStaff: 'ViewPayrollStaff',
897
+ ViewSalesReports: 'ViewSalesReports',
898
+ ViewCostReports: 'ViewCostReports',
899
+ ViewMenuReports: 'ViewMenuReports',
900
+ ViewBrand: 'ViewBrand',
901
+ EditBrand: 'EditBrand',
902
+ CreateBrand: 'CreateBrand',
903
+ TransferBrand: 'TransferBrand',
904
+ ViewProperty: 'ViewProperty',
905
+ EditProperty: 'EditProperty',
906
+ CreateProperty: 'CreateProperty',
907
+ ArchiveProperty: 'ArchiveProperty',
908
+ ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
909
+ EditEntityFeatureFlags: 'EditEntityFeatureFlags',
910
+ CreateOrg: 'CreateOrg',
911
+ EditOrg: 'EditOrg',
912
+ ViewOrg: 'ViewOrg'
913
+ } as const;
914
+
915
+ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
916
+
917
+ /**
918
+ * ID of the resource the permissions are assigned to
919
+ * @export
920
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
921
+ */
922
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
923
+ }
924
+ /**
925
+ *
926
+ * @export
927
+ * @interface OrgPathParam
928
+ */
929
+ export interface OrgPathParam {
930
+ /**
931
+ *
932
+ * @type {string}
933
+ * @memberof OrgPathParam
934
+ */
935
+ 'orgId': string;
936
+ }
937
+ /**
938
+ *
939
+ * @export
940
+ * @interface PathParams
941
+ */
942
+ export interface PathParams {
943
+ /**
944
+ *
945
+ * @type {string}
946
+ * @memberof PathParams
947
+ */
948
+ 'orgId': string;
949
+ /**
950
+ *
951
+ * @type {string}
952
+ * @memberof PathParams
953
+ */
954
+ 'userId': string;
955
+ }
956
+ /**
957
+ *
958
+ * @export
959
+ * @enum {string}
960
+ */
961
+
962
+ export const Permissions = {
963
+ AnyAuditLogs: 'AnyAuditLogs',
964
+ ViewApp: 'ViewApp',
965
+ CreateApp: 'CreateApp',
966
+ UpdateApp: 'UpdateApp',
967
+ ViewAppName: 'ViewAppName',
968
+ EditAppAssets: 'EditAppAssets',
969
+ EditAppFeatures: 'EditAppFeatures',
970
+ ViewTeammates: 'ViewTeammates',
971
+ EditTeammates: 'EditTeammates',
972
+ CreateTeammateOwner: 'CreateTeammateOwner',
973
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
974
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
975
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
976
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
977
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
978
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
979
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
980
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
981
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
982
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
983
+ ViewApmConfigurations: 'ViewApmConfigurations',
984
+ EditApmConfigurations: 'EditApmConfigurations',
985
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
986
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
987
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
988
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
989
+ StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
990
+ ViewDevelopersSettings: 'ViewDevelopersSettings',
991
+ EditDevelopersSettings: 'EditDevelopersSettings',
992
+ ViewOrders: 'ViewOrders',
993
+ UpdateOrdersAccept: 'UpdateOrdersAccept',
994
+ UpdateOrdersReject: 'UpdateOrdersReject',
995
+ UpdateOrdersRefund: 'UpdateOrdersRefund',
996
+ UpdateOrdersDispatch: 'UpdateOrdersDispatch',
997
+ ViewStores: 'ViewStores',
998
+ CreateStores: 'CreateStores',
999
+ EditStores: 'EditStores',
1000
+ ViewStoresOpeningHours: 'ViewStoresOpeningHours',
1001
+ UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
1002
+ UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
1003
+ ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
1004
+ EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
1005
+ EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
1006
+ UpdateStoresName: 'UpdateStoresName',
1007
+ EditStoreKioskSettings: 'EditStoreKioskSettings',
1008
+ EditStoreOrderCapacity: 'EditStoreOrderCapacity',
1009
+ EditStoreNotifications: 'EditStoreNotifications',
1010
+ ArchiveStores: 'ArchiveStores',
1011
+ PublishStores: 'PublishStores',
1012
+ UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
1013
+ UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
1014
+ ViewStoreGroups: 'ViewStoreGroups',
1015
+ CreateStoreGroups: 'CreateStoreGroups',
1016
+ UpdateStoreGroups: 'UpdateStoreGroups',
1017
+ DeleteStoreGroups: 'DeleteStoreGroups',
1018
+ ViewDeliveryZones: 'ViewDeliveryZones',
1019
+ CreateDeliveryZones: 'CreateDeliveryZones',
1020
+ UpdateDeliveryZones: 'UpdateDeliveryZones',
1021
+ DeleteDeliveryZones: 'DeleteDeliveryZones',
1022
+ ViewMenu: 'ViewMenu',
1023
+ CreateMenu: 'CreateMenu',
1024
+ UpdateMenu: 'UpdateMenu',
1025
+ DeleteMenu: 'DeleteMenu',
1026
+ UpdateMenuLock: 'UpdateMenuLock',
1027
+ UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
1028
+ EditMenuImage: 'EditMenuImage',
1029
+ ViewVouchers: 'ViewVouchers',
1030
+ EditVouchers: 'EditVouchers',
1031
+ ViewWebsiteContent: 'ViewWebsiteContent',
1032
+ EditWebsiteContent: 'EditWebsiteContent',
1033
+ ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
1034
+ ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
1035
+ ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
1036
+ ViewBankAccounts: 'ViewBankAccounts',
1037
+ CreateBankAccounts: 'CreateBankAccounts',
1038
+ UpdateBankAccounts: 'UpdateBankAccounts',
1039
+ UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
1040
+ ViewAssignedBankAccount: 'ViewAssignedBankAccount',
1041
+ VerifyBankAccounts: 'VerifyBankAccounts',
1042
+ ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
1043
+ EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
1044
+ EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
1045
+ EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
1046
+ ViewHydraConfig: 'ViewHydraConfig',
1047
+ UpdateHydraConfigManage: 'UpdateHydraConfigManage',
1048
+ InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
1049
+ DeleteTerminal: 'DeleteTerminal',
1050
+ ViewKioskTelemetry: 'ViewKioskTelemetry',
1051
+ ViewCustomers: 'ViewCustomers',
1052
+ EditCustomers: 'EditCustomers',
1053
+ CreateCustomers: 'CreateCustomers',
1054
+ CreateCatalogElements: 'CreateCatalogElements',
1055
+ UpdateCatalogElements: 'UpdateCatalogElements',
1056
+ ViewCatalogElements: 'ViewCatalogElements',
1057
+ DeleteCatalogElements: 'DeleteCatalogElements',
1058
+ ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
1059
+ CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
1060
+ UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
1061
+ DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
1062
+ UpdateMetafields: 'UpdateMetafields',
1063
+ ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
1064
+ PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
1065
+ ViewAppStatistics: 'ViewAppStatistics',
1066
+ ViewApmStatistics: 'ViewApmStatistics',
1067
+ ViewCampaignsStatistics: 'ViewCampaignsStatistics',
1068
+ ViewCustomerStatistics: 'ViewCustomerStatistics',
1069
+ ViewLiveStatistics: 'ViewLiveStatistics',
1070
+ ViewOrderStatistics: 'ViewOrderStatistics',
1071
+ ViewSalesStatistics: 'ViewSalesStatistics',
1072
+ ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
1073
+ ViewVouchersStatistics: 'ViewVouchersStatistics',
1074
+ DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
1075
+ ViewApmAuditLogs: 'ViewApmAuditLogs',
1076
+ ViewStoreAuditLogs: 'ViewStoreAuditLogs',
1077
+ ViewMenuAuditLogs: 'ViewMenuAuditLogs',
1078
+ ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
1079
+ ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
1080
+ ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
1081
+ ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
1082
+ ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
1083
+ ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
1084
+ ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
1085
+ ViewAppAuditLogs: 'ViewAppAuditLogs',
1086
+ ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
1087
+ ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
1088
+ ViewHydraAuditLogs: 'ViewHydraAuditLogs',
1089
+ ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
1090
+ ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
1091
+ ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
1092
+ ViewExternalAuditLogs: 'ViewExternalAuditLogs',
1093
+ CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
1094
+ ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
1095
+ ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
1096
+ ViewChannelAuditLogs: 'ViewChannelAuditLogs',
1097
+ ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
1098
+ SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
1099
+ InviteDriverToApp: 'InviteDriverToApp',
1100
+ GetDriverForApp: 'GetDriverForApp',
1101
+ RemoveDriverFromApp: 'RemoveDriverFromApp',
1102
+ AssignDriverToOrder: 'AssignDriverToOrder',
1103
+ UnassignDriverFromOrder: 'UnassignDriverFromOrder',
1104
+ UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
1105
+ UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
1106
+ ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
1107
+ CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
1108
+ UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
1109
+ DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
1110
+ ViewPayouts: 'ViewPayouts',
1111
+ ViewChannels: 'ViewChannels',
1112
+ ViewOnboarding: 'ViewOnboarding',
1113
+ UpdateOnboarding: 'UpdateOnboarding',
1114
+ ViewClientDevices: 'ViewClientDevices',
1115
+ UpdateClientDevices: 'UpdateClientDevices',
1116
+ EnrollClientDevices: 'EnrollClientDevices',
1117
+ AssignClientDevices: 'AssignClientDevices',
1118
+ ViewClientAuditLogs: 'ViewClientAuditLogs',
1119
+ CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
1120
+ ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
1121
+ UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
1122
+ DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
1123
+ UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
1124
+ CreateAppStoreSubscription: 'CreateAppStoreSubscription',
1125
+ UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
1126
+ DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
1127
+ ViewSalesChannels: 'ViewSalesChannels',
1128
+ EditSalesChannels: 'EditSalesChannels',
1129
+ CreateSalesChannel: 'CreateSalesChannel',
1130
+ ArchiveSalesChannel: 'ArchiveSalesChannel',
1131
+ UnarchiveSalesChannel: 'UnarchiveSalesChannel',
1132
+ PublishSalesChannel: 'PublishSalesChannel',
1133
+ UnpublishSalesChannel: 'UnpublishSalesChannel',
1134
+ CloneSalesChannel: 'CloneSalesChannel',
1135
+ ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
1136
+ CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
1137
+ UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
1138
+ UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
1139
+ ViewSubscriptions: 'ViewSubscriptions',
1140
+ ViewInvoices: 'ViewInvoices',
1141
+ EditAccountsBills: 'EditAccountsBills',
1142
+ ViewAccountsBills: 'ViewAccountsBills',
1143
+ EditAccountsCategories: 'EditAccountsCategories',
1144
+ ViewAccountsCategories: 'ViewAccountsCategories',
1145
+ EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
1146
+ ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
1147
+ EditAccountsCreditBooks: 'EditAccountsCreditBooks',
1148
+ ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
1149
+ EditAccountsExpenses: 'EditAccountsExpenses',
1150
+ ViewAccountsExpenses: 'ViewAccountsExpenses',
1151
+ EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
1152
+ ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
1153
+ EditDocumentExplorer: 'EditDocumentExplorer',
1154
+ ViewDocumentExplorer: 'ViewDocumentExplorer',
1155
+ ViewInventoryReports: 'ViewInventoryReports',
1156
+ EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
1157
+ ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
1158
+ EditInventoryStockItems: 'EditInventoryStockItems',
1159
+ ViewInventoryStockItems: 'ViewInventoryStockItems',
1160
+ EditInventorySupplier: 'EditInventorySupplier',
1161
+ ViewInventorySupplier: 'ViewInventorySupplier',
1162
+ EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
1163
+ ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
1164
+ ViewPayrollReports: 'ViewPayrollReports',
1165
+ EditPayrollHoliday: 'EditPayrollHoliday',
1166
+ ViewPayrollHoliday: 'ViewPayrollHoliday',
1167
+ EditPayrollRota: 'EditPayrollRota',
1168
+ ViewPayrollRota: 'ViewPayrollRota',
1169
+ EditPayrollStaff: 'EditPayrollStaff',
1170
+ ViewPayrollStaff: 'ViewPayrollStaff',
1171
+ ViewSalesReports: 'ViewSalesReports',
1172
+ ViewCostReports: 'ViewCostReports',
1173
+ ViewMenuReports: 'ViewMenuReports',
1174
+ ViewBrand: 'ViewBrand',
1175
+ EditBrand: 'EditBrand',
1176
+ CreateBrand: 'CreateBrand',
1177
+ TransferBrand: 'TransferBrand',
1178
+ ViewProperty: 'ViewProperty',
1179
+ EditProperty: 'EditProperty',
1180
+ CreateProperty: 'CreateProperty',
1181
+ ArchiveProperty: 'ArchiveProperty',
1182
+ ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
1183
+ EditEntityFeatureFlags: 'EditEntityFeatureFlags',
1184
+ CreateOrg: 'CreateOrg',
1185
+ EditOrg: 'EditOrg',
1186
+ ViewOrg: 'ViewOrg'
1187
+ } as const;
1188
+
1189
+ export type Permissions = typeof Permissions[keyof typeof Permissions];
1190
+
1191
+
1192
+ /**
1193
+ * Details for revoking a forbidden role from a principal
1194
+ * @export
1195
+ * @interface RevokeForbiddenRoleRequestBody
1196
+ */
1197
+ export interface RevokeForbiddenRoleRequestBody {
1198
+ /**
1199
+ *
1200
+ * @type {AuthorizationRequestPrincipal}
1201
+ * @memberof RevokeForbiddenRoleRequestBody
1202
+ */
1203
+ 'principal': AuthorizationRequestPrincipal;
1204
+ /**
1205
+ * Compensation role to revoke the forbidden role from
1206
+ * @type {string}
1207
+ * @memberof RevokeForbiddenRoleRequestBody
1208
+ */
1209
+ 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
1210
+ }
1211
+
1212
+ export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
1213
+ OwnerCompensating: 'OwnerCompensating',
1214
+ PropertyOwnerCompensating: 'PropertyOwnerCompensating',
1215
+ ManagedOwnerCompensating: 'ManagedOwnerCompensating',
1216
+ IntegratorCompensating: 'IntegratorCompensating',
1217
+ PropertyManagerCompensating: 'PropertyManagerCompensating',
1218
+ FinanceManagerCompensating: 'FinanceManagerCompensating'
1219
+ } as const;
1220
+
1221
+ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
1222
+
1223
+ /**
1224
+ * Details for revoking a role from a principal
1225
+ * @export
1226
+ * @interface RevokeRoleRequestBody
1227
+ */
1228
+ export interface RevokeRoleRequestBody {
1229
+ /**
1230
+ * Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
1231
+ * @type {string}
1232
+ * @memberof RevokeRoleRequestBody
1233
+ */
1234
+ 'role': RevokeRoleRequestBodyRoleEnum;
1235
+ /**
1236
+ *
1237
+ * @type {AuthorizationRequestResource}
1238
+ * @memberof RevokeRoleRequestBody
1239
+ */
1240
+ 'resource': AuthorizationRequestResource;
1241
+ /**
1242
+ *
1243
+ * @type {AuthorizationRequestPrincipal}
1244
+ * @memberof RevokeRoleRequestBody
1245
+ */
1246
+ 'principal': AuthorizationRequestPrincipal;
1247
+ /**
1248
+ *
1249
+ * @type {string}
1250
+ * @memberof RevokeRoleRequestBody
1251
+ */
1252
+ 'brandId': string;
1253
+ }
1254
+
1255
+ export const RevokeRoleRequestBodyRoleEnum = {
1256
+ OrgViewer: 'OrgViewer',
1257
+ OrgManager: 'OrgManager',
1258
+ OrgAdmin: 'OrgAdmin',
1259
+ BrandViewer: 'BrandViewer',
1260
+ BrandManager: 'BrandManager',
1261
+ BrandAdmin: 'BrandAdmin',
1262
+ StoreViewer: 'StoreViewer',
1263
+ StoreEditor: 'StoreEditor',
1264
+ StoreManager: 'StoreManager',
1265
+ CustomerViewer: 'CustomerViewer',
1266
+ CustomerManager: 'CustomerManager',
1267
+ VoucherViewer: 'VoucherViewer',
1268
+ VoucherEditor: 'VoucherEditor',
1269
+ VoucherManager: 'VoucherManager',
1270
+ VoucherCampaignManager: 'VoucherCampaignManager',
1271
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
1272
+ AnalyticsViewer: 'AnalyticsViewer',
1273
+ ReportsViewer: 'ReportsViewer',
1274
+ FinanceViewer: 'FinanceViewer',
1275
+ FinanceManager: 'FinanceManager',
1276
+ TeamViewer: 'TeamViewer',
1277
+ TeamManager: 'TeamManager',
1278
+ TeamAdmin: 'TeamAdmin',
1279
+ TechViewer: 'TechViewer',
1280
+ TechManager: 'TechManager',
1281
+ AppStoreViewer: 'AppStoreViewer',
1282
+ AppStoreManager: 'AppStoreManager',
1283
+ SalesChannelViewer: 'SalesChannelViewer',
1284
+ SalesChannelEditor: 'SalesChannelEditor',
1285
+ SalesChannelManager: 'SalesChannelManager',
1286
+ DeliveryViewer: 'DeliveryViewer',
1287
+ DeliveryManager: 'DeliveryManager',
1288
+ DriverManager: 'DriverManager',
1289
+ AuditViewer: 'AuditViewer',
1290
+ AuditManager: 'AuditManager',
1291
+ AccountsViewer: 'AccountsViewer',
1292
+ AccountsEditor: 'AccountsEditor',
1293
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
1294
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
1295
+ PayrollViewer: 'PayrollViewer',
1296
+ PayrollEditor: 'PayrollEditor',
1297
+ PropertyViewer: 'PropertyViewer',
1298
+ PropertyManager: 'PropertyManager',
1299
+ PropertyAdmin: 'PropertyAdmin',
1300
+ WebsiteContentEditor: 'WebsiteContentEditor',
1301
+ WebsiteContentViewer: 'WebsiteContentViewer',
1302
+ WebsiteTechViewer: 'WebsiteTechViewer',
1303
+ MenuViewer: 'MenuViewer',
1304
+ MenuEditor: 'MenuEditor',
1305
+ MenuManager: 'MenuManager',
1306
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
1307
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
1308
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
1309
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
1310
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
1311
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
1312
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
1313
+ OrderManager: 'OrderManager',
1314
+ OrderEditor: 'OrderEditor',
1315
+ OrderViewer: 'OrderViewer',
1316
+ InventoryManager: 'InventoryManager',
1317
+ InventoryEditor: 'InventoryEditor',
1318
+ InventoryViewer: 'InventoryViewer',
1319
+ PaymentManager: 'PaymentManager',
1320
+ OnboardingManager: 'OnboardingManager',
1321
+ FeatureFlagManager: 'FeatureFlagManager',
1322
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
1323
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
1324
+ IntegratorMisc: 'IntegratorMisc',
1325
+ PropertyManagerMisc: 'PropertyManagerMisc',
1326
+ FinanceManagerMisc: 'FinanceManagerMisc',
1327
+ SupportMisc: 'SupportMisc'
1328
+ } as const;
1329
+
1330
+ export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
1331
+
1332
+ /**
1333
+ * Successful role revocation response
1334
+ * @export
1335
+ * @interface RevokeRoleSuccessResponse
1336
+ */
1337
+ export interface RevokeRoleSuccessResponse {
1338
+ /**
1339
+ * Confirmation message
1340
+ * @type {string}
1341
+ * @memberof RevokeRoleSuccessResponse
1342
+ */
1343
+ 'message': string;
1344
+ }
1345
+ /**
1346
+ *
1347
+ * @export
1348
+ * @interface RolesInner
1349
+ */
1350
+ export interface RolesInner {
1351
+ /**
1352
+ * Name of the role
1353
+ * @type {string}
1354
+ * @memberof RolesInner
1355
+ */
1356
+ 'name': string;
1357
+ /**
1358
+ *
1359
+ * @type {Permissions & Array<string>}
1360
+ * @memberof RolesInner
1361
+ */
1362
+ 'permissions': Permissions & Array<string>;
1363
+ }
1364
+ /**
1365
+ *
1366
+ * @export
1367
+ * @interface ValidationErrorsInner
1368
+ */
1369
+ export interface ValidationErrorsInner {
1370
+ /**
1371
+ *
1372
+ * @type {Array<ValidationErrorsInnerPathInner>}
1373
+ * @memberof ValidationErrorsInner
1374
+ */
1375
+ 'path'?: Array<ValidationErrorsInnerPathInner>;
1376
+ /**
1377
+ *
1378
+ * @type {string}
1379
+ * @memberof ValidationErrorsInner
1380
+ */
1381
+ 'message': string;
1382
+ }
1383
+ /**
1384
+ *
1385
+ * @export
1386
+ * @interface ValidationErrorsInnerPathInner
1387
+ */
1388
+ export interface ValidationErrorsInnerPathInner {
1389
+ }
1390
+
1391
+ /**
1392
+ * AuthenticationApi - axios parameter creator
1393
+ * @export
1394
+ */
1395
+ export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
1396
+ return {
1397
+ /**
1398
+ * Authenticate and authorize a user to perform an action
1399
+ * @summary Authenticate and authorize Request
1400
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1401
+ * @param {*} [options] Override http request option.
1402
+ * @throws {RequiredError}
1403
+ */
1404
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1405
+ const localVarPath = `/authenticateAndAuthorize`;
1406
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1407
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1408
+ let baseOptions;
1409
+ if (configuration) {
1410
+ baseOptions = configuration.baseOptions;
1411
+ }
1412
+
1413
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1414
+ const localVarHeaderParameter = {} as any;
1415
+ const localVarQueryParameter = {} as any;
1416
+
1417
+ // authentication ApiKeyAuth required
1418
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1419
+
1420
+
1421
+
1422
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1423
+
1424
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1425
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1426
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1427
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1428
+
1429
+ return {
1430
+ url: toPathString(localVarUrlObj),
1431
+ options: localVarRequestOptions,
1432
+ };
1433
+ },
1434
+ }
1435
+ };
1436
+
1437
+ /**
1438
+ * AuthenticationApi - functional programming interface
1439
+ * @export
1440
+ */
1441
+ export const AuthenticationApiFp = function(configuration?: Configuration) {
1442
+ const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
1443
+ return {
1444
+ /**
1445
+ * Authenticate and authorize a user to perform an action
1446
+ * @summary Authenticate and authorize Request
1447
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1448
+ * @param {*} [options] Override http request option.
1449
+ * @throws {RequiredError}
1450
+ */
1451
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1452
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1453
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1454
+ const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1455
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1456
+ },
1457
+ }
1458
+ };
1459
+
1460
+ /**
1461
+ * AuthenticationApi - factory interface
1462
+ * @export
1463
+ */
1464
+ export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1465
+ const localVarFp = AuthenticationApiFp(configuration)
1466
+ return {
1467
+ /**
1468
+ * Authenticate and authorize a user to perform an action
1469
+ * @summary Authenticate and authorize Request
1470
+ * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ */
1474
+ authenticateAndAuthorize(requestParameters: AuthenticationApiAuthenticateAndAuthorizeRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1475
+ return localVarFp.authenticateAndAuthorize(requestParameters.authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
1476
+ },
1477
+ };
1478
+ };
1479
+
1480
+ /**
1481
+ * Request parameters for authenticateAndAuthorize operation in AuthenticationApi.
1482
+ * @export
1483
+ * @interface AuthenticationApiAuthenticateAndAuthorizeRequest
1484
+ */
1485
+ export interface AuthenticationApiAuthenticateAndAuthorizeRequest {
1486
+ /**
1487
+ *
1488
+ * @type {AuthenticateAndAuthorizeRequest}
1489
+ * @memberof AuthenticationApiAuthenticateAndAuthorize
1490
+ */
1491
+ readonly authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest
1492
+ }
1493
+
1494
+ /**
1495
+ * AuthenticationApi - object-oriented interface
1496
+ * @export
1497
+ * @class AuthenticationApi
1498
+ * @extends {BaseAPI}
1499
+ */
1500
+ export class AuthenticationApi extends BaseAPI {
1501
+ /**
1502
+ * Authenticate and authorize a user to perform an action
1503
+ * @summary Authenticate and authorize Request
1504
+ * @param {AuthenticationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1505
+ * @param {*} [options] Override http request option.
1506
+ * @throws {RequiredError}
1507
+ * @memberof AuthenticationApi
1508
+ */
1509
+ public authenticateAndAuthorize(requestParameters: AuthenticationApiAuthenticateAndAuthorizeRequest = {}, options?: RawAxiosRequestConfig) {
1510
+ return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(requestParameters.authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
1511
+ }
1512
+ }
1513
+
1514
+
1515
+
1516
+ /**
1517
+ * AuthorizationApi - axios parameter creator
1518
+ * @export
1519
+ */
1520
+ export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
1521
+ return {
1522
+ /**
1523
+ * Authenticate and authorize a user to perform an action
1524
+ * @summary Authenticate and authorize Request
1525
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1526
+ * @param {*} [options] Override http request option.
1527
+ * @throws {RequiredError}
1528
+ */
1529
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1530
+ const localVarPath = `/authenticateAndAuthorize`;
1531
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1532
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1533
+ let baseOptions;
1534
+ if (configuration) {
1535
+ baseOptions = configuration.baseOptions;
1536
+ }
1537
+
1538
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1539
+ const localVarHeaderParameter = {} as any;
1540
+ const localVarQueryParameter = {} as any;
1541
+
1542
+ // authentication ApiKeyAuth required
1543
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1544
+
1545
+
1546
+
1547
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1548
+
1549
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1550
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1551
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1552
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1553
+
1554
+ return {
1555
+ url: toPathString(localVarUrlObj),
1556
+ options: localVarRequestOptions,
1557
+ };
1558
+ },
1559
+ /**
1560
+ * Check if a user is authorized to perform an action
1561
+ * @summary Authorize Request
1562
+ * @param {AuthorizationRequest} [authorizationRequest]
1563
+ * @param {*} [options] Override http request option.
1564
+ * @throws {RequiredError}
1565
+ */
1566
+ authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1567
+ const localVarPath = `/authorize`;
1568
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1569
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1570
+ let baseOptions;
1571
+ if (configuration) {
1572
+ baseOptions = configuration.baseOptions;
1573
+ }
1574
+
1575
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1576
+ const localVarHeaderParameter = {} as any;
1577
+ const localVarQueryParameter = {} as any;
1578
+
1579
+ // authentication ApiKeyAuth required
1580
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1581
+
1582
+
1583
+
1584
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1585
+
1586
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1587
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1588
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1589
+ localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
1590
+
1591
+ return {
1592
+ url: toPathString(localVarUrlObj),
1593
+ options: localVarRequestOptions,
1594
+ };
1595
+ },
1596
+ }
1597
+ };
1598
+
1599
+ /**
1600
+ * AuthorizationApi - functional programming interface
1601
+ * @export
1602
+ */
1603
+ export const AuthorizationApiFp = function(configuration?: Configuration) {
1604
+ const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
1605
+ return {
1606
+ /**
1607
+ * Authenticate and authorize a user to perform an action
1608
+ * @summary Authenticate and authorize Request
1609
+ * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
1610
+ * @param {*} [options] Override http request option.
1611
+ * @throws {RequiredError}
1612
+ */
1613
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1614
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1615
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1616
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1617
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1618
+ },
1619
+ /**
1620
+ * Check if a user is authorized to perform an action
1621
+ * @summary Authorize Request
1622
+ * @param {AuthorizationRequest} [authorizationRequest]
1623
+ * @param {*} [options] Override http request option.
1624
+ * @throws {RequiredError}
1625
+ */
1626
+ async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
1627
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
1628
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1629
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
1630
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1631
+ },
1632
+ }
1633
+ };
1634
+
1635
+ /**
1636
+ * AuthorizationApi - factory interface
1637
+ * @export
1638
+ */
1639
+ export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1640
+ const localVarFp = AuthorizationApiFp(configuration)
1641
+ return {
1642
+ /**
1643
+ * Authenticate and authorize a user to perform an action
1644
+ * @summary Authenticate and authorize Request
1645
+ * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1646
+ * @param {*} [options] Override http request option.
1647
+ * @throws {RequiredError}
1648
+ */
1649
+ authenticateAndAuthorize(requestParameters: AuthorizationApiAuthenticateAndAuthorizeRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1650
+ return localVarFp.authenticateAndAuthorize(requestParameters.authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
1651
+ },
1652
+ /**
1653
+ * Check if a user is authorized to perform an action
1654
+ * @summary Authorize Request
1655
+ * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
1656
+ * @param {*} [options] Override http request option.
1657
+ * @throws {RequiredError}
1658
+ */
1659
+ authorize(requestParameters: AuthorizationApiAuthorizeRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
1660
+ return localVarFp.authorize(requestParameters.authorizationRequest, options).then((request) => request(axios, basePath));
1661
+ },
1662
+ };
1663
+ };
1664
+
1665
+ /**
1666
+ * Request parameters for authenticateAndAuthorize operation in AuthorizationApi.
1667
+ * @export
1668
+ * @interface AuthorizationApiAuthenticateAndAuthorizeRequest
1669
+ */
1670
+ export interface AuthorizationApiAuthenticateAndAuthorizeRequest {
1671
+ /**
1672
+ *
1673
+ * @type {AuthenticateAndAuthorizeRequest}
1674
+ * @memberof AuthorizationApiAuthenticateAndAuthorize
1675
+ */
1676
+ readonly authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest
1677
+ }
1678
+
1679
+ /**
1680
+ * Request parameters for authorize operation in AuthorizationApi.
1681
+ * @export
1682
+ * @interface AuthorizationApiAuthorizeRequest
1683
+ */
1684
+ export interface AuthorizationApiAuthorizeRequest {
1685
+ /**
1686
+ *
1687
+ * @type {AuthorizationRequest}
1688
+ * @memberof AuthorizationApiAuthorize
1689
+ */
1690
+ readonly authorizationRequest?: AuthorizationRequest
1691
+ }
1692
+
1693
+ /**
1694
+ * AuthorizationApi - object-oriented interface
1695
+ * @export
1696
+ * @class AuthorizationApi
1697
+ * @extends {BaseAPI}
1698
+ */
1699
+ export class AuthorizationApi extends BaseAPI {
1700
+ /**
1701
+ * Authenticate and authorize a user to perform an action
1702
+ * @summary Authenticate and authorize Request
1703
+ * @param {AuthorizationApiAuthenticateAndAuthorizeRequest} requestParameters Request parameters.
1704
+ * @param {*} [options] Override http request option.
1705
+ * @throws {RequiredError}
1706
+ * @memberof AuthorizationApi
1707
+ */
1708
+ public authenticateAndAuthorize(requestParameters: AuthorizationApiAuthenticateAndAuthorizeRequest = {}, options?: RawAxiosRequestConfig) {
1709
+ return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(requestParameters.authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
1710
+ }
1711
+
1712
+ /**
1713
+ * Check if a user is authorized to perform an action
1714
+ * @summary Authorize Request
1715
+ * @param {AuthorizationApiAuthorizeRequest} requestParameters Request parameters.
1716
+ * @param {*} [options] Override http request option.
1717
+ * @throws {RequiredError}
1718
+ * @memberof AuthorizationApi
1719
+ */
1720
+ public authorize(requestParameters: AuthorizationApiAuthorizeRequest = {}, options?: RawAxiosRequestConfig) {
1721
+ return AuthorizationApiFp(this.configuration).authorize(requestParameters.authorizationRequest, options).then((request) => request(this.axios, this.basePath));
1722
+ }
1723
+ }
1724
+
1725
+
1726
+
1727
+ /**
1728
+ * PermissionsApi - axios parameter creator
1729
+ * @export
1730
+ */
1731
+ export const PermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
1732
+ return {
1733
+ /**
1734
+ * List the available permissions
1735
+ * @summary List Permissions
1736
+ * @param {*} [options] Override http request option.
1737
+ * @throws {RequiredError}
1738
+ */
1739
+ listPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1740
+ const localVarPath = `/permissions`;
1741
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1742
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1743
+ let baseOptions;
1744
+ if (configuration) {
1745
+ baseOptions = configuration.baseOptions;
1746
+ }
1747
+
1748
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1749
+ const localVarHeaderParameter = {} as any;
1750
+ const localVarQueryParameter = {} as any;
1751
+
1752
+ // authentication ApiKeyAuth required
1753
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1754
+
1755
+
1756
+
1757
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1758
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1759
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1760
+
1761
+ return {
1762
+ url: toPathString(localVarUrlObj),
1763
+ options: localVarRequestOptions,
1764
+ };
1765
+ },
1766
+ }
1767
+ };
1768
+
1769
+ /**
1770
+ * PermissionsApi - functional programming interface
1771
+ * @export
1772
+ */
1773
+ export const PermissionsApiFp = function(configuration?: Configuration) {
1774
+ const localVarAxiosParamCreator = PermissionsApiAxiosParamCreator(configuration)
1775
+ return {
1776
+ /**
1777
+ * List the available permissions
1778
+ * @summary List Permissions
1779
+ * @param {*} [options] Override http request option.
1780
+ * @throws {RequiredError}
1781
+ */
1782
+ async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>> {
1783
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
1784
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1785
+ const localVarOperationServerBasePath = operationServerMap['PermissionsApi.listPermissions']?.[localVarOperationServerIndex]?.url;
1786
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1787
+ },
1788
+ }
1789
+ };
1790
+
1791
+ /**
1792
+ * PermissionsApi - factory interface
1793
+ * @export
1794
+ */
1795
+ export const PermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1796
+ const localVarFp = PermissionsApiFp(configuration)
1797
+ return {
1798
+ /**
1799
+ * List the available permissions
1800
+ * @summary List Permissions
1801
+ * @param {*} [options] Override http request option.
1802
+ * @throws {RequiredError}
1803
+ */
1804
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse> {
1805
+ return localVarFp.listPermissions(options).then((request) => request(axios, basePath));
1806
+ },
1807
+ };
1808
+ };
1809
+
1810
+ /**
1811
+ * PermissionsApi - object-oriented interface
1812
+ * @export
1813
+ * @class PermissionsApi
1814
+ * @extends {BaseAPI}
1815
+ */
1816
+ export class PermissionsApi extends BaseAPI {
1817
+ /**
1818
+ * List the available permissions
1819
+ * @summary List Permissions
1820
+ * @param {*} [options] Override http request option.
1821
+ * @throws {RequiredError}
1822
+ * @memberof PermissionsApi
1823
+ */
1824
+ public listPermissions(options?: RawAxiosRequestConfig) {
1825
+ return PermissionsApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
1826
+ }
1827
+ }
1828
+
1829
+
1830
+
1831
+ /**
1832
+ * RoleAssignmentApi - axios parameter creator
1833
+ * @export
1834
+ */
1835
+ export const RoleAssignmentApiAxiosParamCreator = function (configuration?: Configuration) {
1836
+ return {
1837
+ /**
1838
+ * Assigns a specified role to a given principal (user, group, etc.)
1839
+ * @summary Assign Role to Principal
1840
+ * @param {string} orgId
1841
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
1842
+ * @param {*} [options] Override http request option.
1843
+ * @throws {RequiredError}
1844
+ */
1845
+ assignRoleToPrincipal: async (orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1846
+ // verify required parameter 'orgId' is not null or undefined
1847
+ assertParamExists('assignRoleToPrincipal', 'orgId', orgId)
1848
+ const localVarPath = `/orgs/{orgId}/roles/assignRoleToPrincipal`
1849
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1850
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1851
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1852
+ let baseOptions;
1853
+ if (configuration) {
1854
+ baseOptions = configuration.baseOptions;
1855
+ }
1856
+
1857
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1858
+ const localVarHeaderParameter = {} as any;
1859
+ const localVarQueryParameter = {} as any;
1860
+
1861
+ // authentication ApiKeyAuth required
1862
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1863
+
1864
+
1865
+
1866
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1867
+
1868
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1869
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1870
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1871
+ localVarRequestOptions.data = serializeDataIfNeeded(assignRoleRequestBody, localVarRequestOptions, configuration)
1872
+
1873
+ return {
1874
+ url: toPathString(localVarUrlObj),
1875
+ options: localVarRequestOptions,
1876
+ };
1877
+ },
1878
+ /**
1879
+ * Get the active roles for a given principal
1880
+ * @summary Get Principal Roles
1881
+ * @param {string} orgId
1882
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
1883
+ * @param {*} [options] Override http request option.
1884
+ * @throws {RequiredError}
1885
+ */
1886
+ getPrincipalRoles: async (orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1887
+ // verify required parameter 'orgId' is not null or undefined
1888
+ assertParamExists('getPrincipalRoles', 'orgId', orgId)
1889
+ const localVarPath = `/orgs/{orgId}/roles/getPrincipalRoles`
1890
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1891
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1892
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1893
+ let baseOptions;
1894
+ if (configuration) {
1895
+ baseOptions = configuration.baseOptions;
1896
+ }
1897
+
1898
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1899
+ const localVarHeaderParameter = {} as any;
1900
+ const localVarQueryParameter = {} as any;
1901
+
1902
+ // authentication ApiKeyAuth required
1903
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1904
+
1905
+
1906
+
1907
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1908
+
1909
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1910
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1911
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1912
+ localVarRequestOptions.data = serializeDataIfNeeded(getPrincipalRolesRequestBody, localVarRequestOptions, configuration)
1913
+
1914
+ return {
1915
+ url: toPathString(localVarUrlObj),
1916
+ options: localVarRequestOptions,
1917
+ };
1918
+ },
1919
+ /**
1920
+ * Revokes a forbidden role from a given principal (user, group, etc.)
1921
+ * @summary Revoke Forbidden Role from Principal
1922
+ * @param {string} orgId
1923
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
1924
+ * @param {*} [options] Override http request option.
1925
+ * @throws {RequiredError}
1926
+ */
1927
+ revokeForbiddenRoleFromPrincipal: async (orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1928
+ // verify required parameter 'orgId' is not null or undefined
1929
+ assertParamExists('revokeForbiddenRoleFromPrincipal', 'orgId', orgId)
1930
+ const localVarPath = `/orgs/{orgId}/roles/revokeForbiddenRoleFromPrincipal`
1931
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1932
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1933
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1934
+ let baseOptions;
1935
+ if (configuration) {
1936
+ baseOptions = configuration.baseOptions;
1937
+ }
1938
+
1939
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1940
+ const localVarHeaderParameter = {} as any;
1941
+ const localVarQueryParameter = {} as any;
1942
+
1943
+ // authentication ApiKeyAuth required
1944
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1945
+
1946
+
1947
+
1948
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1949
+
1950
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1951
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1952
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1953
+ localVarRequestOptions.data = serializeDataIfNeeded(revokeForbiddenRoleRequestBody, localVarRequestOptions, configuration)
1954
+
1955
+ return {
1956
+ url: toPathString(localVarUrlObj),
1957
+ options: localVarRequestOptions,
1958
+ };
1959
+ },
1960
+ /**
1961
+ * Revokes a specified role from a given principal (user, group, etc.)
1962
+ * @summary Revoke Role from Principal
1963
+ * @param {string} orgId
1964
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
1965
+ * @param {*} [options] Override http request option.
1966
+ * @throws {RequiredError}
1967
+ */
1968
+ revokeRoleFromPrincipal: async (orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1969
+ // verify required parameter 'orgId' is not null or undefined
1970
+ assertParamExists('revokeRoleFromPrincipal', 'orgId', orgId)
1971
+ const localVarPath = `/orgs/{orgId}/roles/revokeRoleFromPrincipal`
1972
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1973
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1974
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1975
+ let baseOptions;
1976
+ if (configuration) {
1977
+ baseOptions = configuration.baseOptions;
1978
+ }
1979
+
1980
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1981
+ const localVarHeaderParameter = {} as any;
1982
+ const localVarQueryParameter = {} as any;
1983
+
1984
+ // authentication ApiKeyAuth required
1985
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1986
+
1987
+
1988
+
1989
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1990
+
1991
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1992
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1993
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1994
+ localVarRequestOptions.data = serializeDataIfNeeded(revokeRoleRequestBody, localVarRequestOptions, configuration)
1995
+
1996
+ return {
1997
+ url: toPathString(localVarUrlObj),
1998
+ options: localVarRequestOptions,
1999
+ };
2000
+ },
2001
+ }
2002
+ };
2003
+
2004
+ /**
2005
+ * RoleAssignmentApi - functional programming interface
2006
+ * @export
2007
+ */
2008
+ export const RoleAssignmentApiFp = function(configuration?: Configuration) {
2009
+ const localVarAxiosParamCreator = RoleAssignmentApiAxiosParamCreator(configuration)
2010
+ return {
2011
+ /**
2012
+ * Assigns a specified role to a given principal (user, group, etc.)
2013
+ * @summary Assign Role to Principal
2014
+ * @param {string} orgId
2015
+ * @param {AssignRoleRequestBody} [assignRoleRequestBody]
2016
+ * @param {*} [options] Override http request option.
2017
+ * @throws {RequiredError}
2018
+ */
2019
+ async assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignRoleSuccessResponse>> {
2020
+ const localVarAxiosArgs = await localVarAxiosParamCreator.assignRoleToPrincipal(orgId, assignRoleRequestBody, options);
2021
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2022
+ const localVarOperationServerBasePath = operationServerMap['RoleAssignmentApi.assignRoleToPrincipal']?.[localVarOperationServerIndex]?.url;
2023
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2024
+ },
2025
+ /**
2026
+ * Get the active roles for a given principal
2027
+ * @summary Get Principal Roles
2028
+ * @param {string} orgId
2029
+ * @param {GetPrincipalRolesRequestBody} [getPrincipalRolesRequestBody]
2030
+ * @param {*} [options] Override http request option.
2031
+ * @throws {RequiredError}
2032
+ */
2033
+ async getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrincipalRolesSuccessResponse>> {
2034
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPrincipalRoles(orgId, getPrincipalRolesRequestBody, options);
2035
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2036
+ const localVarOperationServerBasePath = operationServerMap['RoleAssignmentApi.getPrincipalRoles']?.[localVarOperationServerIndex]?.url;
2037
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2038
+ },
2039
+ /**
2040
+ * Revokes a forbidden role from a given principal (user, group, etc.)
2041
+ * @summary Revoke Forbidden Role from Principal
2042
+ * @param {string} orgId
2043
+ * @param {RevokeForbiddenRoleRequestBody} [revokeForbiddenRoleRequestBody]
2044
+ * @param {*} [options] Override http request option.
2045
+ * @throws {RequiredError}
2046
+ */
2047
+ async revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>> {
2048
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeForbiddenRoleFromPrincipal(orgId, revokeForbiddenRoleRequestBody, options);
2049
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2050
+ const localVarOperationServerBasePath = operationServerMap['RoleAssignmentApi.revokeForbiddenRoleFromPrincipal']?.[localVarOperationServerIndex]?.url;
2051
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2052
+ },
2053
+ /**
2054
+ * Revokes a specified role from a given principal (user, group, etc.)
2055
+ * @summary Revoke Role from Principal
2056
+ * @param {string} orgId
2057
+ * @param {RevokeRoleRequestBody} [revokeRoleRequestBody]
2058
+ * @param {*} [options] Override http request option.
2059
+ * @throws {RequiredError}
2060
+ */
2061
+ async revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>> {
2062
+ const localVarAxiosArgs = await localVarAxiosParamCreator.revokeRoleFromPrincipal(orgId, revokeRoleRequestBody, options);
2063
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2064
+ const localVarOperationServerBasePath = operationServerMap['RoleAssignmentApi.revokeRoleFromPrincipal']?.[localVarOperationServerIndex]?.url;
2065
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2066
+ },
2067
+ }
2068
+ };
2069
+
2070
+ /**
2071
+ * RoleAssignmentApi - factory interface
2072
+ * @export
2073
+ */
2074
+ export const RoleAssignmentApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2075
+ const localVarFp = RoleAssignmentApiFp(configuration)
2076
+ return {
2077
+ /**
2078
+ * Assigns a specified role to a given principal (user, group, etc.)
2079
+ * @summary Assign Role to Principal
2080
+ * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
2081
+ * @param {*} [options] Override http request option.
2082
+ * @throws {RequiredError}
2083
+ */
2084
+ assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<AssignRoleSuccessResponse> {
2085
+ return localVarFp.assignRoleToPrincipal(requestParameters.orgId, requestParameters.assignRoleRequestBody, options).then((request) => request(axios, basePath));
2086
+ },
2087
+ /**
2088
+ * Get the active roles for a given principal
2089
+ * @summary Get Principal Roles
2090
+ * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
2091
+ * @param {*} [options] Override http request option.
2092
+ * @throws {RequiredError}
2093
+ */
2094
+ getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse> {
2095
+ return localVarFp.getPrincipalRoles(requestParameters.orgId, requestParameters.getPrincipalRolesRequestBody, options).then((request) => request(axios, basePath));
2096
+ },
2097
+ /**
2098
+ * Revokes a forbidden role from a given principal (user, group, etc.)
2099
+ * @summary Revoke Forbidden Role from Principal
2100
+ * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
2101
+ * @param {*} [options] Override http request option.
2102
+ * @throws {RequiredError}
2103
+ */
2104
+ revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse> {
2105
+ return localVarFp.revokeForbiddenRoleFromPrincipal(requestParameters.orgId, requestParameters.revokeForbiddenRoleRequestBody, options).then((request) => request(axios, basePath));
2106
+ },
2107
+ /**
2108
+ * Revokes a specified role from a given principal (user, group, etc.)
2109
+ * @summary Revoke Role from Principal
2110
+ * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
2111
+ * @param {*} [options] Override http request option.
2112
+ * @throws {RequiredError}
2113
+ */
2114
+ revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse> {
2115
+ return localVarFp.revokeRoleFromPrincipal(requestParameters.orgId, requestParameters.revokeRoleRequestBody, options).then((request) => request(axios, basePath));
2116
+ },
2117
+ };
2118
+ };
2119
+
2120
+ /**
2121
+ * Request parameters for assignRoleToPrincipal operation in RoleAssignmentApi.
2122
+ * @export
2123
+ * @interface RoleAssignmentApiAssignRoleToPrincipalRequest
2124
+ */
2125
+ export interface RoleAssignmentApiAssignRoleToPrincipalRequest {
2126
+ /**
2127
+ *
2128
+ * @type {string}
2129
+ * @memberof RoleAssignmentApiAssignRoleToPrincipal
2130
+ */
2131
+ readonly orgId: string
2132
+
2133
+ /**
2134
+ *
2135
+ * @type {AssignRoleRequestBody}
2136
+ * @memberof RoleAssignmentApiAssignRoleToPrincipal
2137
+ */
2138
+ readonly assignRoleRequestBody?: AssignRoleRequestBody
2139
+ }
2140
+
2141
+ /**
2142
+ * Request parameters for getPrincipalRoles operation in RoleAssignmentApi.
2143
+ * @export
2144
+ * @interface RoleAssignmentApiGetPrincipalRolesRequest
2145
+ */
2146
+ export interface RoleAssignmentApiGetPrincipalRolesRequest {
2147
+ /**
2148
+ *
2149
+ * @type {string}
2150
+ * @memberof RoleAssignmentApiGetPrincipalRoles
2151
+ */
2152
+ readonly orgId: string
2153
+
2154
+ /**
2155
+ *
2156
+ * @type {GetPrincipalRolesRequestBody}
2157
+ * @memberof RoleAssignmentApiGetPrincipalRoles
2158
+ */
2159
+ readonly getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody
2160
+ }
2161
+
2162
+ /**
2163
+ * Request parameters for revokeForbiddenRoleFromPrincipal operation in RoleAssignmentApi.
2164
+ * @export
2165
+ * @interface RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest
2166
+ */
2167
+ export interface RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest {
2168
+ /**
2169
+ *
2170
+ * @type {string}
2171
+ * @memberof RoleAssignmentApiRevokeForbiddenRoleFromPrincipal
2172
+ */
2173
+ readonly orgId: string
2174
+
2175
+ /**
2176
+ *
2177
+ * @type {RevokeForbiddenRoleRequestBody}
2178
+ * @memberof RoleAssignmentApiRevokeForbiddenRoleFromPrincipal
2179
+ */
2180
+ readonly revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody
2181
+ }
2182
+
2183
+ /**
2184
+ * Request parameters for revokeRoleFromPrincipal operation in RoleAssignmentApi.
2185
+ * @export
2186
+ * @interface RoleAssignmentApiRevokeRoleFromPrincipalRequest
2187
+ */
2188
+ export interface RoleAssignmentApiRevokeRoleFromPrincipalRequest {
2189
+ /**
2190
+ *
2191
+ * @type {string}
2192
+ * @memberof RoleAssignmentApiRevokeRoleFromPrincipal
2193
+ */
2194
+ readonly orgId: string
2195
+
2196
+ /**
2197
+ *
2198
+ * @type {RevokeRoleRequestBody}
2199
+ * @memberof RoleAssignmentApiRevokeRoleFromPrincipal
2200
+ */
2201
+ readonly revokeRoleRequestBody?: RevokeRoleRequestBody
2202
+ }
2203
+
2204
+ /**
2205
+ * RoleAssignmentApi - object-oriented interface
2206
+ * @export
2207
+ * @class RoleAssignmentApi
2208
+ * @extends {BaseAPI}
2209
+ */
2210
+ export class RoleAssignmentApi extends BaseAPI {
2211
+ /**
2212
+ * Assigns a specified role to a given principal (user, group, etc.)
2213
+ * @summary Assign Role to Principal
2214
+ * @param {RoleAssignmentApiAssignRoleToPrincipalRequest} requestParameters Request parameters.
2215
+ * @param {*} [options] Override http request option.
2216
+ * @throws {RequiredError}
2217
+ * @memberof RoleAssignmentApi
2218
+ */
2219
+ public assignRoleToPrincipal(requestParameters: RoleAssignmentApiAssignRoleToPrincipalRequest, options?: RawAxiosRequestConfig) {
2220
+ return RoleAssignmentApiFp(this.configuration).assignRoleToPrincipal(requestParameters.orgId, requestParameters.assignRoleRequestBody, options).then((request) => request(this.axios, this.basePath));
2221
+ }
2222
+
2223
+ /**
2224
+ * Get the active roles for a given principal
2225
+ * @summary Get Principal Roles
2226
+ * @param {RoleAssignmentApiGetPrincipalRolesRequest} requestParameters Request parameters.
2227
+ * @param {*} [options] Override http request option.
2228
+ * @throws {RequiredError}
2229
+ * @memberof RoleAssignmentApi
2230
+ */
2231
+ public getPrincipalRoles(requestParameters: RoleAssignmentApiGetPrincipalRolesRequest, options?: RawAxiosRequestConfig) {
2232
+ return RoleAssignmentApiFp(this.configuration).getPrincipalRoles(requestParameters.orgId, requestParameters.getPrincipalRolesRequestBody, options).then((request) => request(this.axios, this.basePath));
2233
+ }
2234
+
2235
+ /**
2236
+ * Revokes a forbidden role from a given principal (user, group, etc.)
2237
+ * @summary Revoke Forbidden Role from Principal
2238
+ * @param {RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest} requestParameters Request parameters.
2239
+ * @param {*} [options] Override http request option.
2240
+ * @throws {RequiredError}
2241
+ * @memberof RoleAssignmentApi
2242
+ */
2243
+ public revokeForbiddenRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeForbiddenRoleFromPrincipalRequest, options?: RawAxiosRequestConfig) {
2244
+ return RoleAssignmentApiFp(this.configuration).revokeForbiddenRoleFromPrincipal(requestParameters.orgId, requestParameters.revokeForbiddenRoleRequestBody, options).then((request) => request(this.axios, this.basePath));
2245
+ }
2246
+
2247
+ /**
2248
+ * Revokes a specified role from a given principal (user, group, etc.)
2249
+ * @summary Revoke Role from Principal
2250
+ * @param {RoleAssignmentApiRevokeRoleFromPrincipalRequest} requestParameters Request parameters.
2251
+ * @param {*} [options] Override http request option.
2252
+ * @throws {RequiredError}
2253
+ * @memberof RoleAssignmentApi
2254
+ */
2255
+ public revokeRoleFromPrincipal(requestParameters: RoleAssignmentApiRevokeRoleFromPrincipalRequest, options?: RawAxiosRequestConfig) {
2256
+ return RoleAssignmentApiFp(this.configuration).revokeRoleFromPrincipal(requestParameters.orgId, requestParameters.revokeRoleRequestBody, options).then((request) => request(this.axios, this.basePath));
2257
+ }
2258
+ }
2259
+
2260
+
2261
+
2262
+ /**
2263
+ * UserPermissionsApi - axios parameter creator
2264
+ * @export
2265
+ */
2266
+ export const UserPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
2267
+ return {
2268
+ /**
2269
+ * List the available permissions for the current user
2270
+ * @summary List Own Permissions
2271
+ * @param {string} orgId
2272
+ * @param {*} [options] Override http request option.
2273
+ * @throws {RequiredError}
2274
+ */
2275
+ listOwnPermissions: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2276
+ // verify required parameter 'orgId' is not null or undefined
2277
+ assertParamExists('listOwnPermissions', 'orgId', orgId)
2278
+ const localVarPath = `/orgs/{orgId}/user/permissions`
2279
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
2280
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2281
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2282
+ let baseOptions;
2283
+ if (configuration) {
2284
+ baseOptions = configuration.baseOptions;
2285
+ }
2286
+
2287
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2288
+ const localVarHeaderParameter = {} as any;
2289
+ const localVarQueryParameter = {} as any;
2290
+
2291
+ // authentication ApiKeyAuth required
2292
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2293
+
2294
+
2295
+
2296
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2297
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2298
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2299
+
2300
+ return {
2301
+ url: toPathString(localVarUrlObj),
2302
+ options: localVarRequestOptions,
2303
+ };
2304
+ },
2305
+ /**
2306
+ * List the available permissions for a given user
2307
+ * @summary List User Permissions
2308
+ * @param {string} orgId
2309
+ * @param {string} userId
2310
+ * @param {*} [options] Override http request option.
2311
+ * @throws {RequiredError}
2312
+ */
2313
+ listUserPermissions: async (orgId: string, userId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2314
+ // verify required parameter 'orgId' is not null or undefined
2315
+ assertParamExists('listUserPermissions', 'orgId', orgId)
2316
+ // verify required parameter 'userId' is not null or undefined
2317
+ assertParamExists('listUserPermissions', 'userId', userId)
2318
+ const localVarPath = `/orgs/{orgId}/user/{userId}/permissions`
2319
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
2320
+ .replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
2321
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2322
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2323
+ let baseOptions;
2324
+ if (configuration) {
2325
+ baseOptions = configuration.baseOptions;
2326
+ }
2327
+
2328
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2329
+ const localVarHeaderParameter = {} as any;
2330
+ const localVarQueryParameter = {} as any;
2331
+
2332
+ // authentication ApiKeyAuth required
2333
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2334
+
2335
+
2336
+
2337
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2338
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2339
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2340
+
2341
+ return {
2342
+ url: toPathString(localVarUrlObj),
2343
+ options: localVarRequestOptions,
2344
+ };
2345
+ },
2346
+ }
2347
+ };
2348
+
2349
+ /**
2350
+ * UserPermissionsApi - functional programming interface
2351
+ * @export
2352
+ */
2353
+ export const UserPermissionsApiFp = function(configuration?: Configuration) {
2354
+ const localVarAxiosParamCreator = UserPermissionsApiAxiosParamCreator(configuration)
2355
+ return {
2356
+ /**
2357
+ * List the available permissions for the current user
2358
+ * @summary List Own Permissions
2359
+ * @param {string} orgId
2360
+ * @param {*} [options] Override http request option.
2361
+ * @throws {RequiredError}
2362
+ */
2363
+ async listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>> {
2364
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOwnPermissions(orgId, options);
2365
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2366
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOwnPermissions']?.[localVarOperationServerIndex]?.url;
2367
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2368
+ },
2369
+ /**
2370
+ * List the available permissions for a given user
2371
+ * @summary List User Permissions
2372
+ * @param {string} orgId
2373
+ * @param {string} userId
2374
+ * @param {*} [options] Override http request option.
2375
+ * @throws {RequiredError}
2376
+ */
2377
+ async listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetUserPermissionsSuccessResponse>> {
2378
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listUserPermissions(orgId, userId, options);
2379
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2380
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listUserPermissions']?.[localVarOperationServerIndex]?.url;
2381
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2382
+ },
2383
+ }
2384
+ };
2385
+
2386
+ /**
2387
+ * UserPermissionsApi - factory interface
2388
+ * @export
2389
+ */
2390
+ export const UserPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2391
+ const localVarFp = UserPermissionsApiFp(configuration)
2392
+ return {
2393
+ /**
2394
+ * List the available permissions for the current user
2395
+ * @summary List Own Permissions
2396
+ * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
2397
+ * @param {*} [options] Override http request option.
2398
+ * @throws {RequiredError}
2399
+ */
2400
+ listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse> {
2401
+ return localVarFp.listOwnPermissions(requestParameters.orgId, options).then((request) => request(axios, basePath));
2402
+ },
2403
+ /**
2404
+ * List the available permissions for a given user
2405
+ * @summary List User Permissions
2406
+ * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
2407
+ * @param {*} [options] Override http request option.
2408
+ * @throws {RequiredError}
2409
+ */
2410
+ listUserPermissions(requestParameters: UserPermissionsApiListUserPermissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetUserPermissionsSuccessResponse> {
2411
+ return localVarFp.listUserPermissions(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
2412
+ },
2413
+ };
2414
+ };
2415
+
2416
+ /**
2417
+ * Request parameters for listOwnPermissions operation in UserPermissionsApi.
2418
+ * @export
2419
+ * @interface UserPermissionsApiListOwnPermissionsRequest
2420
+ */
2421
+ export interface UserPermissionsApiListOwnPermissionsRequest {
2422
+ /**
2423
+ *
2424
+ * @type {string}
2425
+ * @memberof UserPermissionsApiListOwnPermissions
2426
+ */
2427
+ readonly orgId: string
2428
+ }
2429
+
2430
+ /**
2431
+ * Request parameters for listUserPermissions operation in UserPermissionsApi.
2432
+ * @export
2433
+ * @interface UserPermissionsApiListUserPermissionsRequest
2434
+ */
2435
+ export interface UserPermissionsApiListUserPermissionsRequest {
2436
+ /**
2437
+ *
2438
+ * @type {string}
2439
+ * @memberof UserPermissionsApiListUserPermissions
2440
+ */
2441
+ readonly orgId: string
2442
+
2443
+ /**
2444
+ *
2445
+ * @type {string}
2446
+ * @memberof UserPermissionsApiListUserPermissions
2447
+ */
2448
+ readonly userId: string
2449
+ }
2450
+
2451
+ /**
2452
+ * UserPermissionsApi - object-oriented interface
2453
+ * @export
2454
+ * @class UserPermissionsApi
2455
+ * @extends {BaseAPI}
2456
+ */
2457
+ export class UserPermissionsApi extends BaseAPI {
2458
+ /**
2459
+ * List the available permissions for the current user
2460
+ * @summary List Own Permissions
2461
+ * @param {UserPermissionsApiListOwnPermissionsRequest} requestParameters Request parameters.
2462
+ * @param {*} [options] Override http request option.
2463
+ * @throws {RequiredError}
2464
+ * @memberof UserPermissionsApi
2465
+ */
2466
+ public listOwnPermissions(requestParameters: UserPermissionsApiListOwnPermissionsRequest, options?: RawAxiosRequestConfig) {
2467
+ return UserPermissionsApiFp(this.configuration).listOwnPermissions(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
2468
+ }
2469
+
2470
+ /**
2471
+ * List the available permissions for a given user
2472
+ * @summary List User Permissions
2473
+ * @param {UserPermissionsApiListUserPermissionsRequest} requestParameters Request parameters.
2474
+ * @param {*} [options] Override http request option.
2475
+ * @throws {RequiredError}
2476
+ * @memberof UserPermissionsApi
2477
+ */
2478
+ public listUserPermissions(requestParameters: UserPermissionsApiListUserPermissionsRequest, options?: RawAxiosRequestConfig) {
2479
+ return UserPermissionsApiFp(this.configuration).listUserPermissions(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
2480
+ }
2481
+ }
2482
+
2483
+
2484
+