-
Message_AuthRequest
This message is used to authorize websocket connection. It is the first message that POS should send after successful handshake.
-
Message_AuthResponse
This message is used to authorize websocket connection. It is the first message that POS receives after successful handshake.
-
Message_MethodCallRequest
This structure is used to request the other side to call a method.
-
Message_MethodCallResponse
This message is used to send a result of a method call.
-
Method_authorizeLoyaltyCard
Qerko sends this structure as the argument to `authorizeLoyaltyCard(...)` method.
-
Method_cancelIndividualBill
Qerko sends this structure as the argument to `cancelIndividualBill(...)` method.
-
Method_getBill
Qerko sends this structure as the argument to `getBill(...)` method.
-
Method_getBillsByQrCode
Qerko sends this structure as the argument to `searchBills(...)` method.
-
Method_getBillsByTable
Qerko sends this structure as the argument to `getTableContents(...)` method.
-
Method_getOrderById
Qerko sends this structure as the argument to `getOrderById(...)` method.
-
Method_getTableList
Qerko sends this structure as the argument to `getTableList(...)` method.
-
Method_pairCustomer
Qerko sends this structure as the argument to `pairCustomer(...)` method.
-
Method_paymentClosed
Qerko sends this structure as the argument to `paymentClosed(...)` method.
-
Method_paymentProcessed
Qerko sends this structure as the argument to `paymentProcessed(...)` method.
-
Method_paymentStart
Qerko sends this structure as the argument to `paymentStart(...)` method.
-
Method_startIndividualBill
Qerko sends this structure as the argument to `startIndividualBill(...)` method.
-
Method_updateIndividualBill
Qerko sends this structure as the argument to `updateIndividualBill(...)` method.
-
Structure_Bill
POS sends this structure when Qerko needs info about a bill. It carries a meta data and contents of the bill.
-
Structure_BillItem
Data structure of bill item.
-
Structure_Error
This structure is used in various situations to report an error.
-
Structure_IndividualAnswer
This structure represents an answered question.
-
Structure_IndividualBillData
This structure represents an individual bill. It is a composite of Bill structure with a description of the offered bonus and a set of questions which needs to be answered before payment.
-
Structure_IndividualQuestion
This structure represents a question. The question will be answered by the customer and the answer will be sent back to POS. Qerko picks the best UI widget to represent the question.
-
Structure_LoyaltyCardAuthorizationRequest
Qerko sends this structure to the Loyalty Card Authority. It contains properties which are needed to authorize the loyalty card.
-
Structure_LoyaltyCardAuthorizationResponse
Loyalty Card Authority returns this structure in `authorizeLoyaltyCard` method or it is used as an argument for loyaltyCardAuthorizationFinished method. It contains the authorization result.
-
Structure_Payment
Qerko sends this structure to `paymentStart(...)` method or receives it as a response from `getPaymentInfo(...)`.
-
Structure_Receipt
Qerko receives this structure as a response from `paymentProcessed(...)` method. It carries info for generating the receipt. This object is treated as a template data. Feel free to add any relevant info that the restaurant might want to print on the receipt. It will be possible to have per-restaurant template in the future.
-
Structure_Table
POS sends this structure in the list of tables as a response to `getTableList(...)` method. It carries info about a table.
-
_defs
This file contains a bunch of definitions which are shared across other schemas.