class Stripe::TerminalReader

Overview

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

Included Modules

Defined in:

stripe/models/terminal_reader.cr

Constant Summary

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def action : Stripe::TerminalReaderAction | Nil #

[View source]
def action=(new_value : Stripe::TerminalReaderAction | Nil) #

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


[View source]
def device_sw_version : String | Nil #

[View source]
def device_sw_version=(new_value : String | Nil) #

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


[View source]
def device_type : String | Nil #

[View source]
def device_type=(new_value : String | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def ip_address : String | Nil #

[View source]
def ip_address=(new_value : String | Nil) #

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


[View source]
def label : String | Nil #

[View source]
def label=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def location : Stripe::TerminalReaderLocation | Nil #

[View source]
def location=(new_value : Stripe::TerminalReaderLocation | Nil) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def serial_number : String | Nil #

[View source]
def serial_number=(new_value : String | Nil) #

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


[View source]
def status : String | Nil #

[View source]
def status=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]