Class: OpenapiClient::ResponseAmountComponents

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/response_amount_components.rb

Overview

Amount component details, used in responses.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseAmountComponents

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ResponseAmountComponents` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ResponseAmountComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'subtotal')
    self.subtotal = attributes[:'subtotal']
  end

  if attributes.key?(:'vat_amount')
    self.vat_amount = attributes[:'vat_amount']
  end

  if attributes.key?(:'local_tax')
    self.local_tax = attributes[:'local_tax']
  end

  if attributes.key?(:'shipping')
    self.shipping = attributes[:'shipping']
  end

  if attributes.key?(:'cashback')
    self.cashback = attributes[:'cashback']
  end

  if attributes.key?(:'tip')
    self.tip = attributes[:'tip']
  end

  if attributes.key?(:'surcharge')
    self.surcharge = attributes[:'surcharge']
  end

  if attributes.key?(:'convenience_fee')
    self.convenience_fee = attributes[:'convenience_fee']
  end
end

Instance Attribute Details

#cashback ⇒ Object

Cashback amount.



31
32
33
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 31

def cashback
  @cashback
end

#convenience_fee ⇒ Object

Amount added for proccessing or handling fees.



40
41
42
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 40

def convenience_fee
  @convenience_fee
end

#local_tax ⇒ Object

Local tax amount.



25
26
27
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 25

def local_tax
  @local_tax
end

#shipping ⇒ Object

Shipping amount.



28
29
30
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 28

def shipping
  @shipping
end

#subtotal ⇒ Object

Subtotal amount.



19
20
21
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 19

def subtotal
  @subtotal
end

#surcharge ⇒ Object

Surcharge amount.



37
38
39
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 37

def surcharge
  @surcharge
end

#tip ⇒ Object

Tip amount.



34
35
36
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 34

def tip
  @tip
end

#vat_amount ⇒ Object

Value-added tax amount.



22
23
24
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 22

def vat_amount
  @vat_amount
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 43

def self.attribute_map
  {
    :'subtotal' => :'subtotal',
    :'vat_amount' => :'vatAmount',
    :'local_tax' => :'localTax',
    :'shipping' => :'shipping',
    :'cashback' => :'cashback',
    :'tip' => :'tip',
    :'surcharge' => :'surcharge',
    :'convenience_fee' => :'convenienceFee'
  }
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



169
170
171
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 169

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



71
72
73
74
75
76
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 71

def self.openapi_all_of
  [
  :'AmountComponents',
  :'ResponseAmountComponentsAllOf'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 57

def self.openapi_types
  {
    :'subtotal' => :'Float',
    :'vat_amount' => :'Float',
    :'local_tax' => :'Float',
    :'shipping' => :'Float',
    :'cashback' => :'Float',
    :'tip' => :'Float',
    :'surcharge' => :'Float',
    :'convenience_fee' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subtotal == o.subtotal &&
      vat_amount == o.vat_amount &&
      local_tax == o.local_tax &&
      shipping == o.shipping &&
      cashback == o.cashback &&
      tip == o.tip &&
      surcharge == o.surcharge &&
      convenience_fee == o.convenience_fee
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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 197

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 271

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 176

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


156
157
158
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 162

def hash
  [subtotal, vat_amount, local_tax, shipping, cashback, tip, surcharge, convenience_fee].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



128
129
130
131
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 128

def list_invalid_properties
  invalid_properties = Array.new
  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



247
248
249
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 247

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 253

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



241
242
243
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 241

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



135
136
137
 
# File 'lib/openapi_client/models/response_amount_components.rb', line 135

def valid?
  true
end