Class GetTerminalDetailsResponse


  • public class GetTerminalDetailsResponse
    extends Object
    GetTerminalDetailsResponse
    • Constructor Detail

      • GetTerminalDetailsResponse

        public GetTerminalDetailsResponse()
    • Method Detail

      • getBluetoothIp

        public String getBluetoothIp()
        The Bluetooth IP address of the terminal.
        Returns:
        bluetoothIp
      • setBluetoothIp

        public void setBluetoothIp​(String bluetoothIp)
      • getBluetoothMac

        public String getBluetoothMac()
        The Bluetooth MAC address of the terminal.
        Returns:
        bluetoothMac
      • setBluetoothMac

        public void setBluetoothMac​(String bluetoothMac)
      • getCompanyAccount

        public String getCompanyAccount()
        The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account.
        Returns:
        companyAccount
      • setCompanyAccount

        public void setCompanyAccount​(String companyAccount)
      • getCountry

        public String getCountry()
        The country where the terminal is used.
        Returns:
        country
      • setCountry

        public void setCountry​(String country)
      • getDeviceModel

        public String getDeviceModel()
        The model name of the terminal.
        Returns:
        deviceModel
      • setDeviceModel

        public void setDeviceModel​(String deviceModel)
      • getDhcpEnabled

        public Boolean getDhcpEnabled()
        Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal.
        Returns:
        dhcpEnabled
      • setDhcpEnabled

        public void setDhcpEnabled​(Boolean dhcpEnabled)
      • getDisplayLabel

        public String getDisplayLabel()
        The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.
        Returns:
        displayLabel
      • setDisplayLabel

        public void setDisplayLabel​(String displayLabel)
      • getEthernetIp

        public String getEthernetIp()
        The terminal's IP address in your Ethernet network.
        Returns:
        ethernetIp
      • setEthernetIp

        public void setEthernetIp​(String ethernetIp)
      • getEthernetMac

        public String getEthernetMac()
        The terminal's MAC address in your Ethernet network.
        Returns:
        ethernetMac
      • setEthernetMac

        public void setEthernetMac​(String ethernetMac)
      • getFirmwareVersion

        public String getFirmwareVersion()
        The software release currently in use on the terminal.
        Returns:
        firmwareVersion
      • setFirmwareVersion

        public void setFirmwareVersion​(String firmwareVersion)
      • getIccid

        public String getIccid()
        The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
        Returns:
        iccid
      • setIccid

        public void setIccid​(String iccid)
      • getLastActivityDateTime

        public OffsetDateTime getLastActivityDateTime()
        Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
        Returns:
        lastActivityDateTime
      • setLastActivityDateTime

        public void setLastActivityDateTime​(OffsetDateTime lastActivityDateTime)
      • getLastTransactionDateTime

        public OffsetDateTime getLastTransactionDateTime()
        Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
        Returns:
        lastTransactionDateTime
      • setLastTransactionDateTime

        public void setLastTransactionDateTime​(OffsetDateTime lastTransactionDateTime)
      • getLinkNegotiation

        public String getLinkNegotiation()
        The Ethernet link negotiation that the terminal uses: - `auto`: Auto-negotiation - `100full`: 100 Mbps full duplex
        Returns:
        linkNegotiation
      • setLinkNegotiation

        public void setLinkNegotiation​(String linkNegotiation)
      • getMerchantAccount

        public String getMerchantAccount()
        The merchant account that the terminal is associated with. If the response doesn't contain a `store` the terminal is assigned to this merchant account.
        Returns:
        merchantAccount
      • setMerchantAccount

        public void setMerchantAccount​(String merchantAccount)
      • getMerchantInventory

        public Boolean getMerchantInventory()
        Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account. - If **true**, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded. - If **false**, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded.
        Returns:
        merchantInventory
      • setMerchantInventory

        public void setMerchantInventory​(Boolean merchantInventory)
      • getPermanentTerminalId

        public String getPermanentTerminalId()
        The permanent terminal ID.
        Returns:
        permanentTerminalId
      • setPermanentTerminalId

        public void setPermanentTerminalId​(String permanentTerminalId)
      • getSerialNumber

        public String getSerialNumber()
        The serial number of the terminal.
        Returns:
        serialNumber
      • setSerialNumber

        public void setSerialNumber​(String serialNumber)
      • getSimStatus

        public String getSimStatus()
        On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
        Returns:
        simStatus
      • setSimStatus

        public void setSimStatus​(String simStatus)
      • getStore

        public String getStore()
        The store code of the store that the terminal is assigned to.
        Returns:
        store
      • setStore

        public void setStore​(String store)
      • getStoreDetails

        public Store getStoreDetails()
        Get storeDetails
        Returns:
        storeDetails
      • setStoreDetails

        public void setStoreDetails​(Store storeDetails)
      • getTerminal

        public String getTerminal()
        The unique terminal ID.
        Returns:
        terminal
      • setTerminal

        public void setTerminal​(String terminal)
      • getTerminalStatus

        public GetTerminalDetailsResponse.TerminalStatusEnum getTerminalStatus()
        The status of the terminal: - `OnlineToday`, `OnlineLast1Day`, `OnlineLast2Days` etcetera to `OnlineLast7Days`: Indicates when in the past week the terminal was last online. - `SwitchedOff`: Indicates it was more than a week ago that the terminal was last online. - `ReAssignToInventoryPending`, `ReAssignToStorePending`, `ReAssignToMerchantInventoryPending`: Indicates the terminal is scheduled to be reassigned.
        Returns:
        terminalStatus
      • getWifiIp

        public String getWifiIp()
        The terminal's IP address in your Wi-Fi network.
        Returns:
        wifiIp
      • setWifiIp

        public void setWifiIp​(String wifiIp)
      • getWifiMac

        public String getWifiMac()
        The terminal's MAC address in your Wi-Fi network.
        Returns:
        wifiMac
      • setWifiMac

        public void setWifiMac​(String wifiMac)
      • equals

        public boolean equals​(Object o)
        Return true if this GetTerminalDetailsResponse object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • fromJson

        public static GetTerminalDetailsResponse fromJson​(String jsonString)
                                                   throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of GetTerminalDetailsResponse given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of GetTerminalDetailsResponse
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to GetTerminalDetailsResponse
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of GetTerminalDetailsResponse to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException