Class GetTerminalDetailsResponse


  • public class GetTerminalDetailsResponse
    extends Object
    GetTerminalDetailsResponse
    • Constructor Detail

      • GetTerminalDetailsResponse

        public GetTerminalDetailsResponse()
    • Method Detail

      • bluetoothIp

        public GetTerminalDetailsResponse bluetoothIp​(String bluetoothIp)
        The Bluetooth IP address of the terminal.
        Parameters:
        bluetoothIp -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getBluetoothIp

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

        public void setBluetoothIp​(String bluetoothIp)
        The Bluetooth IP address of the terminal.
        Parameters:
        bluetoothIp -
      • bluetoothMac

        public GetTerminalDetailsResponse bluetoothMac​(String bluetoothMac)
        The Bluetooth MAC address of the terminal.
        Parameters:
        bluetoothMac -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getBluetoothMac

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

        public void setBluetoothMac​(String bluetoothMac)
        The Bluetooth MAC address of the terminal.
        Parameters:
        bluetoothMac -
      • companyAccount

        public GetTerminalDetailsResponse companyAccount​(String companyAccount)
        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.
        Parameters:
        companyAccount -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        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.
        Parameters:
        companyAccount -
      • country

        public GetTerminalDetailsResponse country​(String country)
        The country where the terminal is used.
        Parameters:
        country -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getCountry

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

        public void setCountry​(String country)
        The country where the terminal is used.
        Parameters:
        country -
      • deviceModel

        public GetTerminalDetailsResponse deviceModel​(String deviceModel)
        The model name of the terminal.
        Parameters:
        deviceModel -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getDeviceModel

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

        public void setDeviceModel​(String deviceModel)
        The model name of the terminal.
        Parameters:
        deviceModel -
      • dhcpEnabled

        public GetTerminalDetailsResponse dhcpEnabled​(Boolean dhcpEnabled)
        Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal.
        Parameters:
        dhcpEnabled -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal.
        Parameters:
        dhcpEnabled -
      • displayLabel

        public GetTerminalDetailsResponse displayLabel​(String displayLabel)
        The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.
        Parameters:
        displayLabel -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        The label shown on the status bar of the display. This label (if any) is specified in your Customer Area.
        Parameters:
        displayLabel -
      • ethernetIp

        public GetTerminalDetailsResponse ethernetIp​(String ethernetIp)
        The terminal's IP address in your Ethernet network.
        Parameters:
        ethernetIp -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getEthernetIp

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

        public void setEthernetIp​(String ethernetIp)
        The terminal's IP address in your Ethernet network.
        Parameters:
        ethernetIp -
      • ethernetMac

        public GetTerminalDetailsResponse ethernetMac​(String ethernetMac)
        The terminal's MAC address in your Ethernet network.
        Parameters:
        ethernetMac -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getEthernetMac

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

        public void setEthernetMac​(String ethernetMac)
        The terminal's MAC address in your Ethernet network.
        Parameters:
        ethernetMac -
      • firmwareVersion

        public GetTerminalDetailsResponse firmwareVersion​(String firmwareVersion)
        The software release currently in use on the terminal.
        Parameters:
        firmwareVersion -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getFirmwareVersion

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

        public void setFirmwareVersion​(String firmwareVersion)
        The software release currently in use on the terminal.
        Parameters:
        firmwareVersion -
      • iccid

        public GetTerminalDetailsResponse iccid​(String iccid)
        The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
        Parameters:
        iccid -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        The integrated circuit card identifier (ICCID) of the SIM card in the terminal.
        Parameters:
        iccid -
      • lastActivityDateTime

        public GetTerminalDetailsResponse lastActivityDateTime​(OffsetDateTime lastActivityDateTime)
        Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
        Parameters:
        lastActivityDateTime -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago.
        Parameters:
        lastActivityDateTime -
      • lastTransactionDateTime

        public GetTerminalDetailsResponse lastTransactionDateTime​(OffsetDateTime lastTransactionDateTime)
        Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
        Parameters:
        lastTransactionDateTime -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago.
        Parameters:
        lastTransactionDateTime -
      • linkNegotiation

        public GetTerminalDetailsResponse linkNegotiation​(String linkNegotiation)
        The Ethernet link negotiation that the terminal uses: - `auto`: Auto-negotiation - `100full`: 100 Mbps full duplex
        Parameters:
        linkNegotiation -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        The Ethernet link negotiation that the terminal uses: - `auto`: Auto-negotiation - `100full`: 100 Mbps full duplex
        Parameters:
        linkNegotiation -
      • merchantAccount

        public GetTerminalDetailsResponse merchantAccount​(String merchantAccount)
        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.
        Parameters:
        merchantAccount -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        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.
        Parameters:
        merchantAccount -
      • merchantInventory

        public GetTerminalDetailsResponse merchantInventory​(Boolean merchantInventory)
        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.
        Parameters:
        merchantInventory -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        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.
        Parameters:
        merchantInventory -
      • permanentTerminalId

        public GetTerminalDetailsResponse permanentTerminalId​(String permanentTerminalId)
        The permanent terminal ID.
        Parameters:
        permanentTerminalId -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getPermanentTerminalId

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

        public void setPermanentTerminalId​(String permanentTerminalId)
        The permanent terminal ID.
        Parameters:
        permanentTerminalId -
      • serialNumber

        public GetTerminalDetailsResponse serialNumber​(String serialNumber)
        The serial number of the terminal.
        Parameters:
        serialNumber -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getSerialNumber

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

        public void setSerialNumber​(String serialNumber)
        The serial number of the terminal.
        Parameters:
        serialNumber -
      • simStatus

        public GetTerminalDetailsResponse simStatus​(String simStatus)
        On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
        Parameters:
        simStatus -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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)
        On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY.
        Parameters:
        simStatus -
      • store

        public GetTerminalDetailsResponse store​(String store)
        The store code of the store that the terminal is assigned to.
        Parameters:
        store -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getStore

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

        public void setStore​(String store)
        The store code of the store that the terminal is assigned to.
        Parameters:
        store -
      • storeDetails

        public GetTerminalDetailsResponse storeDetails​(Store storeDetails)
        storeDetails
        Parameters:
        storeDetails -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getStoreDetails

        public Store getStoreDetails()
        storeDetails
        Returns:
        storeDetails
      • setStoreDetails

        public void setStoreDetails​(Store storeDetails)
        storeDetails
        Parameters:
        storeDetails -
      • terminal

        public GetTerminalDetailsResponse terminal​(String terminal)
        The unique terminal ID.
        Parameters:
        terminal -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getTerminal

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

        public void setTerminal​(String terminal)
        The unique terminal ID.
        Parameters:
        terminal -
      • terminalStatus

        public GetTerminalDetailsResponse terminalStatus​(GetTerminalDetailsResponse.TerminalStatusEnum terminalStatus)
        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.
        Parameters:
        terminalStatus -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • 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
      • setTerminalStatus

        public void setTerminalStatus​(GetTerminalDetailsResponse.TerminalStatusEnum terminalStatus)
        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.
        Parameters:
        terminalStatus -
      • wifiIp

        public GetTerminalDetailsResponse wifiIp​(String wifiIp)
        The terminal's IP address in your Wi-Fi network.
        Parameters:
        wifiIp -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getWifiIp

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

        public void setWifiIp​(String wifiIp)
        The terminal's IP address in your Wi-Fi network.
        Parameters:
        wifiIp -
      • wifiMac

        public GetTerminalDetailsResponse wifiMac​(String wifiMac)
        The terminal's MAC address in your Wi-Fi network.
        Parameters:
        wifiMac -
        Returns:
        the current GetTerminalDetailsResponse instance, allowing for method chaining
      • getWifiMac

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

        public void setWifiMac​(String wifiMac)
        The terminal's MAC address in your Wi-Fi network.
        Parameters:
        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