Class: SquareConnect::Transaction

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

Overview

Represents a transaction processed with Square, either with thenConnect API or with Square Register.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Returns a new instance of Transaction.



72
73
74
75
76
77
78
79
80
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/transaction.rb', line 72

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[:'created_at']
    self.created_at = attributes[:'created_at']
  end
  
  if attributes[:'tenders']
    if (value = attributes[:'tenders']).is_a?(Array)
      self.tenders = value
    end
  end
  
  if attributes[:'refunds']
    if (value = attributes[:'refunds']).is_a?(Array)
      self.refunds = value
    end
  end
  
  if attributes[:'reference_id']
    self.reference_id = attributes[:'reference_id']
  end
  
  if attributes[:'product']
    self.product = attributes[:'product']
  end
  
end

Instance Attribute Details

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#id ⇒ Object

The transaction’s unique ID.



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

def id
  @id
end

#location_id ⇒ Object

The ID of the transaction’s associated location.



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

def location_id
  @location_id
end

#product ⇒ Object

The product that processed the transaction.



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

def product
  @product
end

#reference_id ⇒ Object

If the transaction was created with the Charge endpoint, thisnvalue is the same as the value provided as the ‘reference_id` parameternin the request to that endpoint.



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

def reference_id
  @reference_id
end

#refunds ⇒ Object

An array of any refunds associated with the transaction.



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

def refunds
  @refunds
end

#tenders ⇒ Object

Descriptions of the tenders used to pay for the transaction.



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

def tenders
  @tenders
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/transaction.rb', line 38

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'location_id' => :'location_id',
    
    :'created_at' => :'created_at',
    
    :'tenders' => :'tenders',
    
    :'refunds' => :'refunds',
    
    :'reference_id' => :'reference_id',
    
    :'product' => :'product'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/square_connect/models/transaction.rb', line 59

def self.swagger_types
  {
    :'id' => :'String',
    :'location_id' => :'String',
    :'created_at' => :'String',
    :'tenders' => :'Array<Tender>',
    :'refunds' => :'Array<Refund>',
    :'reference_id' => :'String',
    :'product' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/square_connect/models/transaction.rb', line 123

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      location_id == o.location_id &&
      created_at == o.created_at &&
      tenders == o.tenders &&
      refunds == o.refunds &&
      reference_id == o.reference_id &&
      product == o.product
end

#_deserialize(type, value) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/square_connect/models/transaction.rb', line 165

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/square_connect/models/transaction.rb', line 222

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/square_connect/models/transaction.rb', line 146

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


136
137
138
 
# File 'lib/square_connect/models/transaction.rb', line 136

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



141
142
143
 
# File 'lib/square_connect/models/transaction.rb', line 141

def hash
  [id, location_id, created_at, tenders, refunds, reference_id, product].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



205
206
207
 
# File 'lib/square_connect/models/transaction.rb', line 205

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



210
211
212
213
214
215
216
217
218
 
# File 'lib/square_connect/models/transaction.rb', line 210

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 



200
201
202
 
# File 'lib/square_connect/models/transaction.rb', line 200

def to_s
  to_hash.to_s
end