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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -20,7 +20,7 @@ import { BaseAPI } from './base';
20
20
  */
21
21
  export interface AssignRoleRequestBody {
22
22
  /**
23
- * Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
23
+ *
24
24
  * @type {string}
25
25
  * @memberof AssignRoleRequestBody
26
26
  */
@@ -37,6 +37,12 @@ export interface AssignRoleRequestBody {
37
37
  * @memberof AssignRoleRequestBody
38
38
  */
39
39
  'principal': AuthorizationRequestPrincipal;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof AssignRoleRequestBody
44
+ */
45
+ 'brandId': string;
40
46
  }
41
47
  export declare const AssignRoleRequestBodyRoleEnum: {
42
48
  readonly OrgViewer: "OrgViewer";
@@ -134,11 +140,11 @@ export interface AssignRoleSuccessResponse {
134
140
  export interface AuthenticateAndAuthorizeRequest {
135
141
  /**
136
142
  * Incoming request headers to be used for authentication
137
- * @type {{ [key: string]: any; }}
143
+ * @type {{ [key: string]: string; }}
138
144
  * @memberof AuthenticateAndAuthorizeRequest
139
145
  */
140
146
  'headers': {
141
- [key: string]: any;
147
+ [key: string]: string;
142
148
  };
143
149
  /**
144
150
  *
@@ -152,7 +158,18 @@ export interface AuthenticateAndAuthorizeRequest {
152
158
  * @memberof AuthenticateAndAuthorizeRequest
153
159
  */
154
160
  'resource'?: AuthorizationRequestResource;
161
+ /**
162
+ * How to check authorisation - any or all of the actions must be allowed
163
+ * @type {string}
164
+ * @memberof AuthenticateAndAuthorizeRequest
165
+ */
166
+ 'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
155
167
  }
168
+ export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: {
169
+ readonly Any: "any";
170
+ readonly All: "all";
171
+ };
172
+ export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
156
173
  /**
157
174
  * Response containing the authentication and authorization decision
158
175
  * @export
@@ -161,10 +178,10 @@ export interface AuthenticateAndAuthorizeRequest {
161
178
  export interface AuthenticateAndAuthorizeResponse {
162
179
  /**
163
180
  *
164
- * @type {AuthenticateAndAuthorizeResponseAuthentication}
181
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
165
182
  * @memberof AuthenticateAndAuthorizeResponse
166
183
  */
167
- 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
184
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
168
185
  /**
169
186
  *
170
187
  * @type {AuthorizationResponse}
@@ -175,249 +192,1738 @@ export interface AuthenticateAndAuthorizeResponse {
175
192
  /**
176
193
  *
177
194
  * @export
178
- * @interface AuthenticateAndAuthorizeResponseAuthentication
179
- */
180
- export interface AuthenticateAndAuthorizeResponseAuthentication {
181
- /**
182
- *
183
- * @type {AuthorizationRequestPrincipal}
184
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
185
- */
186
- 'principal': AuthorizationRequestPrincipal;
187
- /**
188
- * Whether the user is authenticated
189
- * @type {boolean}
190
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
191
- */
192
- 'authenticated': boolean;
193
- /**
194
- * The reason for the authentication failure
195
- * @type {string}
196
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
197
- */
198
- 'reason'?: string;
199
- }
200
- /**
201
- * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
202
- * @export
203
- * @interface AuthorizationRequest
204
- */
205
- export interface AuthorizationRequest {
206
- /**
207
- *
208
- * @type {AuthorizationRequestPrincipal}
209
- * @memberof AuthorizationRequest
210
- */
211
- 'principal': AuthorizationRequestPrincipal;
212
- /**
213
- *
214
- * @type {AuthorizationRequestAction}
215
- * @memberof AuthorizationRequest
216
- */
217
- 'action': AuthorizationRequestAction;
218
- /**
219
- *
220
- * @type {AuthorizationRequestResource}
221
- * @memberof AuthorizationRequest
222
- */
223
- 'resource'?: AuthorizationRequestResource;
224
- }
225
- /**
226
- *
227
- * @export
228
- * @interface AuthorizationRequestAction
229
- */
230
- export interface AuthorizationRequestAction {
231
- }
232
- /**
233
- *
234
- * @export
235
- * @interface AuthorizationRequestPrincipal
195
+ * @interface AuthenticateAndCheckIsInRoleRequest
236
196
  */
237
- export interface AuthorizationRequestPrincipal {
238
- /**
239
- *
240
- * @type {string}
241
- * @memberof AuthorizationRequestPrincipal
242
- */
243
- 'type': AuthorizationRequestPrincipalTypeEnum;
197
+ export interface AuthenticateAndCheckIsInRoleRequest {
244
198
  /**
245
- *
246
- * @type {string}
247
- * @memberof AuthorizationRequestPrincipal
248
- */
249
- 'id': string;
250
- /**
251
- *
252
- * @type {string}
253
- * @memberof AuthorizationRequestPrincipal
199
+ * Incoming request headers to be used for authentication
200
+ * @type {{ [key: string]: string; }}
201
+ * @memberof AuthenticateAndCheckIsInRoleRequest
254
202
  */
255
- 'name'?: string;
203
+ 'headers': {
204
+ [key: string]: string;
205
+ };
256
206
  /**
257
- *
258
- * @type {string}
259
- * @memberof AuthorizationRequestPrincipal
207
+ * Array of roles to check if the principal is in
208
+ * @type {Array<string>}
209
+ * @memberof AuthenticateAndCheckIsInRoleRequest
260
210
  */
261
- 'email'?: string;
211
+ 'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
262
212
  /**
263
213
  *
264
214
  * @type {string}
265
- * @memberof AuthorizationRequestPrincipal
215
+ * @memberof AuthenticateAndCheckIsInRoleRequest
266
216
  */
267
- 'phone'?: string;
217
+ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
268
218
  }
269
- export declare const AuthorizationRequestPrincipalTypeEnum: {
270
- readonly User: "User";
271
- readonly Automation: "Automation";
219
+ export declare const AuthenticateAndCheckIsInRoleRequestRolesEnum: {
220
+ readonly Admin: "Admin";
221
+ readonly Factory: "Factory";
272
222
  };
273
- export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
274
- /**
275
- * @type AuthorizationRequestResource
276
- * @export
277
- */
278
- export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
223
+ export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
224
+ export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: {
225
+ readonly Any: "any";
226
+ readonly All: "all";
227
+ };
228
+ export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
279
229
  /**
280
- *
230
+ * Response containing whether the principal is in any/all of the roles
281
231
  * @export
282
- * @interface AuthorizationRequestResourceOneOf
232
+ * @interface AuthenticateAndCheckIsInRoleResponse
283
233
  */
284
- export interface AuthorizationRequestResourceOneOf {
234
+ export interface AuthenticateAndCheckIsInRoleResponse {
285
235
  /**
286
236
  *
287
- * @type {string}
288
- * @memberof AuthorizationRequestResourceOneOf
237
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
238
+ * @memberof AuthenticateAndCheckIsInRoleResponse
289
239
  */
290
- 'type': AuthorizationRequestResourceOneOfTypeEnum;
240
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
291
241
  /**
292
- *
293
- * @type {string}
294
- * @memberof AuthorizationRequestResourceOneOf
242
+ * result of the check - whether the principal is in any/all of the roles
243
+ * @type {boolean}
244
+ * @memberof AuthenticateAndCheckIsInRoleResponse
295
245
  */
296
- 'id': string;
246
+ 'authorized': boolean;
297
247
  }
298
- export declare const AuthorizationRequestResourceOneOfTypeEnum: {
299
- readonly Property: "Property";
300
- };
301
- export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
302
248
  /**
303
249
  *
304
250
  * @export
305
- * @interface AuthorizationRequestResourceOneOf1
251
+ * @interface AuthenticateAndCheckIsInRoleResponseAuthentication
306
252
  */
307
- export interface AuthorizationRequestResourceOneOf1 {
308
- /**
309
- *
310
- * @type {string}
311
- * @memberof AuthorizationRequestResourceOneOf1
312
- */
313
- 'type': AuthorizationRequestResourceOneOf1TypeEnum;
253
+ export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
314
254
  /**
315
255
  *
316
- * @type {string}
317
- * @memberof AuthorizationRequestResourceOneOf1
256
+ * @type {AuthorizationRequestPrincipal}
257
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
318
258
  */
319
- 'id': string;
320
- }
321
- export declare const AuthorizationRequestResourceOneOf1TypeEnum: {
322
- readonly Org: "Org";
323
- };
324
- export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
325
- /**
326
- *
327
- * @export
328
- * @interface AuthorizationRequestResourceOneOf2
329
- */
330
- export interface AuthorizationRequestResourceOneOf2 {
259
+ 'principal': AuthorizationRequestPrincipal;
331
260
  /**
332
- *
333
- * @type {string}
334
- * @memberof AuthorizationRequestResourceOneOf2
261
+ * Whether the user is authenticated
262
+ * @type {boolean}
263
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
335
264
  */
336
- 'type': AuthorizationRequestResourceOneOf2TypeEnum;
265
+ 'authenticated': boolean;
337
266
  /**
338
- *
267
+ * The reason for the authentication failure
339
268
  * @type {string}
340
- * @memberof AuthorizationRequestResourceOneOf2
269
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
341
270
  */
342
- 'id': string;
271
+ 'reason'?: string;
343
272
  }
344
- export declare const AuthorizationRequestResourceOneOf2TypeEnum: {
345
- readonly Brand: "Brand";
346
- };
347
- export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
348
273
  /**
349
274
  *
350
275
  * @export
351
- * @interface AuthorizationRequestResourceOneOf3
276
+ * @interface AuthorizationBatchRequest
352
277
  */
353
- export interface AuthorizationRequestResourceOneOf3 {
278
+ export interface AuthorizationBatchRequest {
354
279
  /**
355
280
  *
356
- * @type {string}
357
- * @memberof AuthorizationRequestResourceOneOf3
281
+ * @type {AuthorizationRequestPrincipal}
282
+ * @memberof AuthorizationBatchRequest
358
283
  */
359
- 'type': AuthorizationRequestResourceOneOf3TypeEnum;
284
+ 'principal': AuthorizationRequestPrincipal;
360
285
  /**
361
- *
286
+ * The action to check authorisation for
362
287
  * @type {string}
363
- * @memberof AuthorizationRequestResourceOneOf3
288
+ * @memberof AuthorizationBatchRequest
364
289
  */
365
- 'id': string;
290
+ 'action': AuthorizationBatchRequestActionEnum;
291
+ /**
292
+ * Array of resources to check authorisation for
293
+ * @type {Array<AuthorizationRequestResource>}
294
+ * @memberof AuthorizationBatchRequest
295
+ */
296
+ 'resources': Array<AuthorizationRequestResource>;
366
297
  }
367
- export declare const AuthorizationRequestResourceOneOf3TypeEnum: {
368
- readonly SalesChannel: "SalesChannel";
298
+ export declare const AuthorizationBatchRequestActionEnum: {
299
+ readonly AnyAuditLogs: "AnyAuditLogs";
300
+ readonly ViewApp: "ViewApp";
301
+ readonly CreateApp: "CreateApp";
302
+ readonly UpdateApp: "UpdateApp";
303
+ readonly ViewAppName: "ViewAppName";
304
+ readonly EditAppAssets: "EditAppAssets";
305
+ readonly EditAppFeatures: "EditAppFeatures";
306
+ readonly ViewTeammates: "ViewTeammates";
307
+ readonly EditTeammates: "EditTeammates";
308
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
309
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
310
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
311
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
312
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
313
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
314
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
315
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
316
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
317
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
318
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
319
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
320
+ readonly EditApmConfigurations: "EditApmConfigurations";
321
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
322
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
323
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
324
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
325
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
326
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
327
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
328
+ readonly ViewOrders: "ViewOrders";
329
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
330
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
331
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
332
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
333
+ readonly ViewStores: "ViewStores";
334
+ readonly CreateStores: "CreateStores";
335
+ readonly EditStores: "EditStores";
336
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
337
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
338
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
339
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
340
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
341
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
342
+ readonly UpdateStoresName: "UpdateStoresName";
343
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
344
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
345
+ readonly EditStoreNotifications: "EditStoreNotifications";
346
+ readonly ArchiveStores: "ArchiveStores";
347
+ readonly PublishStores: "PublishStores";
348
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
349
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
350
+ readonly ViewStoreGroups: "ViewStoreGroups";
351
+ readonly CreateStoreGroups: "CreateStoreGroups";
352
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
353
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
354
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
355
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
356
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
357
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
358
+ readonly ViewMenu: "ViewMenu";
359
+ readonly CreateMenu: "CreateMenu";
360
+ readonly UpdateMenu: "UpdateMenu";
361
+ readonly DeleteMenu: "DeleteMenu";
362
+ readonly UpdateMenuLock: "UpdateMenuLock";
363
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
364
+ readonly EditMenuImage: "EditMenuImage";
365
+ readonly ViewVouchers: "ViewVouchers";
366
+ readonly EditVouchers: "EditVouchers";
367
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
368
+ readonly EditWebsiteContent: "EditWebsiteContent";
369
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
370
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
371
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
372
+ readonly ViewBankAccounts: "ViewBankAccounts";
373
+ readonly CreateBankAccounts: "CreateBankAccounts";
374
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
375
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
376
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
377
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
378
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
379
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
380
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
381
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
382
+ readonly ViewHydraConfig: "ViewHydraConfig";
383
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
384
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
385
+ readonly DeleteTerminal: "DeleteTerminal";
386
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
387
+ readonly ViewCustomers: "ViewCustomers";
388
+ readonly EditCustomers: "EditCustomers";
389
+ readonly CreateCustomers: "CreateCustomers";
390
+ readonly CreateCatalogElements: "CreateCatalogElements";
391
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
392
+ readonly ViewCatalogElements: "ViewCatalogElements";
393
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
394
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
395
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
396
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
397
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
398
+ readonly UpdateMetafields: "UpdateMetafields";
399
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
400
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
401
+ readonly ViewAppStatistics: "ViewAppStatistics";
402
+ readonly ViewApmStatistics: "ViewApmStatistics";
403
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
404
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
405
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
406
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
407
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
408
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
409
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
410
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
411
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
412
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
413
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
414
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
415
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
416
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
417
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
418
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
419
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
420
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
421
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
422
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
423
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
424
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
425
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
426
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
427
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
428
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
429
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
430
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
431
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
432
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
433
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
434
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
435
+ readonly InviteDriverToApp: "InviteDriverToApp";
436
+ readonly GetDriverForApp: "GetDriverForApp";
437
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
438
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
439
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
440
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
441
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
442
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
443
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
444
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
445
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
446
+ readonly ViewPayouts: "ViewPayouts";
447
+ readonly ViewChannels: "ViewChannels";
448
+ readonly ViewOnboarding: "ViewOnboarding";
449
+ readonly UpdateOnboarding: "UpdateOnboarding";
450
+ readonly ViewClientDevices: "ViewClientDevices";
451
+ readonly UpdateClientDevices: "UpdateClientDevices";
452
+ readonly EnrollClientDevices: "EnrollClientDevices";
453
+ readonly AssignClientDevices: "AssignClientDevices";
454
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
455
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
456
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
457
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
458
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
459
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
460
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
461
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
462
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
463
+ readonly ViewSalesChannels: "ViewSalesChannels";
464
+ readonly EditSalesChannels: "EditSalesChannels";
465
+ readonly CreateSalesChannel: "CreateSalesChannel";
466
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
467
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
468
+ readonly PublishSalesChannel: "PublishSalesChannel";
469
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
470
+ readonly CloneSalesChannel: "CloneSalesChannel";
471
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
472
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
473
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
474
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
475
+ readonly ViewSubscriptions: "ViewSubscriptions";
476
+ readonly ViewInvoices: "ViewInvoices";
477
+ readonly EditAccountsBills: "EditAccountsBills";
478
+ readonly ViewAccountsBills: "ViewAccountsBills";
479
+ readonly EditAccountsCategories: "EditAccountsCategories";
480
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
481
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
482
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
483
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
484
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
485
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
486
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
487
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
488
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
489
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
490
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
491
+ readonly ViewInventoryReports: "ViewInventoryReports";
492
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
493
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
494
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
495
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
496
+ readonly EditInventorySupplier: "EditInventorySupplier";
497
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
498
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
499
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
500
+ readonly ViewPayrollReports: "ViewPayrollReports";
501
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
502
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
503
+ readonly EditPayrollRota: "EditPayrollRota";
504
+ readonly ViewPayrollRota: "ViewPayrollRota";
505
+ readonly EditPayrollStaff: "EditPayrollStaff";
506
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
507
+ readonly ViewSalesReports: "ViewSalesReports";
508
+ readonly ViewCostReports: "ViewCostReports";
509
+ readonly ViewMenuReports: "ViewMenuReports";
510
+ readonly ViewBrand: "ViewBrand";
511
+ readonly EditBrand: "EditBrand";
512
+ readonly CreateBrand: "CreateBrand";
513
+ readonly TransferBrand: "TransferBrand";
514
+ readonly ViewProperty: "ViewProperty";
515
+ readonly EditProperty: "EditProperty";
516
+ readonly CreateProperty: "CreateProperty";
517
+ readonly ArchiveProperty: "ArchiveProperty";
518
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
519
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
520
+ readonly CreateOrg: "CreateOrg";
521
+ readonly EditOrg: "EditOrg";
522
+ readonly ViewOrg: "ViewOrg";
523
+ readonly ViewWebhooks: "ViewWebhooks";
524
+ readonly EditWebhooks: "EditWebhooks";
525
+ readonly RoleAdmin: "RoleAdmin";
526
+ readonly RoleFactory: "RoleFactory";
527
+ };
528
+ export type AuthorizationBatchRequestActionEnum = typeof AuthorizationBatchRequestActionEnum[keyof typeof AuthorizationBatchRequestActionEnum];
529
+ /**
530
+ *
531
+ * @export
532
+ * @interface AuthorizationBatchResponse
533
+ */
534
+ export interface AuthorizationBatchResponse {
535
+ /**
536
+ * Array of allowed resources
537
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
538
+ * @memberof AuthorizationBatchResponse
539
+ */
540
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
541
+ /**
542
+ * Array of denied resources
543
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
544
+ * @memberof AuthorizationBatchResponse
545
+ */
546
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
547
+ }
548
+ /**
549
+ *
550
+ * @export
551
+ * @interface AuthorizationBatchResponseAllowedResourcesInner
552
+ */
553
+ export interface AuthorizationBatchResponseAllowedResourcesInner {
554
+ /**
555
+ * The authorization decision
556
+ * @type {string}
557
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
558
+ */
559
+ 'decision': string;
560
+ /**
561
+ * Whether the action is allowed
562
+ * @type {boolean}
563
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
564
+ */
565
+ 'allowed': boolean;
566
+ /**
567
+ * The policy IDs that were used to make the decision
568
+ * @type {Array<string>}
569
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
570
+ */
571
+ 'policyIds': Array<string>;
572
+ /**
573
+ *
574
+ * @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
575
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
576
+ */
577
+ 'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
578
+ }
579
+ /**
580
+ * @type AuthorizationBatchResponseAllowedResourcesInnerResource
581
+ * Resource that the action was checked for
582
+ * @export
583
+ */
584
+ export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
585
+ /**
586
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on the checkMode - any or all of the permissions must be allowed).
587
+ * @export
588
+ * @interface AuthorizationRequest
589
+ */
590
+ export interface AuthorizationRequest {
591
+ /**
592
+ *
593
+ * @type {AuthorizationRequestPrincipal}
594
+ * @memberof AuthorizationRequest
595
+ */
596
+ 'principal': AuthorizationRequestPrincipal;
597
+ /**
598
+ *
599
+ * @type {AuthorizationRequestAction}
600
+ * @memberof AuthorizationRequest
601
+ */
602
+ 'action': AuthorizationRequestAction;
603
+ /**
604
+ *
605
+ * @type {AuthorizationRequestResource}
606
+ * @memberof AuthorizationRequest
607
+ */
608
+ 'resource'?: AuthorizationRequestResource;
609
+ /**
610
+ * How to check authorisation - any or all of the actions must be allowed
611
+ * @type {string}
612
+ * @memberof AuthorizationRequest
613
+ */
614
+ 'checkMode'?: AuthorizationRequestCheckModeEnum;
615
+ }
616
+ export declare const AuthorizationRequestCheckModeEnum: {
617
+ readonly Any: "any";
618
+ readonly All: "all";
619
+ };
620
+ export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
621
+ /**
622
+ * Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
623
+ * @export
624
+ * @interface AuthorizationRequestAction
625
+ */
626
+ export interface AuthorizationRequestAction {
627
+ }
628
+ /**
629
+ *
630
+ * @export
631
+ * @interface AuthorizationRequestPrincipal
632
+ */
633
+ export interface AuthorizationRequestPrincipal {
634
+ /**
635
+ *
636
+ * @type {string}
637
+ * @memberof AuthorizationRequestPrincipal
638
+ */
639
+ 'type': AuthorizationRequestPrincipalTypeEnum;
640
+ /**
641
+ *
642
+ * @type {string}
643
+ * @memberof AuthorizationRequestPrincipal
644
+ */
645
+ 'id': string;
646
+ /**
647
+ *
648
+ * @type {string}
649
+ * @memberof AuthorizationRequestPrincipal
650
+ */
651
+ 'name'?: string;
652
+ /**
653
+ *
654
+ * @type {string}
655
+ * @memberof AuthorizationRequestPrincipal
656
+ */
657
+ 'email'?: string;
658
+ /**
659
+ *
660
+ * @type {string}
661
+ * @memberof AuthorizationRequestPrincipal
662
+ */
663
+ 'phone'?: string;
664
+ }
665
+ export declare const AuthorizationRequestPrincipalTypeEnum: {
666
+ readonly User: "User";
667
+ readonly Automation: "Automation";
668
+ };
669
+ export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
670
+ /**
671
+ * @type AuthorizationRequestResource
672
+ * @export
673
+ */
674
+ export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
675
+ /**
676
+ *
677
+ * @export
678
+ * @interface AuthorizationRequestResourceOneOf
679
+ */
680
+ export interface AuthorizationRequestResourceOneOf {
681
+ /**
682
+ *
683
+ * @type {string}
684
+ * @memberof AuthorizationRequestResourceOneOf
685
+ */
686
+ 'type': AuthorizationRequestResourceOneOfTypeEnum;
687
+ /**
688
+ *
689
+ * @type {string}
690
+ * @memberof AuthorizationRequestResourceOneOf
691
+ */
692
+ 'id': string;
693
+ }
694
+ export declare const AuthorizationRequestResourceOneOfTypeEnum: {
695
+ readonly Property: "Property";
696
+ };
697
+ export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum];
698
+ /**
699
+ *
700
+ * @export
701
+ * @interface AuthorizationRequestResourceOneOf1
702
+ */
703
+ export interface AuthorizationRequestResourceOneOf1 {
704
+ /**
705
+ *
706
+ * @type {string}
707
+ * @memberof AuthorizationRequestResourceOneOf1
708
+ */
709
+ 'type': AuthorizationRequestResourceOneOf1TypeEnum;
710
+ /**
711
+ *
712
+ * @type {string}
713
+ * @memberof AuthorizationRequestResourceOneOf1
714
+ */
715
+ 'id': string;
716
+ }
717
+ export declare const AuthorizationRequestResourceOneOf1TypeEnum: {
718
+ readonly Org: "Org";
719
+ };
720
+ export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum];
721
+ /**
722
+ *
723
+ * @export
724
+ * @interface AuthorizationRequestResourceOneOf2
725
+ */
726
+ export interface AuthorizationRequestResourceOneOf2 {
727
+ /**
728
+ *
729
+ * @type {string}
730
+ * @memberof AuthorizationRequestResourceOneOf2
731
+ */
732
+ 'type': AuthorizationRequestResourceOneOf2TypeEnum;
733
+ /**
734
+ *
735
+ * @type {string}
736
+ * @memberof AuthorizationRequestResourceOneOf2
737
+ */
738
+ 'id': string;
739
+ }
740
+ export declare const AuthorizationRequestResourceOneOf2TypeEnum: {
741
+ readonly Brand: "Brand";
742
+ };
743
+ export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum];
744
+ /**
745
+ *
746
+ * @export
747
+ * @interface AuthorizationRequestResourceOneOf3
748
+ */
749
+ export interface AuthorizationRequestResourceOneOf3 {
750
+ /**
751
+ *
752
+ * @type {string}
753
+ * @memberof AuthorizationRequestResourceOneOf3
754
+ */
755
+ 'type': AuthorizationRequestResourceOneOf3TypeEnum;
756
+ /**
757
+ *
758
+ * @type {string}
759
+ * @memberof AuthorizationRequestResourceOneOf3
760
+ */
761
+ 'id': string;
762
+ }
763
+ export declare const AuthorizationRequestResourceOneOf3TypeEnum: {
764
+ readonly SalesChannel: "SalesChannel";
765
+ };
766
+ export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
767
+ /**
768
+ * Response containing the authorization decision
769
+ * @export
770
+ * @interface AuthorizationResponse
771
+ */
772
+ export interface AuthorizationResponse {
773
+ /**
774
+ * Whether the action is allowed
775
+ * @type {boolean}
776
+ * @memberof AuthorizationResponse
777
+ */
778
+ 'allowed': boolean;
779
+ /**
780
+ * The authorization decision
781
+ * @type {string}
782
+ * @memberof AuthorizationResponse
783
+ */
784
+ 'decision': string;
785
+ /**
786
+ * The policy IDs that were used to make the decision
787
+ * @type {Array<string>}
788
+ * @memberof AuthorizationResponse
789
+ */
790
+ 'policyIds': Array<string>;
791
+ }
792
+ /**
793
+ *
794
+ * @export
795
+ * @interface ErrorResponse
796
+ */
797
+ export interface ErrorResponse {
798
+ /**
799
+ *
800
+ * @type {string}
801
+ * @memberof ErrorResponse
802
+ */
803
+ 'message': string;
804
+ }
805
+ /**
806
+ * Feature based role and its permissions
807
+ * @export
808
+ * @interface FeatureBasedRole
809
+ */
810
+ export interface FeatureBasedRole {
811
+ /**
812
+ * Name of the role
813
+ * @type {string}
814
+ * @memberof FeatureBasedRole
815
+ */
816
+ 'name': string;
817
+ /**
818
+ * List of permissions
819
+ * @type {Array<string>}
820
+ * @memberof FeatureBasedRole
821
+ */
822
+ 'permissions': Array<FeatureBasedRolePermissionsEnum>;
823
+ }
824
+ export declare const FeatureBasedRolePermissionsEnum: {
825
+ readonly AnyAuditLogs: "AnyAuditLogs";
826
+ readonly ViewApp: "ViewApp";
827
+ readonly CreateApp: "CreateApp";
828
+ readonly UpdateApp: "UpdateApp";
829
+ readonly ViewAppName: "ViewAppName";
830
+ readonly EditAppAssets: "EditAppAssets";
831
+ readonly EditAppFeatures: "EditAppFeatures";
832
+ readonly ViewTeammates: "ViewTeammates";
833
+ readonly EditTeammates: "EditTeammates";
834
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
835
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
836
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
837
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
838
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
839
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
840
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
841
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
842
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
843
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
844
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
845
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
846
+ readonly EditApmConfigurations: "EditApmConfigurations";
847
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
848
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
849
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
850
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
851
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
852
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
853
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
854
+ readonly ViewOrders: "ViewOrders";
855
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
856
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
857
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
858
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
859
+ readonly ViewStores: "ViewStores";
860
+ readonly CreateStores: "CreateStores";
861
+ readonly EditStores: "EditStores";
862
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
863
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
864
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
865
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
866
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
867
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
868
+ readonly UpdateStoresName: "UpdateStoresName";
869
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
870
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
871
+ readonly EditStoreNotifications: "EditStoreNotifications";
872
+ readonly ArchiveStores: "ArchiveStores";
873
+ readonly PublishStores: "PublishStores";
874
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
875
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
876
+ readonly ViewStoreGroups: "ViewStoreGroups";
877
+ readonly CreateStoreGroups: "CreateStoreGroups";
878
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
879
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
880
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
881
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
882
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
883
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
884
+ readonly ViewMenu: "ViewMenu";
885
+ readonly CreateMenu: "CreateMenu";
886
+ readonly UpdateMenu: "UpdateMenu";
887
+ readonly DeleteMenu: "DeleteMenu";
888
+ readonly UpdateMenuLock: "UpdateMenuLock";
889
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
890
+ readonly EditMenuImage: "EditMenuImage";
891
+ readonly ViewVouchers: "ViewVouchers";
892
+ readonly EditVouchers: "EditVouchers";
893
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
894
+ readonly EditWebsiteContent: "EditWebsiteContent";
895
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
896
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
897
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
898
+ readonly ViewBankAccounts: "ViewBankAccounts";
899
+ readonly CreateBankAccounts: "CreateBankAccounts";
900
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
901
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
902
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
903
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
904
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
905
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
906
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
907
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
908
+ readonly ViewHydraConfig: "ViewHydraConfig";
909
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
910
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
911
+ readonly DeleteTerminal: "DeleteTerminal";
912
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
913
+ readonly ViewCustomers: "ViewCustomers";
914
+ readonly EditCustomers: "EditCustomers";
915
+ readonly CreateCustomers: "CreateCustomers";
916
+ readonly CreateCatalogElements: "CreateCatalogElements";
917
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
918
+ readonly ViewCatalogElements: "ViewCatalogElements";
919
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
920
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
921
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
922
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
923
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
924
+ readonly UpdateMetafields: "UpdateMetafields";
925
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
926
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
927
+ readonly ViewAppStatistics: "ViewAppStatistics";
928
+ readonly ViewApmStatistics: "ViewApmStatistics";
929
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
930
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
931
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
932
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
933
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
934
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
935
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
936
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
937
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
938
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
939
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
940
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
941
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
942
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
943
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
944
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
945
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
946
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
947
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
948
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
949
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
950
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
951
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
952
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
953
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
954
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
955
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
956
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
957
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
958
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
959
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
960
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
961
+ readonly InviteDriverToApp: "InviteDriverToApp";
962
+ readonly GetDriverForApp: "GetDriverForApp";
963
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
964
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
965
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
966
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
967
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
968
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
969
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
970
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
971
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
972
+ readonly ViewPayouts: "ViewPayouts";
973
+ readonly ViewChannels: "ViewChannels";
974
+ readonly ViewOnboarding: "ViewOnboarding";
975
+ readonly UpdateOnboarding: "UpdateOnboarding";
976
+ readonly ViewClientDevices: "ViewClientDevices";
977
+ readonly UpdateClientDevices: "UpdateClientDevices";
978
+ readonly EnrollClientDevices: "EnrollClientDevices";
979
+ readonly AssignClientDevices: "AssignClientDevices";
980
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
981
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
982
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
983
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
984
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
985
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
986
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
987
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
988
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
989
+ readonly ViewSalesChannels: "ViewSalesChannels";
990
+ readonly EditSalesChannels: "EditSalesChannels";
991
+ readonly CreateSalesChannel: "CreateSalesChannel";
992
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
993
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
994
+ readonly PublishSalesChannel: "PublishSalesChannel";
995
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
996
+ readonly CloneSalesChannel: "CloneSalesChannel";
997
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
998
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
999
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1000
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1001
+ readonly ViewSubscriptions: "ViewSubscriptions";
1002
+ readonly ViewInvoices: "ViewInvoices";
1003
+ readonly EditAccountsBills: "EditAccountsBills";
1004
+ readonly ViewAccountsBills: "ViewAccountsBills";
1005
+ readonly EditAccountsCategories: "EditAccountsCategories";
1006
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1007
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1008
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1009
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1010
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1011
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1012
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1013
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1014
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1015
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1016
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1017
+ readonly ViewInventoryReports: "ViewInventoryReports";
1018
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1019
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1020
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1021
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1022
+ readonly EditInventorySupplier: "EditInventorySupplier";
1023
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1024
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1025
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1026
+ readonly ViewPayrollReports: "ViewPayrollReports";
1027
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1028
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1029
+ readonly EditPayrollRota: "EditPayrollRota";
1030
+ readonly ViewPayrollRota: "ViewPayrollRota";
1031
+ readonly EditPayrollStaff: "EditPayrollStaff";
1032
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1033
+ readonly ViewSalesReports: "ViewSalesReports";
1034
+ readonly ViewCostReports: "ViewCostReports";
1035
+ readonly ViewMenuReports: "ViewMenuReports";
1036
+ readonly ViewBrand: "ViewBrand";
1037
+ readonly EditBrand: "EditBrand";
1038
+ readonly CreateBrand: "CreateBrand";
1039
+ readonly TransferBrand: "TransferBrand";
1040
+ readonly ViewProperty: "ViewProperty";
1041
+ readonly EditProperty: "EditProperty";
1042
+ readonly CreateProperty: "CreateProperty";
1043
+ readonly ArchiveProperty: "ArchiveProperty";
1044
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1045
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1046
+ readonly CreateOrg: "CreateOrg";
1047
+ readonly EditOrg: "EditOrg";
1048
+ readonly ViewOrg: "ViewOrg";
1049
+ readonly ViewWebhooks: "ViewWebhooks";
1050
+ readonly EditWebhooks: "EditWebhooks";
1051
+ readonly RoleAdmin: "RoleAdmin";
1052
+ readonly RoleFactory: "RoleFactory";
1053
+ };
1054
+ export type FeatureBasedRolePermissionsEnum = typeof FeatureBasedRolePermissionsEnum[keyof typeof FeatureBasedRolePermissionsEnum];
1055
+ /**
1056
+ * Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
1057
+ * @export
1058
+ * @interface GetAuthorizedBrandsRequest
1059
+ */
1060
+ export interface GetAuthorizedBrandsRequest {
1061
+ /**
1062
+ *
1063
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1064
+ * @memberof GetAuthorizedBrandsRequest
1065
+ */
1066
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1067
+ /**
1068
+ * Incoming request headers to be used for authentication
1069
+ * @type {{ [key: string]: string; }}
1070
+ * @memberof GetAuthorizedBrandsRequest
1071
+ */
1072
+ 'headers'?: {
1073
+ [key: string]: string;
1074
+ };
1075
+ /**
1076
+ * The action to check authorisation for
1077
+ * @type {string}
1078
+ * @memberof GetAuthorizedBrandsRequest
1079
+ */
1080
+ 'action': GetAuthorizedBrandsRequestActionEnum;
1081
+ }
1082
+ export declare const GetAuthorizedBrandsRequestActionEnum: {
1083
+ readonly AnyAuditLogs: "AnyAuditLogs";
1084
+ readonly ViewApp: "ViewApp";
1085
+ readonly CreateApp: "CreateApp";
1086
+ readonly UpdateApp: "UpdateApp";
1087
+ readonly ViewAppName: "ViewAppName";
1088
+ readonly EditAppAssets: "EditAppAssets";
1089
+ readonly EditAppFeatures: "EditAppFeatures";
1090
+ readonly ViewTeammates: "ViewTeammates";
1091
+ readonly EditTeammates: "EditTeammates";
1092
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1093
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1094
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1095
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1096
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1097
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1098
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1099
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1100
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1101
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1102
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1103
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1104
+ readonly EditApmConfigurations: "EditApmConfigurations";
1105
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1106
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1107
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1108
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1109
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1110
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1111
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1112
+ readonly ViewOrders: "ViewOrders";
1113
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1114
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1115
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1116
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1117
+ readonly ViewStores: "ViewStores";
1118
+ readonly CreateStores: "CreateStores";
1119
+ readonly EditStores: "EditStores";
1120
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1121
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1122
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1123
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1124
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1125
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1126
+ readonly UpdateStoresName: "UpdateStoresName";
1127
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1128
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1129
+ readonly EditStoreNotifications: "EditStoreNotifications";
1130
+ readonly ArchiveStores: "ArchiveStores";
1131
+ readonly PublishStores: "PublishStores";
1132
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1133
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1134
+ readonly ViewStoreGroups: "ViewStoreGroups";
1135
+ readonly CreateStoreGroups: "CreateStoreGroups";
1136
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1137
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1138
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1139
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1140
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1141
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1142
+ readonly ViewMenu: "ViewMenu";
1143
+ readonly CreateMenu: "CreateMenu";
1144
+ readonly UpdateMenu: "UpdateMenu";
1145
+ readonly DeleteMenu: "DeleteMenu";
1146
+ readonly UpdateMenuLock: "UpdateMenuLock";
1147
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1148
+ readonly EditMenuImage: "EditMenuImage";
1149
+ readonly ViewVouchers: "ViewVouchers";
1150
+ readonly EditVouchers: "EditVouchers";
1151
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1152
+ readonly EditWebsiteContent: "EditWebsiteContent";
1153
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1154
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1155
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1156
+ readonly ViewBankAccounts: "ViewBankAccounts";
1157
+ readonly CreateBankAccounts: "CreateBankAccounts";
1158
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1159
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1160
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1161
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1162
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1163
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1164
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1165
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1166
+ readonly ViewHydraConfig: "ViewHydraConfig";
1167
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1168
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1169
+ readonly DeleteTerminal: "DeleteTerminal";
1170
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1171
+ readonly ViewCustomers: "ViewCustomers";
1172
+ readonly EditCustomers: "EditCustomers";
1173
+ readonly CreateCustomers: "CreateCustomers";
1174
+ readonly CreateCatalogElements: "CreateCatalogElements";
1175
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1176
+ readonly ViewCatalogElements: "ViewCatalogElements";
1177
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1178
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1179
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1180
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1181
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1182
+ readonly UpdateMetafields: "UpdateMetafields";
1183
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1184
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1185
+ readonly ViewAppStatistics: "ViewAppStatistics";
1186
+ readonly ViewApmStatistics: "ViewApmStatistics";
1187
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1188
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1189
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1190
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1191
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1192
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1193
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1194
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1195
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1196
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1197
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1198
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1199
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1200
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1201
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1202
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1203
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1204
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1205
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1206
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1207
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1208
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1209
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1210
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1211
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1212
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1213
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1214
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1215
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1216
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1217
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1218
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1219
+ readonly InviteDriverToApp: "InviteDriverToApp";
1220
+ readonly GetDriverForApp: "GetDriverForApp";
1221
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1222
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1223
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1224
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1225
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1226
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1227
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1228
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1229
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1230
+ readonly ViewPayouts: "ViewPayouts";
1231
+ readonly ViewChannels: "ViewChannels";
1232
+ readonly ViewOnboarding: "ViewOnboarding";
1233
+ readonly UpdateOnboarding: "UpdateOnboarding";
1234
+ readonly ViewClientDevices: "ViewClientDevices";
1235
+ readonly UpdateClientDevices: "UpdateClientDevices";
1236
+ readonly EnrollClientDevices: "EnrollClientDevices";
1237
+ readonly AssignClientDevices: "AssignClientDevices";
1238
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1239
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1240
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1241
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1242
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1243
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1244
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1245
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1246
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1247
+ readonly ViewSalesChannels: "ViewSalesChannels";
1248
+ readonly EditSalesChannels: "EditSalesChannels";
1249
+ readonly CreateSalesChannel: "CreateSalesChannel";
1250
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1251
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1252
+ readonly PublishSalesChannel: "PublishSalesChannel";
1253
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1254
+ readonly CloneSalesChannel: "CloneSalesChannel";
1255
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1256
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1257
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1258
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1259
+ readonly ViewSubscriptions: "ViewSubscriptions";
1260
+ readonly ViewInvoices: "ViewInvoices";
1261
+ readonly EditAccountsBills: "EditAccountsBills";
1262
+ readonly ViewAccountsBills: "ViewAccountsBills";
1263
+ readonly EditAccountsCategories: "EditAccountsCategories";
1264
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1265
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1266
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1267
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1268
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1269
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1270
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1271
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1272
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1273
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1274
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1275
+ readonly ViewInventoryReports: "ViewInventoryReports";
1276
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1277
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1278
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1279
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1280
+ readonly EditInventorySupplier: "EditInventorySupplier";
1281
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1282
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1283
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1284
+ readonly ViewPayrollReports: "ViewPayrollReports";
1285
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1286
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1287
+ readonly EditPayrollRota: "EditPayrollRota";
1288
+ readonly ViewPayrollRota: "ViewPayrollRota";
1289
+ readonly EditPayrollStaff: "EditPayrollStaff";
1290
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1291
+ readonly ViewSalesReports: "ViewSalesReports";
1292
+ readonly ViewCostReports: "ViewCostReports";
1293
+ readonly ViewMenuReports: "ViewMenuReports";
1294
+ readonly ViewBrand: "ViewBrand";
1295
+ readonly EditBrand: "EditBrand";
1296
+ readonly CreateBrand: "CreateBrand";
1297
+ readonly TransferBrand: "TransferBrand";
1298
+ readonly ViewProperty: "ViewProperty";
1299
+ readonly EditProperty: "EditProperty";
1300
+ readonly CreateProperty: "CreateProperty";
1301
+ readonly ArchiveProperty: "ArchiveProperty";
1302
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1303
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1304
+ readonly CreateOrg: "CreateOrg";
1305
+ readonly EditOrg: "EditOrg";
1306
+ readonly ViewOrg: "ViewOrg";
1307
+ readonly ViewWebhooks: "ViewWebhooks";
1308
+ readonly EditWebhooks: "EditWebhooks";
1309
+ readonly RoleAdmin: "RoleAdmin";
1310
+ readonly RoleFactory: "RoleFactory";
1311
+ };
1312
+ export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
1313
+ /**
1314
+ * Response containing the authorized brands
1315
+ * @export
1316
+ * @interface GetAuthorizedBrandsResponse
1317
+ */
1318
+ export interface GetAuthorizedBrandsResponse {
1319
+ /**
1320
+ * Array of allowed resources
1321
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1322
+ * @memberof GetAuthorizedBrandsResponse
1323
+ */
1324
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1325
+ /**
1326
+ * Array of denied resources
1327
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1328
+ * @memberof GetAuthorizedBrandsResponse
1329
+ */
1330
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1331
+ }
1332
+ /**
1333
+ * Request to get authorized orgs for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
1334
+ * @export
1335
+ * @interface GetAuthorizedOrgsRequest
1336
+ */
1337
+ export interface GetAuthorizedOrgsRequest {
1338
+ /**
1339
+ *
1340
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1341
+ * @memberof GetAuthorizedOrgsRequest
1342
+ */
1343
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1344
+ /**
1345
+ * Incoming request headers to be used for authentication
1346
+ * @type {{ [key: string]: string; }}
1347
+ * @memberof GetAuthorizedOrgsRequest
1348
+ */
1349
+ 'headers'?: {
1350
+ [key: string]: string;
1351
+ };
1352
+ /**
1353
+ * The action to check authorisation for
1354
+ * @type {string}
1355
+ * @memberof GetAuthorizedOrgsRequest
1356
+ */
1357
+ 'action': GetAuthorizedOrgsRequestActionEnum;
1358
+ }
1359
+ export declare const GetAuthorizedOrgsRequestActionEnum: {
1360
+ readonly AnyAuditLogs: "AnyAuditLogs";
1361
+ readonly ViewApp: "ViewApp";
1362
+ readonly CreateApp: "CreateApp";
1363
+ readonly UpdateApp: "UpdateApp";
1364
+ readonly ViewAppName: "ViewAppName";
1365
+ readonly EditAppAssets: "EditAppAssets";
1366
+ readonly EditAppFeatures: "EditAppFeatures";
1367
+ readonly ViewTeammates: "ViewTeammates";
1368
+ readonly EditTeammates: "EditTeammates";
1369
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1370
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1371
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1372
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1373
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1374
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1375
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1376
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1377
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1378
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1379
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1380
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1381
+ readonly EditApmConfigurations: "EditApmConfigurations";
1382
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1383
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1384
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1385
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1386
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1387
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1388
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1389
+ readonly ViewOrders: "ViewOrders";
1390
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1391
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1392
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1393
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1394
+ readonly ViewStores: "ViewStores";
1395
+ readonly CreateStores: "CreateStores";
1396
+ readonly EditStores: "EditStores";
1397
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1398
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1399
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1400
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1401
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1402
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1403
+ readonly UpdateStoresName: "UpdateStoresName";
1404
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1405
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1406
+ readonly EditStoreNotifications: "EditStoreNotifications";
1407
+ readonly ArchiveStores: "ArchiveStores";
1408
+ readonly PublishStores: "PublishStores";
1409
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1410
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1411
+ readonly ViewStoreGroups: "ViewStoreGroups";
1412
+ readonly CreateStoreGroups: "CreateStoreGroups";
1413
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1414
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1415
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1416
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1417
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1418
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1419
+ readonly ViewMenu: "ViewMenu";
1420
+ readonly CreateMenu: "CreateMenu";
1421
+ readonly UpdateMenu: "UpdateMenu";
1422
+ readonly DeleteMenu: "DeleteMenu";
1423
+ readonly UpdateMenuLock: "UpdateMenuLock";
1424
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1425
+ readonly EditMenuImage: "EditMenuImage";
1426
+ readonly ViewVouchers: "ViewVouchers";
1427
+ readonly EditVouchers: "EditVouchers";
1428
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1429
+ readonly EditWebsiteContent: "EditWebsiteContent";
1430
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1431
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1432
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1433
+ readonly ViewBankAccounts: "ViewBankAccounts";
1434
+ readonly CreateBankAccounts: "CreateBankAccounts";
1435
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1436
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1437
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1438
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1439
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1440
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1441
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1442
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1443
+ readonly ViewHydraConfig: "ViewHydraConfig";
1444
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1445
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1446
+ readonly DeleteTerminal: "DeleteTerminal";
1447
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1448
+ readonly ViewCustomers: "ViewCustomers";
1449
+ readonly EditCustomers: "EditCustomers";
1450
+ readonly CreateCustomers: "CreateCustomers";
1451
+ readonly CreateCatalogElements: "CreateCatalogElements";
1452
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1453
+ readonly ViewCatalogElements: "ViewCatalogElements";
1454
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1455
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1456
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1457
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1458
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1459
+ readonly UpdateMetafields: "UpdateMetafields";
1460
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1461
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1462
+ readonly ViewAppStatistics: "ViewAppStatistics";
1463
+ readonly ViewApmStatistics: "ViewApmStatistics";
1464
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1465
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1466
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1467
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1468
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1469
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1470
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1471
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1472
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1473
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1474
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1475
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1476
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1477
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1478
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1479
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1480
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1481
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1482
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1483
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1484
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1485
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1486
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1487
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1488
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1489
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1490
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1491
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1492
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1493
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1494
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1495
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1496
+ readonly InviteDriverToApp: "InviteDriverToApp";
1497
+ readonly GetDriverForApp: "GetDriverForApp";
1498
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1499
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1500
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1501
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1502
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1503
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1504
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1505
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1506
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1507
+ readonly ViewPayouts: "ViewPayouts";
1508
+ readonly ViewChannels: "ViewChannels";
1509
+ readonly ViewOnboarding: "ViewOnboarding";
1510
+ readonly UpdateOnboarding: "UpdateOnboarding";
1511
+ readonly ViewClientDevices: "ViewClientDevices";
1512
+ readonly UpdateClientDevices: "UpdateClientDevices";
1513
+ readonly EnrollClientDevices: "EnrollClientDevices";
1514
+ readonly AssignClientDevices: "AssignClientDevices";
1515
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1516
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1517
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1518
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1519
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1520
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1521
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1522
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1523
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1524
+ readonly ViewSalesChannels: "ViewSalesChannels";
1525
+ readonly EditSalesChannels: "EditSalesChannels";
1526
+ readonly CreateSalesChannel: "CreateSalesChannel";
1527
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1528
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1529
+ readonly PublishSalesChannel: "PublishSalesChannel";
1530
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1531
+ readonly CloneSalesChannel: "CloneSalesChannel";
1532
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1533
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1534
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1535
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1536
+ readonly ViewSubscriptions: "ViewSubscriptions";
1537
+ readonly ViewInvoices: "ViewInvoices";
1538
+ readonly EditAccountsBills: "EditAccountsBills";
1539
+ readonly ViewAccountsBills: "ViewAccountsBills";
1540
+ readonly EditAccountsCategories: "EditAccountsCategories";
1541
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1542
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1543
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1544
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1545
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1546
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1547
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1548
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1549
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1550
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1551
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1552
+ readonly ViewInventoryReports: "ViewInventoryReports";
1553
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1554
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1555
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1556
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1557
+ readonly EditInventorySupplier: "EditInventorySupplier";
1558
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1559
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1560
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1561
+ readonly ViewPayrollReports: "ViewPayrollReports";
1562
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1563
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1564
+ readonly EditPayrollRota: "EditPayrollRota";
1565
+ readonly ViewPayrollRota: "ViewPayrollRota";
1566
+ readonly EditPayrollStaff: "EditPayrollStaff";
1567
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1568
+ readonly ViewSalesReports: "ViewSalesReports";
1569
+ readonly ViewCostReports: "ViewCostReports";
1570
+ readonly ViewMenuReports: "ViewMenuReports";
1571
+ readonly ViewBrand: "ViewBrand";
1572
+ readonly EditBrand: "EditBrand";
1573
+ readonly CreateBrand: "CreateBrand";
1574
+ readonly TransferBrand: "TransferBrand";
1575
+ readonly ViewProperty: "ViewProperty";
1576
+ readonly EditProperty: "EditProperty";
1577
+ readonly CreateProperty: "CreateProperty";
1578
+ readonly ArchiveProperty: "ArchiveProperty";
1579
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1580
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1581
+ readonly CreateOrg: "CreateOrg";
1582
+ readonly EditOrg: "EditOrg";
1583
+ readonly ViewOrg: "ViewOrg";
1584
+ readonly ViewWebhooks: "ViewWebhooks";
1585
+ readonly EditWebhooks: "EditWebhooks";
1586
+ readonly RoleAdmin: "RoleAdmin";
1587
+ readonly RoleFactory: "RoleFactory";
1588
+ };
1589
+ export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
1590
+ /**
1591
+ * The principal to get authorized entities for
1592
+ * @export
1593
+ * @interface GetAuthorizedOrgsRequestPrincipal
1594
+ */
1595
+ export interface GetAuthorizedOrgsRequestPrincipal {
1596
+ /**
1597
+ *
1598
+ * @type {string}
1599
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1600
+ */
1601
+ 'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
1602
+ /**
1603
+ *
1604
+ * @type {string}
1605
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1606
+ */
1607
+ 'id': string;
1608
+ /**
1609
+ *
1610
+ * @type {string}
1611
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1612
+ */
1613
+ 'name'?: string;
1614
+ /**
1615
+ *
1616
+ * @type {string}
1617
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1618
+ */
1619
+ 'email'?: string;
1620
+ /**
1621
+ *
1622
+ * @type {string}
1623
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1624
+ */
1625
+ 'phone'?: string;
1626
+ }
1627
+ export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: {
1628
+ readonly User: "User";
1629
+ readonly Automation: "Automation";
1630
+ };
1631
+ export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
1632
+ /**
1633
+ * Response containing the authorized orgs
1634
+ * @export
1635
+ * @interface GetAuthorizedOrgsResponse
1636
+ */
1637
+ export interface GetAuthorizedOrgsResponse {
1638
+ /**
1639
+ * Array of allowed resources
1640
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1641
+ * @memberof GetAuthorizedOrgsResponse
1642
+ */
1643
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1644
+ /**
1645
+ * Array of denied resources
1646
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1647
+ * @memberof GetAuthorizedOrgsResponse
1648
+ */
1649
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1650
+ }
1651
+ /**
1652
+ * Request to get authorized properties for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
1653
+ * @export
1654
+ * @interface GetAuthorizedPropertiesRequest
1655
+ */
1656
+ export interface GetAuthorizedPropertiesRequest {
1657
+ /**
1658
+ *
1659
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1660
+ * @memberof GetAuthorizedPropertiesRequest
1661
+ */
1662
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1663
+ /**
1664
+ * Incoming request headers to be used for authentication
1665
+ * @type {{ [key: string]: string; }}
1666
+ * @memberof GetAuthorizedPropertiesRequest
1667
+ */
1668
+ 'headers'?: {
1669
+ [key: string]: string;
1670
+ };
1671
+ /**
1672
+ * The action to check authorisation for
1673
+ * @type {string}
1674
+ * @memberof GetAuthorizedPropertiesRequest
1675
+ */
1676
+ 'action': GetAuthorizedPropertiesRequestActionEnum;
1677
+ }
1678
+ export declare const GetAuthorizedPropertiesRequestActionEnum: {
1679
+ readonly AnyAuditLogs: "AnyAuditLogs";
1680
+ readonly ViewApp: "ViewApp";
1681
+ readonly CreateApp: "CreateApp";
1682
+ readonly UpdateApp: "UpdateApp";
1683
+ readonly ViewAppName: "ViewAppName";
1684
+ readonly EditAppAssets: "EditAppAssets";
1685
+ readonly EditAppFeatures: "EditAppFeatures";
1686
+ readonly ViewTeammates: "ViewTeammates";
1687
+ readonly EditTeammates: "EditTeammates";
1688
+ readonly CreateTeammateOwner: "CreateTeammateOwner";
1689
+ readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
1690
+ readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
1691
+ readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
1692
+ readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
1693
+ readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
1694
+ readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
1695
+ readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
1696
+ readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
1697
+ readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
1698
+ readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
1699
+ readonly ViewApmConfigurations: "ViewApmConfigurations";
1700
+ readonly EditApmConfigurations: "EditApmConfigurations";
1701
+ readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
1702
+ readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
1703
+ readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
1704
+ readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
1705
+ readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
1706
+ readonly ViewDevelopersSettings: "ViewDevelopersSettings";
1707
+ readonly EditDevelopersSettings: "EditDevelopersSettings";
1708
+ readonly ViewOrders: "ViewOrders";
1709
+ readonly UpdateOrdersAccept: "UpdateOrdersAccept";
1710
+ readonly UpdateOrdersReject: "UpdateOrdersReject";
1711
+ readonly UpdateOrdersRefund: "UpdateOrdersRefund";
1712
+ readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
1713
+ readonly ViewStores: "ViewStores";
1714
+ readonly CreateStores: "CreateStores";
1715
+ readonly EditStores: "EditStores";
1716
+ readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
1717
+ readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
1718
+ readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
1719
+ readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
1720
+ readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
1721
+ readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
1722
+ readonly UpdateStoresName: "UpdateStoresName";
1723
+ readonly EditStoreKioskSettings: "EditStoreKioskSettings";
1724
+ readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
1725
+ readonly EditStoreNotifications: "EditStoreNotifications";
1726
+ readonly ArchiveStores: "ArchiveStores";
1727
+ readonly PublishStores: "PublishStores";
1728
+ readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
1729
+ readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
1730
+ readonly ViewStoreGroups: "ViewStoreGroups";
1731
+ readonly CreateStoreGroups: "CreateStoreGroups";
1732
+ readonly UpdateStoreGroups: "UpdateStoreGroups";
1733
+ readonly DeleteStoreGroups: "DeleteStoreGroups";
1734
+ readonly ViewDeliveryZones: "ViewDeliveryZones";
1735
+ readonly CreateDeliveryZones: "CreateDeliveryZones";
1736
+ readonly UpdateDeliveryZones: "UpdateDeliveryZones";
1737
+ readonly DeleteDeliveryZones: "DeleteDeliveryZones";
1738
+ readonly ViewMenu: "ViewMenu";
1739
+ readonly CreateMenu: "CreateMenu";
1740
+ readonly UpdateMenu: "UpdateMenu";
1741
+ readonly DeleteMenu: "DeleteMenu";
1742
+ readonly UpdateMenuLock: "UpdateMenuLock";
1743
+ readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
1744
+ readonly EditMenuImage: "EditMenuImage";
1745
+ readonly ViewVouchers: "ViewVouchers";
1746
+ readonly EditVouchers: "EditVouchers";
1747
+ readonly ViewWebsiteContent: "ViewWebsiteContent";
1748
+ readonly EditWebsiteContent: "EditWebsiteContent";
1749
+ readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
1750
+ readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
1751
+ readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
1752
+ readonly ViewBankAccounts: "ViewBankAccounts";
1753
+ readonly CreateBankAccounts: "CreateBankAccounts";
1754
+ readonly UpdateBankAccounts: "UpdateBankAccounts";
1755
+ readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
1756
+ readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
1757
+ readonly VerifyBankAccounts: "VerifyBankAccounts";
1758
+ readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
1759
+ readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
1760
+ readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
1761
+ readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
1762
+ readonly ViewHydraConfig: "ViewHydraConfig";
1763
+ readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
1764
+ readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
1765
+ readonly DeleteTerminal: "DeleteTerminal";
1766
+ readonly ViewKioskTelemetry: "ViewKioskTelemetry";
1767
+ readonly ViewCustomers: "ViewCustomers";
1768
+ readonly EditCustomers: "EditCustomers";
1769
+ readonly CreateCustomers: "CreateCustomers";
1770
+ readonly CreateCatalogElements: "CreateCatalogElements";
1771
+ readonly UpdateCatalogElements: "UpdateCatalogElements";
1772
+ readonly ViewCatalogElements: "ViewCatalogElements";
1773
+ readonly DeleteCatalogElements: "DeleteCatalogElements";
1774
+ readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
1775
+ readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
1776
+ readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
1777
+ readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
1778
+ readonly UpdateMetafields: "UpdateMetafields";
1779
+ readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
1780
+ readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
1781
+ readonly ViewAppStatistics: "ViewAppStatistics";
1782
+ readonly ViewApmStatistics: "ViewApmStatistics";
1783
+ readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
1784
+ readonly ViewCustomerStatistics: "ViewCustomerStatistics";
1785
+ readonly ViewLiveStatistics: "ViewLiveStatistics";
1786
+ readonly ViewOrderStatistics: "ViewOrderStatistics";
1787
+ readonly ViewSalesStatistics: "ViewSalesStatistics";
1788
+ readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
1789
+ readonly ViewVouchersStatistics: "ViewVouchersStatistics";
1790
+ readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
1791
+ readonly ViewApmAuditLogs: "ViewApmAuditLogs";
1792
+ readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
1793
+ readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
1794
+ readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
1795
+ readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
1796
+ readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
1797
+ readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
1798
+ readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
1799
+ readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
1800
+ readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
1801
+ readonly ViewAppAuditLogs: "ViewAppAuditLogs";
1802
+ readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
1803
+ readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
1804
+ readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
1805
+ readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
1806
+ readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
1807
+ readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
1808
+ readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
1809
+ readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
1810
+ readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
1811
+ readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
1812
+ readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
1813
+ readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
1814
+ readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
1815
+ readonly InviteDriverToApp: "InviteDriverToApp";
1816
+ readonly GetDriverForApp: "GetDriverForApp";
1817
+ readonly RemoveDriverFromApp: "RemoveDriverFromApp";
1818
+ readonly AssignDriverToOrder: "AssignDriverToOrder";
1819
+ readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
1820
+ readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
1821
+ readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
1822
+ readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
1823
+ readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
1824
+ readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
1825
+ readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
1826
+ readonly ViewPayouts: "ViewPayouts";
1827
+ readonly ViewChannels: "ViewChannels";
1828
+ readonly ViewOnboarding: "ViewOnboarding";
1829
+ readonly UpdateOnboarding: "UpdateOnboarding";
1830
+ readonly ViewClientDevices: "ViewClientDevices";
1831
+ readonly UpdateClientDevices: "UpdateClientDevices";
1832
+ readonly EnrollClientDevices: "EnrollClientDevices";
1833
+ readonly AssignClientDevices: "AssignClientDevices";
1834
+ readonly ViewClientAuditLogs: "ViewClientAuditLogs";
1835
+ readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
1836
+ readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
1837
+ readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
1838
+ readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
1839
+ readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
1840
+ readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
1841
+ readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
1842
+ readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
1843
+ readonly ViewSalesChannels: "ViewSalesChannels";
1844
+ readonly EditSalesChannels: "EditSalesChannels";
1845
+ readonly CreateSalesChannel: "CreateSalesChannel";
1846
+ readonly ArchiveSalesChannel: "ArchiveSalesChannel";
1847
+ readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
1848
+ readonly PublishSalesChannel: "PublishSalesChannel";
1849
+ readonly UnpublishSalesChannel: "UnpublishSalesChannel";
1850
+ readonly CloneSalesChannel: "CloneSalesChannel";
1851
+ readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
1852
+ readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
1853
+ readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
1854
+ readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
1855
+ readonly ViewSubscriptions: "ViewSubscriptions";
1856
+ readonly ViewInvoices: "ViewInvoices";
1857
+ readonly EditAccountsBills: "EditAccountsBills";
1858
+ readonly ViewAccountsBills: "ViewAccountsBills";
1859
+ readonly EditAccountsCategories: "EditAccountsCategories";
1860
+ readonly ViewAccountsCategories: "ViewAccountsCategories";
1861
+ readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
1862
+ readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
1863
+ readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
1864
+ readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
1865
+ readonly EditAccountsExpenses: "EditAccountsExpenses";
1866
+ readonly ViewAccountsExpenses: "ViewAccountsExpenses";
1867
+ readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
1868
+ readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
1869
+ readonly EditDocumentExplorer: "EditDocumentExplorer";
1870
+ readonly ViewDocumentExplorer: "ViewDocumentExplorer";
1871
+ readonly ViewInventoryReports: "ViewInventoryReports";
1872
+ readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
1873
+ readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
1874
+ readonly EditInventoryStockItems: "EditInventoryStockItems";
1875
+ readonly ViewInventoryStockItems: "ViewInventoryStockItems";
1876
+ readonly EditInventorySupplier: "EditInventorySupplier";
1877
+ readonly ViewInventorySupplier: "ViewInventorySupplier";
1878
+ readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
1879
+ readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
1880
+ readonly ViewPayrollReports: "ViewPayrollReports";
1881
+ readonly EditPayrollHoliday: "EditPayrollHoliday";
1882
+ readonly ViewPayrollHoliday: "ViewPayrollHoliday";
1883
+ readonly EditPayrollRota: "EditPayrollRota";
1884
+ readonly ViewPayrollRota: "ViewPayrollRota";
1885
+ readonly EditPayrollStaff: "EditPayrollStaff";
1886
+ readonly ViewPayrollStaff: "ViewPayrollStaff";
1887
+ readonly ViewSalesReports: "ViewSalesReports";
1888
+ readonly ViewCostReports: "ViewCostReports";
1889
+ readonly ViewMenuReports: "ViewMenuReports";
1890
+ readonly ViewBrand: "ViewBrand";
1891
+ readonly EditBrand: "EditBrand";
1892
+ readonly CreateBrand: "CreateBrand";
1893
+ readonly TransferBrand: "TransferBrand";
1894
+ readonly ViewProperty: "ViewProperty";
1895
+ readonly EditProperty: "EditProperty";
1896
+ readonly CreateProperty: "CreateProperty";
1897
+ readonly ArchiveProperty: "ArchiveProperty";
1898
+ readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
1899
+ readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
1900
+ readonly CreateOrg: "CreateOrg";
1901
+ readonly EditOrg: "EditOrg";
1902
+ readonly ViewOrg: "ViewOrg";
1903
+ readonly ViewWebhooks: "ViewWebhooks";
1904
+ readonly EditWebhooks: "EditWebhooks";
1905
+ readonly RoleAdmin: "RoleAdmin";
1906
+ readonly RoleFactory: "RoleFactory";
369
1907
  };
370
- export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
371
- /**
372
- * Response containing the authorization decision
373
- * @export
374
- * @interface AuthorizationResponse
375
- */
376
- export interface AuthorizationResponse {
377
- /**
378
- * Whether the action is allowed
379
- * @type {boolean}
380
- * @memberof AuthorizationResponse
381
- */
382
- 'allowed': boolean;
383
- /**
384
- * The authorization decision
385
- * @type {string}
386
- * @memberof AuthorizationResponse
387
- */
388
- 'decision': string;
389
- /**
390
- * The policy IDs that were used to make the decision
391
- * @type {Array<string>}
392
- * @memberof AuthorizationResponse
393
- */
394
- 'policyIds': Array<string>;
395
- }
1908
+ export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
396
1909
  /**
397
- *
1910
+ * Response containing the authorized properties
398
1911
  * @export
399
- * @interface ErrorResponse
1912
+ * @interface GetAuthorizedPropertiesResponse
400
1913
  */
401
- export interface ErrorResponse {
1914
+ export interface GetAuthorizedPropertiesResponse {
402
1915
  /**
403
- *
404
- * @type {string}
405
- * @memberof ErrorResponse
1916
+ * Array of allowed resources
1917
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1918
+ * @memberof GetAuthorizedPropertiesResponse
406
1919
  */
407
- 'message': string;
408
- }
409
- /**
410
- * Successful permissions retrieval response
411
- * @export
412
- * @interface GetPermissionsSuccessResponse
413
- */
414
- export interface GetPermissionsSuccessResponse {
1920
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
415
1921
  /**
416
- *
417
- * @type {Permissions & Array<string>}
418
- * @memberof GetPermissionsSuccessResponse
1922
+ * Array of denied resources
1923
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1924
+ * @memberof GetAuthorizedPropertiesResponse
419
1925
  */
420
- 'permissions': Permissions & Array<string>;
1926
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
421
1927
  }
422
1928
  /**
423
1929
  * Details for getting roles for a principal
@@ -464,11 +1970,17 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
464
1970
  */
465
1971
  'policyId': string;
466
1972
  /**
467
- * Role name
1973
+ *
1974
+ * @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
1975
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1976
+ */
1977
+ 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
1978
+ /**
1979
+ * Policy type
468
1980
  * @type {string}
469
1981
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
470
1982
  */
471
- 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum;
1983
+ 'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
472
1984
  /**
473
1985
  * Date and time the role was assigned
474
1986
  * @type {string}
@@ -486,7 +1998,7 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
486
1998
  * @type {string}
487
1999
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
488
2000
  */
489
- 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
2001
+ 'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
490
2002
  /**
491
2003
  * Organization ID
492
2004
  * @type {string}
@@ -511,82 +2023,27 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
511
2023
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
512
2024
  */
513
2025
  'salesChannelId'?: string;
2026
+ /**
2027
+ * Principal ID this role is assigned to
2028
+ * @type {string}
2029
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2030
+ */
2031
+ 'principalId': string;
2032
+ /**
2033
+ * Type of principal this role is assigned to
2034
+ * @type {string}
2035
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
2036
+ */
2037
+ 'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
514
2038
  }
515
- export declare const GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum: {
516
- readonly OrgViewer: "OrgViewer";
517
- readonly OrgManager: "OrgManager";
518
- readonly OrgAdmin: "OrgAdmin";
519
- readonly BrandViewer: "BrandViewer";
520
- readonly BrandManager: "BrandManager";
521
- readonly BrandAdmin: "BrandAdmin";
522
- readonly StoreViewer: "StoreViewer";
523
- readonly StoreEditor: "StoreEditor";
524
- readonly StoreManager: "StoreManager";
525
- readonly CustomerViewer: "CustomerViewer";
526
- readonly CustomerManager: "CustomerManager";
527
- readonly VoucherViewer: "VoucherViewer";
528
- readonly VoucherEditor: "VoucherEditor";
529
- readonly VoucherManager: "VoucherManager";
530
- readonly VoucherCampaignManager: "VoucherCampaignManager";
531
- readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
532
- readonly AnalyticsViewer: "AnalyticsViewer";
533
- readonly ReportsViewer: "ReportsViewer";
534
- readonly FinanceViewer: "FinanceViewer";
535
- readonly FinanceManager: "FinanceManager";
536
- readonly TeamViewer: "TeamViewer";
537
- readonly TeamManager: "TeamManager";
538
- readonly TeamAdmin: "TeamAdmin";
539
- readonly TechViewer: "TechViewer";
540
- readonly TechManager: "TechManager";
541
- readonly AppStoreViewer: "AppStoreViewer";
542
- readonly AppStoreManager: "AppStoreManager";
543
- readonly SalesChannelViewer: "SalesChannelViewer";
544
- readonly SalesChannelEditor: "SalesChannelEditor";
545
- readonly SalesChannelManager: "SalesChannelManager";
546
- readonly DeliveryViewer: "DeliveryViewer";
547
- readonly DeliveryManager: "DeliveryManager";
548
- readonly DriverManager: "DriverManager";
549
- readonly AuditViewer: "AuditViewer";
550
- readonly AuditManager: "AuditManager";
551
- readonly AccountsViewer: "AccountsViewer";
552
- readonly AccountsEditor: "AccountsEditor";
553
- readonly DocumentExplorerViewer: "DocumentExplorerViewer";
554
- readonly DocumentExplorerEditor: "DocumentExplorerEditor";
555
- readonly PayrollViewer: "PayrollViewer";
556
- readonly PayrollEditor: "PayrollEditor";
557
- readonly PropertyViewer: "PropertyViewer";
558
- readonly PropertyManager: "PropertyManager";
559
- readonly PropertyAdmin: "PropertyAdmin";
560
- readonly WebsiteContentEditor: "WebsiteContentEditor";
561
- readonly WebsiteContentViewer: "WebsiteContentViewer";
562
- readonly WebsiteTechViewer: "WebsiteTechViewer";
563
- readonly MenuViewer: "MenuViewer";
564
- readonly MenuEditor: "MenuEditor";
565
- readonly MenuManager: "MenuManager";
566
- readonly MenuMetaFieldManager: "MenuMetaFieldManager";
567
- readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
568
- readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
569
- readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
570
- readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
571
- readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
572
- readonly OrderFulfillmentManager: "OrderFulfillmentManager";
573
- readonly OrderManager: "OrderManager";
574
- readonly OrderEditor: "OrderEditor";
575
- readonly OrderViewer: "OrderViewer";
576
- readonly InventoryManager: "InventoryManager";
577
- readonly InventoryEditor: "InventoryEditor";
578
- readonly InventoryViewer: "InventoryViewer";
579
- readonly PaymentManager: "PaymentManager";
580
- readonly OnboardingManager: "OnboardingManager";
581
- readonly FeatureFlagManager: "FeatureFlagManager";
582
- readonly PropertyOwnerMisc: "PropertyOwnerMisc";
583
- readonly ManagedOwnerMisc: "ManagedOwnerMisc";
584
- readonly IntegratorMisc: "IntegratorMisc";
585
- readonly PropertyManagerMisc: "PropertyManagerMisc";
586
- readonly FinanceManagerMisc: "FinanceManagerMisc";
587
- readonly SupportMisc: "SupportMisc";
2039
+ export declare const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum: {
2040
+ readonly Main: "Main";
2041
+ readonly BrandOverride: "BrandOverride";
2042
+ readonly OrgOverride: "OrgOverride";
2043
+ readonly Forbidden: "Forbidden";
2044
+ readonly NamedRole: "NamedRole";
588
2045
  };
589
- export type GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerRoleNameEnum];
2046
+ export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
590
2047
  export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum: {
591
2048
  readonly Property: "Property";
592
2049
  readonly Org: "Org";
@@ -594,18 +2051,17 @@ export declare const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum:
594
2051
  readonly SalesChannel: "SalesChannel";
595
2052
  };
596
2053
  export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
2054
+ export declare const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum: {
2055
+ readonly User: "User";
2056
+ readonly Automation: "Automation";
2057
+ };
2058
+ export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
597
2059
  /**
598
- * Successful roles retrieval response
2060
+ * Role name
599
2061
  * @export
600
- * @interface GetRolesSuccessResponse
2062
+ * @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
601
2063
  */
602
- export interface GetRolesSuccessResponse {
603
- /**
604
- * List of roles available and their permissions
605
- * @type {Array<RolesInner>}
606
- * @memberof GetRolesSuccessResponse
607
- */
608
- 'roles': Array<RolesInner>;
2064
+ export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
609
2065
  }
610
2066
  /**
611
2067
  * Successful user permissions retrieval response
@@ -879,53 +2335,201 @@ export declare const GetUserPermissionsSuccessResponseResourcesValuePermissionsE
879
2335
  readonly CreateOrg: "CreateOrg";
880
2336
  readonly EditOrg: "EditOrg";
881
2337
  readonly ViewOrg: "ViewOrg";
2338
+ readonly ViewWebhooks: "ViewWebhooks";
2339
+ readonly EditWebhooks: "EditWebhooks";
2340
+ readonly RoleAdmin: "RoleAdmin";
2341
+ readonly RoleFactory: "RoleFactory";
2342
+ };
2343
+ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
2344
+ /**
2345
+ * ID of the resource the permissions are assigned to
2346
+ * @export
2347
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
2348
+ */
2349
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
2350
+ }
2351
+ /**
2352
+ *
2353
+ * @export
2354
+ * @interface IsInRoleRequest
2355
+ */
2356
+ export interface IsInRoleRequest {
2357
+ /**
2358
+ *
2359
+ * @type {AuthorizationRequestPrincipal}
2360
+ * @memberof IsInRoleRequest
2361
+ */
2362
+ 'principal': AuthorizationRequestPrincipal;
2363
+ /**
2364
+ * Array of roles to check if the principal is in
2365
+ * @type {Array<string>}
2366
+ * @memberof IsInRoleRequest
2367
+ */
2368
+ 'roles': Array<IsInRoleRequestRolesEnum>;
2369
+ /**
2370
+ * How to check authorisation - any or all of the actions must be allowed
2371
+ * @type {string}
2372
+ * @memberof IsInRoleRequest
2373
+ */
2374
+ 'checkMode'?: IsInRoleRequestCheckModeEnum;
2375
+ }
2376
+ export declare const IsInRoleRequestRolesEnum: {
2377
+ readonly Admin: "Admin";
2378
+ readonly Factory: "Factory";
2379
+ };
2380
+ export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
2381
+ export declare const IsInRoleRequestCheckModeEnum: {
2382
+ readonly Any: "any";
2383
+ readonly All: "all";
2384
+ };
2385
+ export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
2386
+ /**
2387
+ * Response containing whether the principal is in any/all of the roles
2388
+ * @export
2389
+ * @interface IsInRoleResponse
2390
+ */
2391
+ export interface IsInRoleResponse {
2392
+ /**
2393
+ * result of the check - whether the principal is in any/all of the roles
2394
+ * @type {boolean}
2395
+ * @memberof IsInRoleResponse
2396
+ */
2397
+ 'authorized': boolean;
2398
+ }
2399
+ /**
2400
+ * Successful feature based roles retrieval response
2401
+ * @export
2402
+ * @interface ListFeatureBasedRolesSuccessResponse
2403
+ */
2404
+ export interface ListFeatureBasedRolesSuccessResponse {
2405
+ /**
2406
+ *
2407
+ * @type {Array<FeatureBasedRole>}
2408
+ * @memberof ListFeatureBasedRolesSuccessResponse
2409
+ */
2410
+ 'roles': Array<FeatureBasedRole>;
2411
+ }
2412
+ /**
2413
+ *
2414
+ * @export
2415
+ * @interface ListOrgRolesSuccessResponseValueValue
2416
+ */
2417
+ export interface ListOrgRolesSuccessResponseValueValue {
2418
+ /**
2419
+ * Type of resource the permissions are assigned to
2420
+ * @type {string}
2421
+ * @memberof ListOrgRolesSuccessResponseValueValue
2422
+ */
2423
+ 'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
2424
+ /**
2425
+ *
2426
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
2427
+ * @memberof ListOrgRolesSuccessResponseValueValue
2428
+ */
2429
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
2430
+ /**
2431
+ * List of roles that are assigned to the user for the resource
2432
+ * @type {Array<string>}
2433
+ * @memberof ListOrgRolesSuccessResponseValueValue
2434
+ */
2435
+ 'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
2436
+ }
2437
+ export declare const ListOrgRolesSuccessResponseValueValueResourceTypeEnum: {
2438
+ readonly Property: "Property";
2439
+ readonly Org: "Org";
2440
+ readonly Brand: "Brand";
2441
+ readonly SalesChannel: "SalesChannel";
2442
+ };
2443
+ export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
2444
+ export declare const ListOrgRolesSuccessResponseValueValueRolesEnum: {
2445
+ readonly OrgViewer: "OrgViewer";
2446
+ readonly OrgManager: "OrgManager";
2447
+ readonly OrgAdmin: "OrgAdmin";
2448
+ readonly BrandViewer: "BrandViewer";
2449
+ readonly BrandManager: "BrandManager";
2450
+ readonly BrandAdmin: "BrandAdmin";
2451
+ readonly StoreViewer: "StoreViewer";
2452
+ readonly StoreEditor: "StoreEditor";
2453
+ readonly StoreManager: "StoreManager";
2454
+ readonly CustomerViewer: "CustomerViewer";
2455
+ readonly CustomerManager: "CustomerManager";
2456
+ readonly VoucherViewer: "VoucherViewer";
2457
+ readonly VoucherEditor: "VoucherEditor";
2458
+ readonly VoucherManager: "VoucherManager";
2459
+ readonly VoucherCampaignManager: "VoucherCampaignManager";
2460
+ readonly VoucherStatisticsViewer: "VoucherStatisticsViewer";
2461
+ readonly AnalyticsViewer: "AnalyticsViewer";
2462
+ readonly ReportsViewer: "ReportsViewer";
2463
+ readonly FinanceViewer: "FinanceViewer";
2464
+ readonly FinanceManager: "FinanceManager";
2465
+ readonly TeamViewer: "TeamViewer";
2466
+ readonly TeamManager: "TeamManager";
2467
+ readonly TeamAdmin: "TeamAdmin";
2468
+ readonly TechViewer: "TechViewer";
2469
+ readonly TechManager: "TechManager";
2470
+ readonly AppStoreViewer: "AppStoreViewer";
2471
+ readonly AppStoreManager: "AppStoreManager";
2472
+ readonly SalesChannelViewer: "SalesChannelViewer";
2473
+ readonly SalesChannelEditor: "SalesChannelEditor";
2474
+ readonly SalesChannelManager: "SalesChannelManager";
2475
+ readonly DeliveryViewer: "DeliveryViewer";
2476
+ readonly DeliveryManager: "DeliveryManager";
2477
+ readonly DriverManager: "DriverManager";
2478
+ readonly AuditViewer: "AuditViewer";
2479
+ readonly AuditManager: "AuditManager";
2480
+ readonly AccountsViewer: "AccountsViewer";
2481
+ readonly AccountsEditor: "AccountsEditor";
2482
+ readonly DocumentExplorerViewer: "DocumentExplorerViewer";
2483
+ readonly DocumentExplorerEditor: "DocumentExplorerEditor";
2484
+ readonly PayrollViewer: "PayrollViewer";
2485
+ readonly PayrollEditor: "PayrollEditor";
2486
+ readonly PropertyViewer: "PropertyViewer";
2487
+ readonly PropertyManager: "PropertyManager";
2488
+ readonly PropertyAdmin: "PropertyAdmin";
2489
+ readonly WebsiteContentEditor: "WebsiteContentEditor";
2490
+ readonly WebsiteContentViewer: "WebsiteContentViewer";
2491
+ readonly WebsiteTechViewer: "WebsiteTechViewer";
2492
+ readonly MenuViewer: "MenuViewer";
2493
+ readonly MenuEditor: "MenuEditor";
2494
+ readonly MenuManager: "MenuManager";
2495
+ readonly MenuMetaFieldManager: "MenuMetaFieldManager";
2496
+ readonly MenuMetaFieldEditor: "MenuMetaFieldEditor";
2497
+ readonly MenuMetaFieldViewer: "MenuMetaFieldViewer";
2498
+ readonly StoreDeliveryZoneManager: "StoreDeliveryZoneManager";
2499
+ readonly StoreDeliveryZoneEditor: "StoreDeliveryZoneEditor";
2500
+ readonly StoreDeliveryZoneViewer: "StoreDeliveryZoneViewer";
2501
+ readonly OrderFulfillmentManager: "OrderFulfillmentManager";
2502
+ readonly OrderManager: "OrderManager";
2503
+ readonly OrderEditor: "OrderEditor";
2504
+ readonly OrderViewer: "OrderViewer";
2505
+ readonly InventoryManager: "InventoryManager";
2506
+ readonly InventoryEditor: "InventoryEditor";
2507
+ readonly InventoryViewer: "InventoryViewer";
2508
+ readonly PaymentManager: "PaymentManager";
2509
+ readonly OnboardingManager: "OnboardingManager";
2510
+ readonly FeatureFlagManager: "FeatureFlagManager";
2511
+ readonly PropertyOwnerMisc: "PropertyOwnerMisc";
2512
+ readonly ManagedOwnerMisc: "ManagedOwnerMisc";
2513
+ readonly IntegratorMisc: "IntegratorMisc";
2514
+ readonly PropertyManagerMisc: "PropertyManagerMisc";
2515
+ readonly FinanceManagerMisc: "FinanceManagerMisc";
2516
+ readonly SupportMisc: "SupportMisc";
882
2517
  };
883
- export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
884
- /**
885
- * ID of the resource the permissions are assigned to
886
- * @export
887
- * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
888
- */
889
- export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
890
- }
891
- /**
892
- *
893
- * @export
894
- * @interface OrgPathParam
895
- */
896
- export interface OrgPathParam {
897
- /**
898
- *
899
- * @type {string}
900
- * @memberof OrgPathParam
901
- */
902
- 'orgId': string;
903
- }
2518
+ export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
904
2519
  /**
905
- *
2520
+ * Successful permissions retrieval response
906
2521
  * @export
907
- * @interface PathParams
2522
+ * @interface ListPermissionsSuccessResponse
908
2523
  */
909
- export interface PathParams {
910
- /**
911
- *
912
- * @type {string}
913
- * @memberof PathParams
914
- */
915
- 'orgId': string;
2524
+ export interface ListPermissionsSuccessResponse {
916
2525
  /**
917
- *
918
- * @type {string}
919
- * @memberof PathParams
2526
+ * List of permissions
2527
+ * @type {Array<string>}
2528
+ * @memberof ListPermissionsSuccessResponse
920
2529
  */
921
- 'userId': string;
2530
+ 'permissions': Array<ListPermissionsSuccessResponsePermissionsEnum>;
922
2531
  }
923
- /**
924
- *
925
- * @export
926
- * @enum {string}
927
- */
928
- export declare const Permissions: {
2532
+ export declare const ListPermissionsSuccessResponsePermissionsEnum: {
929
2533
  readonly AnyAuditLogs: "AnyAuditLogs";
930
2534
  readonly ViewApp: "ViewApp";
931
2535
  readonly CreateApp: "CreateApp";
@@ -1150,8 +2754,49 @@ export declare const Permissions: {
1150
2754
  readonly CreateOrg: "CreateOrg";
1151
2755
  readonly EditOrg: "EditOrg";
1152
2756
  readonly ViewOrg: "ViewOrg";
2757
+ readonly ViewWebhooks: "ViewWebhooks";
2758
+ readonly EditWebhooks: "EditWebhooks";
2759
+ readonly RoleAdmin: "RoleAdmin";
2760
+ readonly RoleFactory: "RoleFactory";
2761
+ };
2762
+ export type ListPermissionsSuccessResponsePermissionsEnum = typeof ListPermissionsSuccessResponsePermissionsEnum[keyof typeof ListPermissionsSuccessResponsePermissionsEnum];
2763
+ /**
2764
+ * Successful roles retrieval response
2765
+ * @export
2766
+ * @interface ListRolesSuccessResponse
2767
+ */
2768
+ export interface ListRolesSuccessResponse {
2769
+ /**
2770
+ * List of named roles
2771
+ * @type {Array<string>}
2772
+ * @memberof ListRolesSuccessResponse
2773
+ */
2774
+ 'roles': Array<ListRolesSuccessResponseRolesEnum>;
2775
+ }
2776
+ export declare const ListRolesSuccessResponseRolesEnum: {
2777
+ readonly Admin: "Admin";
2778
+ readonly Factory: "Factory";
1153
2779
  };
1154
- export type Permissions = typeof Permissions[keyof typeof Permissions];
2780
+ export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
2781
+ /**
2782
+ * Principals in org
2783
+ * @export
2784
+ * @interface PrincipalsInOrgResponse
2785
+ */
2786
+ export interface PrincipalsInOrgResponse {
2787
+ /**
2788
+ *
2789
+ * @type {string}
2790
+ * @memberof PrincipalsInOrgResponse
2791
+ */
2792
+ 'orgId': string;
2793
+ /**
2794
+ * List of principals in org
2795
+ * @type {Array<AuthorizationRequestPrincipal>}
2796
+ * @memberof PrincipalsInOrgResponse
2797
+ */
2798
+ 'principals': Array<AuthorizationRequestPrincipal>;
2799
+ }
1155
2800
  /**
1156
2801
  * Details for revoking a forbidden role from a principal
1157
2802
  * @export
@@ -1187,7 +2832,7 @@ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeFo
1187
2832
  */
1188
2833
  export interface RevokeRoleRequestBody {
1189
2834
  /**
1190
- * Role to assign to the principal choose from: OrgViewer, OrgManager, OrgAdmin, BrandViewer, BrandManager, BrandAdmin, StoreViewer, StoreEditor, StoreManager, CustomerViewer, CustomerManager, VoucherViewer, VoucherEditor, VoucherManager, VoucherCampaignManager, VoucherStatisticsViewer, AnalyticsViewer, ReportsViewer, FinanceViewer, FinanceManager, TeamViewer, TeamManager, TeamAdmin, TechViewer, TechManager, AppStoreViewer, AppStoreManager, SalesChannelViewer, SalesChannelEditor, SalesChannelManager, DeliveryViewer, DeliveryManager, DriverManager, AuditViewer, AuditManager, AccountsViewer, AccountsEditor, DocumentExplorerViewer, DocumentExplorerEditor, PayrollViewer, PayrollEditor, PropertyViewer, PropertyManager, PropertyAdmin, WebsiteContentEditor, WebsiteContentViewer, WebsiteTechViewer, MenuViewer, MenuEditor, MenuManager, MenuMetaFieldManager, MenuMetaFieldEditor, MenuMetaFieldViewer, StoreDeliveryZoneManager, StoreDeliveryZoneEditor, StoreDeliveryZoneViewer, OrderFulfillmentManager, OrderManager, OrderEditor, OrderViewer, InventoryManager, InventoryEditor, InventoryViewer, PaymentManager, OnboardingManager, FeatureFlagManager, PropertyOwnerMisc, ManagedOwnerMisc, IntegratorMisc, PropertyManagerMisc, FinanceManagerMisc, SupportMisc
2835
+ *
1191
2836
  * @type {string}
1192
2837
  * @memberof RevokeRoleRequestBody
1193
2838
  */
@@ -1299,25 +2944,6 @@ export interface RevokeRoleSuccessResponse {
1299
2944
  */
1300
2945
  'message': string;
1301
2946
  }
1302
- /**
1303
- *
1304
- * @export
1305
- * @interface RolesInner
1306
- */
1307
- export interface RolesInner {
1308
- /**
1309
- * Name of the role
1310
- * @type {string}
1311
- * @memberof RolesInner
1312
- */
1313
- 'name': string;
1314
- /**
1315
- *
1316
- * @type {Permissions & Array<string>}
1317
- * @memberof RolesInner
1318
- */
1319
- 'permissions': Permissions & Array<string>;
1320
- }
1321
2947
  /**
1322
2948
  *
1323
2949
  * @export
@@ -1345,210 +2971,587 @@ export interface ValidationErrorsInner {
1345
2971
  export interface ValidationErrorsInnerPathInner {
1346
2972
  }
1347
2973
  /**
1348
- * AuthenticationApi - axios parameter creator
2974
+ * AuthenticationApi - axios parameter creator
2975
+ * @export
2976
+ */
2977
+ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
2978
+ /**
2979
+ * Authenticate and authorize a user to perform an action
2980
+ * @summary Authenticate and authorize Request
2981
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2982
+ * @param {*} [options] Override http request option.
2983
+ * @throws {RequiredError}
2984
+ */
2985
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2986
+ };
2987
+ /**
2988
+ * AuthenticationApi - functional programming interface
2989
+ * @export
2990
+ */
2991
+ export declare const AuthenticationApiFp: (configuration?: Configuration) => {
2992
+ /**
2993
+ * Authenticate and authorize a user to perform an action
2994
+ * @summary Authenticate and authorize Request
2995
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2996
+ * @param {*} [options] Override http request option.
2997
+ * @throws {RequiredError}
2998
+ */
2999
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3000
+ };
3001
+ /**
3002
+ * AuthenticationApi - factory interface
3003
+ * @export
3004
+ */
3005
+ export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3006
+ /**
3007
+ * Authenticate and authorize a user to perform an action
3008
+ * @summary Authenticate and authorize Request
3009
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3010
+ * @param {*} [options] Override http request option.
3011
+ * @throws {RequiredError}
3012
+ */
3013
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3014
+ };
3015
+ /**
3016
+ * AuthenticationApi - object-oriented interface
3017
+ * @export
3018
+ * @class AuthenticationApi
3019
+ * @extends {BaseAPI}
3020
+ */
3021
+ export declare class AuthenticationApi extends BaseAPI {
3022
+ /**
3023
+ * Authenticate and authorize a user to perform an action
3024
+ * @summary Authenticate and authorize Request
3025
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3026
+ * @param {*} [options] Override http request option.
3027
+ * @throws {RequiredError}
3028
+ * @memberof AuthenticationApi
3029
+ */
3030
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
3031
+ }
3032
+ /**
3033
+ * AuthorizationApi - axios parameter creator
3034
+ * @export
3035
+ */
3036
+ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
3037
+ /**
3038
+ * Authenticate and authorize a user to perform an action
3039
+ * @summary Authenticate and authorize Request
3040
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3041
+ * @param {*} [options] Override http request option.
3042
+ * @throws {RequiredError}
3043
+ */
3044
+ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3045
+ /**
3046
+ * Authenticate and check if a user is in any/all of the roles
3047
+ * @summary Authenticate and Check Is In Role
3048
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3049
+ * @param {*} [options] Override http request option.
3050
+ * @throws {RequiredError}
3051
+ */
3052
+ authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3053
+ /**
3054
+ * Check if a user is authorized to perform an action
3055
+ * @summary Authorize Request
3056
+ * @param {AuthorizationRequest} [authorizationRequest]
3057
+ * @param {*} [options] Override http request option.
3058
+ * @throws {RequiredError}
3059
+ */
3060
+ authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3061
+ /**
3062
+ * Check if a user is authorized to perform an action on multiple resources
3063
+ * @summary Authorize Batch Request
3064
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3065
+ * @param {*} [options] Override http request option.
3066
+ * @throws {RequiredError}
3067
+ */
3068
+ authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3069
+ /**
3070
+ * Check if a user is in any/all of the roles
3071
+ * @summary Check Is In Role
3072
+ * @param {IsInRoleRequest} [isInRoleRequest]
3073
+ * @param {*} [options] Override http request option.
3074
+ * @throws {RequiredError}
3075
+ */
3076
+ checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3077
+ };
3078
+ /**
3079
+ * AuthorizationApi - functional programming interface
3080
+ * @export
3081
+ */
3082
+ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
3083
+ /**
3084
+ * Authenticate and authorize a user to perform an action
3085
+ * @summary Authenticate and authorize Request
3086
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3087
+ * @param {*} [options] Override http request option.
3088
+ * @throws {RequiredError}
3089
+ */
3090
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3091
+ /**
3092
+ * Authenticate and check if a user is in any/all of the roles
3093
+ * @summary Authenticate and Check Is In Role
3094
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3095
+ * @param {*} [options] Override http request option.
3096
+ * @throws {RequiredError}
3097
+ */
3098
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>>;
3099
+ /**
3100
+ * Check if a user is authorized to perform an action
3101
+ * @summary Authorize Request
3102
+ * @param {AuthorizationRequest} [authorizationRequest]
3103
+ * @param {*} [options] Override http request option.
3104
+ * @throws {RequiredError}
3105
+ */
3106
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
3107
+ /**
3108
+ * Check if a user is authorized to perform an action on multiple resources
3109
+ * @summary Authorize Batch Request
3110
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3111
+ * @param {*} [options] Override http request option.
3112
+ * @throws {RequiredError}
3113
+ */
3114
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>>;
3115
+ /**
3116
+ * Check if a user is in any/all of the roles
3117
+ * @summary Check Is In Role
3118
+ * @param {IsInRoleRequest} [isInRoleRequest]
3119
+ * @param {*} [options] Override http request option.
3120
+ * @throws {RequiredError}
3121
+ */
3122
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>>;
3123
+ };
3124
+ /**
3125
+ * AuthorizationApi - factory interface
3126
+ * @export
3127
+ */
3128
+ export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3129
+ /**
3130
+ * Authenticate and authorize a user to perform an action
3131
+ * @summary Authenticate and authorize Request
3132
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3133
+ * @param {*} [options] Override http request option.
3134
+ * @throws {RequiredError}
3135
+ */
3136
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3137
+ /**
3138
+ * Authenticate and check if a user is in any/all of the roles
3139
+ * @summary Authenticate and Check Is In Role
3140
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3141
+ * @param {*} [options] Override http request option.
3142
+ * @throws {RequiredError}
3143
+ */
3144
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse>;
3145
+ /**
3146
+ * Check if a user is authorized to perform an action
3147
+ * @summary Authorize Request
3148
+ * @param {AuthorizationRequest} [authorizationRequest]
3149
+ * @param {*} [options] Override http request option.
3150
+ * @throws {RequiredError}
3151
+ */
3152
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
3153
+ /**
3154
+ * Check if a user is authorized to perform an action on multiple resources
3155
+ * @summary Authorize Batch Request
3156
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3157
+ * @param {*} [options] Override http request option.
3158
+ * @throws {RequiredError}
3159
+ */
3160
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse>;
3161
+ /**
3162
+ * Check if a user is in any/all of the roles
3163
+ * @summary Check Is In Role
3164
+ * @param {IsInRoleRequest} [isInRoleRequest]
3165
+ * @param {*} [options] Override http request option.
3166
+ * @throws {RequiredError}
3167
+ */
3168
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse>;
3169
+ };
3170
+ /**
3171
+ * AuthorizationApi - object-oriented interface
3172
+ * @export
3173
+ * @class AuthorizationApi
3174
+ * @extends {BaseAPI}
3175
+ */
3176
+ export declare class AuthorizationApi extends BaseAPI {
3177
+ /**
3178
+ * Authenticate and authorize a user to perform an action
3179
+ * @summary Authenticate and authorize Request
3180
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3181
+ * @param {*} [options] Override http request option.
3182
+ * @throws {RequiredError}
3183
+ * @memberof AuthorizationApi
3184
+ */
3185
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
3186
+ /**
3187
+ * Authenticate and check if a user is in any/all of the roles
3188
+ * @summary Authenticate and Check Is In Role
3189
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3190
+ * @param {*} [options] Override http request option.
3191
+ * @throws {RequiredError}
3192
+ * @memberof AuthorizationApi
3193
+ */
3194
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
3195
+ /**
3196
+ * Check if a user is authorized to perform an action
3197
+ * @summary Authorize Request
3198
+ * @param {AuthorizationRequest} [authorizationRequest]
3199
+ * @param {*} [options] Override http request option.
3200
+ * @throws {RequiredError}
3201
+ * @memberof AuthorizationApi
3202
+ */
3203
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}>>;
3204
+ /**
3205
+ * Check if a user is authorized to perform an action on multiple resources
3206
+ * @summary Authorize Batch Request
3207
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
3208
+ * @param {*} [options] Override http request option.
3209
+ * @throws {RequiredError}
3210
+ * @memberof AuthorizationApi
3211
+ */
3212
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
3213
+ /**
3214
+ * Check if a user is in any/all of the roles
3215
+ * @summary Check Is In Role
3216
+ * @param {IsInRoleRequest} [isInRoleRequest]
3217
+ * @param {*} [options] Override http request option.
3218
+ * @throws {RequiredError}
3219
+ * @memberof AuthorizationApi
3220
+ */
3221
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
3222
+ }
3223
+ /**
3224
+ * AuthorizedEntitiesApi - axios parameter creator
1349
3225
  * @export
1350
3226
  */
1351
- export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
3227
+ export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => {
1352
3228
  /**
1353
- * Authenticate and authorize a user to perform an action
1354
- * @summary Authenticate and authorize Request
1355
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3229
+ * Get the authorized brands for a given org
3230
+ * @summary Get Authorized Brands
3231
+ * @param {string} orgId
3232
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3233
+ * @param {*} [options] Override http request option.
3234
+ * @throws {RequiredError}
3235
+ */
3236
+ getAuthorizedBrands: (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3237
+ /**
3238
+ * Get the authorized orgs for a given principal
3239
+ * @summary Get Authorized Orgs
3240
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3241
+ * @param {*} [options] Override http request option.
3242
+ * @throws {RequiredError}
3243
+ */
3244
+ getAuthorizedOrgs: (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3245
+ /**
3246
+ * Get the authorized properties for a given org
3247
+ * @summary Get Authorized Properties
3248
+ * @param {string} orgId
3249
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
1356
3250
  * @param {*} [options] Override http request option.
1357
3251
  * @throws {RequiredError}
1358
3252
  */
1359
- authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3253
+ getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1360
3254
  };
1361
3255
  /**
1362
- * AuthenticationApi - functional programming interface
3256
+ * AuthorizedEntitiesApi - functional programming interface
1363
3257
  * @export
1364
3258
  */
1365
- export declare const AuthenticationApiFp: (configuration?: Configuration) => {
3259
+ export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => {
1366
3260
  /**
1367
- * Authenticate and authorize a user to perform an action
1368
- * @summary Authenticate and authorize Request
1369
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3261
+ * Get the authorized brands for a given org
3262
+ * @summary Get Authorized Brands
3263
+ * @param {string} orgId
3264
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3265
+ * @param {*} [options] Override http request option.
3266
+ * @throws {RequiredError}
3267
+ */
3268
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>>;
3269
+ /**
3270
+ * Get the authorized orgs for a given principal
3271
+ * @summary Get Authorized Orgs
3272
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3273
+ * @param {*} [options] Override http request option.
3274
+ * @throws {RequiredError}
3275
+ */
3276
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>>;
3277
+ /**
3278
+ * Get the authorized properties for a given org
3279
+ * @summary Get Authorized Properties
3280
+ * @param {string} orgId
3281
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
1370
3282
  * @param {*} [options] Override http request option.
1371
3283
  * @throws {RequiredError}
1372
3284
  */
1373
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3285
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>>;
1374
3286
  };
1375
3287
  /**
1376
- * AuthenticationApi - factory interface
3288
+ * AuthorizedEntitiesApi - factory interface
1377
3289
  * @export
1378
3290
  */
1379
- export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3291
+ export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1380
3292
  /**
1381
- * Authenticate and authorize a user to perform an action
1382
- * @summary Authenticate and authorize Request
1383
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3293
+ * Get the authorized brands for a given org
3294
+ * @summary Get Authorized Brands
3295
+ * @param {string} orgId
3296
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
3297
+ * @param {*} [options] Override http request option.
3298
+ * @throws {RequiredError}
3299
+ */
3300
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse>;
3301
+ /**
3302
+ * Get the authorized orgs for a given principal
3303
+ * @summary Get Authorized Orgs
3304
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3305
+ * @param {*} [options] Override http request option.
3306
+ * @throws {RequiredError}
3307
+ */
3308
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse>;
3309
+ /**
3310
+ * Get the authorized properties for a given org
3311
+ * @summary Get Authorized Properties
3312
+ * @param {string} orgId
3313
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
1384
3314
  * @param {*} [options] Override http request option.
1385
3315
  * @throws {RequiredError}
1386
3316
  */
1387
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3317
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse>;
1388
3318
  };
1389
3319
  /**
1390
- * AuthenticationApi - object-oriented interface
3320
+ * AuthorizedEntitiesApi - object-oriented interface
1391
3321
  * @export
1392
- * @class AuthenticationApi
3322
+ * @class AuthorizedEntitiesApi
1393
3323
  * @extends {BaseAPI}
1394
3324
  */
1395
- export declare class AuthenticationApi extends BaseAPI {
3325
+ export declare class AuthorizedEntitiesApi extends BaseAPI {
1396
3326
  /**
1397
- * Authenticate and authorize a user to perform an action
1398
- * @summary Authenticate and authorize Request
1399
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3327
+ * Get the authorized brands for a given org
3328
+ * @summary Get Authorized Brands
3329
+ * @param {string} orgId
3330
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1400
3331
  * @param {*} [options] Override http request option.
1401
3332
  * @throws {RequiredError}
1402
- * @memberof AuthenticationApi
3333
+ * @memberof AuthorizedEntitiesApi
3334
+ */
3335
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}>>;
3336
+ /**
3337
+ * Get the authorized orgs for a given principal
3338
+ * @summary Get Authorized Orgs
3339
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
3340
+ * @param {*} [options] Override http request option.
3341
+ * @throws {RequiredError}
3342
+ * @memberof AuthorizedEntitiesApi
3343
+ */
3344
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}>>;
3345
+ /**
3346
+ * Get the authorized properties for a given org
3347
+ * @summary Get Authorized Properties
3348
+ * @param {string} orgId
3349
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3350
+ * @param {*} [options] Override http request option.
3351
+ * @throws {RequiredError}
3352
+ * @memberof AuthorizedEntitiesApi
1403
3353
  */
1404
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
3354
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
1405
3355
  }
1406
3356
  /**
1407
- * AuthorizationApi - axios parameter creator
3357
+ * ConfigurationDataApi - axios parameter creator
1408
3358
  * @export
1409
3359
  */
1410
- export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => {
3360
+ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => {
1411
3361
  /**
1412
- * Authenticate and authorize a user to perform an action
1413
- * @summary Authenticate and authorize Request
1414
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3362
+ * List the available feature based roles
3363
+ * @summary List Feature Based Roles
1415
3364
  * @param {*} [options] Override http request option.
1416
3365
  * @throws {RequiredError}
1417
3366
  */
1418
- authenticateAndAuthorize: (authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3367
+ configListFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1419
3368
  /**
1420
- * Check if a user is authorized to perform an action
1421
- * @summary Authorize Request
1422
- * @param {AuthorizationRequest} [authorizationRequest]
3369
+ * List the available permissions
3370
+ * @summary List Permissions
1423
3371
  * @param {*} [options] Override http request option.
1424
3372
  * @throws {RequiredError}
1425
3373
  */
1426
- authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1427
- };
1428
- /**
1429
- * AuthorizationApi - functional programming interface
1430
- * @export
1431
- */
1432
- export declare const AuthorizationApiFp: (configuration?: Configuration) => {
3374
+ configListPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1433
3375
  /**
1434
- * Authenticate and authorize a user to perform an action
1435
- * @summary Authenticate and authorize Request
1436
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3376
+ * List the available roles
3377
+ * @summary List Roles
1437
3378
  * @param {*} [options] Override http request option.
1438
3379
  * @throws {RequiredError}
1439
3380
  */
1440
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>>;
3381
+ configListRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1441
3382
  /**
1442
- * Check if a user is authorized to perform an action
1443
- * @summary Authorize Request
1444
- * @param {AuthorizationRequest} [authorizationRequest]
3383
+ * List the available feature based roles
3384
+ * @summary List Feature Based Roles
1445
3385
  * @param {*} [options] Override http request option.
1446
3386
  * @throws {RequiredError}
1447
3387
  */
1448
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>>;
1449
- };
1450
- /**
1451
- * AuthorizationApi - factory interface
1452
- * @export
1453
- */
1454
- export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3388
+ listFeatureBasedRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1455
3389
  /**
1456
- * Authenticate and authorize a user to perform an action
1457
- * @summary Authenticate and authorize Request
1458
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3390
+ * List the available permissions
3391
+ * @summary List Permissions
1459
3392
  * @param {*} [options] Override http request option.
1460
3393
  * @throws {RequiredError}
1461
3394
  */
1462
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse>;
3395
+ listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1463
3396
  /**
1464
- * Check if a user is authorized to perform an action
1465
- * @summary Authorize Request
1466
- * @param {AuthorizationRequest} [authorizationRequest]
3397
+ * List the available roles
3398
+ * @summary List Roles
1467
3399
  * @param {*} [options] Override http request option.
1468
3400
  * @throws {RequiredError}
1469
3401
  */
1470
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse>;
3402
+ listRoles: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1471
3403
  };
1472
3404
  /**
1473
- * AuthorizationApi - object-oriented interface
3405
+ * ConfigurationDataApi - functional programming interface
1474
3406
  * @export
1475
- * @class AuthorizationApi
1476
- * @extends {BaseAPI}
1477
3407
  */
1478
- export declare class AuthorizationApi extends BaseAPI {
3408
+ export declare const ConfigurationDataApiFp: (configuration?: Configuration) => {
1479
3409
  /**
1480
- * Authenticate and authorize a user to perform an action
1481
- * @summary Authenticate and authorize Request
1482
- * @param {AuthenticateAndAuthorizeRequest} [authenticateAndAuthorizeRequest]
3410
+ * List the available feature based roles
3411
+ * @summary List Feature Based Roles
1483
3412
  * @param {*} [options] Override http request option.
1484
3413
  * @throws {RequiredError}
1485
- * @memberof AuthorizationApi
1486
3414
  */
1487
- authenticateAndAuthorize(authenticateAndAuthorizeRequest?: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any>>;
3415
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
1488
3416
  /**
1489
- * Check if a user is authorized to perform an action
1490
- * @summary Authorize Request
1491
- * @param {AuthorizationRequest} [authorizationRequest]
3417
+ * List the available permissions
3418
+ * @summary List Permissions
1492
3419
  * @param {*} [options] Override http request option.
1493
3420
  * @throws {RequiredError}
1494
- * @memberof AuthorizationApi
1495
3421
  */
1496
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any>>;
1497
- }
1498
- /**
1499
- * PermissionsApi - axios parameter creator
1500
- * @export
1501
- */
1502
- export declare const PermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
3422
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
3423
+ /**
3424
+ * List the available roles
3425
+ * @summary List Roles
3426
+ * @param {*} [options] Override http request option.
3427
+ * @throws {RequiredError}
3428
+ */
3429
+ configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
3430
+ /**
3431
+ * List the available feature based roles
3432
+ * @summary List Feature Based Roles
3433
+ * @param {*} [options] Override http request option.
3434
+ * @throws {RequiredError}
3435
+ */
3436
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>>;
1503
3437
  /**
1504
3438
  * List the available permissions
1505
3439
  * @summary List Permissions
1506
3440
  * @param {*} [options] Override http request option.
1507
3441
  * @throws {RequiredError}
1508
3442
  */
1509
- listPermissions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3443
+ listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>>;
3444
+ /**
3445
+ * List the available roles
3446
+ * @summary List Roles
3447
+ * @param {*} [options] Override http request option.
3448
+ * @throws {RequiredError}
3449
+ */
3450
+ listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>>;
1510
3451
  };
1511
3452
  /**
1512
- * PermissionsApi - functional programming interface
3453
+ * ConfigurationDataApi - factory interface
1513
3454
  * @export
1514
3455
  */
1515
- export declare const PermissionsApiFp: (configuration?: Configuration) => {
3456
+ export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3457
+ /**
3458
+ * List the available feature based roles
3459
+ * @summary List Feature Based Roles
3460
+ * @param {*} [options] Override http request option.
3461
+ * @throws {RequiredError}
3462
+ */
3463
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
1516
3464
  /**
1517
3465
  * List the available permissions
1518
3466
  * @summary List Permissions
1519
3467
  * @param {*} [options] Override http request option.
1520
3468
  * @throws {RequiredError}
1521
3469
  */
1522
- listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>>;
1523
- };
1524
- /**
1525
- * PermissionsApi - factory interface
1526
- * @export
1527
- */
1528
- export declare const PermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3470
+ configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
3471
+ /**
3472
+ * List the available roles
3473
+ * @summary List Roles
3474
+ * @param {*} [options] Override http request option.
3475
+ * @throws {RequiredError}
3476
+ */
3477
+ configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
3478
+ /**
3479
+ * List the available feature based roles
3480
+ * @summary List Feature Based Roles
3481
+ * @param {*} [options] Override http request option.
3482
+ * @throws {RequiredError}
3483
+ */
3484
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse>;
1529
3485
  /**
1530
3486
  * List the available permissions
1531
3487
  * @summary List Permissions
1532
3488
  * @param {*} [options] Override http request option.
1533
3489
  * @throws {RequiredError}
1534
3490
  */
1535
- listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse>;
3491
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse>;
3492
+ /**
3493
+ * List the available roles
3494
+ * @summary List Roles
3495
+ * @param {*} [options] Override http request option.
3496
+ * @throws {RequiredError}
3497
+ */
3498
+ listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse>;
1536
3499
  };
1537
3500
  /**
1538
- * PermissionsApi - object-oriented interface
3501
+ * ConfigurationDataApi - object-oriented interface
1539
3502
  * @export
1540
- * @class PermissionsApi
3503
+ * @class ConfigurationDataApi
1541
3504
  * @extends {BaseAPI}
1542
3505
  */
1543
- export declare class PermissionsApi extends BaseAPI {
3506
+ export declare class ConfigurationDataApi extends BaseAPI {
3507
+ /**
3508
+ * List the available feature based roles
3509
+ * @summary List Feature Based Roles
3510
+ * @param {*} [options] Override http request option.
3511
+ * @throws {RequiredError}
3512
+ * @memberof ConfigurationDataApi
3513
+ */
3514
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
3515
+ /**
3516
+ * List the available permissions
3517
+ * @summary List Permissions
3518
+ * @param {*} [options] Override http request option.
3519
+ * @throws {RequiredError}
3520
+ * @memberof ConfigurationDataApi
3521
+ */
3522
+ configListPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
3523
+ /**
3524
+ * List the available roles
3525
+ * @summary List Roles
3526
+ * @param {*} [options] Override http request option.
3527
+ * @throws {RequiredError}
3528
+ * @memberof ConfigurationDataApi
3529
+ */
3530
+ configListRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
3531
+ /**
3532
+ * List the available feature based roles
3533
+ * @summary List Feature Based Roles
3534
+ * @param {*} [options] Override http request option.
3535
+ * @throws {RequiredError}
3536
+ * @memberof ConfigurationDataApi
3537
+ */
3538
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFeatureBasedRolesSuccessResponse, any, {}>>;
1544
3539
  /**
1545
3540
  * List the available permissions
1546
3541
  * @summary List Permissions
1547
3542
  * @param {*} [options] Override http request option.
1548
3543
  * @throws {RequiredError}
1549
- * @memberof PermissionsApi
3544
+ * @memberof ConfigurationDataApi
3545
+ */
3546
+ listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
3547
+ /**
3548
+ * List the available roles
3549
+ * @summary List Roles
3550
+ * @param {*} [options] Override http request option.
3551
+ * @throws {RequiredError}
3552
+ * @memberof ConfigurationDataApi
1550
3553
  */
1551
- listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPermissionsSuccessResponse, any>>;
3554
+ listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
1552
3555
  }
1553
3556
  /**
1554
3557
  * RoleAssignmentApi - axios parameter creator
@@ -1692,7 +3695,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
1692
3695
  * @throws {RequiredError}
1693
3696
  * @memberof RoleAssignmentApi
1694
3697
  */
1695
- assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any>>;
3698
+ assignRoleToPrincipal(orgId: string, assignRoleRequestBody?: AssignRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignRoleSuccessResponse, any, {}>>;
1696
3699
  /**
1697
3700
  * Get the active roles for a given principal
1698
3701
  * @summary Get Principal Roles
@@ -1702,7 +3705,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
1702
3705
  * @throws {RequiredError}
1703
3706
  * @memberof RoleAssignmentApi
1704
3707
  */
1705
- getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any>>;
3708
+ getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
1706
3709
  /**
1707
3710
  * Revokes a forbidden role from a given principal (user, group, etc.)
1708
3711
  * @summary Revoke Forbidden Role from Principal
@@ -1712,7 +3715,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
1712
3715
  * @throws {RequiredError}
1713
3716
  * @memberof RoleAssignmentApi
1714
3717
  */
1715
- revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
3718
+ revokeForbiddenRoleFromPrincipal(orgId: string, revokeForbiddenRoleRequestBody?: RevokeForbiddenRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
1716
3719
  /**
1717
3720
  * Revokes a specified role from a given principal (user, group, etc.)
1718
3721
  * @summary Revoke Role from Principal
@@ -1722,13 +3725,88 @@ export declare class RoleAssignmentApi extends BaseAPI {
1722
3725
  * @throws {RequiredError}
1723
3726
  * @memberof RoleAssignmentApi
1724
3727
  */
1725
- revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any>>;
3728
+ revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
3729
+ }
3730
+ /**
3731
+ * UserManagementApi - axios parameter creator
3732
+ * @export
3733
+ */
3734
+ export declare const UserManagementApiAxiosParamCreator: (configuration?: Configuration) => {
3735
+ /**
3736
+ * List the users in a given org
3737
+ * @summary List Users in Org
3738
+ * @param {string} orgId
3739
+ * @param {*} [options] Override http request option.
3740
+ * @throws {RequiredError}
3741
+ */
3742
+ listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3743
+ };
3744
+ /**
3745
+ * UserManagementApi - functional programming interface
3746
+ * @export
3747
+ */
3748
+ export declare const UserManagementApiFp: (configuration?: Configuration) => {
3749
+ /**
3750
+ * List the users in a given org
3751
+ * @summary List Users in Org
3752
+ * @param {string} orgId
3753
+ * @param {*} [options] Override http request option.
3754
+ * @throws {RequiredError}
3755
+ */
3756
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
3757
+ };
3758
+ /**
3759
+ * UserManagementApi - factory interface
3760
+ * @export
3761
+ */
3762
+ export declare const UserManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3763
+ /**
3764
+ * List the users in a given org
3765
+ * @summary List Users in Org
3766
+ * @param {string} orgId
3767
+ * @param {*} [options] Override http request option.
3768
+ * @throws {RequiredError}
3769
+ */
3770
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
3771
+ };
3772
+ /**
3773
+ * UserManagementApi - object-oriented interface
3774
+ * @export
3775
+ * @class UserManagementApi
3776
+ * @extends {BaseAPI}
3777
+ */
3778
+ export declare class UserManagementApi extends BaseAPI {
3779
+ /**
3780
+ * List the users in a given org
3781
+ * @summary List Users in Org
3782
+ * @param {string} orgId
3783
+ * @param {*} [options] Override http request option.
3784
+ * @throws {RequiredError}
3785
+ * @memberof UserManagementApi
3786
+ */
3787
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
1726
3788
  }
1727
3789
  /**
1728
3790
  * UserPermissionsApi - axios parameter creator
1729
3791
  * @export
1730
3792
  */
1731
3793
  export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
3794
+ /**
3795
+ * List the available permissions for the current user
3796
+ * @summary List Org Permissions
3797
+ * @param {string} orgId
3798
+ * @param {*} [options] Override http request option.
3799
+ * @throws {RequiredError}
3800
+ */
3801
+ listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3802
+ /**
3803
+ * List the available roles for the current user
3804
+ * @summary List Org Roles
3805
+ * @param {string} orgId
3806
+ * @param {*} [options] Override http request option.
3807
+ * @throws {RequiredError}
3808
+ */
3809
+ listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1732
3810
  /**
1733
3811
  * List the available permissions for the current user
1734
3812
  * @summary List Own Permissions
@@ -1752,6 +3830,30 @@ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Confi
1752
3830
  * @export
1753
3831
  */
1754
3832
  export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
3833
+ /**
3834
+ * List the available permissions for the current user
3835
+ * @summary List Org Permissions
3836
+ * @param {string} orgId
3837
+ * @param {*} [options] Override http request option.
3838
+ * @throws {RequiredError}
3839
+ */
3840
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
3841
+ [key: string]: {
3842
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3843
+ };
3844
+ }>>;
3845
+ /**
3846
+ * List the available roles for the current user
3847
+ * @summary List Org Roles
3848
+ * @param {string} orgId
3849
+ * @param {*} [options] Override http request option.
3850
+ * @throws {RequiredError}
3851
+ */
3852
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
3853
+ [key: string]: {
3854
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3855
+ };
3856
+ }>>;
1755
3857
  /**
1756
3858
  * List the available permissions for the current user
1757
3859
  * @summary List Own Permissions
@@ -1775,6 +3877,30 @@ export declare const UserPermissionsApiFp: (configuration?: Configuration) => {
1775
3877
  * @export
1776
3878
  */
1777
3879
  export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3880
+ /**
3881
+ * List the available permissions for the current user
3882
+ * @summary List Org Permissions
3883
+ * @param {string} orgId
3884
+ * @param {*} [options] Override http request option.
3885
+ * @throws {RequiredError}
3886
+ */
3887
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
3888
+ [key: string]: {
3889
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3890
+ };
3891
+ }>;
3892
+ /**
3893
+ * List the available roles for the current user
3894
+ * @summary List Org Roles
3895
+ * @param {string} orgId
3896
+ * @param {*} [options] Override http request option.
3897
+ * @throws {RequiredError}
3898
+ */
3899
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
3900
+ [key: string]: {
3901
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3902
+ };
3903
+ }>;
1778
3904
  /**
1779
3905
  * List the available permissions for the current user
1780
3906
  * @summary List Own Permissions
@@ -1800,6 +3926,32 @@ export declare const UserPermissionsApiFactory: (configuration?: Configuration,
1800
3926
  * @extends {BaseAPI}
1801
3927
  */
1802
3928
  export declare class UserPermissionsApi extends BaseAPI {
3929
+ /**
3930
+ * List the available permissions for the current user
3931
+ * @summary List Org Permissions
3932
+ * @param {string} orgId
3933
+ * @param {*} [options] Override http request option.
3934
+ * @throws {RequiredError}
3935
+ * @memberof UserPermissionsApi
3936
+ */
3937
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
3938
+ [key: string]: {
3939
+ [key: string]: GetUserPermissionsSuccessResponseResourcesValue;
3940
+ };
3941
+ }, any, {}>>;
3942
+ /**
3943
+ * List the available roles for the current user
3944
+ * @summary List Org Roles
3945
+ * @param {string} orgId
3946
+ * @param {*} [options] Override http request option.
3947
+ * @throws {RequiredError}
3948
+ * @memberof UserPermissionsApi
3949
+ */
3950
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
3951
+ [key: string]: {
3952
+ [key: string]: ListOrgRolesSuccessResponseValueValue;
3953
+ };
3954
+ }, any, {}>>;
1803
3955
  /**
1804
3956
  * List the available permissions for the current user
1805
3957
  * @summary List Own Permissions
@@ -1808,7 +3960,7 @@ export declare class UserPermissionsApi extends BaseAPI {
1808
3960
  * @throws {RequiredError}
1809
3961
  * @memberof UserPermissionsApi
1810
3962
  */
1811
- listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
3963
+ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
1812
3964
  /**
1813
3965
  * List the available permissions for a given user
1814
3966
  * @summary List User Permissions
@@ -1818,5 +3970,5 @@ export declare class UserPermissionsApi extends BaseAPI {
1818
3970
  * @throws {RequiredError}
1819
3971
  * @memberof UserPermissionsApi
1820
3972
  */
1821
- listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any>>;
3973
+ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
1822
3974
  }