class

Stripe::TerminalReader

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A Reader represents a physical device for accepting payment details. Related guide: Connecting to a reader

Constants

ERROR_MESSAGE_FOR_DEVICE_TYPE = "invalid value for \"device_type\", must be one of [bbpos_chipper2x, bbpos_wisepad3, bbpos_wisepos_e, mobile_phone_reader, simulated_wisepos_e, stripe_m2, stripe_s700, verifone_P400]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [terminal.reader]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [offline, online]."
MAX_LENGTH_FOR_DEVICE_SW_VERSION = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_IP_ADDRESS = 5000
MAX_LENGTH_FOR_LABEL = 5000
MAX_LENGTH_FOR_SERIAL_NUMBER = 5000
VALID_VALUES_FOR_DEVICE_TYPE = String.static_array("bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "stripe_s700", "verifone_P400")
VALID_VALUES_FOR_OBJECT = String.static_array("terminal.reader")
VALID_VALUES_FOR_STATUS = String.static_array("offline", "online")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, action : Stripe::TerminalReaderAction | Nil = nil, device_sw_version : String | Nil = nil, device_type : String | Nil = nil, id : String | Nil = nil, ip_address : String | Nil = nil, label : String | Nil = nil, livemode : Bool | Nil = nil, location : Stripe::TerminalReaderLocation | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, serial_number : String | Nil = nil, status : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

action
Source
action=(new_value : Stripe::TerminalReaderAction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] action Object to be assigned

Source
device_sw_version

The current software version of the reader.

Source
device_sw_version=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] device_sw_version Object to be assigned

Source
device_type

Type of reader, one of bbpos_wisepad3, stripe_m2, stripe_s700, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader.

Source
device_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] device_type Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
ip_address

The local IP address of the reader.

Source
ip_address=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ip_address Object to be assigned

Source
label

Custom label given to the reader for easier identification.

Source
label=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] label Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
location
Source
location=(new_value : Stripe::TerminalReaderLocation | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] location Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
serial_number

Serial number of the reader.

Source
serial_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] serial_number Object to be assigned

Source
status

The networking status of the reader. We do not recommend using this field in flows that may block taking payments.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source