App.md

App

Properties

Name	Type	Description	Notes
appId	String	App Identifier	[optional]
hasIosApp	Boolean	Has iOS app in Apple App Store. This is readonly.	[optional]
iosAppStoreUrl	String	IOS App Store URL	[optional]
hasAndroidApp	Boolean	Has Android app in Google Play Store. This is readonly.	[optional]
androidPlayStoreUrl	String	Android Play Store URL	[optional]
displayDeliveryRestaurantScreen	Boolean	Display delivery restaurant screen	[optional]
logoImageUrl	String	Application Logo.	[optional]
languages	List<Language>	Languages that have been selected to be available to customers.	[optional]
availableAppLanguages	List<Language>	Lists all languages that are supported by Flipdish.	[optional]
appAccessLevel	AppAccessLevelEnum	App access level for the logged in user	[optional]
appResourceSet	List<AppResourceSetEnum>	Constitutes a list of available resources	[optional]
features	List<String>	Feature flags. These cannot be set by 3rd parties.	[optional]
mapCenter	Coordinates	Center of the map coordinates. This is used to center the map when the iOS and Android app first open. This value is automatically set based on the locations of the Stores in the App.	[optional]
mapNorthEast	Coordinates	North East(Top Right) Corner of the map coordinates. This is used to frame the map when the iOS and Android app first open. This value is automatically set based on the locations of the Stores in the App.	[optional]
mapSouthWest	Coordinates	South West (Bottom Left) Corner of the map coordinates. This is used to frame the map when the iOS and Android app first open. This value is automatically set based on the locations of the Stores in the App.	[optional]
googleMapsApiKeyWeb	String	Key to be passed with Google Maps requests	[optional]
orgId	String	Org Id	[optional]
smsRestaurantName	String	SMS Restaurant Name	[optional]
webToAppRedirect	WebToAppRedirectEnum	Web to App Redirect settings	[optional]
name	String	App name. This is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.	[optional]
hostName	String	HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.	[optional]
mainColor	String	Main color of the web / Android / iOS applications	[optional]
kioskPrimaryColour	String	Primary colour used on the Kiosk	[optional]
applicationCategory	ApplicationCategoryEnum	Application Category	[optional]
isPanaceaEnabled	Boolean	Panacea is the term used for websites that are hosted on the my.flipdish.com domain. This value is true when the App's website is hosted on this domain. The alternative to using Panacea websites is to use a custom domain.	[optional]
panaceaVanityUrl	String	In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}	[optional]
cookieConsentPromptEnabled	Boolean	Cookie Consent Prompt Enabled	[optional]
countryId	String	Country identifier in ISO 3166-1 alpha-2 format. This code is set automatically based on the locations of the Stores in the App. The App Country is used - to determine how to parse mobile phone numbers that are entered in their local numbering format - to determine if country specific payment methods should be offered - in various fraud checks	[optional]

Enum: AppAccessLevelEnum

Name	Value
NONE	"None"
OWNER	"Owner"
STOREOWNER	"StoreOwner"
PROPERTYOWNER	"PropertyOwner"
MANAGEDOWNER	"ManagedOwner"
INTEGRATOR	"Integrator"
PROPERTYMANAGER	"PropertyManager"
STOREMANAGER	"StoreManager"
STORESTAFF	"StoreStaff"
STOREREADONLYACCESS	"StoreReadOnlyAccess"
FINANCEMANGER	"FinanceManger"
ONBOARDING	"Onboarding"
SUPPORT	"Support"

Enum: List<AppResourceSetEnum>

Name	Value
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"
ARCHIVESTORES	"ArchiveStores"
PUBLISHSTORES	"PublishStores"
UPDATEPRINTERTERMINALSASSIGN	"UpdatePrinterTerminalsAssign"
UPDATEPRINTERTERMINALSTOGGLE	"UpdatePrinterTerminalsToggle"
EDITSTORENOTIFICATIONS	"EditStoreNotifications"
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"
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"

Enum: WebToAppRedirectEnum

Name	Value
NOREDIRECT	"NoRedirect"
REDIRECTONCE	"RedirectOnce"
REDIRECTALWAYS	"RedirectAlways"
SUGGESTPWA	"SuggestPwa"
FORCEPWA	"ForcePwa"

Enum: ApplicationCategoryEnum

Name	Value
RESTAURANT	"Restaurant"
CAFE	"Cafe"
CONVENIENCE	"Convenience"