com.global.api.terminals.abstractions.IDeviceInterface Maven / Gradle / Ivy

Go to download
package com.global.api.terminals.abstractions;

import com.global.api.entities.enums.*;
import com.global.api.entities.exceptions.ApiException;
import com.global.api.terminals.TerminalResponse;
import com.global.api.terminals.builders.TerminalAuthBuilder;
import com.global.api.terminals.builders.TerminalManageBuilder;
import com.global.api.terminals.genius.enums.TransactionIdType;
import com.global.api.terminals.messaging.IMessageSentInterface;
import com.global.api.terminals.pax.responses.SAFDeleteResponse;
import com.global.api.terminals.pax.responses.SAFSummaryReport;
import com.global.api.terminals.pax.responses.SAFUploadResponse;
import com.global.api.terminals.upa.subgroups.RegisterPOS;

import java.math.BigDecimal;

public interface IDeviceInterface extends IDisposable {
    void setOnMessageSent(IMessageSentInterface onMessageSent);

    // admin calls
    IDeviceResponse addLineItem(String leftText, String rightText) throws ApiException; // UPA
    IDeviceResponse addLineItem(String leftText, String rightText, String runningLeftText, String runningRightText) throws ApiException;
    void cancel() throws ApiException;
    void cancel(Integer cancelParams) throws ApiException; // UPA
    IDeviceResponse closeLane() throws ApiException;
    IDeviceResponse disableHostResponseBeep() throws ApiException;
    ISignatureResponse getSignatureFile() throws ApiException;
    IInitializeResponse initialize() throws ApiException;
    IDeviceResponse openLane() throws ApiException;
    IDeviceResponse ping() throws ApiException; // UPA
    void sendReady() throws ApiException; //UPA
    IDeviceResponse registerPOS(RegisterPOS data) throws ApiException; //UPA
    ISignatureResponse promptForSignature() throws ApiException;
    ISignatureResponse promptForSignature(String transactionId) throws ApiException;    
    IDeviceResponse reboot() throws ApiException;
    IDeviceResponse reset() throws ApiException;
    IDeviceResponse sendFile(SendFileType fileType, String filePath) throws ApiException;
    ISAFResponse sendStoreAndForward() throws ApiException;
    IDeviceResponse setStoreAndForwardMode(boolean enabled) throws ApiException;
    IDeviceResponse setStoreAndForwardMode(SafMode safMode) throws ApiException;
    IDeviceResponse startCard(PaymentMethodType paymentMethodType) throws ApiException;
    TerminalManageBuilder reverse() throws ApiException;

    // batch calls
    IBatchCloseResponse batchClose() throws ApiException;
    IEODResponse endOfDay() throws ApiException;
    SAFUploadResponse safUpload(SafUpload safUploadIndicator) throws ApiException;
    SAFDeleteResponse safDelete(SafDelete safDeleteIndicator) throws ApiException;

    // credit calls
    TerminalAuthBuilder creditAuth(BigDecimal amount) throws ApiException;
    TerminalManageBuilder creditCapture(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder creditRefund(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder creditSale(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder creditAuth() throws ApiException;
    TerminalManageBuilder creditCapture() throws ApiException;
    TerminalAuthBuilder creditRefund() throws ApiException;
    TerminalAuthBuilder creditSale() throws ApiException;
    TerminalAuthBuilder creditVerify() throws ApiException;
    TerminalManageBuilder creditVoid() throws ApiException;
    TerminalManageBuilder voidRefund() throws ApiException;
    TerminalManageBuilder tipAdjust(BigDecimal amount) throws ApiException;

    // debit calls
    TerminalAuthBuilder debitSale(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder debitRefund(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder debitSale() throws ApiException;
    TerminalAuthBuilder debitRefund() throws ApiException;
    TerminalManageBuilder debitVoid() throws ApiException;

    // gift calls
    TerminalAuthBuilder giftSale(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder giftSale() throws ApiException;
    TerminalAuthBuilder giftAddValue() throws ApiException;
    TerminalAuthBuilder giftAddValue(BigDecimal amount) throws ApiException;
    TerminalManageBuilder giftVoid() throws ApiException;
    TerminalAuthBuilder giftBalance() throws ApiException;

    // ebt calls
    TerminalAuthBuilder ebtBalance() throws ApiException;
    TerminalAuthBuilder ebtPurchase() throws ApiException;
    TerminalAuthBuilder ebtPurchase(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder ebtRefund() throws ApiException;
    TerminalAuthBuilder ebtRefund(BigDecimal amount) throws ApiException;
    TerminalAuthBuilder ebtWithdrawal() throws ApiException;
    TerminalAuthBuilder ebtWithdrawal(BigDecimal amount) throws ApiException;
    
    // report calls
    SAFSummaryReport safSummaryReport(SafReportSummary safReportIndicator) throws ApiException;
    IBatchReportResponse getBatchSummary() throws ApiException;
    IBatchReportResponse getBatchSummary(String batchId) throws ApiException;
    IBatchReportResponse getBatchDetails() throws ApiException;
    IBatchReportResponse getBatchDetails(String batchId) throws ApiException;
    IBatchReportResponse getBatchDetails(String batchId, boolean printReport) throws ApiException;
    IBatchReportResponse getOpenTabDetails() throws ApiException;
    TerminalResponse getTransactionDetails(TransactionType transactionType, String transactionId, TransactionIdType transactionIdType) throws ApiException;

    TerminalManageBuilder refundById(BigDecimal amount) throws ApiException;
}