Class: IntegrationApi::LineItems

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/models/line_items.rb

Overview

LineItems Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/integration_api/models/line_items.rb', line 72

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

amount



19
20
21
 
# File 'lib/integration_api/models/line_items.rb', line 19

def amount
  @amount
end

#currency_code ⇒ Object

currency_code



22
23
24
 
# File 'lib/integration_api/models/line_items.rb', line 22

def currency_code
  @currency_code
end

#description ⇒ Object

description



25
26
27
 
# File 'lib/integration_api/models/line_items.rb', line 25

def description
  @description
end

#line_item_id ⇒ Object

lineItemId



28
29
30
 
# File 'lib/integration_api/models/line_items.rb', line 28

def line_item_id
  @line_item_id
end

#quantity ⇒ Object

quantity



31
32
33
 
# File 'lib/integration_api/models/line_items.rb', line 31

def quantity
  @quantity
end

#rate ⇒ Object

rate



34
35
36
 
# File 'lib/integration_api/models/line_items.rb', line 34

def rate
  @rate
end

#subtotal ⇒ Object

subtotal



37
38
39
 
# File 'lib/integration_api/models/line_items.rb', line 37

def subtotal
  @subtotal
end

#tax ⇒ Object

tax



40
41
42
 
# File 'lib/integration_api/models/line_items.rb', line 40

def tax
  @tax
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/integration_api/models/line_items.rb', line 43

def self.attribute_map
  {
    :'amount' => :'amount',
    :'currency_code' => :'currency_code',
    :'description' => :'description',
    :'line_item_id' => :'line_item_id',
    :'quantity' => :'quantity',
    :'rate' => :'rate',
    :'subtotal' => :'subtotal',
    :'tax' => :'tax'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'amount' => :'Float',
    :'currency_code' => :'String',
    :'description' => :'String',
    :'line_item_id' => :'String',
    :'quantity' => :'Float',
    :'rate' => :'Float',
    :'subtotal' => :'Float',
    :'tax' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/integration_api/models/line_items.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      currency_code == o.currency_code &&
      description == o.description &&
      line_item_id == o.line_item_id &&
      quantity == o.quantity &&
      rate == o.rate &&
      subtotal == o.subtotal &&
      tax == o.tax
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



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
 
# File 'lib/integration_api/models/line_items.rb', line 199

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = IntegrationApi.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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/integration_api/models/line_items.rb', line 264

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



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

def build_from_hash(attributes)
  self.class.swagger_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[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


166
167
168
 
# File 'lib/integration_api/models/line_items.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/integration_api/models/line_items.rb', line 172

def hash
  [amount, currency_code, description, line_item_id, quantity, rate, subtotal, tax].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @currency_code.nil?
    invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @rate.nil?
    invalid_properties.push('invalid value for "rate", rate cannot be nil.')
  end

  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



245
246
247
 
# File 'lib/integration_api/models/line_items.rb', line 245

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



251
252
253
254
255
256
257
258
 
# File 'lib/integration_api/models/line_items.rb', line 251

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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



239
240
241
 
# File 'lib/integration_api/models/line_items.rb', line 239

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



140
141
142
143
144
145
146
147
 
# File 'lib/integration_api/models/line_items.rb', line 140

def valid?
  return false if @amount.nil?
  return false if @currency_code.nil?
  return false if @description.nil?
  return false if @quantity.nil?
  return false if @rate.nil?
  true
end