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 the Connect API or with Square Point of Sale. The ‘tenders` field of this object lists all methods of payment used to pay in the transaction.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
148
149
150
151
 
# File 'lib/square_connect/models/transaction.rb', line 101

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?(:'location_id')
    self.location_id = attributes[:'location_id']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'tenders')
    if (value = attributes[:'tenders']).is_a?(Array)
      self.tenders = value
    end
  end

  if attributes.has_key?(:'refunds')
    if (value = attributes[:'refunds']).is_a?(Array)
      self.refunds = value
    end
  end

  if attributes.has_key?(:'reference_id')
    self.reference_id = attributes[:'reference_id']
  end

  if attributes.has_key?(:'product')
    self.product = attributes[:'product']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'shipping_address')
    self.shipping_address = attributes[:'shipping_address']
  end

  if attributes.has_key?(:'order_id')
    self.order_id = attributes[:'order_id']
  end

end

Instance Attribute Details

#client_id ⇒ Object

If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction’s canonical ‘id`, which is generated by Square’s backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value.



37
38
39
 
# File 'lib/square_connect/models/transaction.rb', line 37

def client_id
  @client_id
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#id ⇒ Object

The transaction’s unique ID, issued by Square payments servers.



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

def id
  @id
end

#location_id ⇒ Object

The ID of the transaction’s associated location.



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

def location_id
  @location_id
end

#order_id ⇒ Object

The order_id is an identifier for the order associated with this transaction, if any.



43
44
45
 
# File 'lib/square_connect/models/transaction.rb', line 43

def order_id
  @order_id
end

#product ⇒ Object

The Square product that processed the transaction.



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

def product
  @product
end

#reference_id ⇒ Object

If the transaction was created with the [Charge](#endpoint-charge) endpoint, this value is the same as the value provided for the ‘reference_id` parameter in the request to that endpoint. Otherwise, it is not set.



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

def reference_id
  @reference_id
end

#refunds ⇒ Object

Refunds that have been applied to any tender in the transaction.



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

def refunds
  @refunds
end

#shipping_address ⇒ Object

The shipping address provided in the request, if any.



40
41
42
 
# File 'lib/square_connect/models/transaction.rb', line 40

def shipping_address
  @shipping_address
end

#tenders ⇒ Object

The tenders used to pay in the transaction.



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

def tenders
  @tenders
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/square_connect/models/transaction.rb', line 84

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/square_connect/models/transaction.rb', line 180

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 &&
      client_id == o.client_id &&
      shipping_address == o.shipping_address &&
      order_id == o.order_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/square_connect/models/transaction.rb', line 231

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/square_connect/models/transaction.rb', line 297

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/square_connect/models/transaction.rb', line 210

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/square_connect/models/transaction.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/square_connect/models/transaction.rb', line 203

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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



155
156
157
158
 
# File 'lib/square_connect/models/transaction.rb', line 155

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



277
278
279
 
# File 'lib/square_connect/models/transaction.rb', line 277

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
 
# File 'lib/square_connect/models/transaction.rb', line 283

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

Returns:

  • (String) —

    String presentation of the object



271
272
273
 
# File 'lib/square_connect/models/transaction.rb', line 271

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
 
# File 'lib/square_connect/models/transaction.rb', line 162

def valid?
  product_validator = EnumAttributeValidator.new('String', ["REGISTER", "EXTERNAL_API", "BILLING", "APPOINTMENTS", "INVOICES", "ONLINE_STORE", "PAYROLL", "OTHER"])
  return false unless product_validator.valid?(@product)
  return true
end