Class: SquareConnect::Tender

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/tender.rb

Overview

Represents a form of tender used to pay in a transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tender

Returns a new instance of Tender.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/square_connect/models/tender.rb', line 96

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'location_id']
    self.location_id = attributes[:'location_id']
  end
  
  if attributes[:'transaction_id']
    self.transaction_id = attributes[:'transaction_id']
  end
  
  if attributes[:'created_at']
    self.created_at = attributes[:'created_at']
  end
  
  if attributes[:'note']
    self.note = attributes[:'note']
  end
  
  if attributes[:'amount_money']
    self.amount_money = attributes[:'amount_money']
  end
  
  if attributes[:'processing_fee_money']
    self.processing_fee_money = attributes[:'processing_fee_money']
  end
  
  if attributes[:'customer_id']
    self.customer_id = attributes[:'customer_id']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'card_details']
    self.card_details = attributes[:'card_details']
  end
  
  if attributes[:'cash_details']
    self.cash_details = attributes[:'cash_details']
  end
  
end

Instance Attribute Details

#amount_money ⇒ Object

The amount of the tender.



32
33
34
 
# File 'lib/square_connect/models/tender.rb', line 32

def amount_money
  @amount_money
end

#card_details ⇒ Object

The details of the card tender.nThis value is present only if the value of ‘type` is `CARD`.



44
45
46
 
# File 'lib/square_connect/models/tender.rb', line 44

def card_details
  @card_details
end

#cash_details ⇒ Object

The details of the cash tender.nThis value is present only if the value of ‘type` is `CASH`.



47
48
49
 
# File 'lib/square_connect/models/tender.rb', line 47

def cash_details
  @cash_details
end

#created_at ⇒ Object

The time when the tender was created, in RFC 3339 format.



26
27
28
 
# File 'lib/square_connect/models/tender.rb', line 26

def created_at
  @created_at
end

#customer_id ⇒ Object

If the tender represents a customer’s card on file, this isnthe ID of the associated customer.



38
39
40
 
# File 'lib/square_connect/models/tender.rb', line 38

def customer_id
  @customer_id
end

#id ⇒ Object

The tender’s unique ID.



17
18
19
 
# File 'lib/square_connect/models/tender.rb', line 17

def id
  @id
end

#location_id ⇒ Object

The ID of the tender’s associated location.



20
21
22
 
# File 'lib/square_connect/models/tender.rb', line 20

def location_id
  @location_id
end

#note ⇒ Object

An optional note associated with the tender at the time of payment.



29
30
31
 
# File 'lib/square_connect/models/tender.rb', line 29

def note
  @note
end

#processing_fee_money ⇒ Object

The amount of any Square processing fees applied to the tender.



35
36
37
 
# File 'lib/square_connect/models/tender.rb', line 35

def processing_fee_money
  @processing_fee_money
end

#transaction_id ⇒ Object

The ID of the tender’s associated transaction.



23
24
25
 
# File 'lib/square_connect/models/tender.rb', line 23

def transaction_id
  @transaction_id
end

#type ⇒ Object

The type of tender.



41
42
43
 
# File 'lib/square_connect/models/tender.rb', line 41

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/square_connect/models/tender.rb', line 50

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'location_id' => :'location_id',
    
    :'transaction_id' => :'transaction_id',
    
    :'created_at' => :'created_at',
    
    :'note' => :'note',
    
    :'amount_money' => :'amount_money',
    
    :'processing_fee_money' => :'processing_fee_money',
    
    :'customer_id' => :'customer_id',
    
    :'type' => :'type',
    
    :'card_details' => :'card_details',
    
    :'cash_details' => :'cash_details'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/square_connect/models/tender.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'transaction_id' => :'String',
    :'created_at' => :'String',
    :'note' => :'String',
    :'amount_money' => :'Money',
    :'processing_fee_money' => :'Money',
    :'customer_id' => :'String',
    :'type' => :'String',
    :'card_details' => :'TenderCardDetails',
    :'cash_details' => :'TenderCashDetails'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/square_connect/models/tender.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      location_id == o.location_id &&
      transaction_id == o.transaction_id &&
      created_at == o.created_at &&
      note == o.note &&
      amount_money == o.amount_money &&
      processing_fee_money == o.processing_fee_money &&
      customer_id == o.customer_id &&
      type == o.type &&
      card_details == o.card_details &&
      cash_details == o.cash_details
end

#_deserialize(type, value) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/square_connect/models/tender.rb', line 205

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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
    _model = SquareConnect.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/square_connect/models/tender.rb', line 262

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

build the object from hash



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/square_connect/models/tender.rb', line 186

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/square_connect/models/tender.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



181
182
183
 
# File 'lib/square_connect/models/tender.rb', line 181

def hash
  [id, location_id, transaction_id, created_at, note, amount_money, processing_fee_money, customer_id, type, card_details, cash_details].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



245
246
247
 
# File 'lib/square_connect/models/tender.rb', line 245

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



250
251
252
253
254
255
256
257
258
 
# File 'lib/square_connect/models/tender.rb', line 250

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 ⇒ Object 



240
241
242
 
# File 'lib/square_connect/models/tender.rb', line 240

def to_s
  to_hash.to_s
end