import { Events, Message } from './Messages';
import { PurchaseResponse } from './Purchase';
import { RequestIdHelper } from './RequestIdHelper';
import { Nullable } from './types';
//
// This class represents the BillDetails that the POS will be asked for throughout a PayAtTable flow.
//
export class BillStatusResponse
{
public Result: any;
public BillId: any;
public TableId: any;
public OperatorId: any;
public TotalAmount: any;
public OutstandingAmount: any;
public BillData: any;
constructor(data: any = {}) {
const {
Result = null,
BillId = null,
TableId = null,
OperatorId = null,
TotalAmount = 0,
OutstandingAmount = 0,
BillData = "",
} = data;
//
// Set this Error accordingly if you are not able to return the BillDetails that were asked from you.
//
this.Result = Result;
//
// This is a unique identifier that you assign to each bill.
// It migt be for example, the timestamp of when the cover was opened.
//
this.BillId = BillId;
//
// This is the table id that this bill was for.
// The waiter will enter it on the Eftpos at the start of the PayAtTable flow and the Eftpos will
// retrieve the bill using the table id.
//
this.TableId = TableId;
this.OperatorId = OperatorId;
//
// The Total Amount on this bill, in cents.
//
this.TotalAmount = TotalAmount;
//
// The currently outsanding amount on this bill, in cents.
//
this.OutstandingAmount = OutstandingAmount;
//
// Your POS is required to persist some state on behalf of the Eftpos so the Eftpos can recover state.
// It is just a piece of string that you save against your billId.
// WHenever you're asked for BillDetails, make sure you return this piece of data if you have it.
//
this.BillData = BillData;
}
getBillPaymentHistory()
{
if (!this.BillData)
{
return [];
}
let billPaymentHistory = [];
const savedBillData = JSON.parse(this.BillData);
return savedBillData.map((bill) => {
return new PaymentHistoryEntry(bill.payment_type, bill.payment_summary);
});
}
static ToBillData(ph)
{
if (ph.length < 1)
{
return "";
}
return JSON.stringify(ph);
}
ToMessage(messageId)
{
const data: any = {
"success": this.Result==BillRetrievalResult.SUCCESS
};
if (this.BillId) data.bill_id = this.BillId;
if (this.TableId) data.table_id = this.TableId;
if (this.Result == BillRetrievalResult.SUCCESS)
{
data.bill_total_amount = this.TotalAmount;
data.bill_outstanding_amount = this.OutstandingAmount;
data.bill_payment_history = this.getBillPaymentHistory();
}
else
{
data.error_reason = this.Result.toString();
data.error_detail = this.Result.toString();
}
return new Message(messageId, Events.PayAtTableBillDetails, data, true);
}
}
export const BillRetrievalResult =
{
SUCCESS: 'SUCCESS',
INVALID_TABLE_ID: 'INVALID_TABLE_ID',
INVALID_BILL_ID: 'INVALID_BILL_ID',
INVALID_OPERATOR_ID: 'INVALID_OPERATOR_ID'
};
export const PaymentType =
{
CARD: 'CARD',
CASH: 'CASH'
};
export class BillPayment
{
public _incomingAdvice: any;
public BillId: any;
public TableId: any;
public OperatorId: any;
public PaymentFlowStarted: any;
public PaymentType: any;
public PurchaseResponse: any;
public PurchaseAmount: any;
public TipAmount: any;
public SurchargeAmount: any;
constructor(m)
{
this._incomingAdvice = m;
this.BillId = this._incomingAdvice.Data["bill_id"];
this.TableId = this._incomingAdvice.Data["table_id"];
this.OperatorId = this._incomingAdvice.Data["operator_id"];
this.PaymentFlowStarted = null;
const pt = this._incomingAdvice.Data["payment_type"];
this.PaymentType = pt;
// this is when we ply the sub object "payment_details" into a purchase response for convenience.
const purchaseMsg = new Message(m.Id, "payment_details", m.Data["payment_details"], false);
this.PurchaseResponse = new PurchaseResponse(purchaseMsg);
this.PurchaseAmount = this.PurchaseResponse.GetPurchaseAmount();
this.TipAmount = this.PurchaseResponse.GetTipAmount();
this.SurchargeAmount = this.PurchaseResponse.GetSurchargeAmount();
}
}
export class PaymentHistoryEntry
{
public PaymentType: any;
public PaymentSummary: any;
constructor(paymentType, paymentSummary)
{
this.PaymentType = paymentType;
this.PaymentSummary = paymentSummary;
}
toJSON() {
return {
payment_type: this.PaymentType,
payment_summary: this.PaymentSummary
};
}
GetTerminalRefId()
{
return this.PaymentSummary["terminal_ref_id"];
}
}
export class PayAtTableConfig
{
public PayAtTableEnabled: any;
public OperatorIdEnabled: any;
public SplitByAmountEnabled: any;
public EqualSplitEnabled: any;
public TableRetrievalEnabled: any;
public TippingEnabled: any;
public SummaryReportEnabled: any;
public LabelPayButton: any;
public LabelOperatorId: any;
public LabelTableId: any;
public AllowedOperatorIds: any;
constructor() {
this.PayAtTableEnabled = false;
this.OperatorIdEnabled = false;
this.SplitByAmountEnabled = false;
this.EqualSplitEnabled = false;
this.TableRetrievalEnabled = false;
this.TippingEnabled = false;
this.SummaryReportEnabled = false;
this.LabelPayButton = '';
this.LabelOperatorId = '';
this.LabelTableId = '';
//
//
// Fill in with operator ids that the eftpos terminal will validate against.
// Leave Empty to allow any operator_id through.
//
this.AllowedOperatorIds = [];
}
ToMessage(messageId)
{
const data = {
"pay_at_table_enabled": this.PayAtTableEnabled,
"operator_id_enabled": this.OperatorIdEnabled,
"split_by_amount_enabled": this.SplitByAmountEnabled,
"equal_split_enabled": this.EqualSplitEnabled,
"tipping_enabled": this.TippingEnabled,
"summary_report_enabled": this.SummaryReportEnabled,
"pay_button_label": this.LabelPayButton,
"operator_id_label": this.LabelOperatorId,
"table_id_label": this.LabelTableId,
"operator_id_list": this.AllowedOperatorIds,
"table_retrieval_enabled": this.TableRetrievalEnabled,
};
return new Message(messageId, Events.PayAtTableSetTableConfig, data, true);
}
static FeatureDisableMessage(messageId) {
const data = {
"pay_at_table_enabled": false
};
return new Message(messageId, Events.PayAtTableSetTableConfig, data, true);
}
}
//
// These attributes work for COM interop.
//
export class GetOpenTablesResponse
{
public TableData: Nullable;
constructor(TableData: Nullable = []) {
///
/// Your POS is required to persist some state on behalf of the Eftpos so the Eftpos can recover state.
/// It is just a piece of string that you save against your operatorId.
/// Whenever you're asked for OpenTables, make sure you return this piece of data if you have it.
///
this.TableData = TableData;
}
GetOpenTables()
{
if (!this.TableData)
{
return [];
}
return this.TableData;
}
ToMessage(messageId)
{
const data = {
tables: this.GetOpenTables()
};
return new Message(messageId, Events.PayAtTableOpenTables, data, true);
}
}
//
// These attributes work for COM interop.
//
export class OpenTablesEntry
{
public TableId: any;
public Label: any;
public BillOutstandingAmount: any;
constructor(data: any = {}) {
const { TableId = null, Label = null, BillOutstandingAmount = null } = data;
this.TableId = TableId;
this.Label = Label;
this.BillOutstandingAmount = BillOutstandingAmount;
}
toJSON() {
return {
table_id: this.TableId,
label: this.Label,
bill_outstanding_amount: this.BillOutstandingAmount
}
}
}
///
/// These attributes work for COM interop.
///
export class BillPaymentFlowEndedResponse
{
public BillId: any;
public BillOutstandingAmount: any;
public BillTotalAmount: any;
public OperatorId: any;
public TableId: any;
public CardTotalCount: any;
public CardTotalAmount: any;
public CashTotalCount: any;
public CashTotalAmount: any;
constructor(m)
{
this.BillId = m.Data.bill_id;
this.BillOutstandingAmount = m.Data.bill_outstanding_amount;
this.BillTotalAmount = m.Data.bill_total_amount;
this.OperatorId = m.Data.operator_id;
this.TableId = m.Data.table_id;
this.CardTotalCount = m.Data.card_total_count;
this.CardTotalAmount = m.Data.card_total_amount;
this.CashTotalCount = m.Data.cash_total_count;
this.CashTotalAmount = m.Data.cash_total_amount;
}
}
export class BillPaymentFlowEndedAckRequest
{
public BillId: any;
public Id: any;
constructor(billId)
{
this.BillId = billId;
this.Id = '';
}
ToMessage()
{
const data = {
"bill_id": this.BillId,
};
return new Message(RequestIdHelper.Id("authad"), Events.PayAtTableBillPaymentFlowEndedAck, data, true);
}
}