Class: SquareConnect::OrderLineItemTax

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

Overview

Represents a tax that applies to one or more line items in an order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineItemTax

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 86

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?(:'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.



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

def applied_money
  @applied_money
end

#catalog_object_id ⇒ Object

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



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

def catalog_object_id
  @catalog_object_id
end

#name ⇒ Object

The tax’s name.



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

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%.



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

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



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

def scope
  @scope
end

#type ⇒ Object

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



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

def type
  @type
end

#uid ⇒ Object

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



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

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'uid' => :'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.



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

def self.swagger_types
  {
    :'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



225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 273

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 339

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 252

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


239
240
241
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 124

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 !@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



319
320
321
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 319

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



325
326
327
328
329
330
331
332
333
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 325

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



313
314
315
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 313

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/square_connect/models/order_line_item_tax.rb', line 147

def valid?
  return false if !@uid.nil? && @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
  type_validator = EnumAttributeValidator.new('String', ["UNKNOWN_TAX", "ADDITIVE", "INCLUSIVE"])
  return false unless type_validator.valid?(@type)
  return false if !@percentage.nil? && @percentage.to_s.length > 10
  scope_validator = EnumAttributeValidator.new('String', ["OTHER_TAX_SCOPE", "LINE_ITEM", "ORDER"])
  return false unless scope_validator.valid?(@scope)
  return true
end