Class: SquareConnect::Refund

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Refund

Returns a new instance of Refund.



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/square_connect/models/refund.rb', line 84

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[:'tender_id']
    self.tender_id = attributes[:'tender_id']
  end
  
  if attributes[:'created_at']
    self.created_at = attributes[:'created_at']
  end
  
  if attributes[:'reason']
    self.reason = attributes[:'reason']
  end
  
  if attributes[:'amount_money']
    self.amount_money = attributes[:'amount_money']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'processing_fee_money']
    self.processing_fee_money = attributes[:'processing_fee_money']
  end
  
end

Instance Attribute Details

#amount_money ⇒ Object

The amount of money refunded.



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

def amount_money
  @amount_money
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#id ⇒ Object

The unique ID of the refund.



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

def id
  @id
end

#location_id ⇒ Object

The ID of the refund’s associated location.



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

def location_id
  @location_id
end

#processing_fee_money ⇒ Object

The amount of processing fee refunded.



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

def processing_fee_money
  @processing_fee_money
end

#reason ⇒ Object

The reason for the refund being issued.



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

def reason
  @reason
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#tender_id ⇒ Object

The ID of the tender refunded.



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

def tender_id
  @tender_id
end

#transaction_id ⇒ Object

The ID of the transaction refunded.



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

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/square_connect/models/refund.rb', line 44

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'location_id' => :'location_id',
    
    :'transaction_id' => :'transaction_id',
    
    :'tender_id' => :'tender_id',
    
    :'created_at' => :'created_at',
    
    :'reason' => :'reason',
    
    :'amount_money' => :'amount_money',
    
    :'status' => :'status',
    
    :'processing_fee_money' => :'processing_fee_money'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/square_connect/models/refund.rb', line 69

def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'transaction_id' => :'String',
    :'tender_id' => :'String',
    :'created_at' => :'String',
    :'reason' => :'String',
    :'amount_money' => :'Money',
    :'status' => :'String',
    :'processing_fee_money' => :'Money'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/square_connect/models/refund.rb', line 139

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 &&
      tender_id == o.tender_id &&
      created_at == o.created_at &&
      reason == o.reason &&
      amount_money == o.amount_money &&
      status == o.status &&
      processing_fee_money == o.processing_fee_money
end

#_deserialize(type, value) ⇒ Object 



183
184
185
186
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
 
# File 'lib/square_connect/models/refund.rb', line 183

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/square_connect/models/refund.rb', line 240

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/square_connect/models/refund.rb', line 164

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


154
155
156
 
# File 'lib/square_connect/models/refund.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



159
160
161
 
# File 'lib/square_connect/models/refund.rb', line 159

def hash
  [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



223
224
225
 
# File 'lib/square_connect/models/refund.rb', line 223

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



228
229
230
231
232
233
234
235
236
 
# File 'lib/square_connect/models/refund.rb', line 228

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 



218
219
220
 
# File 'lib/square_connect/models/refund.rb', line 218

def to_s
  to_hash.to_s
end