@flipdish/authorization 0.2.11 → 0.2.13-rc.1765379152

package/dist/api.d.ts

@@ -158,7 +158,18 @@ export interface AuthenticateAndAuthorizeRequest {
      * @memberof AuthenticateAndAuthorizeRequest
      */
     'resource'?: AuthorizationRequestResource;
+    /**
+     * How to check authorisation - any or all of the actions must be allowed
+     * @type {string}
+     * @memberof AuthenticateAndAuthorizeRequest
+     */
+    'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
 }
+export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: {
+    readonly Any: "any";
+    readonly All: "all";
+};
+export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
 /**
  * Response containing the authentication and authorization decision
  * @export
@@ -199,7 +210,7 @@ export interface AuthenticateAndCheckIsInRoleRequest {
      */
     'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
     /**
-     * How to check if the principal is in any/all of the roles
+     *
      * @type {string}
      * @memberof AuthenticateAndCheckIsInRoleRequest
      */
@@ -272,11 +283,11 @@ export interface AuthorizationBatchRequest {
      */
     'principal': AuthorizationRequestPrincipal;
     /**
-     *
-     * @type {Permissions}
+     * The action to check authorisation for
+     * @type {string}
      * @memberof AuthorizationBatchRequest
      */
-    'action': Permissions;
+    'action': AuthorizationBatchRequestActionEnum;
     /**
      * Array of resources to check authorisation for
      * @type {Array<AuthorizationRequestResource>}
@@ -284,6 +295,237 @@ export interface AuthorizationBatchRequest {
      */
     'resources': Array<AuthorizationRequestResource>;
 }
+export declare const AuthorizationBatchRequestActionEnum: {
+    readonly AnyAuditLogs: "AnyAuditLogs";
+    readonly ViewApp: "ViewApp";
+    readonly CreateApp: "CreateApp";
+    readonly UpdateApp: "UpdateApp";
+    readonly ViewAppName: "ViewAppName";
+    readonly EditAppAssets: "EditAppAssets";
+    readonly EditAppFeatures: "EditAppFeatures";
+    readonly ViewTeammates: "ViewTeammates";
+    readonly EditTeammates: "EditTeammates";
+    readonly CreateTeammateOwner: "CreateTeammateOwner";
+    readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
+    readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
+    readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
+    readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
+    readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
+    readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
+    readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
+    readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
+    readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
+    readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
+    readonly ViewApmConfigurations: "ViewApmConfigurations";
+    readonly EditApmConfigurations: "EditApmConfigurations";
+    readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
+    readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
+    readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
+    readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
+    readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
+    readonly ViewDevelopersSettings: "ViewDevelopersSettings";
+    readonly EditDevelopersSettings: "EditDevelopersSettings";
+    readonly ViewOrders: "ViewOrders";
+    readonly UpdateOrdersAccept: "UpdateOrdersAccept";
+    readonly UpdateOrdersReject: "UpdateOrdersReject";
+    readonly UpdateOrdersRefund: "UpdateOrdersRefund";
+    readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
+    readonly ViewStores: "ViewStores";
+    readonly CreateStores: "CreateStores";
+    readonly EditStores: "EditStores";
+    readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
+    readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
+    readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
+    readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
+    readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
+    readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
+    readonly UpdateStoresName: "UpdateStoresName";
+    readonly EditStoreKioskSettings: "EditStoreKioskSettings";
+    readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
+    readonly EditStoreNotifications: "EditStoreNotifications";
+    readonly ArchiveStores: "ArchiveStores";
+    readonly PublishStores: "PublishStores";
+    readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
+    readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
+    readonly ViewStoreGroups: "ViewStoreGroups";
+    readonly CreateStoreGroups: "CreateStoreGroups";
+    readonly UpdateStoreGroups: "UpdateStoreGroups";
+    readonly DeleteStoreGroups: "DeleteStoreGroups";
+    readonly ViewDeliveryZones: "ViewDeliveryZones";
+    readonly CreateDeliveryZones: "CreateDeliveryZones";
+    readonly UpdateDeliveryZones: "UpdateDeliveryZones";
+    readonly DeleteDeliveryZones: "DeleteDeliveryZones";
+    readonly ViewMenu: "ViewMenu";
+    readonly CreateMenu: "CreateMenu";
+    readonly UpdateMenu: "UpdateMenu";
+    readonly DeleteMenu: "DeleteMenu";
+    readonly UpdateMenuLock: "UpdateMenuLock";
+    readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
+    readonly EditMenuImage: "EditMenuImage";
+    readonly ViewVouchers: "ViewVouchers";
+    readonly EditVouchers: "EditVouchers";
+    readonly ViewWebsiteContent: "ViewWebsiteContent";
+    readonly EditWebsiteContent: "EditWebsiteContent";
+    readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
+    readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
+    readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
+    readonly ViewBankAccounts: "ViewBankAccounts";
+    readonly CreateBankAccounts: "CreateBankAccounts";
+    readonly UpdateBankAccounts: "UpdateBankAccounts";
+    readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
+    readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
+    readonly VerifyBankAccounts: "VerifyBankAccounts";
+    readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
+    readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
+    readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
+    readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
+    readonly ViewHydraConfig: "ViewHydraConfig";
+    readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
+    readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
+    readonly DeleteTerminal: "DeleteTerminal";
+    readonly ViewKioskTelemetry: "ViewKioskTelemetry";
+    readonly ViewCustomers: "ViewCustomers";
+    readonly EditCustomers: "EditCustomers";
+    readonly CreateCustomers: "CreateCustomers";
+    readonly CreateCatalogElements: "CreateCatalogElements";
+    readonly UpdateCatalogElements: "UpdateCatalogElements";
+    readonly ViewCatalogElements: "ViewCatalogElements";
+    readonly DeleteCatalogElements: "DeleteCatalogElements";
+    readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
+    readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
+    readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
+    readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
+    readonly UpdateMetafields: "UpdateMetafields";
+    readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
+    readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
+    readonly ViewAppStatistics: "ViewAppStatistics";
+    readonly ViewApmStatistics: "ViewApmStatistics";
+    readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
+    readonly ViewCustomerStatistics: "ViewCustomerStatistics";
+    readonly ViewLiveStatistics: "ViewLiveStatistics";
+    readonly ViewOrderStatistics: "ViewOrderStatistics";
+    readonly ViewSalesStatistics: "ViewSalesStatistics";
+    readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
+    readonly ViewVouchersStatistics: "ViewVouchersStatistics";
+    readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
+    readonly ViewApmAuditLogs: "ViewApmAuditLogs";
+    readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
+    readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
+    readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
+    readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
+    readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
+    readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
+    readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
+    readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
+    readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
+    readonly ViewAppAuditLogs: "ViewAppAuditLogs";
+    readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
+    readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
+    readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
+    readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
+    readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
+    readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
+    readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
+    readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
+    readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
+    readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
+    readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
+    readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
+    readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
+    readonly InviteDriverToApp: "InviteDriverToApp";
+    readonly GetDriverForApp: "GetDriverForApp";
+    readonly RemoveDriverFromApp: "RemoveDriverFromApp";
+    readonly AssignDriverToOrder: "AssignDriverToOrder";
+    readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
+    readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
+    readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
+    readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
+    readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
+    readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
+    readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
+    readonly ViewPayouts: "ViewPayouts";
+    readonly ViewChannels: "ViewChannels";
+    readonly ViewOnboarding: "ViewOnboarding";
+    readonly UpdateOnboarding: "UpdateOnboarding";
+    readonly ViewClientDevices: "ViewClientDevices";
+    readonly UpdateClientDevices: "UpdateClientDevices";
+    readonly EnrollClientDevices: "EnrollClientDevices";
+    readonly AssignClientDevices: "AssignClientDevices";
+    readonly ViewClientAuditLogs: "ViewClientAuditLogs";
+    readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
+    readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
+    readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
+    readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
+    readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
+    readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
+    readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
+    readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
+    readonly ViewSalesChannels: "ViewSalesChannels";
+    readonly EditSalesChannels: "EditSalesChannels";
+    readonly CreateSalesChannel: "CreateSalesChannel";
+    readonly ArchiveSalesChannel: "ArchiveSalesChannel";
+    readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
+    readonly PublishSalesChannel: "PublishSalesChannel";
+    readonly UnpublishSalesChannel: "UnpublishSalesChannel";
+    readonly CloneSalesChannel: "CloneSalesChannel";
+    readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
+    readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
+    readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
+    readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
+    readonly ViewSubscriptions: "ViewSubscriptions";
+    readonly ViewInvoices: "ViewInvoices";
+    readonly EditAccountsBills: "EditAccountsBills";
+    readonly ViewAccountsBills: "ViewAccountsBills";
+    readonly EditAccountsCategories: "EditAccountsCategories";
+    readonly ViewAccountsCategories: "ViewAccountsCategories";
+    readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
+    readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
+    readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
+    readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
+    readonly EditAccountsExpenses: "EditAccountsExpenses";
+    readonly ViewAccountsExpenses: "ViewAccountsExpenses";
+    readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
+    readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
+    readonly EditDocumentExplorer: "EditDocumentExplorer";
+    readonly ViewDocumentExplorer: "ViewDocumentExplorer";
+    readonly ViewInventoryReports: "ViewInventoryReports";
+    readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
+    readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
+    readonly EditInventoryStockItems: "EditInventoryStockItems";
+    readonly ViewInventoryStockItems: "ViewInventoryStockItems";
+    readonly EditInventorySupplier: "EditInventorySupplier";
+    readonly ViewInventorySupplier: "ViewInventorySupplier";
+    readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
+    readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
+    readonly ViewPayrollReports: "ViewPayrollReports";
+    readonly EditPayrollHoliday: "EditPayrollHoliday";
+    readonly ViewPayrollHoliday: "ViewPayrollHoliday";
+    readonly EditPayrollRota: "EditPayrollRota";
+    readonly ViewPayrollRota: "ViewPayrollRota";
+    readonly EditPayrollStaff: "EditPayrollStaff";
+    readonly ViewPayrollStaff: "ViewPayrollStaff";
+    readonly ViewSalesReports: "ViewSalesReports";
+    readonly ViewCostReports: "ViewCostReports";
+    readonly ViewMenuReports: "ViewMenuReports";
+    readonly ViewBrand: "ViewBrand";
+    readonly EditBrand: "EditBrand";
+    readonly CreateBrand: "CreateBrand";
+    readonly TransferBrand: "TransferBrand";
+    readonly ViewProperty: "ViewProperty";
+    readonly EditProperty: "EditProperty";
+    readonly CreateProperty: "CreateProperty";
+    readonly ArchiveProperty: "ArchiveProperty";
+    readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
+    readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
+    readonly CreateOrg: "CreateOrg";
+    readonly EditOrg: "EditOrg";
+    readonly ViewOrg: "ViewOrg";
+    readonly ViewWebhooks: "ViewWebhooks";
+    readonly EditWebhooks: "EditWebhooks";
+    readonly RoleAdmin: "RoleAdmin";
+    readonly RoleFactory: "RoleFactory";
+};
+export type AuthorizationBatchRequestActionEnum = typeof AuthorizationBatchRequestActionEnum[keyof typeof AuthorizationBatchRequestActionEnum];
 /**
  *
  * @export
@@ -336,12 +578,12 @@ export interface AuthorizationBatchResponseAllowedResourcesInner {
 }
 /**
  * @type AuthorizationBatchResponseAllowedResourcesInnerResource
- *
+ * Resource that the action was checked for
  * @export
  */
 export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
 /**
- * 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).
+ * 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).
  * @export
  * @interface AuthorizationRequest
  */
@@ -364,9 +606,20 @@ export interface AuthorizationRequest {
      * @memberof AuthorizationRequest
      */
     'resource'?: AuthorizationRequestResource;
+    /**
+     * How to check authorisation - any or all of the actions must be allowed
+     * @type {string}
+     * @memberof AuthorizationRequest
+     */
+    'checkMode'?: AuthorizationRequestCheckModeEnum;
 }
+export declare const AuthorizationRequestCheckModeEnum: {
+    readonly Any: "any";
+    readonly All: "all";
+};
+export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
 /**
- *
+ * Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
  * @export
  * @interface AuthorizationRequestAction
  */
@@ -510,64 +763,295 @@ export interface AuthorizationRequestResourceOneOf3 {
 export declare const AuthorizationRequestResourceOneOf3TypeEnum: {
     readonly SalesChannel: "SalesChannel";
 };
-export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
-/**
- * Response containing the authorization decision
- * @export
- * @interface AuthorizationResponse
- */
-export interface AuthorizationResponse {
-    /**
-     * Whether the action is allowed
-     * @type {boolean}
-     * @memberof AuthorizationResponse
-     */
-    'allowed': boolean;
-    /**
-     * The authorization decision
-     * @type {string}
-     * @memberof AuthorizationResponse
-     */
-    'decision': string;
-    /**
-     * The policy IDs that were used to make the decision
-     * @type {Array<string>}
-     * @memberof AuthorizationResponse
-     */
-    'policyIds': Array<string>;
-}
-/**
- *
- * @export
- * @interface ErrorResponse
- */
-export interface ErrorResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof ErrorResponse
-     */
-    'message': string;
-}
-/**
- * Feature based role and its permissions
- * @export
- * @interface FeatureBasedRole
- */
-export interface FeatureBasedRole {
-    /**
-     * Name of the role
-     * @type {string}
-     * @memberof FeatureBasedRole
-     */
-    'name': string;
-    /**
-     *
-     * @type {Permissions & Array<string>}
-     * @memberof FeatureBasedRole
-     */
-    'permissions': Permissions & Array<string>;
-}
+export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
+/**
+ * Response containing the authorization decision
+ * @export
+ * @interface AuthorizationResponse
+ */
+export interface AuthorizationResponse {
+    /**
+     * Whether the action is allowed
+     * @type {boolean}
+     * @memberof AuthorizationResponse
+     */
+    'allowed': boolean;
+    /**
+     * The authorization decision
+     * @type {string}
+     * @memberof AuthorizationResponse
+     */
+    'decision': string;
+    /**
+     * The policy IDs that were used to make the decision
+     * @type {Array<string>}
+     * @memberof AuthorizationResponse
+     */
+    'policyIds': Array<string>;
+}
+/**
+ *
+ * @export
+ * @interface ErrorResponse
+ */
+export interface ErrorResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    'message': string;
+}
+/**
+ * Feature based role and its permissions
+ * @export
+ * @interface FeatureBasedRole
+ */
+export interface FeatureBasedRole {
+    /**
+     * Name of the role
+     * @type {string}
+     * @memberof FeatureBasedRole
+     */
+    'name': string;
+    /**
+     * List of permissions
+     * @type {Array<string>}
+     * @memberof FeatureBasedRole
+     */
+    'permissions': Array<FeatureBasedRolePermissionsEnum>;
+}
+export declare const FeatureBasedRolePermissionsEnum: {
+    readonly AnyAuditLogs: "AnyAuditLogs";
+    readonly ViewApp: "ViewApp";
+    readonly CreateApp: "CreateApp";
+    readonly UpdateApp: "UpdateApp";
+    readonly ViewAppName: "ViewAppName";
+    readonly EditAppAssets: "EditAppAssets";
+    readonly EditAppFeatures: "EditAppFeatures";
+    readonly ViewTeammates: "ViewTeammates";
+    readonly EditTeammates: "EditTeammates";
+    readonly CreateTeammateOwner: "CreateTeammateOwner";
+    readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner";
+    readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner";
+    readonly CreateTeammateStoreManager: "CreateTeammateStoreManager";
+    readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff";
+    readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess";
+    readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager";
+    readonly CreateTeammateIntegrator: "CreateTeammateIntegrator";
+    readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
+    readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
+    readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
+    readonly ViewApmConfigurations: "ViewApmConfigurations";
+    readonly EditApmConfigurations: "EditApmConfigurations";
+    readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
+    readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations";
+    readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations";
+    readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations";
+    readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations";
+    readonly ViewDevelopersSettings: "ViewDevelopersSettings";
+    readonly EditDevelopersSettings: "EditDevelopersSettings";
+    readonly ViewOrders: "ViewOrders";
+    readonly UpdateOrdersAccept: "UpdateOrdersAccept";
+    readonly UpdateOrdersReject: "UpdateOrdersReject";
+    readonly UpdateOrdersRefund: "UpdateOrdersRefund";
+    readonly UpdateOrdersDispatch: "UpdateOrdersDispatch";
+    readonly ViewStores: "ViewStores";
+    readonly CreateStores: "CreateStores";
+    readonly EditStores: "EditStores";
+    readonly ViewStoresOpeningHours: "ViewStoresOpeningHours";
+    readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery";
+    readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours";
+    readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride";
+    readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride";
+    readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary";
+    readonly UpdateStoresName: "UpdateStoresName";
+    readonly EditStoreKioskSettings: "EditStoreKioskSettings";
+    readonly EditStoreOrderCapacity: "EditStoreOrderCapacity";
+    readonly EditStoreNotifications: "EditStoreNotifications";
+    readonly ArchiveStores: "ArchiveStores";
+    readonly PublishStores: "PublishStores";
+    readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign";
+    readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle";
+    readonly ViewStoreGroups: "ViewStoreGroups";
+    readonly CreateStoreGroups: "CreateStoreGroups";
+    readonly UpdateStoreGroups: "UpdateStoreGroups";
+    readonly DeleteStoreGroups: "DeleteStoreGroups";
+    readonly ViewDeliveryZones: "ViewDeliveryZones";
+    readonly CreateDeliveryZones: "CreateDeliveryZones";
+    readonly UpdateDeliveryZones: "UpdateDeliveryZones";
+    readonly DeleteDeliveryZones: "DeleteDeliveryZones";
+    readonly ViewMenu: "ViewMenu";
+    readonly CreateMenu: "CreateMenu";
+    readonly UpdateMenu: "UpdateMenu";
+    readonly DeleteMenu: "DeleteMenu";
+    readonly UpdateMenuLock: "UpdateMenuLock";
+    readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily";
+    readonly EditMenuImage: "EditMenuImage";
+    readonly ViewVouchers: "ViewVouchers";
+    readonly EditVouchers: "EditVouchers";
+    readonly ViewWebsiteContent: "ViewWebsiteContent";
+    readonly EditWebsiteContent: "EditWebsiteContent";
+    readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified";
+    readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated";
+    readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed";
+    readonly ViewBankAccounts: "ViewBankAccounts";
+    readonly CreateBankAccounts: "CreateBankAccounts";
+    readonly UpdateBankAccounts: "UpdateBankAccounts";
+    readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign";
+    readonly ViewAssignedBankAccount: "ViewAssignedBankAccount";
+    readonly VerifyBankAccounts: "VerifyBankAccounts";
+    readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations";
+    readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations";
+    readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees";
+    readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited";
+    readonly ViewHydraConfig: "ViewHydraConfig";
+    readonly UpdateHydraConfigManage: "UpdateHydraConfigManage";
+    readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
+    readonly DeleteTerminal: "DeleteTerminal";
+    readonly ViewKioskTelemetry: "ViewKioskTelemetry";
+    readonly ViewCustomers: "ViewCustomers";
+    readonly EditCustomers: "EditCustomers";
+    readonly CreateCustomers: "CreateCustomers";
+    readonly CreateCatalogElements: "CreateCatalogElements";
+    readonly UpdateCatalogElements: "UpdateCatalogElements";
+    readonly ViewCatalogElements: "ViewCatalogElements";
+    readonly DeleteCatalogElements: "DeleteCatalogElements";
+    readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions";
+    readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions";
+    readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions";
+    readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions";
+    readonly UpdateMetafields: "UpdateMetafields";
+    readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges";
+    readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges";
+    readonly ViewAppStatistics: "ViewAppStatistics";
+    readonly ViewApmStatistics: "ViewApmStatistics";
+    readonly ViewCampaignsStatistics: "ViewCampaignsStatistics";
+    readonly ViewCustomerStatistics: "ViewCustomerStatistics";
+    readonly ViewLiveStatistics: "ViewLiveStatistics";
+    readonly ViewOrderStatistics: "ViewOrderStatistics";
+    readonly ViewSalesStatistics: "ViewSalesStatistics";
+    readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics";
+    readonly ViewVouchersStatistics: "ViewVouchersStatistics";
+    readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport";
+    readonly ViewApmAuditLogs: "ViewApmAuditLogs";
+    readonly ViewStoreAuditLogs: "ViewStoreAuditLogs";
+    readonly ViewMenuAuditLogs: "ViewMenuAuditLogs";
+    readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs";
+    readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs";
+    readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs";
+    readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs";
+    readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs";
+    readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs";
+    readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs";
+    readonly ViewAppAuditLogs: "ViewAppAuditLogs";
+    readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs";
+    readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs";
+    readonly ViewHydraAuditLogs: "ViewHydraAuditLogs";
+    readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs";
+    readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs";
+    readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs";
+    readonly ViewExternalAuditLogs: "ViewExternalAuditLogs";
+    readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents";
+    readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs";
+    readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs";
+    readonly ViewChannelAuditLogs: "ViewChannelAuditLogs";
+    readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs";
+    readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer";
+    readonly InviteDriverToApp: "InviteDriverToApp";
+    readonly GetDriverForApp: "GetDriverForApp";
+    readonly RemoveDriverFromApp: "RemoveDriverFromApp";
+    readonly AssignDriverToOrder: "AssignDriverToOrder";
+    readonly UnassignDriverFromOrder: "UnassignDriverFromOrder";
+    readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus";
+    readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus";
+    readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration";
+    readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration";
+    readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration";
+    readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration";
+    readonly ViewPayouts: "ViewPayouts";
+    readonly ViewChannels: "ViewChannels";
+    readonly ViewOnboarding: "ViewOnboarding";
+    readonly UpdateOnboarding: "UpdateOnboarding";
+    readonly ViewClientDevices: "ViewClientDevices";
+    readonly UpdateClientDevices: "UpdateClientDevices";
+    readonly EnrollClientDevices: "EnrollClientDevices";
+    readonly AssignClientDevices: "AssignClientDevices";
+    readonly ViewClientAuditLogs: "ViewClientAuditLogs";
+    readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration";
+    readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration";
+    readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration";
+    readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration";
+    readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings";
+    readonly CreateAppStoreSubscription: "CreateAppStoreSubscription";
+    readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription";
+    readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription";
+    readonly ViewSalesChannels: "ViewSalesChannels";
+    readonly EditSalesChannels: "EditSalesChannels";
+    readonly CreateSalesChannel: "CreateSalesChannel";
+    readonly ArchiveSalesChannel: "ArchiveSalesChannel";
+    readonly UnarchiveSalesChannel: "UnarchiveSalesChannel";
+    readonly PublishSalesChannel: "PublishSalesChannel";
+    readonly UnpublishSalesChannel: "UnpublishSalesChannel";
+    readonly CloneSalesChannel: "CloneSalesChannel";
+    readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration";
+    readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration";
+    readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration";
+    readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration";
+    readonly ViewSubscriptions: "ViewSubscriptions";
+    readonly ViewInvoices: "ViewInvoices";
+    readonly EditAccountsBills: "EditAccountsBills";
+    readonly ViewAccountsBills: "ViewAccountsBills";
+    readonly EditAccountsCategories: "EditAccountsCategories";
+    readonly ViewAccountsCategories: "ViewAccountsCategories";
+    readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts";
+    readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts";
+    readonly EditAccountsCreditBooks: "EditAccountsCreditBooks";
+    readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks";
+    readonly EditAccountsExpenses: "EditAccountsExpenses";
+    readonly ViewAccountsExpenses: "ViewAccountsExpenses";
+    readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts";
+    readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts";
+    readonly EditDocumentExplorer: "EditDocumentExplorer";
+    readonly ViewDocumentExplorer: "ViewDocumentExplorer";
+    readonly ViewInventoryReports: "ViewInventoryReports";
+    readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders";
+    readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders";
+    readonly EditInventoryStockItems: "EditInventoryStockItems";
+    readonly ViewInventoryStockItems: "ViewInventoryStockItems";
+    readonly EditInventorySupplier: "EditInventorySupplier";
+    readonly ViewInventorySupplier: "ViewInventorySupplier";
+    readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles";
+    readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles";
+    readonly ViewPayrollReports: "ViewPayrollReports";
+    readonly EditPayrollHoliday: "EditPayrollHoliday";
+    readonly ViewPayrollHoliday: "ViewPayrollHoliday";
+    readonly EditPayrollRota: "EditPayrollRota";
+    readonly ViewPayrollRota: "ViewPayrollRota";
+    readonly EditPayrollStaff: "EditPayrollStaff";
+    readonly ViewPayrollStaff: "ViewPayrollStaff";
+    readonly ViewSalesReports: "ViewSalesReports";
+    readonly ViewCostReports: "ViewCostReports";
+    readonly ViewMenuReports: "ViewMenuReports";
+    readonly ViewBrand: "ViewBrand";
+    readonly EditBrand: "EditBrand";
+    readonly CreateBrand: "CreateBrand";
+    readonly TransferBrand: "TransferBrand";
+    readonly ViewProperty: "ViewProperty";
+    readonly EditProperty: "EditProperty";
+    readonly CreateProperty: "CreateProperty";
+    readonly ArchiveProperty: "ArchiveProperty";
+    readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags";
+    readonly EditEntityFeatureFlags: "EditEntityFeatureFlags";
+    readonly CreateOrg: "CreateOrg";
+    readonly EditOrg: "EditOrg";
+    readonly ViewOrg: "ViewOrg";
+    readonly ViewWebhooks: "ViewWebhooks";
+    readonly EditWebhooks: "EditWebhooks";
+    readonly RoleAdmin: "RoleAdmin";
+    readonly RoleFactory: "RoleFactory";
+};
+export type FeatureBasedRolePermissionsEnum = typeof FeatureBasedRolePermissionsEnum[keyof typeof FeatureBasedRolePermissionsEnum];
 /**
  * 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.
  * @export
@@ -1883,7 +2367,7 @@ export interface IsInRoleRequest {
      */
     'roles': Array<IsInRoleRequestRolesEnum>;
     /**
-     * How to check if the principal is in any/all of the roles
+     * How to check authorisation - any or all of the actions must be allowed
      * @type {string}
      * @memberof IsInRoleRequest
      */
@@ -2039,36 +2523,13 @@ export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRoles
  */
 export interface ListPermissionsSuccessResponse {
     /**
-     *
-     * @type {Permissions & Array<string>}
-     * @memberof ListPermissionsSuccessResponse
-     */
-    'permissions': Permissions & Array<string>;
-}
-/**
- * Successful roles retrieval response
- * @export
- * @interface ListRolesSuccessResponse
- */
-export interface ListRolesSuccessResponse {
-    /**
-     * List of named roles
+     * List of permissions
      * @type {Array<string>}
-     * @memberof ListRolesSuccessResponse
+     * @memberof ListPermissionsSuccessResponse
      */
-    'roles': Array<ListRolesSuccessResponseRolesEnum>;
+    'permissions': Array<ListPermissionsSuccessResponsePermissionsEnum>;
 }
-export declare const ListRolesSuccessResponseRolesEnum: {
-    readonly Admin: "Admin";
-    readonly Factory: "Factory";
-};
-export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
-/**
- *
- * @export
- * @enum {string}
- */
-export declare const Permissions: {
+export declare const ListPermissionsSuccessResponsePermissionsEnum: {
     readonly AnyAuditLogs: "AnyAuditLogs";
     readonly ViewApp: "ViewApp";
     readonly CreateApp: "CreateApp";
@@ -2298,7 +2759,25 @@ export declare const Permissions: {
     readonly RoleAdmin: "RoleAdmin";
     readonly RoleFactory: "RoleFactory";
 };
-export type Permissions = typeof Permissions[keyof typeof Permissions];
+export type ListPermissionsSuccessResponsePermissionsEnum = typeof ListPermissionsSuccessResponsePermissionsEnum[keyof typeof ListPermissionsSuccessResponsePermissionsEnum];
+/**
+ * Successful roles retrieval response
+ * @export
+ * @interface ListRolesSuccessResponse
+ */
+export interface ListRolesSuccessResponse {
+    /**
+     * List of named roles
+     * @type {Array<string>}
+     * @memberof ListRolesSuccessResponse
+     */
+    'roles': Array<ListRolesSuccessResponseRolesEnum>;
+}
+export declare const ListRolesSuccessResponseRolesEnum: {
+    readonly Admin: "Admin";
+    readonly Factory: "Factory";
+};
+export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
 /**
  * Details for revoking a forbidden role from a principal
  * @export