Class: SquareConnect::V1CashDrawerEvent
- Inherits:
-
Object
- Object
- SquareConnect::V1CashDrawerEvent
- Defined in:
- lib/square_connect/models/v1_cash_drawer_event.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#created_at ⇒ Object
The time when the event occurred, in ISO 8601 format.
-
#description ⇒ Object
An optional description of the event, entered by the employee that created it.
-
#employee_id ⇒ Object
The ID of the employee that created the event.
-
#event_money ⇒ Object
The amount of money that was added to or removed from the cash drawer because of the event.
-
#event_type ⇒ Object
The type of event that occurred.
-
#id ⇒ Object
The event’s unique ID.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ V1CashDrawerEvent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ V1CashDrawerEvent
Initializes the object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 81 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'employee_id') self.employee_id = attributes[:'employee_id'] end if attributes.has_key?(:'event_type') self.event_type = attributes[:'event_type'] end if attributes.has_key?(:'event_money') self.event_money = attributes[:'event_money'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end end |
Instance Attribute Details
#created_at ⇒ Object
The time when the event occurred, in ISO 8601 format.
28 29 30 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 28 def created_at @created_at end |
#description ⇒ Object
An optional description of the event, entered by the employee that created it.
31 32 33 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 31 def description @description end |
#employee_id ⇒ Object
The ID of the employee that created the event.
19 20 21 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 19 def employee_id @employee_id end |
#event_money ⇒ Object
The amount of money that was added to or removed from the cash drawer because of the event. This value can be positive (for added money) or negative (for removed money).
25 26 27 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 25 def event_money @event_money end |
#event_type ⇒ Object
The type of event that occurred.
22 23 24 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 22 def event_type @event_type end |
#id ⇒ Object
The event’s unique ID.
16 17 18 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 16 def id @id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 56 def self.attribute_map { :'id' => :'id', :'employee_id' => :'employee_id', :'event_type' => :'event_type', :'event_money' => :'event_money', :'created_at' => :'created_at', :'description' => :'description' } end |
.swagger_types ⇒ Object
Attribute type mapping.
68 69 70 71 72 73 74 75 76 77 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 68 def self.swagger_types { :'id' => :'String', :'employee_id' => :'String', :'event_type' => :'String', :'event_money' => :'V1Money', :'created_at' => :'String', :'description' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
140 141 142 143 144 145 146 147 148 149 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 140 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && employee_id == o.employee_id && event_type == o.event_type && event_money == o.event_money && created_at == o.created_at && description == o.description end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 187 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = SquareConnect.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 253 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 166 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
153 154 155 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 153 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
159 160 161 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 159 def hash [id, employee_id, event_type, event_money, created_at, description].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
115 116 117 118 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 115 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
233 234 235 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 233 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
239 240 241 242 243 244 245 246 247 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 239 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
227 228 229 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 227 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
122 123 124 125 126 |
# File 'lib/square_connect/models/v1_cash_drawer_event.rb', line 122 def valid? event_type_validator = EnumAttributeValidator.new('String', ["NO_SALE", "CASH_TENDER_PAYMENT", "OTHER_TENDER_PAYMENT", "CASH_TENDER_CANCELED_PAYMENT", "OTHER_TENDER_CANCELED_PAYMENT", "CASH_TENDER_REFUND", "OTHER_TENDER_REFUND", "PAID_IN", "PAID_OUT"]) return false unless event_type_validator.valid?(@event_type) return true end |