Class Terminal


  • public class Terminal
    extends Object
    Terminal
    • Constructor Detail

      • Terminal

        public Terminal()
    • Method Detail

      • getAssigned

        public Boolean getAssigned()
        The [assignment status](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api) of the terminal. If true, the terminal is assigned. If false, the terminal is in inventory and can't be boarded.
        Returns:
        assigned
      • setAssigned

        public void setAssigned​(Boolean assigned)
      • getBluetoothIp

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

        public void setBluetoothIp​(String bluetoothIp)
      • bluetoothMac

        public Terminal bluetoothMac​(String bluetoothMac)
      • getBluetoothMac

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

        public void setBluetoothMac​(String bluetoothMac)
      • getCity

        public String getCity()
        The city where the terminal is located.
        Returns:
        city
      • setCity

        public void setCity​(String city)
      • companyAccount

        public Terminal companyAccount​(String companyAccount)
      • 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)
      • getCountryCode

        public String getCountryCode()
        The country code of the country where the terminal is located.
        Returns:
        countryCode
      • setCountryCode

        public void setCountryCode​(String countryCode)
      • getDeviceModel

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

        public void setDeviceModel​(String deviceModel)
      • getEthernetIp

        public String getEthernetIp()
        The ethernet IP address of the terminal.
        Returns:
        ethernetIp
      • setEthernetIp

        public void setEthernetIp​(String ethernetIp)
      • getEthernetMac

        public String getEthernetMac()
        The ethernet MAC address of the terminal.
        Returns:
        ethernetMac
      • setEthernetMac

        public void setEthernetMac​(String ethernetMac)
      • firmwareVersion

        public Terminal firmwareVersion​(String firmwareVersion)
      • 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)
      • getId

        public String getId()
        The unique identifier of the terminal.
        Returns:
        id
      • setId

        public void setId​(String id)
      • 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)
      • lastTransactionDateTime

        public Terminal lastTransactionDateTime​(OffsetDateTime lastTransactionDateTime)
      • 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)
      • linkNegotiation

        public Terminal linkNegotiation​(String linkNegotiation)
      • 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)
      • serialNumber

        public Terminal serialNumber​(String serialNumber)
      • 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)
      • getStatus

        public String getStatus()
        Indicates when the terminal was last online, whether the terminal is being reassigned, or whether the terminal is turned off. If the terminal was last online more that a week ago, it is also shown as turned off.
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
      • getStoreStatus

        public String getStoreStatus()
        The status of the store that the terminal is assigned to.
        Returns:
        storeStatus
      • setStoreStatus

        public void setStoreStatus​(String storeStatus)
      • 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)
      • getWifiSsid

        public String getWifiSsid()
        The SSID of the Wi-Fi network that your terminal is connected to.
        Returns:
        wifiSsid
      • setWifiSsid

        public void setWifiSsid​(String wifiSsid)
      • hashCode

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

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                                       throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to Terminal
      • fromJson

        public static Terminal fromJson​(String jsonString)
                                 throws IOException
        Create an instance of Terminal given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Terminal
        Throws:
        IOException - if the JSON string is invalid with respect to Terminal
      • toJson

        public String toJson()
        Convert an instance of Terminal to an JSON string
        Returns:
        JSON string