@flipdish/authorization 0.2.11-rc.1764849351 → 0.2.12-rc.1765346440

package/api.ts

@@ -169,7 +169,21 @@ 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 const AuthenticateAndAuthorizeRequestCheckModeEnum = {
+    Any: 'any',
+    All: 'all'
+} as const;
+
+export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
+
 /**
  * Response containing the authentication and authorization decision
  * @export
@@ -208,7 +222,7 @@ export interface AuthenticateAndCheckIsInRoleRequest {
      */
     'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
     /**
-     * How to check if the principal is in any/all of the roles
+     * 
      * @type {string}
      * @memberof AuthenticateAndCheckIsInRoleRequest
      */
@@ -285,11 +299,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>}
@@ -297,6 +311,240 @@ export interface AuthorizationBatchRequest {
      */
     'resources': Array<AuthorizationRequestResource>;
 }
+
+export const AuthorizationBatchRequestActionEnum = {
+    AnyAuditLogs: 'AnyAuditLogs',
+    ViewApp: 'ViewApp',
+    CreateApp: 'CreateApp',
+    UpdateApp: 'UpdateApp',
+    ViewAppName: 'ViewAppName',
+    EditAppAssets: 'EditAppAssets',
+    EditAppFeatures: 'EditAppFeatures',
+    ViewTeammates: 'ViewTeammates',
+    EditTeammates: 'EditTeammates',
+    CreateTeammateOwner: 'CreateTeammateOwner',
+    CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
+    CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
+    CreateTeammateStoreManager: 'CreateTeammateStoreManager',
+    CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
+    CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
+    CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
+    CreateTeammateIntegrator: 'CreateTeammateIntegrator',
+    CreateTeammateOnboarding: 'CreateTeammateOnboarding',
+    CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
+    CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
+    ViewApmConfigurations: 'ViewApmConfigurations',
+    EditApmConfigurations: 'EditApmConfigurations',
+    ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
+    CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
+    UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
+    DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
+    StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
+    ViewDevelopersSettings: 'ViewDevelopersSettings',
+    EditDevelopersSettings: 'EditDevelopersSettings',
+    ViewOrders: 'ViewOrders',
+    UpdateOrdersAccept: 'UpdateOrdersAccept',
+    UpdateOrdersReject: 'UpdateOrdersReject',
+    UpdateOrdersRefund: 'UpdateOrdersRefund',
+    UpdateOrdersDispatch: 'UpdateOrdersDispatch',
+    ViewStores: 'ViewStores',
+    CreateStores: 'CreateStores',
+    EditStores: 'EditStores',
+    ViewStoresOpeningHours: 'ViewStoresOpeningHours',
+    UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
+    UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
+    ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
+    EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
+    EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
+    UpdateStoresName: 'UpdateStoresName',
+    EditStoreKioskSettings: 'EditStoreKioskSettings',
+    EditStoreOrderCapacity: 'EditStoreOrderCapacity',
+    EditStoreNotifications: 'EditStoreNotifications',
+    ArchiveStores: 'ArchiveStores',
+    PublishStores: 'PublishStores',
+    UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
+    UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
+    ViewStoreGroups: 'ViewStoreGroups',
+    CreateStoreGroups: 'CreateStoreGroups',
+    UpdateStoreGroups: 'UpdateStoreGroups',
+    DeleteStoreGroups: 'DeleteStoreGroups',
+    ViewDeliveryZones: 'ViewDeliveryZones',
+    CreateDeliveryZones: 'CreateDeliveryZones',
+    UpdateDeliveryZones: 'UpdateDeliveryZones',
+    DeleteDeliveryZones: 'DeleteDeliveryZones',
+    ViewMenu: 'ViewMenu',
+    CreateMenu: 'CreateMenu',
+    UpdateMenu: 'UpdateMenu',
+    DeleteMenu: 'DeleteMenu',
+    UpdateMenuLock: 'UpdateMenuLock',
+    UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
+    EditMenuImage: 'EditMenuImage',
+    ViewVouchers: 'ViewVouchers',
+    EditVouchers: 'EditVouchers',
+    ViewWebsiteContent: 'ViewWebsiteContent',
+    EditWebsiteContent: 'EditWebsiteContent',
+    ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
+    ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
+    ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
+    ViewBankAccounts: 'ViewBankAccounts',
+    CreateBankAccounts: 'CreateBankAccounts',
+    UpdateBankAccounts: 'UpdateBankAccounts',
+    UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
+    ViewAssignedBankAccount: 'ViewAssignedBankAccount',
+    VerifyBankAccounts: 'VerifyBankAccounts',
+    ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
+    EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
+    EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
+    EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
+    ViewHydraConfig: 'ViewHydraConfig',
+    UpdateHydraConfigManage: 'UpdateHydraConfigManage',
+    InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
+    DeleteTerminal: 'DeleteTerminal',
+    ViewKioskTelemetry: 'ViewKioskTelemetry',
+    ViewCustomers: 'ViewCustomers',
+    EditCustomers: 'EditCustomers',
+    CreateCustomers: 'CreateCustomers',
+    CreateCatalogElements: 'CreateCatalogElements',
+    UpdateCatalogElements: 'UpdateCatalogElements',
+    ViewCatalogElements: 'ViewCatalogElements',
+    DeleteCatalogElements: 'DeleteCatalogElements',
+    ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
+    CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
+    UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
+    DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
+    UpdateMetafields: 'UpdateMetafields',
+    ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
+    PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
+    ViewAppStatistics: 'ViewAppStatistics',
+    ViewApmStatistics: 'ViewApmStatistics',
+    ViewCampaignsStatistics: 'ViewCampaignsStatistics',
+    ViewCustomerStatistics: 'ViewCustomerStatistics',
+    ViewLiveStatistics: 'ViewLiveStatistics',
+    ViewOrderStatistics: 'ViewOrderStatistics',
+    ViewSalesStatistics: 'ViewSalesStatistics',
+    ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
+    ViewVouchersStatistics: 'ViewVouchersStatistics',
+    DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
+    ViewApmAuditLogs: 'ViewApmAuditLogs',
+    ViewStoreAuditLogs: 'ViewStoreAuditLogs',
+    ViewMenuAuditLogs: 'ViewMenuAuditLogs',
+    ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
+    ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
+    ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
+    ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
+    ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
+    ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
+    ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
+    ViewAppAuditLogs: 'ViewAppAuditLogs',
+    ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
+    ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
+    ViewHydraAuditLogs: 'ViewHydraAuditLogs',
+    ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
+    ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
+    ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
+    ViewExternalAuditLogs: 'ViewExternalAuditLogs',
+    CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
+    ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
+    ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
+    ViewChannelAuditLogs: 'ViewChannelAuditLogs',
+    ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
+    SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
+    InviteDriverToApp: 'InviteDriverToApp',
+    GetDriverForApp: 'GetDriverForApp',
+    RemoveDriverFromApp: 'RemoveDriverFromApp',
+    AssignDriverToOrder: 'AssignDriverToOrder',
+    UnassignDriverFromOrder: 'UnassignDriverFromOrder',
+    UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
+    UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
+    ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
+    CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
+    UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
+    DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
+    ViewPayouts: 'ViewPayouts',
+    ViewChannels: 'ViewChannels',
+    ViewOnboarding: 'ViewOnboarding',
+    UpdateOnboarding: 'UpdateOnboarding',
+    ViewClientDevices: 'ViewClientDevices',
+    UpdateClientDevices: 'UpdateClientDevices',
+    EnrollClientDevices: 'EnrollClientDevices',
+    AssignClientDevices: 'AssignClientDevices',
+    ViewClientAuditLogs: 'ViewClientAuditLogs',
+    CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
+    ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
+    UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
+    DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
+    UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
+    CreateAppStoreSubscription: 'CreateAppStoreSubscription',
+    UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
+    DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
+    ViewSalesChannels: 'ViewSalesChannels',
+    EditSalesChannels: 'EditSalesChannels',
+    CreateSalesChannel: 'CreateSalesChannel',
+    ArchiveSalesChannel: 'ArchiveSalesChannel',
+    UnarchiveSalesChannel: 'UnarchiveSalesChannel',
+    PublishSalesChannel: 'PublishSalesChannel',
+    UnpublishSalesChannel: 'UnpublishSalesChannel',
+    CloneSalesChannel: 'CloneSalesChannel',
+    ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
+    CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
+    UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
+    UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
+    ViewSubscriptions: 'ViewSubscriptions',
+    ViewInvoices: 'ViewInvoices',
+    EditAccountsBills: 'EditAccountsBills',
+    ViewAccountsBills: 'ViewAccountsBills',
+    EditAccountsCategories: 'EditAccountsCategories',
+    ViewAccountsCategories: 'ViewAccountsCategories',
+    EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
+    ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
+    EditAccountsCreditBooks: 'EditAccountsCreditBooks',
+    ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
+    EditAccountsExpenses: 'EditAccountsExpenses',
+    ViewAccountsExpenses: 'ViewAccountsExpenses',
+    EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
+    ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
+    EditDocumentExplorer: 'EditDocumentExplorer',
+    ViewDocumentExplorer: 'ViewDocumentExplorer',
+    ViewInventoryReports: 'ViewInventoryReports',
+    EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
+    ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
+    EditInventoryStockItems: 'EditInventoryStockItems',
+    ViewInventoryStockItems: 'ViewInventoryStockItems',
+    EditInventorySupplier: 'EditInventorySupplier',
+    ViewInventorySupplier: 'ViewInventorySupplier',
+    EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
+    ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
+    ViewPayrollReports: 'ViewPayrollReports',
+    EditPayrollHoliday: 'EditPayrollHoliday',
+    ViewPayrollHoliday: 'ViewPayrollHoliday',
+    EditPayrollRota: 'EditPayrollRota',
+    ViewPayrollRota: 'ViewPayrollRota',
+    EditPayrollStaff: 'EditPayrollStaff',
+    ViewPayrollStaff: 'ViewPayrollStaff',
+    ViewSalesReports: 'ViewSalesReports',
+    ViewCostReports: 'ViewCostReports',
+    ViewMenuReports: 'ViewMenuReports',
+    ViewBrand: 'ViewBrand',
+    EditBrand: 'EditBrand',
+    CreateBrand: 'CreateBrand',
+    TransferBrand: 'TransferBrand',
+    ViewProperty: 'ViewProperty',
+    EditProperty: 'EditProperty',
+    CreateProperty: 'CreateProperty',
+    ArchiveProperty: 'ArchiveProperty',
+    ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
+    EditEntityFeatureFlags: 'EditEntityFeatureFlags',
+    CreateOrg: 'CreateOrg',
+    EditOrg: 'EditOrg',
+    ViewOrg: 'ViewOrg',
+    ViewWebhooks: 'ViewWebhooks',
+    EditWebhooks: 'EditWebhooks',
+    RoleAdmin: 'RoleAdmin',
+    RoleFactory: 'RoleFactory'
+} as const;
+
+export type AuthorizationBatchRequestActionEnum = typeof AuthorizationBatchRequestActionEnum[keyof typeof AuthorizationBatchRequestActionEnum];
+
 /**
  * 
  * @export
@@ -349,13 +597,13 @@ 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
  */
@@ -378,9 +626,23 @@ 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 const AuthorizationRequestCheckModeEnum = {
+    Any: 'any',
+    All: 'all'
+} as const;
+
+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
  */
@@ -539,65 +801,299 @@ export const AuthorizationRequestResourceOneOf3TypeEnum = {
     SalesChannel: 'SalesChannel'
 } as const;
 
-export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum];
+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 const FeatureBasedRolePermissionsEnum = {
+    AnyAuditLogs: 'AnyAuditLogs',
+    ViewApp: 'ViewApp',
+    CreateApp: 'CreateApp',
+    UpdateApp: 'UpdateApp',
+    ViewAppName: 'ViewAppName',
+    EditAppAssets: 'EditAppAssets',
+    EditAppFeatures: 'EditAppFeatures',
+    ViewTeammates: 'ViewTeammates',
+    EditTeammates: 'EditTeammates',
+    CreateTeammateOwner: 'CreateTeammateOwner',
+    CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
+    CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
+    CreateTeammateStoreManager: 'CreateTeammateStoreManager',
+    CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
+    CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
+    CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
+    CreateTeammateIntegrator: 'CreateTeammateIntegrator',
+    CreateTeammateOnboarding: 'CreateTeammateOnboarding',
+    CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
+    CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
+    ViewApmConfigurations: 'ViewApmConfigurations',
+    EditApmConfigurations: 'EditApmConfigurations',
+    ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
+    CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
+    UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
+    DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
+    StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
+    ViewDevelopersSettings: 'ViewDevelopersSettings',
+    EditDevelopersSettings: 'EditDevelopersSettings',
+    ViewOrders: 'ViewOrders',
+    UpdateOrdersAccept: 'UpdateOrdersAccept',
+    UpdateOrdersReject: 'UpdateOrdersReject',
+    UpdateOrdersRefund: 'UpdateOrdersRefund',
+    UpdateOrdersDispatch: 'UpdateOrdersDispatch',
+    ViewStores: 'ViewStores',
+    CreateStores: 'CreateStores',
+    EditStores: 'EditStores',
+    ViewStoresOpeningHours: 'ViewStoresOpeningHours',
+    UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
+    UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
+    ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
+    EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
+    EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
+    UpdateStoresName: 'UpdateStoresName',
+    EditStoreKioskSettings: 'EditStoreKioskSettings',
+    EditStoreOrderCapacity: 'EditStoreOrderCapacity',
+    EditStoreNotifications: 'EditStoreNotifications',
+    ArchiveStores: 'ArchiveStores',
+    PublishStores: 'PublishStores',
+    UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
+    UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
+    ViewStoreGroups: 'ViewStoreGroups',
+    CreateStoreGroups: 'CreateStoreGroups',
+    UpdateStoreGroups: 'UpdateStoreGroups',
+    DeleteStoreGroups: 'DeleteStoreGroups',
+    ViewDeliveryZones: 'ViewDeliveryZones',
+    CreateDeliveryZones: 'CreateDeliveryZones',
+    UpdateDeliveryZones: 'UpdateDeliveryZones',
+    DeleteDeliveryZones: 'DeleteDeliveryZones',
+    ViewMenu: 'ViewMenu',
+    CreateMenu: 'CreateMenu',
+    UpdateMenu: 'UpdateMenu',
+    DeleteMenu: 'DeleteMenu',
+    UpdateMenuLock: 'UpdateMenuLock',
+    UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
+    EditMenuImage: 'EditMenuImage',
+    ViewVouchers: 'ViewVouchers',
+    EditVouchers: 'EditVouchers',
+    ViewWebsiteContent: 'ViewWebsiteContent',
+    EditWebsiteContent: 'EditWebsiteContent',
+    ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
+    ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
+    ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
+    ViewBankAccounts: 'ViewBankAccounts',
+    CreateBankAccounts: 'CreateBankAccounts',
+    UpdateBankAccounts: 'UpdateBankAccounts',
+    UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
+    ViewAssignedBankAccount: 'ViewAssignedBankAccount',
+    VerifyBankAccounts: 'VerifyBankAccounts',
+    ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
+    EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
+    EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
+    EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
+    ViewHydraConfig: 'ViewHydraConfig',
+    UpdateHydraConfigManage: 'UpdateHydraConfigManage',
+    InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
+    DeleteTerminal: 'DeleteTerminal',
+    ViewKioskTelemetry: 'ViewKioskTelemetry',
+    ViewCustomers: 'ViewCustomers',
+    EditCustomers: 'EditCustomers',
+    CreateCustomers: 'CreateCustomers',
+    CreateCatalogElements: 'CreateCatalogElements',
+    UpdateCatalogElements: 'UpdateCatalogElements',
+    ViewCatalogElements: 'ViewCatalogElements',
+    DeleteCatalogElements: 'DeleteCatalogElements',
+    ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
+    CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
+    UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
+    DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
+    UpdateMetafields: 'UpdateMetafields',
+    ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
+    PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
+    ViewAppStatistics: 'ViewAppStatistics',
+    ViewApmStatistics: 'ViewApmStatistics',
+    ViewCampaignsStatistics: 'ViewCampaignsStatistics',
+    ViewCustomerStatistics: 'ViewCustomerStatistics',
+    ViewLiveStatistics: 'ViewLiveStatistics',
+    ViewOrderStatistics: 'ViewOrderStatistics',
+    ViewSalesStatistics: 'ViewSalesStatistics',
+    ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
+    ViewVouchersStatistics: 'ViewVouchersStatistics',
+    DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
+    ViewApmAuditLogs: 'ViewApmAuditLogs',
+    ViewStoreAuditLogs: 'ViewStoreAuditLogs',
+    ViewMenuAuditLogs: 'ViewMenuAuditLogs',
+    ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
+    ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
+    ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
+    ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
+    ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
+    ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
+    ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
+    ViewAppAuditLogs: 'ViewAppAuditLogs',
+    ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
+    ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
+    ViewHydraAuditLogs: 'ViewHydraAuditLogs',
+    ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
+    ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
+    ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
+    ViewExternalAuditLogs: 'ViewExternalAuditLogs',
+    CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
+    ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
+    ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
+    ViewChannelAuditLogs: 'ViewChannelAuditLogs',
+    ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
+    SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
+    InviteDriverToApp: 'InviteDriverToApp',
+    GetDriverForApp: 'GetDriverForApp',
+    RemoveDriverFromApp: 'RemoveDriverFromApp',
+    AssignDriverToOrder: 'AssignDriverToOrder',
+    UnassignDriverFromOrder: 'UnassignDriverFromOrder',
+    UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
+    UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
+    ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
+    CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
+    UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
+    DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
+    ViewPayouts: 'ViewPayouts',
+    ViewChannels: 'ViewChannels',
+    ViewOnboarding: 'ViewOnboarding',
+    UpdateOnboarding: 'UpdateOnboarding',
+    ViewClientDevices: 'ViewClientDevices',
+    UpdateClientDevices: 'UpdateClientDevices',
+    EnrollClientDevices: 'EnrollClientDevices',
+    AssignClientDevices: 'AssignClientDevices',
+    ViewClientAuditLogs: 'ViewClientAuditLogs',
+    CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
+    ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
+    UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
+    DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
+    UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
+    CreateAppStoreSubscription: 'CreateAppStoreSubscription',
+    UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
+    DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
+    ViewSalesChannels: 'ViewSalesChannels',
+    EditSalesChannels: 'EditSalesChannels',
+    CreateSalesChannel: 'CreateSalesChannel',
+    ArchiveSalesChannel: 'ArchiveSalesChannel',
+    UnarchiveSalesChannel: 'UnarchiveSalesChannel',
+    PublishSalesChannel: 'PublishSalesChannel',
+    UnpublishSalesChannel: 'UnpublishSalesChannel',
+    CloneSalesChannel: 'CloneSalesChannel',
+    ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
+    CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
+    UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
+    UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
+    ViewSubscriptions: 'ViewSubscriptions',
+    ViewInvoices: 'ViewInvoices',
+    EditAccountsBills: 'EditAccountsBills',
+    ViewAccountsBills: 'ViewAccountsBills',
+    EditAccountsCategories: 'EditAccountsCategories',
+    ViewAccountsCategories: 'ViewAccountsCategories',
+    EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
+    ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
+    EditAccountsCreditBooks: 'EditAccountsCreditBooks',
+    ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
+    EditAccountsExpenses: 'EditAccountsExpenses',
+    ViewAccountsExpenses: 'ViewAccountsExpenses',
+    EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
+    ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
+    EditDocumentExplorer: 'EditDocumentExplorer',
+    ViewDocumentExplorer: 'ViewDocumentExplorer',
+    ViewInventoryReports: 'ViewInventoryReports',
+    EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
+    ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
+    EditInventoryStockItems: 'EditInventoryStockItems',
+    ViewInventoryStockItems: 'ViewInventoryStockItems',
+    EditInventorySupplier: 'EditInventorySupplier',
+    ViewInventorySupplier: 'ViewInventorySupplier',
+    EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
+    ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
+    ViewPayrollReports: 'ViewPayrollReports',
+    EditPayrollHoliday: 'EditPayrollHoliday',
+    ViewPayrollHoliday: 'ViewPayrollHoliday',
+    EditPayrollRota: 'EditPayrollRota',
+    ViewPayrollRota: 'ViewPayrollRota',
+    EditPayrollStaff: 'EditPayrollStaff',
+    ViewPayrollStaff: 'ViewPayrollStaff',
+    ViewSalesReports: 'ViewSalesReports',
+    ViewCostReports: 'ViewCostReports',
+    ViewMenuReports: 'ViewMenuReports',
+    ViewBrand: 'ViewBrand',
+    EditBrand: 'EditBrand',
+    CreateBrand: 'CreateBrand',
+    TransferBrand: 'TransferBrand',
+    ViewProperty: 'ViewProperty',
+    EditProperty: 'EditProperty',
+    CreateProperty: 'CreateProperty',
+    ArchiveProperty: 'ArchiveProperty',
+    ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
+    EditEntityFeatureFlags: 'EditEntityFeatureFlags',
+    CreateOrg: 'CreateOrg',
+    EditOrg: 'EditOrg',
+    ViewOrg: 'ViewOrg',
+    ViewWebhooks: 'ViewWebhooks',
+    EditWebhooks: 'EditWebhooks',
+    RoleAdmin: 'RoleAdmin',
+    RoleFactory: 'RoleFactory'
+} as const;
+
+export type FeatureBasedRolePermissionsEnum = typeof FeatureBasedRolePermissionsEnum[keyof typeof FeatureBasedRolePermissionsEnum];
 
-/**
- * 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>;
-}
 /**
  * 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
@@ -1926,7 +2422,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
      */
@@ -2090,40 +2586,14 @@ 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 const ListRolesSuccessResponseRolesEnum = {
-    Admin: 'Admin',
-    Factory: 'Factory'
-} as const;
-
-export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
-
-/**
- * 
- * @export
- * @enum {string}
- */
-
-export const Permissions = {
+export const ListPermissionsSuccessResponsePermissionsEnum = {
     AnyAuditLogs: 'AnyAuditLogs',
     ViewApp: 'ViewApp',
     CreateApp: 'CreateApp',
@@ -2354,8 +2824,28 @@ export const Permissions = {
     RoleFactory: 'RoleFactory'
 } as const;
 
-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 const ListRolesSuccessResponseRolesEnum = {
+    Admin: 'Admin',
+    Factory: 'Factory'
+} as const;
 
+export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
 
 /**
  * Details for revoking a forbidden role from a principal