{ "openapi": "3.0.3", "info": { "title": "Flipdish API - Apps", "version": "v1.0", "description": "Flipdish Open API v1.0 \u2014 Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.", "contact": { "name": "Flipdish Support", "email": "help@flipdish.com", "url": "https://help.flipdish.com" }, "x-generated-from": "https://api.flipdish.co/swagger/docs/v1.0", "x-last-validated": "2026-06-02" }, "servers": [ { "url": "https://api.flipdish.co", "description": "Flipdish production API" } ], "security": [ { "oauth2": [ "api" ] } ], "tags": [ { "name": "AppStore", "description": "Operations for App Store." }, { "name": "AppStoreConfigurations", "description": "Operations for App Store Configurations." }, { "name": "AppStoreDeveloper", "description": "Operations for App Store Developer." }, { "name": "AppStoreEntitlements", "description": "Operations for App Store Entitlements." }, { "name": "Apps", "description": "Operations for Apps." }, { "name": "Channels", "description": "Operations for Channels." }, { "name": "FirebaseApps", "description": "Operations for Firebase Apps." }, { "name": "MobileApps", "description": "Operations for Mobile Apps." }, { "name": "Website", "description": "Operations for Website." }, { "name": "WhiteLabelBuilds", "description": "Operations for White Label Builds." }, { "name": "WhiteLabelConfig", "description": "Operations for White Label Config." } ], "paths": { "/api/v1.0/apps/{appId}": { "get": { "tags": [ "Apps" ], "operationId": "GetApp", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_App_" }, "examples": { "GetApp200Example": { "summary": "Default GetApp 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "HasIosApp": true, "IosAppStoreUrl": "https://api.flipdish.co/example", "HasAndroidApp": true, "AndroidPlayStoreUrl": "https://api.flipdish.co/example", "DisplayDeliveryRestaurantScreen": true, "LogoImageUrl": "https://api.flipdish.co/example", "Languages": [], "AvailableAppLanguages": [], "AppAccessLevel": "None", "AppResourceSet": [ "ViewApp" ], "Features": [ "string" ], "MapCenter": { "Latitude": 1.0, "Longitude": 1.0 }, "MapNorthEast": { "Latitude": 1.0, "Longitude": 1.0 }, "MapSouthWest": { "Latitude": 1.0, "Longitude": 1.0 }, "GoogleMapsApiKeyWeb": "string", "OrgId": "500123", "SmsRestaurantName": "Example Name", "WebToAppRedirect": "NoRedirect", "Name": "Example Name", "HostName": "Example Name", "MainColor": "string", "KioskPrimaryColour": "string", "ApplicationCategory": "Restaurant", "IsPanaceaEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CookieConsentPromptEnabled": true, "CountryId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApp400Example": { "summary": "Default GetApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApp401Example": { "summary": "Default GetApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApp403Example": { "summary": "Default GetApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApp404Example": { "summary": "Default GetApp 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApp500Example": { "summary": "Default GetApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App", "description": "Get App via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/name": { "get": { "tags": [ "Apps" ], "operationId": "GetAppName", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "GetAppName200Example": { "summary": "Default GetAppName 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppName400Example": { "summary": "Default GetAppName 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppName401Example": { "summary": "Default GetAppName 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppName403Example": { "summary": "Default GetAppName 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppName404Example": { "summary": "Default GetAppName 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppName500Example": { "summary": "Default GetAppName 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Name", "description": "Get App Name via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/name).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/supportedcountries": { "get": { "tags": [ "Apps" ], "operationId": "GetSupportedCountries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_SupportedCountry_" }, "examples": { "GetSupportedCountries200Example": { "summary": "Default GetSupportedCountries 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSupportedCountries400Example": { "summary": "Default GetSupportedCountries 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSupportedCountries401Example": { "summary": "Default GetSupportedCountries 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSupportedCountries403Example": { "summary": "Default GetSupportedCountries 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSupportedCountries500Example": { "summary": "Default GetSupportedCountries 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Supported Countries", "description": "Get Supported Countries via the Flipdish Open API v1.0 (GET /api/v1.0/apps/supportedcountries).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/compliance": { "get": { "tags": [ "Apps" ], "operationId": "GetCompliance", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppCompliance_" }, "examples": { "GetCompliance200Example": { "summary": "Default GetCompliance 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "ComplianceType": "Default", "AllowDisablingOfGdpr": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCompliance400Example": { "summary": "Default GetCompliance 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCompliance401Example": { "summary": "Default GetCompliance 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCompliance403Example": { "summary": "Default GetCompliance 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetCompliance500Example": { "summary": "Default GetCompliance 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Compliance", "description": "Get Compliance via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/compliance).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Apps" ], "operationId": "SetCompliance", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "complianceType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Default", "GdprCompliance" ] }, "description": "The compliance type query parameter.", "example": "Default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppCompliance_" }, "examples": { "SetCompliance200Example": { "summary": "Default SetCompliance 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "ComplianceType": "Default", "AllowDisablingOfGdpr": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCompliance400Example": { "summary": "Default SetCompliance 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCompliance401Example": { "summary": "Default SetCompliance 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCompliance403Example": { "summary": "Default SetCompliance 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetCompliance500Example": { "summary": "Default SetCompliance 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set Compliance", "description": "Set Compliance via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/compliance).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/panacea/url": { "get": { "tags": [ "Apps" ], "operationId": "GetPanaceaVanityUrl", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "GetPanaceaVanityUrl200Example": { "summary": "Default GetPanaceaVanityUrl 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPanaceaVanityUrl400Example": { "summary": "Default GetPanaceaVanityUrl 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPanaceaVanityUrl401Example": { "summary": "Default GetPanaceaVanityUrl 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPanaceaVanityUrl403Example": { "summary": "Default GetPanaceaVanityUrl 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPanaceaVanityUrl404Example": { "summary": "Default GetPanaceaVanityUrl 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPanaceaVanityUrl500Example": { "summary": "Default GetPanaceaVanityUrl 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Panacea Vanity Url", "description": "Get Panacea Vanity Url via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/panacea/url).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Apps" ], "operationId": "SetPanaceaVanityUrl", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "vanityUrl", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The vanity url query parameter.", "example": "https://api.flipdish.co/example" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "SetPanaceaVanityUrl200Example": { "summary": "Default SetPanaceaVanityUrl 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPanaceaVanityUrl400Example": { "summary": "Default SetPanaceaVanityUrl 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPanaceaVanityUrl401Example": { "summary": "Default SetPanaceaVanityUrl 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPanaceaVanityUrl403Example": { "summary": "Default SetPanaceaVanityUrl 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPanaceaVanityUrl404Example": { "summary": "Default SetPanaceaVanityUrl 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetPanaceaVanityUrl500Example": { "summary": "Default SetPanaceaVanityUrl 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set Panacea Vanity Url", "description": "Set Panacea Vanity Url via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/panacea/url).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{whitelabelId}/lookup": { "get": { "tags": [ "Apps" ], "operationId": "LookupByWhitelabelId", "parameters": [ { "name": "whitelabelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The whitelabel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppLookup" }, "examples": { "LookupByWhitelabelId200Example": { "summary": "Default LookupByWhitelabelId 200 response", "x-microcks-default": true, "value": { "AppId": "500123" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookupByWhitelabelId400Example": { "summary": "Default LookupByWhitelabelId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookupByWhitelabelId401Example": { "summary": "Default LookupByWhitelabelId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookupByWhitelabelId403Example": { "summary": "Default LookupByWhitelabelId 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookupByWhitelabelId404Example": { "summary": "Default LookupByWhitelabelId 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "LookupByWhitelabelId500Example": { "summary": "Default LookupByWhitelabelId 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Lookup by Whitelabel Id", "description": "Lookup by Whitelabel Id via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{whitelabelId}/lookup).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/hostnamestatus": { "get": { "tags": [ "Apps" ], "operationId": "GetAppHostnameStatus", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_DnsRecordInformation_" }, "examples": { "GetAppHostnameStatus200Example": { "summary": "Default GetAppHostnameStatus 200 response", "x-microcks-default": true, "value": { "Data": { "IsCNameReady": true, "IsAReady": true, "IsApiCNameReady": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppHostnameStatus400Example": { "summary": "Default GetAppHostnameStatus 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppHostnameStatus401Example": { "summary": "Default GetAppHostnameStatus 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppHostnameStatus403Example": { "summary": "Default GetAppHostnameStatus 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "Either the App Config was not found or there is no hostname associated to it.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppHostnameStatus404Example": { "summary": "Default GetAppHostnameStatus 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppHostnameStatus500Example": { "summary": "Default GetAppHostnameStatus 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Hostname Status", "description": "Get App Hostname Status via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/hostnamestatus).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps": { "get": { "tags": [ "Apps" ], "operationId": "GetApps", "parameters": [ { "name": "nameFilter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The name filter query parameter.", "example": "Example Name" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page query parameter.", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The limit query parameter.", "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_App_" }, "examples": { "GetApps200Example": { "summary": "Default GetApps 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApps400Example": { "summary": "Default GetApps 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApps401Example": { "summary": "Default GetApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApps403Example": { "summary": "Default GetApps 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetApps500Example": { "summary": "Default GetApps 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Apps", "description": "Get Apps via the Flipdish Open API v1.0 (GET /api/v1.0/apps).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Apps" ], "operationId": "CreateApp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppParameters" }, "examples": { "CreateAppRequestExample": { "summary": "Default CreateApp request", "x-microcks-default": true, "value": { "Name": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "CreateApp200Example": { "summary": "Default CreateApp 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateApp400Example": { "summary": "Default CreateApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateApp401Example": { "summary": "Default CreateApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateApp403Example": { "summary": "Default CreateApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateApp500Example": { "summary": "Default CreateApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Create App", "description": "Create App via the Flipdish Open API v1.0 (POST /api/v1.0/apps).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/panacea/url/available": { "get": { "tags": [ "Apps" ], "operationId": "IsPanaceaVanityUrlAvailable", "parameters": [ { "name": "vanityUrl", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The vanity url query parameter.", "example": "https://api.flipdish.co/example" }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "IsPanaceaVanityUrlAvailable200Example": { "summary": "Default IsPanaceaVanityUrlAvailable 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "IsPanaceaVanityUrlAvailable400Example": { "summary": "Default IsPanaceaVanityUrlAvailable 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "IsPanaceaVanityUrlAvailable401Example": { "summary": "Default IsPanaceaVanityUrlAvailable 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "IsPanaceaVanityUrlAvailable403Example": { "summary": "Default IsPanaceaVanityUrlAvailable 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "IsPanaceaVanityUrlAvailable404Example": { "summary": "Default IsPanaceaVanityUrlAvailable 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "IsPanaceaVanityUrlAvailable500Example": { "summary": "Default IsPanaceaVanityUrlAvailable 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Is Panacea Vanity Url Available", "description": "Is Panacea Vanity Url Available via the Flipdish Open API v1.0 (GET /api/v1.0/apps/{appId}/panacea/url/available).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/logo": { "post": { "tags": [ "Apps" ], "operationId": "UploadAppLogo", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppLogo400Example": { "summary": "Default UploadAppLogo 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppLogo401Example": { "summary": "Default UploadAppLogo 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppLogo403Example": { "summary": "Default UploadAppLogo 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppLogo404Example": { "summary": "Default UploadAppLogo 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppLogo500Example": { "summary": "Default UploadAppLogo 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Upload App Logo", "description": "Upload App Logo via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/logo).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/config": { "post": { "tags": [ "Apps" ], "operationId": "SetAppConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppConfigUpdateModel" }, "examples": { "SetAppConfigRequestExample": { "summary": "Default SetAppConfig request", "x-microcks-default": true, "value": { "Name": "Example Name", "HostName": "Example Name", "MainColor": "string", "KioskPrimaryColour": "string", "ApplicationCategory": "Restaurant", "IsPanaceaEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CookieConsentPromptEnabled": true, "LogoImageUrl": "https://api.flipdish.co/example", "CountryId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_App_" }, "examples": { "SetAppConfig200Example": { "summary": "Default SetAppConfig 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "HasIosApp": true, "IosAppStoreUrl": "https://api.flipdish.co/example", "HasAndroidApp": true, "AndroidPlayStoreUrl": "https://api.flipdish.co/example", "DisplayDeliveryRestaurantScreen": true, "LogoImageUrl": "https://api.flipdish.co/example", "Languages": [], "AvailableAppLanguages": [], "AppAccessLevel": "None", "AppResourceSet": [ "ViewApp" ], "Features": [ "string" ], "MapCenter": { "Latitude": 1.0, "Longitude": 1.0 }, "MapNorthEast": { "Latitude": 1.0, "Longitude": 1.0 }, "MapSouthWest": { "Latitude": 1.0, "Longitude": 1.0 }, "GoogleMapsApiKeyWeb": "string", "OrgId": "500123", "SmsRestaurantName": "Example Name", "WebToAppRedirect": "NoRedirect", "Name": "Example Name", "HostName": "Example Name", "MainColor": "string", "KioskPrimaryColour": "string", "ApplicationCategory": "Restaurant", "IsPanaceaEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CookieConsentPromptEnabled": true, "CountryId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppConfig400Example": { "summary": "Default SetAppConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppConfig401Example": { "summary": "Default SetAppConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppConfig403Example": { "summary": "Default SetAppConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppConfig404Example": { "summary": "Default SetAppConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppConfig500Example": { "summary": "Default SetAppConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set App Config", "description": "Set App Config via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/config).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/appstorename": { "post": { "tags": [ "Apps" ], "operationId": "SetAppStoreName", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppStoreName400Example": { "summary": "Default SetAppStoreName 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppStoreName401Example": { "summary": "Default SetAppStoreName 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppStoreName403Example": { "summary": "Default SetAppStoreName 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppStoreName404Example": { "summary": "Default SetAppStoreName 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppStoreName500Example": { "summary": "Default SetAppStoreName 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set App Store Name", "description": "Set App Store Name via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/appstorename).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/orgId/{orgId}": { "post": { "tags": [ "Apps" ], "operationId": "Apps_SetPropertyId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The org id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Apps_SetPropertyId200Example": { "summary": "Default Apps_SetPropertyId 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Apps_SetPropertyId400Example": { "summary": "Default Apps_SetPropertyId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Apps_SetPropertyId401Example": { "summary": "Default Apps_SetPropertyId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Apps_SetPropertyId403Example": { "summary": "Default Apps_SetPropertyId 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Apps_SetPropertyId500Example": { "summary": "Default Apps_SetPropertyId 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Apps_Set Property Id", "description": "Apps_Set Property Id via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/orgId/{orgId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/config/languages": { "post": { "tags": [ "Apps" ], "operationId": "SetAppLanguages", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "examples": { "SetAppLanguagesRequestExample": { "summary": "Default SetAppLanguages request", "x-microcks-default": true, "value": [ { "LanguageId": "500123", "DisplayOrder": 1, "Name": "Example Name", "Enabled": true } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_App_" }, "examples": { "SetAppLanguages200Example": { "summary": "Default SetAppLanguages 200 response", "x-microcks-default": true, "value": { "Data": { "AppId": "500123", "HasIosApp": true, "IosAppStoreUrl": "https://api.flipdish.co/example", "HasAndroidApp": true, "AndroidPlayStoreUrl": "https://api.flipdish.co/example", "DisplayDeliveryRestaurantScreen": true, "LogoImageUrl": "https://api.flipdish.co/example", "Languages": [], "AvailableAppLanguages": [], "AppAccessLevel": "None", "AppResourceSet": [ "ViewApp" ], "Features": [ "string" ], "MapCenter": { "Latitude": 1.0, "Longitude": 1.0 }, "MapNorthEast": { "Latitude": 1.0, "Longitude": 1.0 }, "MapSouthWest": { "Latitude": 1.0, "Longitude": 1.0 }, "GoogleMapsApiKeyWeb": "string", "OrgId": "500123", "SmsRestaurantName": "Example Name", "WebToAppRedirect": "NoRedirect", "Name": "Example Name", "HostName": "Example Name", "MainColor": "string", "KioskPrimaryColour": "string", "ApplicationCategory": "Restaurant", "IsPanaceaEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CookieConsentPromptEnabled": true, "CountryId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppLanguages400Example": { "summary": "Default SetAppLanguages 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppLanguages401Example": { "summary": "Default SetAppLanguages 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppLanguages403Example": { "summary": "Default SetAppLanguages 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppLanguages404Example": { "summary": "Default SetAppLanguages 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppLanguages500Example": { "summary": "Default SetAppLanguages 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set App Languages", "description": "Set App Languages via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/config/languages).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/SendPushNotification/{customerId}": { "post": { "tags": [ "Apps" ], "operationId": "SendPushNotification", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The customer id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPushNotification400Example": { "summary": "Default SendPushNotification 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPushNotification401Example": { "summary": "Default SendPushNotification 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPushNotification403Example": { "summary": "Default SendPushNotification 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPushNotification404Example": { "summary": "Default SendPushNotification 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SendPushNotification500Example": { "summary": "Default SendPushNotification 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Send Push Notification", "description": "Send Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/SendPushNotification/{customerId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/third-party-integrations": { "post": { "tags": [ "Apps" ], "operationId": "SetThirdPartyIntegrations", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "enabled", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "The enabled query parameter.", "example": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetThirdPartyIntegrations400Example": { "summary": "Default SetThirdPartyIntegrations 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetThirdPartyIntegrations401Example": { "summary": "Default SetThirdPartyIntegrations 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetThirdPartyIntegrations403Example": { "summary": "Default SetThirdPartyIntegrations 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetThirdPartyIntegrations404Example": { "summary": "Default SetThirdPartyIntegrations 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetThirdPartyIntegrations500Example": { "summary": "Default SetThirdPartyIntegrations 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set Third Party Integrations", "description": "Set Third Party Integrations via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/third-party-integrations).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/hostname": { "post": { "tags": [ "Apps" ], "operationId": "SetAppHostname", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "hostname", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The hostname query parameter.", "example": "Example Name" }, { "name": "isEmbed", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The is embed query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "SetAppHostname200Example": { "summary": "Default SetAppHostname 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppHostname400Example": { "summary": "Default SetAppHostname 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppHostname401Example": { "summary": "Default SetAppHostname 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppHostname403Example": { "summary": "Default SetAppHostname 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppHostname404Example": { "summary": "Default SetAppHostname 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetAppHostname500Example": { "summary": "Default SetAppHostname 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set App Hostname", "description": "Set App Hostname via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/hostname).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/apps/{appId}/nextgenweb": { "post": { "tags": [ "Apps" ], "operationId": "ToggleNextGenWeb", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "hostname", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The hostname query parameter.", "example": "Example Name" }, { "name": "vanityUrl", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The vanity url query parameter.", "example": "https://api.flipdish.co/example" }, { "name": "isNextGenWeb", "in": "query", "required": true, "schema": { "type": "boolean" }, "description": "The is next gen web query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "ToggleNextGenWeb200Example": { "summary": "Default ToggleNextGenWeb 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ToggleNextGenWeb400Example": { "summary": "Default ToggleNextGenWeb 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ToggleNextGenWeb401Example": { "summary": "Default ToggleNextGenWeb 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ToggleNextGenWeb403Example": { "summary": "Default ToggleNextGenWeb 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ToggleNextGenWeb404Example": { "summary": "Default ToggleNextGenWeb 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ToggleNextGenWeb500Example": { "summary": "Default ToggleNextGenWeb 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Toggle Next Gen Web", "description": "Toggle Next Gen Web via the Flipdish Open API v1.0 (POST /api/v1.0/apps/{appId}/nextgenweb).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/appstore/apps/{appStoreAppId}": { "get": { "tags": [ "AppStore" ], "operationId": "GetAppStoreApp", "parameters": [ { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The app id query parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreApp_" }, "examples": { "GetAppStoreApp200Example": { "summary": "Default GetAppStoreApp 200 response", "x-microcks-default": true, "value": { "Data": { "Id": "500123", "VerificationStatus": "Draft", "Logo": "string", "OAuthAppId": "500123", "Internal": true, "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "IsEnabled": true, "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApp400Example": { "summary": "Default GetAppStoreApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApp401Example": { "summary": "Default GetAppStoreApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApp403Example": { "summary": "Default GetAppStoreApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApp404Example": { "summary": "Default GetAppStoreApp 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApp500Example": { "summary": "Default GetAppStoreApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Store App", "description": "Get App Store App via the Flipdish Open API v1.0 (GET /api/v1.0/appstore/apps/{appStoreAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/appstore/apps": { "get": { "tags": [ "AppStore" ], "operationId": "GetAppStoreApps", "parameters": [ { "name": "search", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The search query parameter.", "example": "string" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The page query parameter.", "example": 1 }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" }, "description": "The limit query parameter.", "example": 1 }, { "name": "excludeNotOwned", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The exclude not owned query parameter.", "example": true }, { "name": "showOnlyVerified", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The show only verified query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaginationResult_AppStoreAppSummary_" }, "examples": { "GetAppStoreApps200Example": { "summary": "Default GetAppStoreApps 200 response", "x-microcks-default": true, "value": { "Page": 1, "Limit": 1, "TotalRecordCount": 12.5, "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApps400Example": { "summary": "Default GetAppStoreApps 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApps401Example": { "summary": "Default GetAppStoreApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApps403Example": { "summary": "Default GetAppStoreApps 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreApps500Example": { "summary": "Default GetAppStoreApps 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Store Apps", "description": "Get App Store Apps via the Flipdish Open API v1.0 (GET /api/v1.0/appstore/apps).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps": { "get": { "tags": [ "AppStoreConfigurations" ], "operationId": "GetConfiguredApps", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_AppStoreAppSummary_" }, "examples": { "GetConfiguredApps200Example": { "summary": "Default GetConfiguredApps 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredApps400Example": { "summary": "Default GetConfiguredApps 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredApps401Example": { "summary": "Default GetConfiguredApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredApps403Example": { "summary": "Default GetConfiguredApps 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredApps500Example": { "summary": "Default GetConfiguredApps 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Configured Apps", "description": "Get Configured Apps via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/appstore/apps).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}": { "get": { "tags": [ "AppStoreConfigurations" ], "operationId": "GetConfiguredAppSingleApp", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_AppStoreAppConfigurationSummary_" }, "examples": { "GetConfiguredAppSingleApp200Example": { "summary": "Default GetConfiguredAppSingleApp 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredAppSingleApp400Example": { "summary": "Default GetConfiguredAppSingleApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredAppSingleApp401Example": { "summary": "Default GetConfiguredAppSingleApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredAppSingleApp403Example": { "summary": "Default GetConfiguredAppSingleApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredAppSingleApp404Example": { "summary": "Default GetConfiguredAppSingleApp 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetConfiguredAppSingleApp500Example": { "summary": "Default GetConfiguredAppSingleApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Configured App Single App", "description": "Get Configured App Single App via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/appstore/apps/{appStoreAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/appstore/oauthresponse/{appStoreAppId}/responsecode": { "get": { "tags": [ "AppStoreConfigurations" ], "operationId": "AppStoreConfigurations_AppStoreHandleOauthResponseCode", "parameters": [ { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AppStoreConfigurations_AppStoreHandleOauthResponseCode200Example": { "summary": "Default AppStoreConfigurations_AppStoreHandleOauthResponseCode 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppStoreConfigurations_AppStoreHandleOauthResponseCode400Example": { "summary": "Default AppStoreConfigurations_AppStoreHandleOauthResponseCode 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppStoreConfigurations_AppStoreHandleOauthResponseCode401Example": { "summary": "Default AppStoreConfigurations_AppStoreHandleOauthResponseCode 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppStoreConfigurations_AppStoreHandleOauthResponseCode403Example": { "summary": "Default AppStoreConfigurations_AppStoreHandleOauthResponseCode 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppStoreConfigurations_AppStoreHandleOauthResponseCode500Example": { "summary": "Default AppStoreConfigurations_AppStoreHandleOauthResponseCode 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish App Store Configurations_App Store Handle Oauth Response Code", "description": "App Store Configurations_App Store Handle Oauth Response Code via the Flipdish Open API v1.0 (GET /api/v1.0/appstore/oauthresponse/{appStoreAppId}/responsecode).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}": { "get": { "tags": [ "AppStoreConfigurations" ], "operationId": "GetAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The config id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreAppConfiguration_" }, "examples": { "GetAppStoreConfig200Example": { "summary": "Default GetAppStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "Id": "500123", "AppId": "500123", "AppStoreAppId": "500123", "IsEnabled": true, "StoreIds": [ 1 ], "Settings": [], "VerificationStatus": "Draft", "Logo": "string", "OAuthAppId": "500123", "Internal": true, "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig400Example": { "summary": "Default GetAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig401Example": { "summary": "Default GetAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig403Example": { "summary": "Default GetAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig404Example": { "summary": "Default GetAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig500Example": { "summary": "Default GetAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Store Config", "description": "Get App Store Config via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "AppStoreConfigurations" ], "operationId": "UpdateAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The config id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppStoreAppConfiguration" }, "examples": { "UpdateAppStoreConfigRequestExample": { "summary": "Default UpdateAppStoreConfig request", "x-microcks-default": true, "value": { "IsEnabled": true, "StoreIds": [ 1 ], "Settings": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig400Example": { "summary": "Default UpdateAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig401Example": { "summary": "Default UpdateAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig403Example": { "summary": "Default UpdateAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig404Example": { "summary": "Default UpdateAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig500Example": { "summary": "Default UpdateAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App Store Config", "description": "Update App Store Config via the Flipdish Open API v1.0 (PUT /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "AppStoreConfigurations" ], "operationId": "DeleteAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The config id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "DeleteAppStoreConfig200Example": { "summary": "Default DeleteAppStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreConfig400Example": { "summary": "Default DeleteAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreConfig401Example": { "summary": "Default DeleteAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreConfig403Example": { "summary": "Default DeleteAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreConfig404Example": { "summary": "Default DeleteAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreConfig500Example": { "summary": "Default DeleteAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Delete App Store Config", "description": "Delete App Store Config via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config": { "post": { "tags": [ "AppStoreConfigurations" ], "operationId": "CreateAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreAppConfiguration_" }, "examples": { "CreateAppStoreConfig200Example": { "summary": "Default CreateAppStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "Id": "500123", "AppId": "500123", "AppStoreAppId": "500123", "IsEnabled": true, "StoreIds": [ 1 ], "Settings": [], "VerificationStatus": "Draft", "Logo": "string", "OAuthAppId": "500123", "Internal": true, "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreConfig400Example": { "summary": "Default CreateAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreConfig401Example": { "summary": "Default CreateAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreConfig403Example": { "summary": "Default CreateAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreConfig404Example": { "summary": "Default CreateAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreConfig500Example": { "summary": "Default CreateAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Create App Store Config", "description": "Create App Store Config via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/action": { "post": { "tags": [ "AppStoreConfigurations" ], "operationId": "ExecuteConfigurationAction", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The config id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteConfigurationActionRequest" }, "examples": { "ExecuteConfigurationActionRequestExample": { "summary": "Default ExecuteConfigurationAction request", "x-microcks-default": true, "value": { "Key": "string", "Action": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_ExecuteConfigurationActionResult_" }, "examples": { "ExecuteConfigurationAction200Example": { "summary": "Default ExecuteConfigurationAction 200 response", "x-microcks-default": true, "value": { "Data": { "ErrorMessage": "string", "InfoMessage": "string", "RedirectUrl": "https://api.flipdish.co/example", "RedirectTarget": "Default" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ExecuteConfigurationAction400Example": { "summary": "Default ExecuteConfigurationAction 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ExecuteConfigurationAction401Example": { "summary": "Default ExecuteConfigurationAction 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ExecuteConfigurationAction403Example": { "summary": "Default ExecuteConfigurationAction 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "ExecuteConfigurationAction500Example": { "summary": "Default ExecuteConfigurationAction 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Execute Configuration Action", "description": "Execute Configuration Action via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/action).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/updatesettings": { "post": { "tags": [ "AppStoreConfigurations" ], "operationId": "UpdateAppStoreConfigSettingValues", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "configId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The config id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppStoreAppConfigurationValuesBatch" }, "examples": { "UpdateAppStoreConfigSettingValuesRequestExample": { "summary": "Default UpdateAppStoreConfigSettingValues request", "x-microcks-default": true, "value": { "Settings": [] } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfigSettingValues400Example": { "summary": "Default UpdateAppStoreConfigSettingValues 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfigSettingValues401Example": { "summary": "Default UpdateAppStoreConfigSettingValues 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfigSettingValues403Example": { "summary": "Default UpdateAppStoreConfigSettingValues 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfigSettingValues404Example": { "summary": "Default UpdateAppStoreConfigSettingValues 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfigSettingValues500Example": { "summary": "Default UpdateAppStoreConfigSettingValues 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App Store Config Setting Values", "description": "Update App Store Config Setting Values via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/config/{configId}/updatesettings).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product": { "get": { "tags": [ "AppStoreDeveloper" ], "operationId": "GetAppExternalProduct", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppExternalProduct400Example": { "summary": "Default GetAppExternalProduct 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppExternalProduct401Example": { "summary": "Default GetAppExternalProduct 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppExternalProduct403Example": { "summary": "Default GetAppExternalProduct 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppExternalProduct404Example": { "summary": "Default GetAppExternalProduct 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppExternalProduct500Example": { "summary": "Default GetAppExternalProduct 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App External Product", "description": "Get App External Product via the Flipdish Open API v1.0 (GET /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "put": { "tags": [ "AppStoreDeveloper" ], "operationId": "UpdateExternalProduct", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppStoreAppExternalProduct" }, "examples": { "UpdateExternalProductRequestExample": { "summary": "Default UpdateExternalProduct request", "x-microcks-default": true, "value": { "ExternalProductId": "500123" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateExternalProduct400Example": { "summary": "Default UpdateExternalProduct 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateExternalProduct401Example": { "summary": "Default UpdateExternalProduct 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateExternalProduct403Example": { "summary": "Default UpdateExternalProduct 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateExternalProduct404Example": { "summary": "Default UpdateExternalProduct 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateExternalProduct500Example": { "summary": "Default UpdateExternalProduct 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update External Product", "description": "Update External Product via the Flipdish Open API v1.0 (PUT /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_product).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_function_signing_key": { "get": { "tags": [ "AppStoreDeveloper" ], "operationId": "GetExternalFunctionSigningKey", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "GetExternalFunctionSigningKey200Example": { "summary": "Default GetExternalFunctionSigningKey 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetExternalFunctionSigningKey400Example": { "summary": "Default GetExternalFunctionSigningKey 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetExternalFunctionSigningKey401Example": { "summary": "Default GetExternalFunctionSigningKey 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetExternalFunctionSigningKey403Example": { "summary": "Default GetExternalFunctionSigningKey 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetExternalFunctionSigningKey404Example": { "summary": "Default GetExternalFunctionSigningKey 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetExternalFunctionSigningKey500Example": { "summary": "Default GetExternalFunctionSigningKey 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get External Function Signing Key", "description": "Get External Function Signing Key via the Flipdish Open API v1.0 (GET /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/external_function_signing_key).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}": { "put": { "tags": [ "AppStoreDeveloper" ], "operationId": "UpdateAppStoreApp", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppStoreApp" }, "examples": { "UpdateAppStoreAppRequestExample": { "summary": "Default UpdateAppStoreApp request", "x-microcks-default": true, "value": { "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "IsEnabled": true, "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreApp400Example": { "summary": "Default UpdateAppStoreApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreApp401Example": { "summary": "Default UpdateAppStoreApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreApp403Example": { "summary": "Default UpdateAppStoreApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreApp404Example": { "summary": "Default UpdateAppStoreApp 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreApp500Example": { "summary": "Default UpdateAppStoreApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App Store App", "description": "Update App Store App via the Flipdish Open API v1.0 (PUT /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "AppStoreDeveloper" ], "operationId": "DeleteAppStoreApp", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiStringResult" }, "examples": { "DeleteAppStoreApp200Example": { "summary": "Default DeleteAppStoreApp 200 response", "x-microcks-default": true, "value": { "Data": "string" } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreApp400Example": { "summary": "Default DeleteAppStoreApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreApp401Example": { "summary": "Default DeleteAppStoreApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreApp403Example": { "summary": "Default DeleteAppStoreApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreApp404Example": { "summary": "Default DeleteAppStoreApp 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteAppStoreApp500Example": { "summary": "Default DeleteAppStoreApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Delete App Store App", "description": "Delete App Store App via the Flipdish Open API v1.0 (DELETE /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/verification": { "put": { "tags": [ "AppStoreDeveloper" ], "operationId": "AppVerificationUpdate", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" }, { "name": "verificationStatus", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "Draft", "Submitted", "Verified" ] }, "description": "The verification status query parameter.", "example": "Draft" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppVerificationUpdate400Example": { "summary": "Default AppVerificationUpdate 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppVerificationUpdate401Example": { "summary": "Default AppVerificationUpdate 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppVerificationUpdate403Example": { "summary": "Default AppVerificationUpdate 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppVerificationUpdate404Example": { "summary": "Default AppVerificationUpdate 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AppVerificationUpdate500Example": { "summary": "Default AppVerificationUpdate 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish App Verification Update", "description": "App Verification Update via the Flipdish Open API v1.0 (PUT /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/verification).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps": { "post": { "tags": [ "AppStoreDeveloper" ], "operationId": "CreateAppStoreApp", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppStoreApp" }, "examples": { "CreateAppStoreAppRequestExample": { "summary": "Default CreateAppStoreApp request", "x-microcks-default": true, "value": { "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "IsEnabled": true, "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreApp_" }, "examples": { "CreateAppStoreApp200Example": { "summary": "Default CreateAppStoreApp 200 response", "x-microcks-default": true, "value": { "Data": { "Id": "500123", "VerificationStatus": "Draft", "Logo": "string", "OAuthAppId": "500123", "Internal": true, "Details": "string", "ConfigurationType": "ExternalLink", "StoreSelectorType": "None", "FieldGroups": [], "SetupInstructions": "string", "ExternalSetupLink": "https://api.flipdish.co/example", "TeammateAppAccessLevel": "Owner", "PermissionsType": "Teammate", "Support": { "PrivacyPolicy": "string", "TermsOfUse": "string", "CompanyWebsite": "string", "LearnMore": "string", "InstallationMessage": "string", "SupportEmail": "owner@example.com" }, "ExternalFunctionActionUrl": "https://api.flipdish.co/example", "ExternalFunctionSignatureKey": "string", "IsPaid": true, "Name": "Example Name", "Description": "string", "IsEnabled": true, "Categories": [ "PointOfSale" ], "Countries": [ "GB" ], "DeveloperName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreApp400Example": { "summary": "Default CreateAppStoreApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreApp401Example": { "summary": "Default CreateAppStoreApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreApp403Example": { "summary": "Default CreateAppStoreApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "CreateAppStoreApp500Example": { "summary": "Default CreateAppStoreApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Create App Store App", "description": "Create App Store App via the Flipdish Open API v1.0 (POST /api/v1.0/oauthclients/{oauthAppId}/appstore/apps).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/logo": { "post": { "tags": [ "AppStoreDeveloper" ], "operationId": "UploadAppStoreAppLogo", "parameters": [ { "name": "oauthAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The oauth app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Image": { "description": "App Store App Logo", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadAppStoreAppLogoRequestExample": { "summary": "Default UploadAppStoreAppLogo request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreAppLogo400Example": { "summary": "Default UploadAppStoreAppLogo 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreAppLogo401Example": { "summary": "Default UploadAppStoreAppLogo 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreAppLogo403Example": { "summary": "Default UploadAppStoreAppLogo 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreAppLogo404Example": { "summary": "Default UploadAppStoreAppLogo 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreAppLogo500Example": { "summary": "Default UploadAppStoreAppLogo 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Upload App Store App Logo", "description": "Upload App Store App Logo via the Flipdish Open API v1.0 (POST /api/v1.0/oauthclients/{oauthAppId}/appstore/apps/{appStoreAppId}/logo).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlements": { "get": { "tags": [ "AppStoreEntitlements" ], "operationId": "GetAppStoreAppEntitlements", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "appStoreAppId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app store app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreAppEntitlements_" }, "examples": { "GetAppStoreAppEntitlements200Example": { "summary": "Default GetAppStoreAppEntitlements 200 response", "x-microcks-default": true, "value": { "Data": { "EntitlementQuantity": 3, "CurrentUsage": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreAppEntitlements400Example": { "summary": "Default GetAppStoreAppEntitlements 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreAppEntitlements401Example": { "summary": "Default GetAppStoreAppEntitlements 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreAppEntitlements403Example": { "summary": "Default GetAppStoreAppEntitlements 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreAppEntitlements404Example": { "summary": "Default GetAppStoreAppEntitlements 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreAppEntitlements500Example": { "summary": "Default GetAppStoreAppEntitlements 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Store App Entitlements", "description": "Get App Store App Entitlements via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/appstore/apps/{appStoreAppId}/entitlements).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels": { "get": { "tags": [ "Channels" ], "operationId": "GetChannels", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "List of enabled Channels", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Channel_" }, "examples": { "GetChannels200Example": { "summary": "Default GetChannels 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannels400Example": { "summary": "Default GetChannels 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannels401Example": { "summary": "Default GetChannels 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannels403Example": { "summary": "Default GetChannels 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannels500Example": { "summary": "Default GetChannels 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Channels", "description": "Get Channels via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/{id}": { "get": { "tags": [ "Channels" ], "operationId": "GetChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The id path parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "A representation of a Channel object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_Channel_" }, "examples": { "GetChannel200Example": { "summary": "Default GetChannel 200 response", "x-microcks-default": true, "value": { "Data": { "ChannelId": 500123, "TranslationKey": "string", "Source": "Internal", "LogoUri": "https://api.flipdish.co/example", "Available": true, "MaintainedExternally": true } } } } } } }, "400": { "description": "Data not found with the given ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannel400Example": { "summary": "Default GetChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannel401Example": { "summary": "Default GetChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannel403Example": { "summary": "Default GetChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "Data not found with the given ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannel404Example": { "summary": "Default GetChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Unidentified error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetChannel500Example": { "summary": "Default GetChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Channel", "description": "Get Channel via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels/{id}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/assigned-channels": { "get": { "tags": [ "Channels" ], "operationId": "GetAssignedChannels", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Channel_" }, "examples": { "GetAssignedChannels200Example": { "summary": "Default GetAssignedChannels 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "AppId information was not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAssignedChannels400Example": { "summary": "Default GetAssignedChannels 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAssignedChannels401Example": { "summary": "Default GetAssignedChannels 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAssignedChannels403Example": { "summary": "Default GetAssignedChannels 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Unidentified error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAssignedChannels500Example": { "summary": "Default GetAssignedChannels 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Assigned Channels", "description": "Get Assigned Channels via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels/assigned-channels).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/available-channels": { "get": { "tags": [ "Channels" ], "operationId": "GetAvailableChannels", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "The lisf of available channels for that AppId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_Channel_" }, "examples": { "GetAvailableChannels200Example": { "summary": "Default GetAvailableChannels 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "AppId information was not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAvailableChannels400Example": { "summary": "Default GetAvailableChannels 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAvailableChannels401Example": { "summary": "Default GetAvailableChannels 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAvailableChannels403Example": { "summary": "Default GetAvailableChannels 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Unidentified error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAvailableChannels500Example": { "summary": "Default GetAvailableChannels 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Available Channels", "description": "Get Available Channels via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels/available-channels).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/{channelId}/stores": { "get": { "tags": [ "Channels" ], "operationId": "GetStoresBySalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" }, "examples": { "GetStoresBySalesChannel200Example": { "summary": "Default GetStoresBySalesChannel 200 response", "x-microcks-default": true, "value": { "Stores": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresBySalesChannel400Example": { "summary": "Default GetStoresBySalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresBySalesChannel401Example": { "summary": "Default GetStoresBySalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresBySalesChannel403Example": { "summary": "Default GetStoresBySalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresBySalesChannel500Example": { "summary": "Default GetStoresBySalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Stores by Sales Channel", "description": "Get Stores by Sales Channel via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels/{channelId}/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Channels" ], "operationId": "DetachAllStoresFromSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DetachAllStoresFromSalesChannel200Example": { "summary": "Default DetachAllStoresFromSalesChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachAllStoresFromSalesChannel400Example": { "summary": "Default DetachAllStoresFromSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachAllStoresFromSalesChannel401Example": { "summary": "Default DetachAllStoresFromSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachAllStoresFromSalesChannel403Example": { "summary": "Default DetachAllStoresFromSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachAllStoresFromSalesChannel500Example": { "summary": "Default DetachAllStoresFromSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Detach All Stores from Sales Channel", "description": "Detach All Stores from Sales Channel via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/channels/{channelId}/stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/{channelId}/assigned-stores": { "get": { "tags": [ "Channels" ], "operationId": "GetStoresAssignedToChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_StoreChannelAssignment_" }, "examples": { "GetStoresAssignedToChannel200Example": { "summary": "Default GetStoresAssignedToChannel 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresAssignedToChannel400Example": { "summary": "Default GetStoresAssignedToChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresAssignedToChannel401Example": { "summary": "Default GetStoresAssignedToChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresAssignedToChannel403Example": { "summary": "Default GetStoresAssignedToChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStoresAssignedToChannel500Example": { "summary": "Default GetStoresAssignedToChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "deprecated": true, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Stores Assigned to Channel", "description": "Get Stores Assigned to Channel via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/channels/{channelId}/assigned-stores).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/{channelId}/assign-appId": { "post": { "tags": [ "Channels" ], "operationId": "AssignAppIdToSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AssignAppIdToSalesChannel200Example": { "summary": "Default AssignAppIdToSalesChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppChannelAssignment_" }, "examples": { "AssignAppIdToSalesChannel201Example": { "summary": "Default AssignAppIdToSalesChannel 201 response", "x-microcks-default": true, "value": { "Data": { "ChannelId": 500123, "AppId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignAppIdToSalesChannel400Example": { "summary": "Default AssignAppIdToSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignAppIdToSalesChannel401Example": { "summary": "Default AssignAppIdToSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignAppIdToSalesChannel403Example": { "summary": "Default AssignAppIdToSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignAppIdToSalesChannel404Example": { "summary": "Default AssignAppIdToSalesChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignAppIdToSalesChannel500Example": { "summary": "Default AssignAppIdToSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Assign App Id to Sales Channel", "description": "Assign App Id to Sales Channel via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/channels/{channelId}/assign-appId).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/{channelId}/stores/{storeId}": { "post": { "tags": [ "Channels" ], "operationId": "AttachStoreToSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AttachStoreToSalesChannel200Example": { "summary": "Default AttachStoreToSalesChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToSalesChannel400Example": { "summary": "Default AttachStoreToSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToSalesChannel401Example": { "summary": "Default AttachStoreToSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToSalesChannel403Example": { "summary": "Default AttachStoreToSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AttachStoreToSalesChannel500Example": { "summary": "Default AttachStoreToSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Attach Store to Sales Channel", "description": "Attach Store to Sales Channel via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/channels/{channelId}/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Channels" ], "operationId": "DetachStoreFromSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id path parameter.", "example": 500123 }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DetachStoreFromSalesChannel200Example": { "summary": "Default DetachStoreFromSalesChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachStoreFromSalesChannel400Example": { "summary": "Default DetachStoreFromSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachStoreFromSalesChannel401Example": { "summary": "Default DetachStoreFromSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachStoreFromSalesChannel403Example": { "summary": "Default DetachStoreFromSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DetachStoreFromSalesChannel500Example": { "summary": "Default DetachStoreFromSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Detach Store from Sales Channel", "description": "Detach Store from Sales Channel via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/channels/{channelId}/stores/{storeId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/assign-store": { "post": { "tags": [ "Channels" ], "operationId": "AssignStoreToChannel", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "AssignStoreToChannel200Example": { "summary": "Default AssignStoreToChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_StoreChannelAssignment_" }, "examples": { "AssignStoreToChannel201Example": { "summary": "Default AssignStoreToChannel 201 response", "x-microcks-default": true, "value": { "Data": { "ChannelId": 500123, "StoreId": 500123, "StoreName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoreToChannel400Example": { "summary": "Default AssignStoreToChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoreToChannel401Example": { "summary": "Default AssignStoreToChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoreToChannel403Example": { "summary": "Default AssignStoreToChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoreToChannel404Example": { "summary": "Default AssignStoreToChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AssignStoreToChannel500Example": { "summary": "Default AssignStoreToChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "deprecated": true, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Assign Store to Channel", "description": "Assign Store to Channel via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/channels/assign-store).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/channels/unassign-store": { "delete": { "tags": [ "Channels" ], "operationId": "UnassignStoreFromChannel", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The store id query parameter.", "example": 500123 }, { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "channelId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The channel id query parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "UnassignStoreFromChannel200Example": { "summary": "Default UnassignStoreFromChannel 200 response", "x-microcks-default": true, "value": {} } } } } }, "204": { "description": "NoContent" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignStoreFromChannel400Example": { "summary": "Default UnassignStoreFromChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignStoreFromChannel401Example": { "summary": "Default UnassignStoreFromChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignStoreFromChannel403Example": { "summary": "Default UnassignStoreFromChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignStoreFromChannel404Example": { "summary": "Default UnassignStoreFromChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UnassignStoreFromChannel500Example": { "summary": "Default UnassignStoreFromChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "deprecated": true, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Unassign Store from Channel", "description": "Unassign Store from Channel via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/channels/unassign-store).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/FirebaseApp/{whitelabelId}": { "get": { "tags": [ "FirebaseApps" ], "operationId": "FirebaseApps_GetFirebaseApp", "parameters": [ { "name": "whitelabelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The whitelabel id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FirebaseApps_GetFirebaseApp200Example": { "summary": "Default FirebaseApps_GetFirebaseApp 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_GetFirebaseApp400Example": { "summary": "Default FirebaseApps_GetFirebaseApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_GetFirebaseApp401Example": { "summary": "Default FirebaseApps_GetFirebaseApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_GetFirebaseApp403Example": { "summary": "Default FirebaseApps_GetFirebaseApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_GetFirebaseApp500Example": { "summary": "Default FirebaseApps_GetFirebaseApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Firebase Apps_Get Firebase App", "description": "Firebase Apps_Get Firebase App via the Flipdish Open API v1.0 (GET /api/v1.0/FirebaseApp/{whitelabelId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/FirebaseApp": { "post": { "tags": [ "FirebaseApps" ], "operationId": "FirebaseApps_AddFirebaseApp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirebaseApp" }, "examples": { "FirebaseApps_AddFirebaseAppRequestExample": { "summary": "Default FirebaseApps_AddFirebaseApp request", "x-microcks-default": true, "value": { "WhitelabelId": 500123, "PackageId": "500123", "FirebaseAppId": "500123", "FirebaseProjectId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FirebaseApps_AddFirebaseApp200Example": { "summary": "Default FirebaseApps_AddFirebaseApp 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_AddFirebaseApp400Example": { "summary": "Default FirebaseApps_AddFirebaseApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_AddFirebaseApp401Example": { "summary": "Default FirebaseApps_AddFirebaseApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_AddFirebaseApp403Example": { "summary": "Default FirebaseApps_AddFirebaseApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_AddFirebaseApp500Example": { "summary": "Default FirebaseApps_AddFirebaseApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Firebase Apps_Add Firebase App", "description": "Firebase Apps_Add Firebase App via the Flipdish Open API v1.0 (POST /api/v1.0/FirebaseApp).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/FirebaseApp/{whiteLabelId}": { "delete": { "tags": [ "FirebaseApps" ], "operationId": "FirebaseApps_DeleteFirebaseApp", "parameters": [ { "name": "whiteLabelId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The white label id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "FirebaseApps_DeleteFirebaseApp200Example": { "summary": "Default FirebaseApps_DeleteFirebaseApp 200 response", "x-microcks-default": true, "value": {} } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_DeleteFirebaseApp400Example": { "summary": "Default FirebaseApps_DeleteFirebaseApp 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_DeleteFirebaseApp401Example": { "summary": "Default FirebaseApps_DeleteFirebaseApp 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_DeleteFirebaseApp403Example": { "summary": "Default FirebaseApps_DeleteFirebaseApp 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "FirebaseApps_DeleteFirebaseApp500Example": { "summary": "Default FirebaseApps_DeleteFirebaseApp 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Firebase Apps_Delete Firebase App", "description": "Firebase Apps_Delete Firebase App via the Flipdish Open API v1.0 (DELETE /api/v1.0/FirebaseApp/{whiteLabelId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission/details": { "get": { "tags": [ "MobileApps" ], "operationId": "GetSubmissionDetails", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MobileAppsSubmissionDetails_" }, "examples": { "GetSubmissionDetails200Example": { "summary": "Default GetSubmissionDetails 200 response", "x-microcks-default": true, "value": { "Data": { "MobileAppsSubmissionId": 500123, "AppName": "Example Name", "AppDescription": "string", "AppShortDescription": "string", "Keywords": [ "string" ], "AppLogoUrl": "https://api.flipdish.co/example", "AutoPublish": true, "Status": [] } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionDetails400Example": { "summary": "Default GetSubmissionDetails 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionDetails401Example": { "summary": "Default GetSubmissionDetails 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionDetails403Example": { "summary": "Default GetSubmissionDetails 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionDetails404Example": { "summary": "Default GetSubmissionDetails 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionDetails500Example": { "summary": "Default GetSubmissionDetails 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Submission Details", "description": "Get Submission Details via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/submission/details).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/saleschannel/details": { "get": { "tags": [ "MobileApps" ], "operationId": "GetAppConfigSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppConfigSalesChannel_" }, "examples": { "GetAppConfigSalesChannel200Example": { "summary": "Default GetAppConfigSalesChannel 200 response", "x-microcks-default": true, "value": { "Data": { "EmailRequestMode": "DoNotRequest", "WebToAppRedirect": "NoRedirect", "AddressEntryType": "MapFirst", "DisplayDeliveryRestaurantListScreen": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppConfigSalesChannel400Example": { "summary": "Default GetAppConfigSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppConfigSalesChannel401Example": { "summary": "Default GetAppConfigSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppConfigSalesChannel403Example": { "summary": "Default GetAppConfigSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppConfigSalesChannel404Example": { "summary": "Default GetAppConfigSalesChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppConfigSalesChannel500Example": { "summary": "Default GetAppConfigSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Config Sales Channel", "description": "Get App Config Sales Channel via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/saleschannel/details).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission/{submissionId}/status": { "get": { "tags": [ "MobileApps" ], "operationId": "GetSubmissionStatus", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The submission id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MobileAppsSubmissionStatus_" }, "examples": { "GetSubmissionStatus200Example": { "summary": "Default GetSubmissionStatus 200 response", "x-microcks-default": true, "value": { "Data": { "MobileAppsSubmissionStatusId": 500123, "MobileAppsSubmissionId": 500123, "Type": "None", "AppStatus": "None", "UpdateStatus": "None", "LastUpdateStatusTime": "2026-06-02T12:00:00Z", "CreateTime": "2026-06-02T12:00:00Z", "UpdateTime": "2026-06-02T12:00:00Z", "Notes": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionStatus400Example": { "summary": "Default GetSubmissionStatus 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionStatus401Example": { "summary": "Default GetSubmissionStatus 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionStatus403Example": { "summary": "Default GetSubmissionStatus 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionStatus404Example": { "summary": "Default GetSubmissionStatus 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetSubmissionStatus500Example": { "summary": "Default GetSubmissionStatus 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Submission Status", "description": "Get Submission Status via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/submission/{submissionId}/status).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "MobileApps" ], "operationId": "UpdateSubmissionStatus", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The submission id path parameter.", "example": 500123 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMobileAppsSubmissionStatus" }, "examples": { "UpdateSubmissionStatusRequestExample": { "summary": "Default UpdateSubmissionStatus request", "x-microcks-default": true, "value": { "MobileAppsSubmissionStatusId": 500123, "Type": "None", "AppStatus": "None", "UpdateStatus": "None", "LastUpdateStatusTime": "2026-06-02T12:00:00Z", "Notes": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_UpdateMobileAppsSubmissionStatus_" }, "examples": { "UpdateSubmissionStatus200Example": { "summary": "Default UpdateSubmissionStatus 200 response", "x-microcks-default": true, "value": { "Data": { "MobileAppsSubmissionStatusId": 500123, "Type": "None", "AppStatus": "None", "UpdateStatus": "None", "LastUpdateStatusTime": "2026-06-02T12:00:00Z", "Notes": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateSubmissionStatus400Example": { "summary": "Default UpdateSubmissionStatus 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateSubmissionStatus401Example": { "summary": "Default UpdateSubmissionStatus 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateSubmissionStatus403Example": { "summary": "Default UpdateSubmissionStatus 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateSubmissionStatus404Example": { "summary": "Default UpdateSubmissionStatus 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateSubmissionStatus500Example": { "summary": "Default UpdateSubmissionStatus 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update Submission Status", "description": "Update Submission Status via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission/{submissionId}/status).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/statistics": { "get": { "tags": [ "MobileApps" ], "operationId": "GetStatistics", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "platformTypes", "in": "query", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "None", "Android", "IOS" ] } }, "description": "The platform types query parameter.", "example": [ "None" ] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiArrayResult_MobileAppsStatistics_" }, "examples": { "GetStatistics200Example": { "summary": "Default GetStatistics 200 response", "x-microcks-default": true, "value": { "Data": [] } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStatistics400Example": { "summary": "Default GetStatistics 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStatistics401Example": { "summary": "Default GetStatistics 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStatistics403Example": { "summary": "Default GetStatistics 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStatistics404Example": { "summary": "Default GetStatistics 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetStatistics500Example": { "summary": "Default GetStatistics 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Statistics", "description": "Get Statistics via the Flipdish Open API v1.0 (GET /api/v1.0/mobileapps/{appId}/statistics).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission": { "post": { "tags": [ "MobileApps" ], "operationId": "Submission", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MobileAppsSubmission_" }, "examples": { "Submission200Example": { "summary": "Default Submission 200 response", "x-microcks-default": true, "value": { "Data": { "SubmissionId": 500123, "AppName": "Example Name", "AppDescription": "string", "AppShortDescription": "string", "Keywords": [ "string" ], "AutoPublish": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Submission400Example": { "summary": "Default Submission 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Submission401Example": { "summary": "Default Submission 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Submission403Example": { "summary": "Default Submission 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Submission404Example": { "summary": "Default Submission 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Submission500Example": { "summary": "Default Submission 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Submission", "description": "Submission via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/resubmission": { "post": { "tags": [ "MobileApps" ], "operationId": "Resubmission", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MobileAppsSubmission_" }, "examples": { "Resubmission200Example": { "summary": "Default Resubmission 200 response", "x-microcks-default": true, "value": { "Data": { "SubmissionId": 500123, "AppName": "Example Name", "AppDescription": "string", "AppShortDescription": "string", "Keywords": [ "string" ], "AutoPublish": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Resubmission400Example": { "summary": "Default Resubmission 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Resubmission401Example": { "summary": "Default Resubmission 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Resubmission403Example": { "summary": "Default Resubmission 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Resubmission404Example": { "summary": "Default Resubmission 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Resubmission500Example": { "summary": "Default Resubmission 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Resubmission", "description": "Resubmission via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/resubmission).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/saleschannel": { "post": { "tags": [ "MobileApps" ], "operationId": "UpdateAppConfigSalesChannel", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppConfigSalesChannel" }, "examples": { "UpdateAppConfigSalesChannelRequestExample": { "summary": "Default UpdateAppConfigSalesChannel request", "x-microcks-default": true, "value": { "EmailRequestMode": "DoNotRequest", "WebToAppRedirect": "NoRedirect", "AddressEntryType": "MapFirst", "DisplayDeliveryRestaurantListScreen": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppConfigSalesChannel_" }, "examples": { "UpdateAppConfigSalesChannel200Example": { "summary": "Default UpdateAppConfigSalesChannel 200 response", "x-microcks-default": true, "value": { "Data": { "EmailRequestMode": "DoNotRequest", "WebToAppRedirect": "NoRedirect", "AddressEntryType": "MapFirst", "DisplayDeliveryRestaurantListScreen": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppConfigSalesChannel400Example": { "summary": "Default UpdateAppConfigSalesChannel 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppConfigSalesChannel401Example": { "summary": "Default UpdateAppConfigSalesChannel 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppConfigSalesChannel403Example": { "summary": "Default UpdateAppConfigSalesChannel 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppConfigSalesChannel404Example": { "summary": "Default UpdateAppConfigSalesChannel 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppConfigSalesChannel500Example": { "summary": "Default UpdateAppConfigSalesChannel 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App Config Sales Channel", "description": "Update App Config Sales Channel via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/saleschannel).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission/image": { "post": { "tags": [ "MobileApps" ], "operationId": "UploadImage", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "Image": { "description": "Mobile Apps image", "type": "string", "format": "binary" } }, "required": [ "Image" ] }, "examples": { "UploadImageRequestExample": { "summary": "Default UploadImage request", "x-microcks-default": true, "value": { "Image": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_MobileAppsImage_" }, "examples": { "UploadImage200Example": { "summary": "Default UploadImage 200 response", "x-microcks-default": true, "value": { "Data": { "ImageUri": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadImage400Example": { "summary": "Default UploadImage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadImage401Example": { "summary": "Default UploadImage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadImage403Example": { "summary": "Default UploadImage 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadImage404Example": { "summary": "Default UploadImage 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadImage500Example": { "summary": "Default UploadImage 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Upload Image", "description": "Upload Image via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission/image).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission/{submissionId}/publish": { "post": { "tags": [ "MobileApps" ], "operationId": "Publish", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The submission id path parameter.", "example": 500123 }, { "name": "platformType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "None", "Android", "IOS" ] }, "description": "The platform type query parameter.", "example": "None" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_RestApiIntegerResult_" }, "examples": { "Publish200Example": { "summary": "Default Publish 200 response", "x-microcks-default": true, "value": { "Data": { "Data": 1 } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Publish400Example": { "summary": "Default Publish 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Publish401Example": { "summary": "Default Publish 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Publish403Example": { "summary": "Default Publish 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Publish404Example": { "summary": "Default Publish 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Publish500Example": { "summary": "Default Publish 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Publish", "description": "Publish via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission/{submissionId}/publish).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/mobileapps/{appId}/submission/{submissionId}/unpublish": { "post": { "tags": [ "MobileApps" ], "operationId": "Unpublish", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The submission id path parameter.", "example": 500123 }, { "name": "platformType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "None", "Android", "IOS" ] }, "description": "The platform type query parameter.", "example": "None" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiIntegerResult" }, "examples": { "Unpublish200Example": { "summary": "Default Unpublish 200 response", "x-microcks-default": true, "value": { "Data": 1 } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Unpublish400Example": { "summary": "Default Unpublish 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Unpublish401Example": { "summary": "Default Unpublish 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Unpublish403Example": { "summary": "Default Unpublish 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Unpublish404Example": { "summary": "Default Unpublish 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Unpublish500Example": { "summary": "Default Unpublish 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Unpublish", "description": "Unpublish via the Flipdish Open API v1.0 (POST /api/v1.0/mobileapps/{appId}/submission/{submissionId}/unpublish).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/index": { "get": { "tags": [ "Website" ], "operationId": "GetIndexConfiguration", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_IndexPage_" }, "examples": { "GetIndexConfiguration200Example": { "summary": "Default GetIndexConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "Testimonials": [], "Images": [], "AboutSectionEnabled": true, "AboutSectionTitle": "string", "AboutSectionSubtitle": "string", "AboutSectionLeftTitle": "string", "AboutSectionLeftBody": "string", "AboutSectionRightTitle": "string", "AboutSectionRightBody": "string", "OpeningHoursEnabled": true, "MenuPreviewEnabled": true, "GalleryEnabled": true, "TestimonialsEnabled": true, "ContactFormEnabled": true, "ContactFormEmail": "owner@example.com", "MapEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetIndexConfiguration400Example": { "summary": "Default GetIndexConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetIndexConfiguration401Example": { "summary": "Default GetIndexConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetIndexConfiguration403Example": { "summary": "Default GetIndexConfiguration 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetIndexConfiguration404Example": { "summary": "Default GetIndexConfiguration 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetIndexConfiguration500Example": { "summary": "Default GetIndexConfiguration 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Index Configuration", "description": "Get Index Configuration via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/website/index).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "Website" ], "operationId": "SetIndexConfiguration", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexPageBase" }, "examples": { "SetIndexConfigurationRequestExample": { "summary": "Default SetIndexConfiguration request", "x-microcks-default": true, "value": { "AboutSectionEnabled": true, "AboutSectionTitle": "string", "AboutSectionSubtitle": "string", "AboutSectionLeftTitle": "string", "AboutSectionLeftBody": "string", "AboutSectionRightTitle": "string", "AboutSectionRightBody": "string", "OpeningHoursEnabled": true, "MenuPreviewEnabled": true, "GalleryEnabled": true, "TestimonialsEnabled": true, "ContactFormEnabled": true, "ContactFormEmail": "owner@example.com", "MapEnabled": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_IndexPageBase_" }, "examples": { "SetIndexConfiguration200Example": { "summary": "Default SetIndexConfiguration 200 response", "x-microcks-default": true, "value": { "Data": { "AboutSectionEnabled": true, "AboutSectionTitle": "string", "AboutSectionSubtitle": "string", "AboutSectionLeftTitle": "string", "AboutSectionLeftBody": "string", "AboutSectionRightTitle": "string", "AboutSectionRightBody": "string", "OpeningHoursEnabled": true, "MenuPreviewEnabled": true, "GalleryEnabled": true, "TestimonialsEnabled": true, "ContactFormEnabled": true, "ContactFormEmail": "owner@example.com", "MapEnabled": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetIndexConfiguration400Example": { "summary": "Default SetIndexConfiguration 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetIndexConfiguration401Example": { "summary": "Default SetIndexConfiguration 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetIndexConfiguration403Example": { "summary": "Default SetIndexConfiguration 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetIndexConfiguration404Example": { "summary": "Default SetIndexConfiguration 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SetIndexConfiguration500Example": { "summary": "Default SetIndexConfiguration 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Set Index Configuration", "description": "Set Index Configuration via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/website/index).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/dnscheck": { "get": { "tags": [ "Website" ], "operationId": "Website_CheckNow", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Website_CheckNow400Example": { "summary": "Default Website_CheckNow 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Website_CheckNow401Example": { "summary": "Default Website_CheckNow 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Website_CheckNow403Example": { "summary": "Default Website_CheckNow 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "Website_CheckNow500Example": { "summary": "Default Website_CheckNow 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Website_Check Now", "description": "Website_Check Now via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/website/dnscheck).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/testimonial": { "post": { "tags": [ "Website" ], "operationId": "AddTestimonial", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_WebsiteTestimonial_" }, "examples": { "AddTestimonial200Example": { "summary": "Default AddTestimonial 200 response", "x-microcks-default": true, "value": { "Data": { "TestimonialId": 500123, "Author": "string", "Message": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddTestimonial400Example": { "summary": "Default AddTestimonial 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddTestimonial401Example": { "summary": "Default AddTestimonial 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddTestimonial403Example": { "summary": "Default AddTestimonial 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddTestimonial404Example": { "summary": "Default AddTestimonial 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "AddTestimonial500Example": { "summary": "Default AddTestimonial 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Add Testimonial", "description": "Add Testimonial via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/website/testimonial).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/image/{imageLocation}": { "post": { "tags": [ "Website" ], "operationId": "UploadWebsiteImage", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "imageLocation", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "IndexHeader", "IndexAboutSectionLeft", "IndexAboutSectionRight", "IndexGallery", "IndexOpeningHoursHeader", "IndexTestimonialsHeader" ] }, "description": "The image location path parameter.", "example": "IndexHeader" } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_WebsiteImage_" }, "examples": { "UploadWebsiteImage200Example": { "summary": "Default UploadWebsiteImage 200 response", "x-microcks-default": true, "value": { "Data": { "ImageId": 500123, "ImageLocation": "IndexHeader", "ImageUrl": "https://api.flipdish.co/example" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadWebsiteImage400Example": { "summary": "Default UploadWebsiteImage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadWebsiteImage401Example": { "summary": "Default UploadWebsiteImage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadWebsiteImage403Example": { "summary": "Default UploadWebsiteImage 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadWebsiteImage404Example": { "summary": "Default UploadWebsiteImage 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadWebsiteImage500Example": { "summary": "Default UploadWebsiteImage 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Upload Website Image", "description": "Upload Website Image via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/website/image/{imageLocation}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/testimonial/{testimonialId}": { "post": { "tags": [ "Website" ], "operationId": "EditTestimonial", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "testimonialId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The testimonial id path parameter.", "example": 500123 } ], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_WebsiteTestimonial_" }, "examples": { "EditTestimonial200Example": { "summary": "Default EditTestimonial 200 response", "x-microcks-default": true, "value": { "Data": { "TestimonialId": 500123, "Author": "string", "Message": "string" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditTestimonial400Example": { "summary": "Default EditTestimonial 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditTestimonial401Example": { "summary": "Default EditTestimonial 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditTestimonial403Example": { "summary": "Default EditTestimonial 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditTestimonial404Example": { "summary": "Default EditTestimonial 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "EditTestimonial500Example": { "summary": "Default EditTestimonial 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Edit Testimonial", "description": "Edit Testimonial via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/website/testimonial/{testimonialId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "tags": [ "Website" ], "operationId": "DeleteTestimonial", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "testimonialId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The testimonial id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTestimonial400Example": { "summary": "Default DeleteTestimonial 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTestimonial401Example": { "summary": "Default DeleteTestimonial 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTestimonial403Example": { "summary": "Default DeleteTestimonial 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTestimonial404Example": { "summary": "Default DeleteTestimonial 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteTestimonial500Example": { "summary": "Default DeleteTestimonial 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Delete Testimonial", "description": "Delete Testimonial via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/website/testimonial/{testimonialId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/{appId}/website/image/{imageId}": { "delete": { "tags": [ "Website" ], "operationId": "DeleteWebsiteImage", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The image id path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebsiteImage400Example": { "summary": "Default DeleteWebsiteImage 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebsiteImage401Example": { "summary": "Default DeleteWebsiteImage 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebsiteImage403Example": { "summary": "Default DeleteWebsiteImage 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebsiteImage404Example": { "summary": "Default DeleteWebsiteImage 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "DeleteWebsiteImage500Example": { "summary": "Default DeleteWebsiteImage 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Delete Website Image", "description": "Delete Website Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/website/image/{imageId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelbuilds/health": { "get": { "tags": [ "WhiteLabelBuilds" ], "operationId": "HealthCheck", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "HealthCheck200Example": { "summary": "Default HealthCheck 200 response", "x-microcks-default": true, "value": "string" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck400Example": { "summary": "Default HealthCheck 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck401Example": { "summary": "Default HealthCheck 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck403Example": { "summary": "Default HealthCheck 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck500Example": { "summary": "Default HealthCheck 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Health Check", "description": "Health Check via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelbuilds/health).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelbuilds/{appId}/android": { "post": { "tags": [ "WhiteLabelBuilds" ], "operationId": "SubmitAndroidBuild", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "branch", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The branch query parameter.", "example": "string" }, { "name": "lane", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The lane query parameter.", "example": "string" }, { "name": "buildType", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The build type query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BuildResultModel_" }, "examples": { "SubmitAndroidBuild200Example": { "summary": "Default SubmitAndroidBuild 200 response", "x-microcks-default": true, "value": { "Data": { "Message": "string", "BuildId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidBuild400Example": { "summary": "Default SubmitAndroidBuild 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidBuild401Example": { "summary": "Default SubmitAndroidBuild 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidBuild403Example": { "summary": "Default SubmitAndroidBuild 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidBuild500Example": { "summary": "Default SubmitAndroidBuild 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Submit Android Build", "description": "Submit Android Build via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelbuilds/{appId}/android).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelbuilds/ios/multiple": { "post": { "tags": [ "WhiteLabelBuilds" ], "operationId": "SubmitIosApps", "parameters": [ { "name": "whiteLabelIds", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The white label ids query parameter.", "example": "string" }, { "name": "branch", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The branch query parameter.", "example": "string" }, { "name": "buildType", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The build type query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BuildResultModel_" }, "examples": { "SubmitIosApps200Example": { "summary": "Default SubmitIosApps 200 response", "x-microcks-default": true, "value": { "Data": { "Message": "string", "BuildId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosApps400Example": { "summary": "Default SubmitIosApps 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosApps401Example": { "summary": "Default SubmitIosApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosApps403Example": { "summary": "Default SubmitIosApps 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosApps500Example": { "summary": "Default SubmitIosApps 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Submit Ios Apps", "description": "Submit Ios Apps via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelbuilds/ios/multiple).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelbuilds/{appId}/ios": { "post": { "tags": [ "WhiteLabelBuilds" ], "operationId": "SubmitIosBuild", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" }, { "name": "buildType", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The build type query parameter.", "example": "string" }, { "name": "branch", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The branch query parameter.", "example": "string" }, { "name": "submitForReview", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "The submit for review query parameter.", "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BuildResultModel_" }, "examples": { "SubmitIosBuild200Example": { "summary": "Default SubmitIosBuild 200 response", "x-microcks-default": true, "value": { "Data": { "Message": "string", "BuildId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosBuild400Example": { "summary": "Default SubmitIosBuild 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosBuild401Example": { "summary": "Default SubmitIosBuild 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosBuild403Example": { "summary": "Default SubmitIosBuild 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitIosBuild500Example": { "summary": "Default SubmitIosBuild 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Submit Ios Build", "description": "Submit Ios Build via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelbuilds/{appId}/ios).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelbuilds/android/multiple": { "post": { "tags": [ "WhiteLabelBuilds" ], "operationId": "SubmitAndroidApps", "parameters": [ { "name": "whiteLabelIds", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The white label ids query parameter.", "example": "string" }, { "name": "branch", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The branch query parameter.", "example": "string" }, { "name": "buildType", "in": "query", "required": false, "schema": { "type": "string" }, "description": "The build type query parameter.", "example": "string" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_BuildResultModel_" }, "examples": { "SubmitAndroidApps200Example": { "summary": "Default SubmitAndroidApps 200 response", "x-microcks-default": true, "value": { "Data": { "Message": "string", "BuildId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidApps400Example": { "summary": "Default SubmitAndroidApps 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidApps401Example": { "summary": "Default SubmitAndroidApps 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidApps403Example": { "summary": "Default SubmitAndroidApps 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "SubmitAndroidApps500Example": { "summary": "Default SubmitAndroidApps 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Submit Android Apps", "description": "Submit Android Apps via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelbuilds/android/multiple).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/health": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "HealthCheck", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "examples": { "HealthCheck200Example": { "summary": "Default HealthCheck 200 response", "x-microcks-default": true, "value": "string" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck400Example": { "summary": "Default HealthCheck 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Authentication has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck401Example": { "summary": "Default HealthCheck 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck403Example": { "summary": "Default HealthCheck 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "HealthCheck500Example": { "summary": "Default HealthCheck 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Health Check", "description": "Health Check via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/health).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/id/{wlid}": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "GetWhiteLabelConfig", "parameters": [ { "name": "wlid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "description": "The wlid path parameter.", "example": 500123 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_WhiteLabelConfigModel_" }, "examples": { "GetWhiteLabelConfig200Example": { "summary": "Default GetWhiteLabelConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelLanguages": [], "WhiteLabelAssets": [], "ColorScheme": { "WhiteLabelColorSchemeId": 500123, "Font": "string", "Color": "string", "Color2": "string", "Color3": "string", "Color4": "string", "Color5": "string", "Color6": "string", "Color7": "string", "Color8": "string", "Color9": "string", "Color10": "string", "Color11": "string", "Color12": "string" }, "WhiteLabelConfigId": 500123, "WhiteLabelId": 500123, "WhiteLabelName": "Example Name", "AppNameId": "500123", "OrgId": "500123", "SmsRestaurantName": "Example Name", "DeepLinkUrlScheme": "https://api.flipdish.co/example", "HostName": "Example Name", "NexmoSupportSmsNumber": "string", "TwilioSupportSmsNumber": "string", "MixpanelToken": "string", "IntercomAppId": "500123", "ShareMessageEmailSubject": "owner@example.com", "ShareMessageEmailMessage": "owner@example.com", "ShareMessageSmsMessage": "string", "ShareMessageWhatsAppMessage": "string", "ShareMessageFacebookMessage": "string", "ShareMessageTwitterMessage": "string", "ShareMessageGenericMessage": "string", "DisplayDeliveryRestaurantListScreen": true, "ContactFormType": 1, "ContactPhoneNumber": "+353000000000", "DisplayBumpSideMenuItem": true, "DisplayFreeCokeSideMenuItem": true, "AppStoreUrl": "https://api.flipdish.co/example", "DeliveryEnabled": true, "PickupEnabled": true, "DisplayPickupRestaurantListScreen": true, "DisplayCuisineTypeListAndRestaurantSearchBar": true, "DisplayUserRestaurantRatings": true, "ReadyToPublishWeb": true, "ReadyToPublishIos": true, "ReadyToPublishAndroid": true, "DisplayFooterLinksToOtherSites": true, "DisplayOnlineOrderingMenu": true, "HideAppConfigFromAdminList": true, "ComplianceType": "Default", "IsMenuMigratedToRms": true, "MapBoundryMaxLongitude": 1.0, "MapBoundryMinLongitude": 1.0, "MapBoundryMaxLatitude": 1.0, "MapBoundryMinLatitude": 1.0, "AppStoreAppleId": "500123", "AppStoreToken": "string", "WebsiteDisplayStaticMenuPage": true, "IsEmbed": true, "DisplayTipOptionToUsersByDefault": true, "EmailRequestMode": 1, "AddressEntryType": 1, "AddressLayout": 1, "Category": 1, "MapCenterLatitude": 1.0, "MapCenterLongitude": 1.0, "IntercomTokenIos": "string", "IntercomTokenAndroid": "500123", "GoogleAnalyticsTokensCsv": "string", "FacebookTokensCsv": "string", "ShareMessageGenericUrl": "https://api.flipdish.co/example", "PrivateSupportEmailAddress": "owner@example.com", "AppStoreId": "500123", "PlayConsoleAccount": 3, "ApnCertificateValidAfter": "2026-06-02T12:00:00Z", "ApnCertificateValidBefore": "2026-06-02T12:00:00Z", "DineInEnabled": true, "AppFont": "string", "WhiteLabelColorSchemeId": 500123, "WhiteLabelImagesId": 500123, "AppStoreCopyright": "string", "AppStoreDescription": "string", "AppStoreShortDescription": "string", "AppStoreKeywords": "string", "AppStoreMarketingUrl": "https://api.flipdish.co/example", "AppStoreName": "Example Name", "AppStorePrivacyUrl": "https://api.flipdish.co/example", "AppStoreSupportUrl": "https://api.flipdish.co/example", "AppStoreReleaseNotes": "string", "AppStoreIconUrl": "https://api.flipdish.co/example", "AppStoreIconThumbnail100Url": "https://api.flipdish.co/example", "TransparentLogoUrl": "https://api.flipdish.co/example", "LogoImageName": "Example Name", "KioskNameScreenImage": "Example Name", "WebToAppRedirect": 1, "FeaturesCsv": "string", "AppStorePassword": "string", "AppStoreTeamId": "500123", "AppStoreAppGroup": "string", "AppStoreSigningIdentity": "string", "AppStoreItcTeamId": "500123", "HeadHtml": "string", "SocialTwitterUrl": "https://api.flipdish.co/example", "SocialFacebookUrl": "https://api.flipdish.co/example", "SocialInstagramUrl": "https://api.flipdish.co/example", "SocialPintrestUrl": "https://api.flipdish.co/example", "SocialTripAdvisorUrl": "https://api.flipdish.co/example", "SocialGooglePlusUrl": "https://api.flipdish.co/example", "SocialFourSquareUrl": "https://api.flipdish.co/example", "SocialYelpUrl": "https://api.flipdish.co/example", "WebsiteType": 1, "ExternalOrderingPageUrl": "https://api.flipdish.co/example", "PanaceaEnabled": true, "CookieConsentPromptEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CountryId": "500123", "ReferralUserId": 500123, "ReferralCampaignId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfig400Example": { "summary": "Default GetWhiteLabelConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfig401Example": { "summary": "Default GetWhiteLabelConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfig403Example": { "summary": "Default GetWhiteLabelConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfig404Example": { "summary": "Default GetWhiteLabelConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfig500Example": { "summary": "Default GetWhiteLabelConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get White Label Config", "description": "Get White Label Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/id/{wlid}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/name/{appId}": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "GetWhiteLabelConfigByAppNameId", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_WhiteLabelConfigModel_" }, "examples": { "GetWhiteLabelConfigByAppNameId200Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelLanguages": [], "WhiteLabelAssets": [], "ColorScheme": { "WhiteLabelColorSchemeId": 500123, "Font": "string", "Color": "string", "Color2": "string", "Color3": "string", "Color4": "string", "Color5": "string", "Color6": "string", "Color7": "string", "Color8": "string", "Color9": "string", "Color10": "string", "Color11": "string", "Color12": "string" }, "WhiteLabelConfigId": 500123, "WhiteLabelId": 500123, "WhiteLabelName": "Example Name", "AppNameId": "500123", "OrgId": "500123", "SmsRestaurantName": "Example Name", "DeepLinkUrlScheme": "https://api.flipdish.co/example", "HostName": "Example Name", "NexmoSupportSmsNumber": "string", "TwilioSupportSmsNumber": "string", "MixpanelToken": "string", "IntercomAppId": "500123", "ShareMessageEmailSubject": "owner@example.com", "ShareMessageEmailMessage": "owner@example.com", "ShareMessageSmsMessage": "string", "ShareMessageWhatsAppMessage": "string", "ShareMessageFacebookMessage": "string", "ShareMessageTwitterMessage": "string", "ShareMessageGenericMessage": "string", "DisplayDeliveryRestaurantListScreen": true, "ContactFormType": 1, "ContactPhoneNumber": "+353000000000", "DisplayBumpSideMenuItem": true, "DisplayFreeCokeSideMenuItem": true, "AppStoreUrl": "https://api.flipdish.co/example", "DeliveryEnabled": true, "PickupEnabled": true, "DisplayPickupRestaurantListScreen": true, "DisplayCuisineTypeListAndRestaurantSearchBar": true, "DisplayUserRestaurantRatings": true, "ReadyToPublishWeb": true, "ReadyToPublishIos": true, "ReadyToPublishAndroid": true, "DisplayFooterLinksToOtherSites": true, "DisplayOnlineOrderingMenu": true, "HideAppConfigFromAdminList": true, "ComplianceType": "Default", "IsMenuMigratedToRms": true, "MapBoundryMaxLongitude": 1.0, "MapBoundryMinLongitude": 1.0, "MapBoundryMaxLatitude": 1.0, "MapBoundryMinLatitude": 1.0, "AppStoreAppleId": "500123", "AppStoreToken": "string", "WebsiteDisplayStaticMenuPage": true, "IsEmbed": true, "DisplayTipOptionToUsersByDefault": true, "EmailRequestMode": 1, "AddressEntryType": 1, "AddressLayout": 1, "Category": 1, "MapCenterLatitude": 1.0, "MapCenterLongitude": 1.0, "IntercomTokenIos": "string", "IntercomTokenAndroid": "500123", "GoogleAnalyticsTokensCsv": "string", "FacebookTokensCsv": "string", "ShareMessageGenericUrl": "https://api.flipdish.co/example", "PrivateSupportEmailAddress": "owner@example.com", "AppStoreId": "500123", "PlayConsoleAccount": 3, "ApnCertificateValidAfter": "2026-06-02T12:00:00Z", "ApnCertificateValidBefore": "2026-06-02T12:00:00Z", "DineInEnabled": true, "AppFont": "string", "WhiteLabelColorSchemeId": 500123, "WhiteLabelImagesId": 500123, "AppStoreCopyright": "string", "AppStoreDescription": "string", "AppStoreShortDescription": "string", "AppStoreKeywords": "string", "AppStoreMarketingUrl": "https://api.flipdish.co/example", "AppStoreName": "Example Name", "AppStorePrivacyUrl": "https://api.flipdish.co/example", "AppStoreSupportUrl": "https://api.flipdish.co/example", "AppStoreReleaseNotes": "string", "AppStoreIconUrl": "https://api.flipdish.co/example", "AppStoreIconThumbnail100Url": "https://api.flipdish.co/example", "TransparentLogoUrl": "https://api.flipdish.co/example", "LogoImageName": "Example Name", "KioskNameScreenImage": "Example Name", "WebToAppRedirect": 1, "FeaturesCsv": "string", "AppStorePassword": "string", "AppStoreTeamId": "500123", "AppStoreAppGroup": "string", "AppStoreSigningIdentity": "string", "AppStoreItcTeamId": "500123", "HeadHtml": "string", "SocialTwitterUrl": "https://api.flipdish.co/example", "SocialFacebookUrl": "https://api.flipdish.co/example", "SocialInstagramUrl": "https://api.flipdish.co/example", "SocialPintrestUrl": "https://api.flipdish.co/example", "SocialTripAdvisorUrl": "https://api.flipdish.co/example", "SocialGooglePlusUrl": "https://api.flipdish.co/example", "SocialFourSquareUrl": "https://api.flipdish.co/example", "SocialYelpUrl": "https://api.flipdish.co/example", "WebsiteType": 1, "ExternalOrderingPageUrl": "https://api.flipdish.co/example", "PanaceaEnabled": true, "CookieConsentPromptEnabled": true, "PanaceaVanityUrl": "https://api.flipdish.co/example", "CountryId": "500123", "ReferralUserId": 500123, "ReferralCampaignId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfigByAppNameId400Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfigByAppNameId401Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfigByAppNameId403Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfigByAppNameId404Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetWhiteLabelConfigByAppNameId500Example": { "summary": "Default GetWhiteLabelConfigByAppNameId 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get White Label Config by App Name Id", "description": "Get White Label Config by App Name Id via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/name/{appId}).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/{appId}/general": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "GetAppGeneralConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppGeneralConfigModel_" }, "examples": { "GetAppGeneralConfig200Example": { "summary": "Default GetAppGeneralConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "DeepLinkUrlScheme": "https://api.flipdish.co/example", "SmsRestaurantName": "Example Name", "NexmoSupportSmsNumber": "string", "TwilioSupportSmsNumber": "string", "FallbackPhoneNumberPrefix": "+353000000000", "AutocompletePhoneNumberLength": 3, "ContactFormType": "string", "PrivateSupportEmailAddress": "owner@example.com", "ContactPhoneNumber": "+353000000000", "DeliveryEnabled": true, "PickupEnabled": true, "DineInEnabled": true, "DisplayDeliveryRestaurantListScreen": true, "DisplayPickupRestaurantListScreen": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppGeneralConfig400Example": { "summary": "Default GetAppGeneralConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppGeneralConfig401Example": { "summary": "Default GetAppGeneralConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppGeneralConfig403Example": { "summary": "Default GetAppGeneralConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppGeneralConfig404Example": { "summary": "Default GetAppGeneralConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppGeneralConfig500Example": { "summary": "Default GetAppGeneralConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App General Config", "description": "Get App General Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/{appId}/general).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "WhiteLabelConfig" ], "operationId": "UpdateAppGeneralConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppGeneralConfigModel" }, "examples": { "UpdateAppGeneralConfigRequestExample": { "summary": "Default UpdateAppGeneralConfig request", "x-microcks-default": true, "value": { "WhiteLabelId": 500123, "DeepLinkUrlScheme": "https://api.flipdish.co/example", "SmsRestaurantName": "Example Name", "NexmoSupportSmsNumber": "string", "TwilioSupportSmsNumber": "string", "FallbackPhoneNumberPrefix": "+353000000000", "AutocompletePhoneNumberLength": 3, "ContactFormType": "string", "PrivateSupportEmailAddress": "owner@example.com", "ContactPhoneNumber": "+353000000000", "DeliveryEnabled": true, "PickupEnabled": true, "DineInEnabled": true, "DisplayDeliveryRestaurantListScreen": true, "DisplayPickupRestaurantListScreen": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppGeneralConfigModel_" }, "examples": { "UpdateAppGeneralConfig200Example": { "summary": "Default UpdateAppGeneralConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "DeepLinkUrlScheme": "https://api.flipdish.co/example", "SmsRestaurantName": "Example Name", "NexmoSupportSmsNumber": "string", "TwilioSupportSmsNumber": "string", "FallbackPhoneNumberPrefix": "+353000000000", "AutocompletePhoneNumberLength": 3, "ContactFormType": "string", "PrivateSupportEmailAddress": "owner@example.com", "ContactPhoneNumber": "+353000000000", "DeliveryEnabled": true, "PickupEnabled": true, "DineInEnabled": true, "DisplayDeliveryRestaurantListScreen": true, "DisplayPickupRestaurantListScreen": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppGeneralConfig400Example": { "summary": "Default UpdateAppGeneralConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppGeneralConfig401Example": { "summary": "Default UpdateAppGeneralConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppGeneralConfig403Example": { "summary": "Default UpdateAppGeneralConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppGeneralConfig404Example": { "summary": "Default UpdateAppGeneralConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppGeneralConfig500Example": { "summary": "Default UpdateAppGeneralConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App General Config", "description": "Update App General Config via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelconfig/{appId}/general).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/{appId}/appstore": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "GetAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreConfigModel_" }, "examples": { "GetAppStoreConfig200Example": { "summary": "Default GetAppStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "ReadyToPublishToAppStore": true, "AppStoreName": "Example Name", "AppStoreAppleId": "500123", "AppStoreUrl": "https://api.flipdish.co/example", "AppStoreId": "500123", "AppStorePassword": "string", "TeamId": "500123", "AppGroupId": "500123", "BundleId": "500123", "AppStoreSigningIdentity": "string", "AppStoreToken": "string", "AppStoreMerchantId": "500123", "P8PrivateKey": "string", "P8PrivateKeyId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig400Example": { "summary": "Default GetAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig401Example": { "summary": "Default GetAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig403Example": { "summary": "Default GetAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig404Example": { "summary": "Default GetAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetAppStoreConfig500Example": { "summary": "Default GetAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get App Store Config", "description": "Get App Store Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/{appId}/appstore).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "WhiteLabelConfig" ], "operationId": "UpdateAppStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppStoreConfigModel" }, "examples": { "UpdateAppStoreConfigRequestExample": { "summary": "Default UpdateAppStoreConfig request", "x-microcks-default": true, "value": { "WhiteLabelId": 500123, "ReadyToPublishToAppStore": true, "AppStoreName": "Example Name", "AppStoreAppleId": "500123", "AppStoreUrl": "https://api.flipdish.co/example", "AppStoreId": "500123", "AppStorePassword": "string", "TeamId": "500123", "AppGroupId": "500123", "BundleId": "500123", "AppStoreSigningIdentity": "string", "AppStoreToken": "string", "AppStoreMerchantId": "500123", "P8PrivateKey": "string", "P8PrivateKeyId": "500123" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AppStoreConfigModel_" }, "examples": { "UpdateAppStoreConfig200Example": { "summary": "Default UpdateAppStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "ReadyToPublishToAppStore": true, "AppStoreName": "Example Name", "AppStoreAppleId": "500123", "AppStoreUrl": "https://api.flipdish.co/example", "AppStoreId": "500123", "AppStorePassword": "string", "TeamId": "500123", "AppGroupId": "500123", "BundleId": "500123", "AppStoreSigningIdentity": "string", "AppStoreToken": "string", "AppStoreMerchantId": "500123", "P8PrivateKey": "string", "P8PrivateKeyId": "500123" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig400Example": { "summary": "Default UpdateAppStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig401Example": { "summary": "Default UpdateAppStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig403Example": { "summary": "Default UpdateAppStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig404Example": { "summary": "Default UpdateAppStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdateAppStoreConfig500Example": { "summary": "Default UpdateAppStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update App Store Config", "description": "Update App Store Config via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelconfig/{appId}/appstore).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/{appId}/playstore": { "get": { "tags": [ "WhiteLabelConfig" ], "operationId": "GetPlayStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_PlayStoreConfigModel_" }, "examples": { "GetPlayStoreConfig200Example": { "summary": "Default GetPlayStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "BundleId": "500123", "Description": "string", "ShortDescription": "string", "Copyright": "string", "Keywords": "string", "MarketingUrl": "https://api.flipdish.co/example", "PrivacyUrl": "https://api.flipdish.co/example", "SupportUrl": "https://api.flipdish.co/example", "PlayConsoleAccount": 3, "ReleaseNotes": "string", "StoreIcon": "string", "ReadyToPublishAndroid": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPlayStoreConfig400Example": { "summary": "Default GetPlayStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPlayStoreConfig401Example": { "summary": "Default GetPlayStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPlayStoreConfig403Example": { "summary": "Default GetPlayStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPlayStoreConfig404Example": { "summary": "Default GetPlayStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "GetPlayStoreConfig500Example": { "summary": "Default GetPlayStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Get Play Store Config", "description": "Get Play Store Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/{appId}/playstore).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "post": { "tags": [ "WhiteLabelConfig" ], "operationId": "UpdatePlayStoreConfig", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayStoreConfigModel" }, "examples": { "UpdatePlayStoreConfigRequestExample": { "summary": "Default UpdatePlayStoreConfig request", "x-microcks-default": true, "value": { "WhiteLabelId": 500123, "BundleId": "500123", "Description": "string", "ShortDescription": "string", "Copyright": "string", "Keywords": "string", "MarketingUrl": "https://api.flipdish.co/example", "PrivacyUrl": "https://api.flipdish.co/example", "SupportUrl": "https://api.flipdish.co/example", "PlayConsoleAccount": 3, "ReleaseNotes": "string", "StoreIcon": "string", "ReadyToPublishAndroid": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_PlayStoreConfigModel_" }, "examples": { "UpdatePlayStoreConfig200Example": { "summary": "Default UpdatePlayStoreConfig 200 response", "x-microcks-default": true, "value": { "Data": { "WhiteLabelId": 500123, "BundleId": "500123", "Description": "string", "ShortDescription": "string", "Copyright": "string", "Keywords": "string", "MarketingUrl": "https://api.flipdish.co/example", "PrivacyUrl": "https://api.flipdish.co/example", "SupportUrl": "https://api.flipdish.co/example", "PlayConsoleAccount": 3, "ReleaseNotes": "string", "StoreIcon": "string", "ReadyToPublishAndroid": true } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePlayStoreConfig400Example": { "summary": "Default UpdatePlayStoreConfig 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePlayStoreConfig401Example": { "summary": "Default UpdatePlayStoreConfig 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePlayStoreConfig403Example": { "summary": "Default UpdatePlayStoreConfig 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePlayStoreConfig404Example": { "summary": "Default UpdatePlayStoreConfig 404 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UpdatePlayStoreConfig500Example": { "summary": "Default UpdatePlayStoreConfig 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Update Play Store Config", "description": "Update Play Store Config via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelconfig/{appId}/playstore).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/api/v1.0/whitelabelconfig/{appId}/app-store-icon": { "post": { "tags": [ "WhiteLabelConfig" ], "operationId": "UploadAppStoreIcon", "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The app id path parameter.", "example": "500123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpPostedFileBase" }, "examples": { "UploadAppStoreIconRequestExample": { "summary": "Default UploadAppStoreIcon request", "x-microcks-default": true, "value": { "ContentLength": 1, "ContentType": "string", "FileName": "Example Name", "InputStream": { "CanRead": true, "CanSeek": true, "CanTimeout": true, "CanWrite": true, "Length": 1, "Position": 1, "ReadTimeout": 1, "WriteTimeout": 1 } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResult_AssetResultModel_" }, "examples": { "UploadAppStoreIcon200Example": { "summary": "Default UploadAppStoreIcon 200 response", "x-microcks-default": true, "value": { "Data": { "Message": "string", "AssetUrl": "https://api.flipdish.co/example", "AssetName": "Example Name" } } } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreIcon400Example": { "summary": "Default UploadAppStoreIcon 400 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreIcon401Example": { "summary": "Default UploadAppStoreIcon 401 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "403": { "description": "Successful authentication, but authorization has been denied for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreIcon403Example": { "summary": "Default UploadAppStoreIcon 403 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlipdishError" }, "examples": { "UploadAppStoreIcon500Example": { "summary": "Default UploadAppStoreIcon 500 response", "x-microcks-default": true, "value": { "error": { "errorMessage": "Invalid or missing parameters.", "errorCode": "BadRequest", "details": "Validation failed for field 'storeId'." } } } } } } } }, "security": [ { "oauth2": [ "api" ] } ], "summary": "Flipdish Upload App Store Icon", "description": "Upload App Store Icon via the Flipdish Open API v1.0 (POST /api/v1.0/whitelabelconfig/{appId}/app-store-icon).", "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } } }, "components": { "schemas": { "App": { "description": "App", "type": "object", "properties": { "AppId": { "description": "App Identifier", "type": "string", "example": "500123" }, "HasIosApp": { "description": "Has iOS app in Apple App Store. This is readonly.", "type": "boolean", "example": true }, "IosAppStoreUrl": { "description": "IOS App Store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "HasAndroidApp": { "description": "Has Android app in Google Play Store. This is readonly.", "type": "boolean", "example": true }, "AndroidPlayStoreUrl": { "description": "Android Play Store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "DisplayDeliveryRestaurantScreen": { "description": "Display delivery restaurant screen", "type": "boolean", "example": true }, "LogoImageUrl": { "description": "Application Logo.", "type": "string", "example": "https://api.flipdish.co/example" }, "Languages": { "description": "Languages that have been selected to be available to customers.", "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "example": [] }, "AvailableAppLanguages": { "description": "Lists all languages that are supported by Flipdish.", "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "example": [] }, "AppAccessLevel": { "description": "App access level for the logged in user", "enum": [ "None", "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger", "Onboarding", "Support" ], "type": "string", "example": "None" }, "AppResourceSet": { "description": "Constitutes a list of available resources", "type": "array", "items": { "enum": [ "ViewApp", "CreateApp", "UpdateApp", "ViewAppName", "EditAppAssets", "EditAppFeatures", "ViewTeammates", "EditTeammates", "CreateTeammateOwner", "CreateTeammateManagedOwner", "CreateTeammateStoreOwner", "CreateTeammateStoreManager", "CreateTeammateStoreStaff", "CreateTeammateStoreReadAccess", "CreateTeammateFinanceManager", "CreateTeammateIntegrator", "CreateTeammateOnboarding", "CreateTeammatePropertyManager", "CreateTeammatePropertyOwner", "ViewApmConfigurations", "EditApmConfigurations", "ViewCampaignsConfigurations", "CreateCampaignsConfigurations", "UpdateCampaignsConfigurations", "DeleteCampaignsConfigurations", "StampLoyaltyCardAgainstCampaignsConfigurations", "ViewDevelopersSettings", "EditDevelopersSettings", "ViewOrders", "UpdateOrdersAccept", "UpdateOrdersReject", "UpdateOrdersRefund", "UpdateOrdersDispatch", "ViewStores", "CreateStores", "EditStores", "ViewStoresOpeningHours", "UpdateStoresOpenForCollectionOrDelivery", "UpdateStoresOpeningHours", "ViewStoresOpeningHoursOverride", "EditStoresOpeningHoursOverride", "EditStoresOpeningHoursOverrideTemporary", "UpdateStoresName", "EditStoreKioskSettings", "EditStoreOrderCapacity", "ArchiveStores", "PublishStores", "UpdatePrinterTerminalsAssign", "UpdatePrinterTerminalsToggle", "EditStoreNotifications", "ViewStoreGroups", "CreateStoreGroups", "UpdateStoreGroups", "DeleteStoreGroups", "ViewDeliveryZones", "CreateDeliveryZones", "UpdateDeliveryZones", "DeleteDeliveryZones", "ViewMenu", "CreateMenu", "UpdateMenu", "DeleteMenu", "UpdateMenuLock", "UpdateMenuItemsHideTemporarily", "EditMenuImage", "ViewVouchers", "EditVouchers", "ViewWebsiteContent", "EditWebsiteContent", "ViewWebsiteDnsVerified", "ViewWebsiteCertificateCreated", "ViewWebsiteCertificateRenewed", "ViewBankAccounts", "CreateBankAccounts", "UpdateBankAccounts", "UpdateBankAccountsAssign", "ViewAssignedBankAccount", "VerifyBankAccounts", "ViewServiceChargeConfigurations", "EditServiceChargeConfigurations", "EditStoreDeliveryZoneFees", "EditStoreDeliveryFeesLimited", "ViewHydraConfig", "UpdateHydraConfigManage", "InitiateBluetoothPairingMode", "DeleteTerminal", "ViewKioskTelemetry", "ViewCustomers", "EditCustomers", "CreateCustomers", "CreateCatalogElements", "UpdateCatalogElements", "ViewCatalogElements", "DeleteCatalogElements", "ViewMetafieldDefinitions", "CreateMetafieldDefinitions", "UpdateMetafieldDefinitions", "DeleteMetafieldDefinitions", "UpdateMetafields", "ViewCatalogMenuChanges", "PublishCatalogMenuChanges", "ViewAppStatistics", "ViewApmStatistics", "ViewCampaignsStatistics", "ViewCustomerStatistics", "ViewLiveStatistics", "ViewOrderStatistics", "ViewSalesStatistics", "ViewSalesEndOfDayStatistics", "ViewVouchersStatistics", "DownloadCustomerCsvExport", "ViewApmAuditLogs", "ViewStoreAuditLogs", "ViewMenuAuditLogs", "ViewBankAccountAuditLogs", "ViewFeeConfigurationsAuditLogs", "ViewOrdersAuditLogs", "ViewVouchersAuditLogs", "ViewUserEventsAuditLogs", "ViewCampaignsAuditLogs", "ViewTeammatesAuditLogs", "ViewAppAuditLogs", "ViewCustomerAuditLogs", "ViewPrinterAuditLogs", "ViewHydraAuditLogs", "ViewPushNotificationAuditLogs", "ViewStripeCustomConnectedAccountAuditLogs", "ViewKioskBluetoothDeviceAuditLogs", "ViewExternalAuditLogs", "CreateExternalAuditLogEvents", "ViewCatalogAuditLogs", "ViewOrderFulfillmentAuditLogs", "ViewChannelAuditLogs", "ViewAppStoreAuditLogs", "SendPushNotificationToCustomer", "InviteDriverToApp", "GetDriverForApp", "RemoveDriverFromApp", "AssignDriverToOrder", "UnassignDriverFromOrder", "UpdateOrdersDeliveryTrackingStatus", "UpdateOrderFulfillmentStatus", "ViewFulfillmentStatesConfiguration", "CreateFulfillmentStatesConfiguration", "UpdateFulfillmentStatesConfiguration", "DeleteFulfillmentStatesConfiguration", "ViewPayouts", "ViewChannels", "ViewOnboarding", "UpdateOnboarding", "ViewClientDevices", "UpdateClientDevices", "EnrollClientDevices", "AssignClientDevices", "ViewClientAuditLogs", "CreateAppStoreAppConfiguration", "ViewAppStoreAppConfiguration", "UpdateAppStoreAppConfiguration", "DeleteAppStoreAppConfiguration", "UpdateAppStoreAppConfigurationSettings", "CreateAppStoreSubscription", "UpdateAppStoreSubscription", "DeleteAppStoreSubscription", "ViewSalesChannels", "EditSalesChannels", "ViewPayGreenWhiteLabelConfiguration", "CreatePayGreenWhiteLabelConfiguration", "UpdatePayGreenWhiteLabelConfiguration", "UpdatePayGreenStoreConfiguration", "ViewSubscriptions", "ViewInvoices", "EditAccountsBills", "ViewAccountsBills", "EditAccountsCategories", "ViewAccountsCategories", "EditAccountsCreditAccounts", "ViewAccountsCreditAccounts", "EditAccountsCreditBooks", "ViewAccountsCreditBooks", "EditAccountsExpenses", "ViewAccountsExpenses", "EditAccountsTransactionAccounts", "ViewAccountsTransactionAccounts", "EditDocumentExplorer", "ViewDocumentExplorer", "ViewInventoryReports", "EditInventoryPurchaseOrders", "ViewInventoryPurchaseOrders", "EditInventoryStockItems", "ViewInventoryStockItems", "EditInventorySupplier", "ViewInventorySupplier", "EditInventoryTrackingProfiles", "ViewInventoryTrackingProfiles", "ViewPayrollReports", "EditPayrollHoliday", "ViewPayrollHoliday", "EditPayrollRota", "ViewPayrollRota", "EditPayrollStaff", "ViewPayrollStaff", "ViewSalesReports", "ViewCostReports", "ViewMenuReports" ], "type": "string" }, "example": [ "ViewApp" ] }, "Features": { "description": "Feature flags. These cannot be set by 3rd parties.", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "MapCenter": { "$ref": "#/components/schemas/Coordinates" }, "MapNorthEast": { "$ref": "#/components/schemas/Coordinates" }, "MapSouthWest": { "$ref": "#/components/schemas/Coordinates" }, "GoogleMapsApiKeyWeb": { "description": "Key to be passed with Google Maps requests", "type": "string", "example": "string" }, "OrgId": { "description": "Org Id", "type": "string", "example": "500123" }, "SmsRestaurantName": { "description": "SMS Restaurant Name", "type": "string", "example": "Example Name" }, "WebToAppRedirect": { "description": "Web to App Redirect settings", "enum": [ "NoRedirect", "RedirectOnce", "RedirectAlways", "SuggestPwa", "ForcePwa" ], "type": "string", "example": "NoRedirect" }, "Name": { "description": "App name. \r\nThis is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.", "type": "string", "example": "Example Name" }, "HostName": { "description": "HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.", "type": "string", "example": "Example Name" }, "MainColor": { "description": "Main color of the web / Android / iOS applications", "type": "string", "example": "string" }, "KioskPrimaryColour": { "description": "Primary colour used on the Kiosk", "type": "string", "example": "string" }, "ApplicationCategory": { "description": "Application Category", "enum": [ "Restaurant", "Cafe", "Convenience" ], "type": "string", "example": "Restaurant" }, "IsPanaceaEnabled": { "description": "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.\r\nThe alternative to using Panacea websites is to use a custom domain.", "type": "boolean", "example": true }, "PanaceaVanityUrl": { "description": "In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}", "type": "string", "example": "https://api.flipdish.co/example" }, "CookieConsentPromptEnabled": { "description": "Cookie Consent Prompt Enabled", "type": "boolean", "example": true }, "CountryId": { "description": "Country identifier in ISO 3166-1 alpha-2 format. \r\nThis code is set automatically based on the locations of the Stores in the App. \r\n\r\nThe App Country is used \r\n - to determine how to parse mobile phone numbers that are entered in their local numbering format\r\n - to determine if country specific payment methods should be offered\r\n - in various fraud checks", "maxLength": 2, "minLength": 0, "type": "string", "example": "500123" } } }, "AppChannelAssignment": { "description": "Describes a ChannelAssignment which is \r\nwhen a AppId is assigned to a Sales Channel", "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Id of the channel on the assignment", "type": "integer", "example": 500123 }, "AppId": { "description": "AppId of the assignment", "type": "string", "example": "500123" } } }, "AppCompliance": { "description": "Application compliance model", "type": "object", "properties": { "AppId": { "description": "App ID", "type": "string", "example": "500123" }, "ComplianceType": { "description": "Type of compliance.\r\nThis controls if the Flipdish websites and apps display cookie consent banners and adjust cookies to be inline with various regulations. \r\nYou should set this correctly based on your region.", "enum": [ "Default", "GdprCompliance" ], "type": "string", "example": "Default" }, "AllowDisablingOfGdpr": { "description": "For EU countries, we should not allow to change the option to \u201cDefault banner\u201d, but all other countries should be able to do so.", "type": "boolean", "example": true } } }, "AppConfigSalesChannel": { "description": "App Config Sales Channel", "type": "object", "properties": { "EmailRequestMode": { "description": "Display a popup to users requesting their email address", "enum": [ "DoNotRequest", "Request", "Require" ], "type": "string", "example": "DoNotRequest" }, "WebToAppRedirect": { "description": "Sends users to their native apps or request them to install the pwa", "enum": [ "NoRedirect", "RedirectOnce", "RedirectAlways", "SuggestPwa", "ForcePwa" ], "type": "string", "example": "NoRedirect" }, "AddressEntryType": { "description": "Address entry type - TextEntryManualDisallowed is the only supported configuration", "enum": [ "MapFirst", "TextEntryManualAllowed", "TextEntryManualDisallowed" ], "type": "string", "example": "MapFirst" }, "DisplayDeliveryRestaurantListScreen": { "description": "Display Pickup Restaurant List Screen", "type": "boolean", "example": true } } }, "AppConfigUpdateModel": { "description": "Application configuration", "type": "object", "properties": { "Name": { "description": "App name. \r\nThis is used in various places on the Apple App Store, Google Play Store, mobile apps and websites.", "type": "string", "example": "Example Name" }, "HostName": { "description": "HostName on which the web-ordering system is allowed to be hosted or that a Flipdish website is hosted on.", "type": "string", "example": "Example Name" }, "MainColor": { "description": "Main color of the web / Android / iOS applications", "type": "string", "example": "string" }, "KioskPrimaryColour": { "description": "Primary colour used on the Kiosk", "type": "string", "example": "string" }, "ApplicationCategory": { "description": "Application Category", "enum": [ "Restaurant", "Cafe", "Convenience" ], "type": "string", "example": "Restaurant" }, "IsPanaceaEnabled": { "description": "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.\r\nThe alternative to using Panacea websites is to use a custom domain.", "type": "boolean", "example": true }, "PanaceaVanityUrl": { "description": "In case of IsPanaceaEnabled is true, the app can be accessed via https://my.flipdish.com/{PanaceaVanityUrl}", "type": "string", "example": "https://api.flipdish.co/example" }, "CookieConsentPromptEnabled": { "description": "Cookie Consent Prompt Enabled", "type": "boolean", "example": true }, "LogoImageUrl": { "description": "Logo image URL", "type": "string", "example": "https://api.flipdish.co/example" }, "CountryId": { "description": "Country identifier in ISO 3166-1 alpha-2 format. \r\nThis code is set automatically based on the locations of the Stores in the App. \r\n\r\nThe App Country is used \r\n - to determine how to parse mobile phone numbers that are entered in their local numbering format\r\n - to determine if country specific payment methods should be offered\r\n - in various fraud checks", "maxLength": 2, "minLength": 0, "type": "string", "example": "500123" } } }, "AppGeneralConfigModel": { "description": "App general configuration model", "type": "object", "properties": { "WhiteLabelId": { "format": "int32", "description": "White label ID", "type": "integer", "example": 500123 }, "DeepLinkUrlScheme": { "description": "Deep link URL scheme", "type": "string", "example": "https://api.flipdish.co/example" }, "SmsRestaurantName": { "description": "SMS restaurant name", "type": "string", "example": "Example Name" }, "NexmoSupportSmsNumber": { "description": "Nexmo support SMS number", "type": "string", "example": "string" }, "TwilioSupportSmsNumber": { "description": "Twilio support SMS number", "type": "string", "example": "string" }, "FallbackPhoneNumberPrefix": { "description": "Fallback phone number prefix", "type": "string", "example": "+353000000000" }, "AutocompletePhoneNumberLength": { "format": "int32", "description": "Autocomplete phone number length", "type": "integer", "example": 3 }, "ContactFormType": { "description": "Contact form type\r\nNone = 0,\r\nEmail = 1,\r\nIntercom = 2,\r\nWebView = 3,\r\nFlipdishMessages = 4", "type": "string", "example": "string" }, "PrivateSupportEmailAddress": { "description": "Private support email address", "type": "string", "example": "owner@example.com" }, "ContactPhoneNumber": { "description": "Contact phone number", "type": "string", "example": "+353000000000" }, "DeliveryEnabled": { "description": "Delivery enabled", "type": "boolean", "example": true }, "PickupEnabled": { "description": "Pickup enabled", "type": "boolean", "example": true }, "DineInEnabled": { "description": "Dine in enabled", "type": "boolean", "example": true }, "DisplayDeliveryRestaurantListScreen": { "description": "Display delivery restaurant list screen", "type": "boolean", "example": true }, "DisplayPickupRestaurantListScreen": { "description": "Display pickup restaurant list screen", "type": "boolean", "example": true } } }, "AppLookup": { "description": "App lookup model", "type": "object", "properties": { "AppId": { "description": "App id", "type": "string", "example": "500123" } } }, "AppStoreApp": { "required": [ "Id", "VerificationStatus", "OAuthAppId", "Internal", "Details", "ConfigurationType", "StoreSelectorType", "PermissionsType", "Name", "Description", "Categories", "Countries" ], "type": "object", "properties": { "Id": { "type": "string", "example": "500123" }, "VerificationStatus": { "enum": [ "Draft", "Submitted", "Verified" ], "type": "string", "example": "Draft" }, "Logo": { "type": "string", "example": "string" }, "OAuthAppId": { "type": "string", "example": "500123" }, "Internal": { "type": "boolean", "example": true }, "Details": { "type": "string", "example": "string" }, "ConfigurationType": { "enum": [ "ExternalLink", "FlipdishHosted" ], "type": "string", "example": "ExternalLink" }, "StoreSelectorType": { "enum": [ "None", "Single", "Multiple" ], "type": "string", "example": "None" }, "FieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroup" }, "example": [] }, "SetupInstructions": { "type": "string", "example": "string" }, "ExternalSetupLink": { "type": "string", "example": "https://api.flipdish.co/example" }, "TeammateAppAccessLevel": { "enum": [ "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger" ], "type": "string", "example": "Owner" }, "PermissionsType": { "enum": [ "Teammate" ], "type": "string", "example": "Teammate" }, "Support": { "$ref": "#/components/schemas/AppStoreAppSupportInfo" }, "ExternalFunctionActionUrl": { "type": "string", "example": "https://api.flipdish.co/example" }, "ExternalFunctionSignatureKey": { "type": "string", "example": "string" }, "IsPaid": { "type": "boolean", "example": true }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "IsEnabled": { "type": "boolean", "example": true }, "Categories": { "type": "array", "items": { "enum": [ "PointOfSale", "DeliveryAndLogistics", "CRM", "GiftCard", "Accounting", "LoyaltyAndMarketing", "Other" ], "type": "string" }, "example": [ "PointOfSale" ] }, "Countries": { "type": "array", "items": { "enum": [ "GB", "IE", "FR", "ES", "PT", "IT", "DE", "PL", "BE", "LU", "NL", "US", "CA", "BG", "MX", "AU", "NZ" ], "type": "string" }, "example": [ "GB" ] }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "AppStoreAppConfiguration": { "required": [ "Id", "AppId", "AppStoreAppId", "IsEnabled", "VerificationStatus", "OAuthAppId", "Internal", "Details", "ConfigurationType", "StoreSelectorType", "PermissionsType", "Name", "Description", "Categories", "Countries" ], "type": "object", "properties": { "Id": { "type": "string", "example": "500123" }, "AppId": { "type": "string", "example": "500123" }, "AppStoreAppId": { "type": "string", "example": "500123" }, "IsEnabled": { "type": "boolean", "example": true }, "StoreIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "Settings": { "type": "array", "items": { "$ref": "#/components/schemas/Setting" }, "example": [] }, "VerificationStatus": { "enum": [ "Draft", "Submitted", "Verified" ], "type": "string", "example": "Draft" }, "Logo": { "type": "string", "example": "string" }, "OAuthAppId": { "type": "string", "example": "500123" }, "Internal": { "type": "boolean", "example": true }, "Details": { "type": "string", "example": "string" }, "ConfigurationType": { "enum": [ "ExternalLink", "FlipdishHosted" ], "type": "string", "example": "ExternalLink" }, "StoreSelectorType": { "enum": [ "None", "Single", "Multiple" ], "type": "string", "example": "None" }, "FieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroup" }, "example": [] }, "SetupInstructions": { "type": "string", "example": "string" }, "ExternalSetupLink": { "type": "string", "example": "https://api.flipdish.co/example" }, "TeammateAppAccessLevel": { "enum": [ "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger" ], "type": "string", "example": "Owner" }, "PermissionsType": { "enum": [ "Teammate" ], "type": "string", "example": "Teammate" }, "Support": { "$ref": "#/components/schemas/AppStoreAppSupportInfo" }, "ExternalFunctionActionUrl": { "type": "string", "example": "https://api.flipdish.co/example" }, "ExternalFunctionSignatureKey": { "type": "string", "example": "string" }, "IsPaid": { "type": "boolean", "example": true }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "Categories": { "type": "array", "items": { "enum": [ "PointOfSale", "DeliveryAndLogistics", "CRM", "GiftCard", "Accounting", "LoyaltyAndMarketing", "Other" ], "type": "string" }, "example": [ "PointOfSale" ] }, "Countries": { "type": "array", "items": { "enum": [ "GB", "IE", "FR", "ES", "PT", "IT", "DE", "PL", "BE", "LU", "NL", "US", "CA", "BG", "MX", "AU", "NZ" ], "type": "string" }, "example": [ "GB" ] }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "AppStoreAppConfigurationSummary": { "required": [ "Id", "AppId", "IsEnabled", "Stores", "ConfigurationType", "StoreSelectorType", "Internal", "AppStoreAppId", "Name", "Description" ], "type": "object", "properties": { "Id": { "type": "string", "example": "500123" }, "AppId": { "type": "string", "example": "500123" }, "IsEnabled": { "type": "boolean", "example": true }, "Stores": { "type": "array", "items": { "$ref": "#/components/schemas/ConfiguredStore" }, "example": [] }, "ConfigurationType": { "enum": [ "ExternalLink", "FlipdishHosted" ], "type": "string", "example": "ExternalLink" }, "StoreSelectorType": { "enum": [ "None", "Single", "Multiple" ], "type": "string", "example": "None" }, "Internal": { "type": "boolean", "example": true }, "AppStoreAppId": { "type": "string", "example": "500123" }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "Logo": { "type": "string", "example": "string" }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "AppStoreAppEntitlements": { "type": "object", "properties": { "EntitlementQuantity": { "format": "int32", "type": "integer", "example": 3 }, "CurrentUsage": { "format": "int32", "type": "integer", "example": 1 } } }, "AppStoreAppSummary": { "required": [ "Id", "VerificationStatus", "Internal", "Name", "Description", "Categories", "Countries" ], "type": "object", "properties": { "Id": { "type": "string", "example": "500123" }, "VerificationStatus": { "enum": [ "Draft", "Submitted", "Verified" ], "type": "string", "example": "Draft" }, "Logo": { "type": "string", "example": "string" }, "Internal": { "type": "boolean", "example": true }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "IsEnabled": { "type": "boolean", "example": true }, "Categories": { "type": "array", "items": { "enum": [ "PointOfSale", "DeliveryAndLogistics", "CRM", "GiftCard", "Accounting", "LoyaltyAndMarketing", "Other" ], "type": "string" }, "example": [ "PointOfSale" ] }, "Countries": { "type": "array", "items": { "enum": [ "GB", "IE", "FR", "ES", "PT", "IT", "DE", "PL", "BE", "LU", "NL", "US", "CA", "BG", "MX", "AU", "NZ" ], "type": "string" }, "example": [ "GB" ] }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "AppStoreAppSupportInfo": { "type": "object", "properties": { "PrivacyPolicy": { "type": "string", "example": "string" }, "TermsOfUse": { "type": "string", "example": "string" }, "CompanyWebsite": { "type": "string", "example": "string" }, "LearnMore": { "type": "string", "example": "string" }, "InstallationMessage": { "type": "string", "example": "string" }, "SupportEmail": { "type": "string", "example": "owner@example.com" } } }, "AppStoreConfigModel": { "description": "App Store configuration model", "type": "object", "properties": { "WhiteLabelId": { "format": "int32", "description": "White label ID", "type": "integer", "example": 500123 }, "ReadyToPublishToAppStore": { "description": "Ready to publish to app store", "type": "boolean", "example": true }, "AppStoreName": { "description": "App store name", "type": "string", "example": "Example Name" }, "AppStoreAppleId": { "description": "App Store Apple ID", "type": "string", "example": "500123" }, "AppStoreUrl": { "description": "App Store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AppStoreId": { "description": "App Store ID", "type": "string", "example": "500123" }, "AppStorePassword": { "description": "App Store password", "type": "string", "example": "string" }, "TeamId": { "description": "Team ID", "type": "string", "example": "500123" }, "AppGroupId": { "description": "App Group ID", "type": "string", "example": "500123" }, "BundleId": { "description": "Bundle ID", "type": "string", "example": "500123" }, "AppStoreSigningIdentity": { "description": "App Store signing identity", "type": "string", "example": "string" }, "AppStoreToken": { "description": "App Store token", "type": "string", "example": "string" }, "AppStoreMerchantId": { "description": "App Store merchant ID", "type": "string", "example": "500123" }, "P8PrivateKey": { "description": "P8 private key", "type": "string", "example": "string" }, "P8PrivateKeyId": { "description": "P8 private key ID", "type": "string", "example": "500123" } } }, "AssetResultModel": { "description": "Asset result model", "type": "object", "properties": { "Message": { "description": "Asset result message", "type": "string", "example": "string" }, "AssetUrl": { "description": "Asset URL or path", "type": "string", "example": "https://api.flipdish.co/example" }, "AssetName": { "description": "Asset name", "type": "string", "example": "Example Name" } } }, "BuildResultModel": { "description": "Build result model", "type": "object", "properties": { "Message": { "description": "Build result message", "type": "string", "example": "string" }, "BuildId": { "description": "Build ID or reference", "type": "string", "example": "500123" } } }, "Channel": { "description": "Channel.", "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Channel Id", "type": "integer", "example": 500123 }, "TranslationKey": { "description": "Channel TranslationKey", "type": "string", "example": "string" }, "Source": { "description": "Channel Source", "enum": [ "Internal", "External" ], "type": "string", "example": "Internal" }, "LogoUri": { "description": "Channel Logo URl", "type": "string", "example": "https://api.flipdish.co/example" }, "Available": { "description": "Channel is Available or not", "type": "boolean", "example": true }, "MaintainedExternally": { "description": "Channel is Maintained Externally or not", "type": "boolean", "example": true } } }, "ConfiguredStore": { "type": "object", "properties": { "StoreId": { "format": "int32", "type": "integer", "example": 500123 }, "Name": { "type": "string", "example": "Example Name" } } }, "Coordinates": { "description": "Coordinates", "type": "object", "properties": { "Latitude": { "format": "double", "description": "Latitude", "type": "number", "example": 1.0 }, "Longitude": { "format": "double", "description": "Longitude", "type": "number", "example": 1.0 } } }, "CreateAppParameters": { "description": "The parameters required to create a new app.", "type": "object", "properties": { "Name": { "description": "The name of the brand that this app/white-label represents.", "type": "string", "example": "Example Name" } } }, "CreateAppStoreApp": { "required": [ "Details", "ConfigurationType", "StoreSelectorType", "PermissionsType", "Name", "Description", "Categories", "Countries" ], "type": "object", "properties": { "Details": { "type": "string", "example": "string" }, "ConfigurationType": { "enum": [ "ExternalLink", "FlipdishHosted" ], "type": "string", "example": "ExternalLink" }, "StoreSelectorType": { "enum": [ "None", "Single", "Multiple" ], "type": "string", "example": "None" }, "FieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroup" }, "example": [] }, "SetupInstructions": { "type": "string", "example": "string" }, "ExternalSetupLink": { "type": "string", "example": "https://api.flipdish.co/example" }, "TeammateAppAccessLevel": { "enum": [ "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger" ], "type": "string", "example": "Owner" }, "PermissionsType": { "enum": [ "Teammate" ], "type": "string", "example": "Teammate" }, "Support": { "$ref": "#/components/schemas/AppStoreAppSupportInfo" }, "ExternalFunctionActionUrl": { "type": "string", "example": "https://api.flipdish.co/example" }, "ExternalFunctionSignatureKey": { "type": "string", "example": "string" }, "IsPaid": { "type": "boolean", "example": true }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "IsEnabled": { "type": "boolean", "example": true }, "Categories": { "type": "array", "items": { "enum": [ "PointOfSale", "DeliveryAndLogistics", "CRM", "GiftCard", "Accounting", "LoyaltyAndMarketing", "Other" ], "type": "string" }, "example": [ "PointOfSale" ] }, "Countries": { "type": "array", "items": { "enum": [ "GB", "IE", "FR", "ES", "PT", "IT", "DE", "PL", "BE", "LU", "NL", "US", "CA", "BG", "MX", "AU", "NZ" ], "type": "string" }, "example": [ "GB" ] }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "DnsRecordInformation": { "description": "Holds the information for the A and CNAME Records of a domain.", "type": "object", "properties": { "IsCNameReady": { "description": "indicates whether the CNAME record is ready or not.", "type": "boolean", "example": true }, "IsAReady": { "description": "indicates whether the A record is ready or not.", "type": "boolean", "example": true }, "IsApiCNameReady": { "description": "indicates whether the API CNAME record is ready or not.", "type": "boolean", "example": true } } }, "ExecuteConfigurationActionRequest": { "type": "object", "properties": { "Key": { "type": "string", "example": "string" }, "Action": { "type": "string", "example": "string" } } }, "ExecuteConfigurationActionResult": { "type": "object", "properties": { "ErrorMessage": { "type": "string", "example": "string" }, "InfoMessage": { "type": "string", "example": "string" }, "RedirectUrl": { "type": "string", "example": "https://api.flipdish.co/example" }, "RedirectTarget": { "enum": [ "Default", "NewWindow", "Popup" ], "type": "string", "nullable": true, "example": "Default" } } }, "Field": { "required": [ "Name", "Description", "Key", "Position", "FieldType" ], "type": "object", "properties": { "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "Key": { "type": "string", "example": "string" }, "Tooltip": { "type": "string", "example": "string" }, "Position": { "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer", "example": 1 }, "DefaultValue": { "type": "string", "example": "string" }, "ValidValues": { "type": "array", "items": { "$ref": "#/components/schemas/ValidValue" }, "example": [] }, "ValidationRegex": { "type": "string", "example": "string" }, "FieldType": { "enum": [ "Text", "TextArea", "Integer", "Decimal", "Date", "DateTime", "Time", "Select", "Boolean", "ActionButton" ], "type": "string", "example": "Text" }, "IsFlipdishRestricted": { "type": "boolean", "nullable": true, "example": true } } }, "FieldGroup": { "required": [ "Name", "Position" ], "type": "object", "properties": { "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "Tooltip": { "type": "string", "example": "string" }, "Position": { "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer", "example": 1 }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "example": [] } } }, "FirebaseApp": { "description": "FirebaseApp.", "type": "object", "properties": { "WhitelabelId": { "format": "int32", "description": "WhitelabelId.", "type": "integer", "example": 500123 }, "PackageId": { "description": "PackageId.", "type": "string", "example": "500123" }, "FirebaseAppId": { "description": "FirebaseAppId.", "type": "string", "example": "500123" }, "FirebaseProjectId": { "description": "FirebaseProjectId.", "type": "string", "example": "500123" } } }, "FlipdishError": { "type": "object", "description": "Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).", "properties": { "error": { "type": "object", "description": "Error detail object.", "properties": { "errorMessage": { "type": "string", "description": "Descriptive explanation of the issue.", "example": "Invalid or missing parameters." }, "errorCode": { "type": "string", "description": "Unique identifier for programmatic error handling.", "example": "BadRequest" }, "details": { "type": "string", "description": "Additional context returned in non-production environments.", "example": "Validation failed for field 'storeId'." } } } } }, "HttpPostedFileBase": { "type": "object", "properties": { "ContentLength": { "format": "int32", "type": "integer", "readOnly": true, "example": 1 }, "ContentType": { "type": "string", "readOnly": true, "example": "string" }, "FileName": { "type": "string", "readOnly": true, "example": "Example Name" }, "InputStream": { "$ref": "#/components/schemas/Stream" } } }, "IndexPage": { "description": "Index Page", "type": "object", "properties": { "Testimonials": { "description": "Testimonials", "type": "array", "items": { "$ref": "#/components/schemas/WebsiteTestimonial" }, "example": [] }, "Images": { "description": "Images", "type": "array", "items": { "$ref": "#/components/schemas/WebsiteImage" }, "example": [] }, "AboutSectionEnabled": { "description": "About section enabled", "type": "boolean", "example": true }, "AboutSectionTitle": { "description": "About section title", "type": "string", "example": "string" }, "AboutSectionSubtitle": { "description": "About section sub-title", "type": "string", "example": "string" }, "AboutSectionLeftTitle": { "description": "About section title left", "type": "string", "example": "string" }, "AboutSectionLeftBody": { "description": "About section text left", "type": "string", "example": "string" }, "AboutSectionRightTitle": { "description": "About section title right", "type": "string", "example": "string" }, "AboutSectionRightBody": { "description": "About section text right", "type": "string", "example": "string" }, "OpeningHoursEnabled": { "description": "Opening hours section Enabled", "type": "boolean", "example": true }, "MenuPreviewEnabled": { "description": "Menu Preview section Enabled", "type": "boolean", "example": true }, "GalleryEnabled": { "description": "Gallery section enabled", "type": "boolean", "example": true }, "TestimonialsEnabled": { "description": "Testimonials section Enabled", "type": "boolean", "example": true }, "ContactFormEnabled": { "description": "Contact Form section Enabled", "type": "boolean", "example": true }, "ContactFormEmail": { "description": "Contact Form Email", "type": "string", "example": "owner@example.com" }, "MapEnabled": { "description": "Map section Enabled", "type": "boolean", "example": true } } }, "IndexPageBase": { "description": "Base of Index Page", "type": "object", "properties": { "AboutSectionEnabled": { "description": "About section enabled", "type": "boolean", "example": true }, "AboutSectionTitle": { "description": "About section title", "type": "string", "example": "string" }, "AboutSectionSubtitle": { "description": "About section sub-title", "type": "string", "example": "string" }, "AboutSectionLeftTitle": { "description": "About section title left", "type": "string", "example": "string" }, "AboutSectionLeftBody": { "description": "About section text left", "type": "string", "example": "string" }, "AboutSectionRightTitle": { "description": "About section title right", "type": "string", "example": "string" }, "AboutSectionRightBody": { "description": "About section text right", "type": "string", "example": "string" }, "OpeningHoursEnabled": { "description": "Opening hours section Enabled", "type": "boolean", "example": true }, "MenuPreviewEnabled": { "description": "Menu Preview section Enabled", "type": "boolean", "example": true }, "GalleryEnabled": { "description": "Gallery section enabled", "type": "boolean", "example": true }, "TestimonialsEnabled": { "description": "Testimonials section Enabled", "type": "boolean", "example": true }, "ContactFormEnabled": { "description": "Contact Form section Enabled", "type": "boolean", "example": true }, "ContactFormEmail": { "description": "Contact Form Email", "type": "string", "example": "owner@example.com" }, "MapEnabled": { "description": "Map section Enabled", "type": "boolean", "example": true } } }, "Language": { "description": "Sorted Language", "type": "object", "properties": { "LanguageId": { "description": "ISO 639-1 Language Code", "type": "string", "example": "500123" }, "DisplayOrder": { "format": "int32", "description": "Display Order", "type": "integer", "example": 1 }, "Name": { "description": "Language Name", "type": "string", "example": "Example Name" }, "Enabled": { "description": "Is the language enabled for use.", "type": "boolean", "example": true } } }, "MobileAppsImage": { "description": "Mobile Apps Image", "type": "object", "properties": { "ImageUri": { "description": "Unique catalog Item id", "type": "string", "example": "https://api.flipdish.co/example" } } }, "MobileAppsStatistics": { "description": "Mobile Apps Statistics", "type": "object", "properties": { "NumberDownload": { "format": "int32", "description": "Number Download", "type": "integer", "example": 3 }, "CurrentRate": { "format": "int32", "description": "Current Rate", "type": "integer", "example": 1 }, "CurrentVersion": { "description": "Current Version", "type": "string", "example": "string" }, "PlayStoreLink": { "description": "Play Store Link", "type": "string", "example": "https://api.flipdish.co/example" }, "AppBundleId": { "description": "App Bundle Id", "type": "string", "example": "500123" }, "LastUpdated": { "format": "date-time", "description": "Last Updated", "type": "string", "example": "2026-06-02T12:00:00Z" }, "Notes": { "description": "Last Updated", "type": "string", "example": "string" }, "Published": { "description": "Published", "type": "boolean", "example": true }, "PlatformType": { "description": "Platform Type", "enum": [ "None", "Android", "IOS" ], "type": "string", "example": "None" } } }, "MobileAppsSubmission": { "description": "Mobile Apps form submission", "required": [ "AppName", "AppDescription", "AppShortDescription" ], "type": "object", "properties": { "SubmissionId": { "format": "int32", "description": "Mobile Apps Submission Id", "type": "integer", "example": 500123 }, "AppName": { "description": "App Name", "type": "string", "example": "Example Name" }, "AppDescription": { "description": "App Description", "type": "string", "example": "string" }, "AppShortDescription": { "description": "App Description", "type": "string", "example": "string" }, "Keywords": { "description": "Keywords", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "AutoPublish": { "description": "Publish automatically", "type": "boolean", "example": true } } }, "MobileAppsSubmissionDetails": { "description": "Mobile Apps form submission", "type": "object", "properties": { "MobileAppsSubmissionId": { "format": "int32", "description": "Mobile Apps Submission Id", "type": "integer", "example": 500123 }, "AppName": { "description": "App Name", "type": "string", "example": "Example Name" }, "AppDescription": { "description": "App Description", "type": "string", "example": "string" }, "AppShortDescription": { "description": "App Description", "type": "string", "example": "string" }, "Keywords": { "description": "Keywords", "type": "array", "items": { "type": "string" }, "example": [ "string" ] }, "AppLogoUrl": { "description": "Logo URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AutoPublish": { "description": "Publish automatically", "type": "boolean", "example": true }, "Status": { "description": "Mobile App Status", "type": "array", "items": { "$ref": "#/components/schemas/MobileAppsSubmissionStatus" }, "example": [] } } }, "MobileAppsSubmissionStatus": { "description": "Mobile Apps Status", "type": "object", "properties": { "MobileAppsSubmissionStatusId": { "format": "int32", "description": "Mobile Apps Submission Status Id", "type": "integer", "example": 500123 }, "MobileAppsSubmissionId": { "format": "int32", "description": "Mobile Apps Submission Id", "type": "integer", "example": 500123 }, "Type": { "description": "Mobile Type", "enum": [ "None", "Android", "IOS" ], "type": "string", "example": "None" }, "AppStatus": { "description": "Mobile App Status", "enum": [ "None", "Published", "Unpublished" ], "type": "string", "example": "None" }, "UpdateStatus": { "description": "Mobile App Status", "enum": [ "None", "Submitted", "InReview", "Rejected", "Approved", "Published" ], "type": "string", "example": "None" }, "LastUpdateStatusTime": { "format": "date-time", "description": "Mobile LastUpdateStatusTime", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "CreateTime": { "format": "date-time", "description": "Mobile CreateTime", "type": "string", "example": "2026-06-02T12:00:00Z" }, "UpdateTime": { "format": "date-time", "description": "Mobile UpdateTime", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Notes": { "description": "Mobile Notes", "type": "string", "example": "string" } } }, "PlayStoreConfigModel": { "description": "Play Store configuration model", "type": "object", "properties": { "WhiteLabelId": { "format": "int32", "description": "White label ID", "type": "integer", "example": 500123 }, "BundleId": { "description": "Bundle ID", "type": "string", "example": "500123" }, "Description": { "description": "Description", "type": "string", "example": "string" }, "ShortDescription": { "description": "Short description", "type": "string", "example": "string" }, "Copyright": { "description": "Copyright", "type": "string", "example": "string" }, "Keywords": { "description": "Keywords", "type": "string", "example": "string" }, "MarketingUrl": { "description": "Marketing URL", "type": "string", "example": "https://api.flipdish.co/example" }, "PrivacyUrl": { "description": "Privacy URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SupportUrl": { "description": "Support URL", "type": "string", "example": "https://api.flipdish.co/example" }, "PlayConsoleAccount": { "format": "int32", "description": "Play Console account\r\n0: UK, 1: IE", "type": "integer", "example": 3 }, "ReleaseNotes": { "description": "Release notes", "type": "string", "example": "string" }, "StoreIcon": { "description": "Store icon URL", "type": "string", "example": "string" }, "ReadyToPublishAndroid": { "description": "Ready to publish Android", "type": "boolean", "example": true } } }, "Response": { "type": "object", "properties": { "Stores": { "type": "array", "items": { "$ref": "#/components/schemas/StoreItemHeader" }, "example": [] } } }, "RestApiArrayResult_AppStoreAppConfigurationSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreAppConfigurationSummary" }, "example": [] } } }, "RestApiArrayResult_AppStoreAppSummary_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreAppSummary" }, "example": [] } } }, "RestApiArrayResult_Channel_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/Channel" }, "example": [] } } }, "RestApiArrayResult_MobileAppsStatistics_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/MobileAppsStatistics" }, "example": [] } } }, "RestApiArrayResult_StoreChannelAssignment_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/StoreChannelAssignment" }, "example": [] } } }, "RestApiArrayResult_SupportedCountry_": { "description": "Rest api array result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/SupportedCountry" }, "example": [] } } }, "RestApiIntegerResult": { "description": "Rest api integer result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "format": "int32", "description": "Data integer", "type": "integer", "example": 1 } } }, "RestApiPaginationResult_AppStoreAppSummary_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/AppStoreAppSummary" }, "example": [] } } }, "RestApiPaginationResult_App_": { "description": "Rest api pagination result", "required": [ "Page", "Limit", "TotalRecordCount", "Data" ], "type": "object", "properties": { "Page": { "format": "int32", "description": "Current page index", "type": "integer", "example": 1 }, "Limit": { "format": "int32", "description": "Current page size", "type": "integer", "example": 1 }, "TotalRecordCount": { "format": "int32", "description": "Total record count", "type": "integer", "example": 12.5 }, "Data": { "description": "Generic data object.", "type": "array", "items": { "$ref": "#/components/schemas/App" }, "example": [] } } }, "RestApiResult_AppChannelAssignment_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppChannelAssignment" } } }, "RestApiResult_AppCompliance_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppCompliance" } } }, "RestApiResult_AppConfigSalesChannel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppConfigSalesChannel" } } }, "RestApiResult_AppGeneralConfigModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppGeneralConfigModel" } } }, "RestApiResult_AppStoreAppConfiguration_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppStoreAppConfiguration" } } }, "RestApiResult_AppStoreAppEntitlements_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppStoreAppEntitlements" } } }, "RestApiResult_AppStoreApp_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppStoreApp" } } }, "RestApiResult_AppStoreConfigModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AppStoreConfigModel" } } }, "RestApiResult_App_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/App" } } }, "RestApiResult_AssetResultModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/AssetResultModel" } } }, "RestApiResult_BuildResultModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/BuildResultModel" } } }, "RestApiResult_Channel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/Channel" } } }, "RestApiResult_DnsRecordInformation_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/DnsRecordInformation" } } }, "RestApiResult_ExecuteConfigurationActionResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/ExecuteConfigurationActionResult" } } }, "RestApiResult_IndexPageBase_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/IndexPageBase" } } }, "RestApiResult_IndexPage_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/IndexPage" } } }, "RestApiResult_MobileAppsImage_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MobileAppsImage" } } }, "RestApiResult_MobileAppsSubmissionDetails_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MobileAppsSubmissionDetails" } } }, "RestApiResult_MobileAppsSubmissionStatus_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MobileAppsSubmissionStatus" } } }, "RestApiResult_MobileAppsSubmission_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/MobileAppsSubmission" } } }, "RestApiResult_PlayStoreConfigModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/PlayStoreConfigModel" } } }, "RestApiResult_RestApiIntegerResult_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/RestApiIntegerResult" } } }, "RestApiResult_StoreChannelAssignment_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/StoreChannelAssignment" } } }, "RestApiResult_UpdateMobileAppsSubmissionStatus_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/UpdateMobileAppsSubmissionStatus" } } }, "RestApiResult_WebsiteImage_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WebsiteImage" } } }, "RestApiResult_WebsiteTestimonial_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WebsiteTestimonial" } } }, "RestApiResult_WhiteLabelConfigModel_": { "description": "Rest api result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "$ref": "#/components/schemas/WhiteLabelConfigModel" } } }, "RestApiStringResult": { "description": "Rest api string result", "required": [ "Data" ], "type": "object", "properties": { "Data": { "description": "Data string", "type": "string", "example": "string" } } }, "Setting": { "type": "object", "properties": { "Key": { "type": "string", "example": "string" }, "Value": { "type": "string", "example": "string" } } }, "StoreChannelAssignment": { "description": "Represents a store that is assigned to a Sales Channel", "type": "object", "properties": { "ChannelId": { "format": "int32", "description": "Channel ID", "type": "integer", "example": 500123 }, "StoreId": { "format": "int32", "description": "Store ID", "type": "integer", "example": 500123 }, "StoreName": { "description": "Store Name", "type": "string", "example": "Example Name" } } }, "StoreItemHeader": { "type": "object", "properties": { "StoreId": { "format": "int32", "type": "integer", "example": 500123 }, "Name": { "type": "string", "example": "Example Name" } } }, "Stream": { "type": "object", "properties": { "CanRead": { "type": "boolean", "readOnly": true, "example": true }, "CanSeek": { "type": "boolean", "readOnly": true, "example": true }, "CanTimeout": { "type": "boolean", "readOnly": true, "example": true }, "CanWrite": { "type": "boolean", "readOnly": true, "example": true }, "Length": { "format": "int64", "type": "integer", "readOnly": true, "example": 1 }, "Position": { "format": "int64", "type": "integer", "example": 1 }, "ReadTimeout": { "format": "int32", "type": "integer", "example": 1 }, "WriteTimeout": { "format": "int32", "type": "integer", "example": 1 } } }, "SupportedCountry": { "description": "Describes a supported country", "type": "object", "properties": { "CountryCode": { "description": "Country code", "type": "string", "example": "IE" }, "Name": { "description": "Nice display name for a country", "type": "string", "example": "Example Name" }, "PhoneCode": { "format": "int32", "description": "Country internatinoal phone code prefix", "type": "integer", "example": 1 }, "LanguageCode": { "description": "Language code", "type": "string", "example": "string" }, "LanguageName": { "description": "Language name", "type": "string", "example": "Example Name" }, "OtpNumber": { "description": "The phone number provided to Store staff which, in conjunction with a one-time-code, will connect them to the customer.", "type": "string", "example": "string" }, "SupportNumber": { "description": "The store's support phone number, displayed to customers.", "type": "string", "example": "string" }, "AddressLayout": { "description": "Address layout format. This changes the layout of address entry forms on the web app, iOS and Android app and should be set based on local custom.", "enum": [ "BuildingFirst", "AddressFirst", "FullStreetAddressFirst" ], "type": "string", "example": "BuildingFirst" }, "PostCodeType": { "description": "Post code type", "enum": [ "None", "PostCode", "Zip" ], "type": "string", "example": "None" }, "SupportRegion": { "description": "Supported region. This is not used.", "enum": [ "Default", "Spain", "Benelux" ], "type": "string", "example": "Default" } } }, "UpdateAppStoreApp": { "required": [ "Details", "ConfigurationType", "StoreSelectorType", "PermissionsType", "Name", "Description", "Categories", "Countries" ], "type": "object", "properties": { "Details": { "type": "string", "example": "string" }, "ConfigurationType": { "enum": [ "ExternalLink", "FlipdishHosted" ], "type": "string", "example": "ExternalLink" }, "StoreSelectorType": { "enum": [ "None", "Single", "Multiple" ], "type": "string", "example": "None" }, "FieldGroups": { "type": "array", "items": { "$ref": "#/components/schemas/FieldGroup" }, "example": [] }, "SetupInstructions": { "type": "string", "example": "string" }, "ExternalSetupLink": { "type": "string", "example": "https://api.flipdish.co/example" }, "TeammateAppAccessLevel": { "enum": [ "Owner", "StoreOwner", "PropertyOwner", "ManagedOwner", "Integrator", "PropertyManager", "StoreManager", "StoreStaff", "StoreReadOnlyAccess", "FinanceManger" ], "type": "string", "example": "Owner" }, "PermissionsType": { "enum": [ "Teammate" ], "type": "string", "example": "Teammate" }, "Support": { "$ref": "#/components/schemas/AppStoreAppSupportInfo" }, "ExternalFunctionActionUrl": { "type": "string", "example": "https://api.flipdish.co/example" }, "ExternalFunctionSignatureKey": { "type": "string", "example": "string" }, "IsPaid": { "type": "boolean", "example": true }, "Name": { "type": "string", "example": "Example Name" }, "Description": { "type": "string", "example": "string" }, "IsEnabled": { "type": "boolean", "example": true }, "Categories": { "type": "array", "items": { "enum": [ "PointOfSale", "DeliveryAndLogistics", "CRM", "GiftCard", "Accounting", "LoyaltyAndMarketing", "Other" ], "type": "string" }, "example": [ "PointOfSale" ] }, "Countries": { "type": "array", "items": { "enum": [ "GB", "IE", "FR", "ES", "PT", "IT", "DE", "PL", "BE", "LU", "NL", "US", "CA", "BG", "MX", "AU", "NZ" ], "type": "string" }, "example": [ "GB" ] }, "DeveloperName": { "type": "string", "example": "Example Name" } } }, "UpdateAppStoreAppConfiguration": { "required": [ "IsEnabled" ], "type": "object", "properties": { "IsEnabled": { "type": "boolean", "example": true }, "StoreIds": { "type": "array", "items": { "format": "int32", "type": "integer" }, "example": [ 1 ] }, "Settings": { "type": "array", "items": { "$ref": "#/components/schemas/Setting" }, "example": [] } } }, "UpdateAppStoreAppConfigurationValuesBatch": { "type": "object", "properties": { "Settings": { "type": "array", "items": { "$ref": "#/components/schemas/Setting" }, "example": [] } } }, "UpdateAppStoreAppExternalProduct": { "type": "object", "properties": { "ExternalProductId": { "type": "string", "example": "500123" } } }, "UpdateMobileAppsSubmissionStatus": { "description": "Update Mobile Apps Status", "type": "object", "properties": { "MobileAppsSubmissionStatusId": { "format": "int32", "description": "Mobile Apps Submission Status Id", "type": "integer", "nullable": true, "example": 500123 }, "Type": { "description": "Mobile Type", "enum": [ "None", "Android", "IOS" ], "type": "string", "example": "None" }, "AppStatus": { "description": "Mobile App Status", "enum": [ "None", "Published", "Unpublished" ], "type": "string", "example": "None" }, "UpdateStatus": { "description": "Mobile App Status", "enum": [ "None", "Submitted", "InReview", "Rejected", "Approved", "Published" ], "type": "string", "example": "None" }, "LastUpdateStatusTime": { "format": "date-time", "description": "Mobile LastUpdateStatusTime", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "Notes": { "description": "Mobile Notes", "type": "string", "example": "string" } } }, "ValidValue": { "required": [ "Code", "Name" ], "type": "object", "properties": { "Code": { "type": "string", "example": "string" }, "Name": { "type": "string", "example": "Example Name" } } }, "WebsiteImage": { "description": "Represents a website image", "type": "object", "properties": { "ImageId": { "format": "int32", "description": "Represents the id of the image", "type": "integer", "example": 500123 }, "ImageLocation": { "description": "Represents the location of the image", "enum": [ "IndexHeader", "IndexAboutSectionLeft", "IndexAboutSectionRight", "IndexGallery", "IndexOpeningHoursHeader", "IndexTestimonialsHeader" ], "type": "string", "example": "IndexHeader" }, "ImageUrl": { "description": "Represents the image url", "type": "string", "example": "https://api.flipdish.co/example" } } }, "WebsiteTestimonial": { "description": "Represents a testimonial", "type": "object", "properties": { "TestimonialId": { "format": "int32", "description": "Id of the testimonial", "type": "integer", "example": 500123 }, "Author": { "description": "Author of the testimonial", "type": "string", "example": "string" }, "Message": { "description": "Message of the testimonial", "type": "string", "example": "string" } } }, "WhiteLabelAssetModel": { "description": "White label asset model", "type": "object", "properties": { "WhiteLabelAssetId": { "format": "int32", "description": "White label asset ID", "type": "integer", "example": 500123 }, "WhiteLabelConfigId": { "format": "int32", "description": "White label configuration ID", "type": "integer", "example": 500123 }, "FilePath": { "description": "File path", "type": "string", "example": "string" }, "Url": { "description": "Asset URL", "type": "string", "example": "https://api.flipdish.co/example" }, "TsUpdate": { "format": "date-time", "description": "Timestamp update", "type": "string", "example": "2026-06-02T12:00:00Z" } } }, "WhiteLabelColorSchemeModel": { "description": "White label color scheme model", "type": "object", "properties": { "WhiteLabelColorSchemeId": { "format": "int32", "description": "White label color scheme ID", "type": "integer", "example": 500123 }, "Font": { "description": "Font", "type": "string", "example": "string" }, "Color": { "description": "Color", "type": "string", "example": "string" }, "Color2": { "description": "Color 2", "type": "string", "example": "string" }, "Color3": { "description": "Color 3", "type": "string", "example": "string" }, "Color4": { "description": "Color 4", "type": "string", "example": "string" }, "Color5": { "description": "Color 5", "type": "string", "example": "string" }, "Color6": { "description": "Color 6", "type": "string", "example": "string" }, "Color7": { "description": "Color 7", "type": "string", "example": "string" }, "Color8": { "description": "Color 8", "type": "string", "example": "string" }, "Color9": { "description": "Color 9", "type": "string", "example": "string" }, "Color10": { "description": "Color 10", "type": "string", "example": "string" }, "Color11": { "description": "Color 11", "type": "string", "example": "string" }, "Color12": { "description": "Color 12 (Kiosk Primary Colour)", "type": "string", "example": "string" } } }, "WhiteLabelConfigModel": { "description": "WhiteLabelConfig model", "type": "object", "properties": { "WhiteLabelLanguages": { "description": "White label languages", "type": "array", "items": { "$ref": "#/components/schemas/WhiteLabelLanguageModel" }, "example": [] }, "WhiteLabelAssets": { "description": "White label assets", "type": "array", "items": { "$ref": "#/components/schemas/WhiteLabelAssetModel" }, "example": [] }, "ColorScheme": { "$ref": "#/components/schemas/WhiteLabelColorSchemeModel" }, "WhiteLabelConfigId": { "format": "int32", "description": "White label configuration ID", "type": "integer", "example": 500123 }, "WhiteLabelId": { "format": "int32", "description": "White label ID", "type": "integer", "example": 500123 }, "WhiteLabelName": { "description": "White label name", "type": "string", "example": "Example Name" }, "AppNameId": { "description": "App name ID (Bundle ID Suffix)", "type": "string", "example": "500123" }, "OrgId": { "description": "Organization ID", "type": "string", "example": "500123" }, "SmsRestaurantName": { "description": "SMS restaurant name", "type": "string", "example": "Example Name" }, "DeepLinkUrlScheme": { "description": "Deep link URL scheme", "type": "string", "example": "https://api.flipdish.co/example" }, "HostName": { "description": "Host name", "type": "string", "example": "Example Name" }, "NexmoSupportSmsNumber": { "description": "Nexmo support SMS number", "type": "string", "example": "string" }, "TwilioSupportSmsNumber": { "description": "Twilio support SMS number", "type": "string", "example": "string" }, "MixpanelToken": { "description": "Mixpanel token", "type": "string", "example": "string" }, "IntercomAppId": { "description": "Intercom app ID", "type": "string", "example": "500123" }, "ShareMessageEmailSubject": { "description": "Share message email subject", "type": "string", "example": "owner@example.com" }, "ShareMessageEmailMessage": { "description": "Share message email message", "type": "string", "example": "owner@example.com" }, "ShareMessageSmsMessage": { "description": "Share message SMS message", "type": "string", "example": "string" }, "ShareMessageWhatsAppMessage": { "description": "Share message WhatsApp message", "type": "string", "example": "string" }, "ShareMessageFacebookMessage": { "description": "Share message Facebook message", "type": "string", "example": "string" }, "ShareMessageTwitterMessage": { "description": "Share message Twitter message", "type": "string", "example": "string" }, "ShareMessageGenericMessage": { "description": "Share message generic message", "type": "string", "example": "string" }, "DisplayDeliveryRestaurantListScreen": { "description": "Display delivery restaurant list screen", "type": "boolean", "example": true }, "ContactFormType": { "format": "int32", "description": "Contact form type", "type": "integer", "example": 1 }, "ContactPhoneNumber": { "description": "Contact phone number", "type": "string", "example": "+353000000000" }, "DisplayBumpSideMenuItem": { "description": "Display bump side menu item", "type": "boolean", "example": true }, "DisplayFreeCokeSideMenuItem": { "description": "Display free coke side menu item", "type": "boolean", "example": true }, "AppStoreUrl": { "description": "App store URL", "type": "string", "example": "https://api.flipdish.co/example" }, "DeliveryEnabled": { "description": "Delivery enabled", "type": "boolean", "example": true }, "PickupEnabled": { "description": "Pickup enabled", "type": "boolean", "example": true }, "DisplayPickupRestaurantListScreen": { "description": "Display pickup restaurant list screen", "type": "boolean", "example": true }, "DisplayCuisineTypeListAndRestaurantSearchBar": { "description": "Display cuisine type list and restaurant search bar", "type": "boolean", "example": true }, "DisplayUserRestaurantRatings": { "description": "Display user restaurant ratings", "type": "boolean", "example": true }, "ReadyToPublishWeb": { "description": "Ready to publish web", "type": "boolean", "example": true }, "ReadyToPublishIos": { "description": "Ready to publish iOS", "type": "boolean", "example": true }, "ReadyToPublishAndroid": { "description": "Ready to publish Android", "type": "boolean", "example": true }, "DisplayFooterLinksToOtherSites": { "description": "Display footer links to other sites", "type": "boolean", "example": true }, "DisplayOnlineOrderingMenu": { "description": "Display online ordering menu", "type": "boolean", "example": true }, "HideAppConfigFromAdminList": { "description": "Hide app config from admin list", "type": "boolean", "example": true }, "ComplianceType": { "description": "Compliance type", "enum": [ "Default", "GdprCompliance" ], "type": "string", "example": "Default" }, "IsMenuMigratedToRms": { "description": "Is menu migrated to RMS", "type": "boolean", "example": true }, "MapBoundryMaxLongitude": { "format": "double", "description": "Map boundary max longitude", "type": "number", "nullable": true, "example": 1.0 }, "MapBoundryMinLongitude": { "format": "double", "description": "Map boundary min longitude", "type": "number", "nullable": true, "example": 1.0 }, "MapBoundryMaxLatitude": { "format": "double", "description": "Map boundary max latitude", "type": "number", "nullable": true, "example": 1.0 }, "MapBoundryMinLatitude": { "format": "double", "description": "Map boundary min latitude", "type": "number", "nullable": true, "example": 1.0 }, "AppStoreAppleId": { "description": "App store Apple ID", "type": "string", "example": "500123" }, "AppStoreToken": { "description": "App store token", "type": "string", "example": "string" }, "WebsiteDisplayStaticMenuPage": { "description": "Website display static menu page", "type": "boolean", "example": true }, "IsEmbed": { "description": "Is embed", "type": "boolean", "nullable": true, "example": true }, "DisplayTipOptionToUsersByDefault": { "description": "Display tip option to users by default", "type": "boolean", "example": true }, "EmailRequestMode": { "format": "int32", "description": "Email request mode", "type": "integer", "example": 1 }, "AddressEntryType": { "format": "int32", "description": "Address entry type", "type": "integer", "example": 1 }, "AddressLayout": { "format": "int32", "description": "Address layout", "type": "integer", "example": 1 }, "Category": { "format": "int32", "description": "Category", "type": "integer", "example": 1 }, "MapCenterLatitude": { "format": "double", "description": "Map center latitude", "type": "number", "example": 1.0 }, "MapCenterLongitude": { "format": "double", "description": "Map center longitude", "type": "number", "example": 1.0 }, "IntercomTokenIos": { "description": "Intercom token iOS", "type": "string", "example": "string" }, "IntercomTokenAndroid": { "description": "Intercom token Android", "type": "string", "example": "500123" }, "GoogleAnalyticsTokensCsv": { "description": "Google Analytics tokens CSV", "type": "string", "example": "string" }, "FacebookTokensCsv": { "description": "Facebook tokens CSV", "type": "string", "example": "string" }, "ShareMessageGenericUrl": { "description": "Share message generic URL", "type": "string", "example": "https://api.flipdish.co/example" }, "PrivateSupportEmailAddress": { "description": "Private support email address", "type": "string", "example": "owner@example.com" }, "AppStoreId": { "description": "App store ID", "type": "string", "example": "500123" }, "PlayConsoleAccount": { "format": "int32", "description": "Play console account", "type": "integer", "example": 3 }, "ApnCertificateValidAfter": { "format": "date-time", "description": "APN certificate valid after", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "ApnCertificateValidBefore": { "format": "date-time", "description": "APN certificate valid before", "type": "string", "nullable": true, "example": "2026-06-02T12:00:00Z" }, "DineInEnabled": { "description": "Dine in enabled", "type": "boolean", "example": true }, "AppFont": { "description": "App font", "type": "string", "example": "string" }, "WhiteLabelColorSchemeId": { "format": "int32", "description": "White label color scheme ID", "type": "integer", "example": 500123 }, "WhiteLabelImagesId": { "format": "int32", "description": "White label images ID", "type": "integer", "example": 500123 }, "AppStoreCopyright": { "description": "App store copyright", "type": "string", "example": "string" }, "AppStoreDescription": { "description": "App store description", "type": "string", "example": "string" }, "AppStoreShortDescription": { "description": "App store short description", "type": "string", "example": "string" }, "AppStoreKeywords": { "description": "App store keywords", "type": "string", "example": "string" }, "AppStoreMarketingUrl": { "description": "App store marketing URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AppStoreName": { "description": "App store name", "type": "string", "example": "Example Name" }, "AppStorePrivacyUrl": { "description": "App store privacy URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AppStoreSupportUrl": { "description": "App store support URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AppStoreReleaseNotes": { "description": "App store release notes", "type": "string", "example": "string" }, "AppStoreIconUrl": { "description": "App store icon URL", "type": "string", "example": "https://api.flipdish.co/example" }, "AppStoreIconThumbnail100Url": { "description": "App store icon thumbnail 100 URL", "type": "string", "example": "https://api.flipdish.co/example" }, "TransparentLogoUrl": { "description": "Transparent logo URL", "type": "string", "example": "https://api.flipdish.co/example" }, "LogoImageName": { "description": "Logo image name", "type": "string", "example": "Example Name" }, "KioskNameScreenImage": { "description": "Kiosk name screen image", "type": "string", "example": "Example Name" }, "WebToAppRedirect": { "format": "int32", "description": "Web to app redirect", "type": "integer", "example": 1 }, "FeaturesCsv": { "description": "Features CSV", "type": "string", "example": "string" }, "AppStorePassword": { "description": "App store password", "type": "string", "example": "string" }, "AppStoreTeamId": { "description": "App store team ID", "type": "string", "example": "500123" }, "AppStoreAppGroup": { "description": "App store app group", "type": "string", "example": "string" }, "AppStoreSigningIdentity": { "description": "App store signing identity", "type": "string", "example": "string" }, "AppStoreItcTeamId": { "description": "App store ITC team ID", "type": "string", "example": "500123" }, "HeadHtml": { "description": "Head HTML", "type": "string", "example": "string" }, "SocialTwitterUrl": { "description": "Social Twitter URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialFacebookUrl": { "description": "Social Facebook URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialInstagramUrl": { "description": "Social Instagram URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialPintrestUrl": { "description": "Social Pinterest URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialTripAdvisorUrl": { "description": "Social TripAdvisor URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialGooglePlusUrl": { "description": "Social Google Plus URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialFourSquareUrl": { "description": "Social FourSquare URL", "type": "string", "example": "https://api.flipdish.co/example" }, "SocialYelpUrl": { "description": "Social Yelp URL", "type": "string", "example": "https://api.flipdish.co/example" }, "WebsiteType": { "format": "int32", "description": "Website type", "type": "integer", "example": 1 }, "ExternalOrderingPageUrl": { "description": "External ordering page URL", "type": "string", "example": "https://api.flipdish.co/example" }, "PanaceaEnabled": { "description": "Panacea enabled", "type": "boolean", "example": true }, "CookieConsentPromptEnabled": { "description": "Cookie consent prompt enabled", "type": "boolean", "example": true }, "PanaceaVanityUrl": { "description": "Panacea vanity URL", "type": "string", "example": "https://api.flipdish.co/example" }, "CountryId": { "description": "Country ID", "type": "string", "example": "500123" }, "ReferralUserId": { "format": "int32", "description": "Referral user ID", "type": "integer", "nullable": true, "example": 500123 }, "ReferralCampaignId": { "description": "Referral campaign ID", "type": "string", "example": "500123" } } }, "WhiteLabelLanguageModel": { "description": "White label language model", "type": "object", "properties": { "LanguageId": { "description": "Language ID", "type": "string", "example": "500123" } } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "description": "OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token).", "flows": { "implicit": { "authorizationUrl": "https://api.flipdish.co/identity/connect/authorize", "scopes": { "api": "Access to the Flipdish API" } }, "clientCredentials": { "tokenUrl": "https://api.flipdish.co/identity/connect/token", "scopes": { "api": "Access to the Flipdish API" } } } } } } }