Class: SquareConnect::OrderReturnTax

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

Overview

The line item tax being returned.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderReturnTax

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
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
 
# File 'lib/square_connect/models/order_return_tax.rb', line 70

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#applied_money ⇒ Object

The amount of the money applied by the tax in an order.



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

def applied_money
  @applied_money
end

#catalog_object_id ⇒ Object

The catalog object id referencing [CatalogTax](#type-catalogtax).



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

def catalog_object_id
  @catalog_object_id
end

#name ⇒ Object

The tax’s name.



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

def name
  @name
end

#percentage ⇒ Object

The percentage of the tax, as a string representation of a decimal number. A value of ‘7.25` corresponds to a percentage of 7.25%.



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

def percentage
  @percentage
end

#scope ⇒ Object

Indicates the level at which the tax applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values



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

def scope
  @scope
end

#source_tax_uid ⇒ Object

‘uid` of the Tax from the Order which contains the original charge of this tax.



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

def source_tax_uid
  @source_tax_uid
end

#type ⇒ Object

Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values



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

def type
  @type
end

#uid ⇒ Object

Unique ID that identifies the return tax only within this order. This field is read-only.



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

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/square_connect/models/order_return_tax.rb', line 41

def self.attribute_map
  {
    :'uid' => :'uid',
    :'source_tax_uid' => :'source_tax_uid',
    :'catalog_object_id' => :'catalog_object_id',
    :'name' => :'name',
    :'type' => :'type',
    :'percentage' => :'percentage',
    :'applied_money' => :'applied_money',
    :'scope' => :'scope'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/square_connect/models/order_return_tax.rb', line 55

def self.swagger_types
  {
    :'uid' => :'String',
    :'source_tax_uid' => :'String',
    :'catalog_object_id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'percentage' => :'String',
    :'applied_money' => :'Money',
    :'scope' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/square_connect/models/order_return_tax.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      source_tax_uid == o.source_tax_uid &&
      catalog_object_id == o.catalog_object_id &&
      name == o.name &&
      type == o.type &&
      percentage == o.percentage &&
      applied_money == o.applied_money &&
      scope == o.scope
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/square_connect/models/order_return_tax.rb', line 254

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/square_connect/models/order_return_tax.rb', line 320

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/square_connect/models/order_return_tax.rb', line 233

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


220
221
222
 
# File 'lib/square_connect/models/order_return_tax.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/square_connect/models/order_return_tax.rb', line 226

def hash
  [uid, source_tax_uid, catalog_object_id, name, type, percentage, applied_money, scope].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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/square_connect/models/order_return_tax.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  end

  if !@source_tax_uid.nil? && @source_tax_uid.to_s.length > 60
    invalid_properties.push("invalid value for 'source_tax_uid', the character length must be smaller than or equal to 60.")
  end

  if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
    invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.")
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  end

  if !@percentage.nil? && @percentage.to_s.length > 10
    invalid_properties.push("invalid value for 'percentage', the character length must be smaller than or equal to 10.")
  end

  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



300
301
302
 
# File 'lib/square_connect/models/order_return_tax.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/square_connect/models/order_return_tax.rb', line 306

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



294
295
296
 
# File 'lib/square_connect/models/order_return_tax.rb', line 294

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



139
140
141
142
143
144
145
146
 
# File 'lib/square_connect/models/order_return_tax.rb', line 139

def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@source_tax_uid.nil? && @source_tax_uid.to_s.length > 60
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@percentage.nil? && @percentage.to_s.length > 10
  return true
end