Class: StorecoveApi::InvoiceLine

Inherits:
Object
  • Object
show all
Defined in:
lib/storecove/models/invoice_line.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceLine

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/storecove/models/invoice_line.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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

end

Instance Attribute Details

#accounting_cost_code ⇒ Object

Returns the value of attribute accounting_cost_code.



34
35
36
 
# File 'lib/storecove/models/invoice_line.rb', line 34

def accounting_cost_code
  @accounting_cost_code
end

#amount_excluding_vat ⇒ Object

The amount excluding VAT. Should equal quantity x itemPrice (if these are both present). A difference of 5 cents or 1% between the calculated value and the provided value is allowed.



30
31
32
 
# File 'lib/storecove/models/invoice_line.rb', line 30

def amount_excluding_vat
  @amount_excluding_vat
end

#description ⇒ Object

The description for this invoice line.



21
22
23
 
# File 'lib/storecove/models/invoice_line.rb', line 21

def description
  @description
end

#id ⇒ Object

Your id for this invoice line.



18
19
20
 
# File 'lib/storecove/models/invoice_line.rb', line 18

def id
  @id
end

#image_url ⇒ Object

A URL to an image for the product in the invoice line.



37
38
39
 
# File 'lib/storecove/models/invoice_line.rb', line 37

def image_url
  @image_url
end

#invoice_period ⇒ Object

The period (or specific date) to which the invoice line applies. Format: yyyy-mm-dd - yyyy-mm-dd.



24
25
26
 
# File 'lib/storecove/models/invoice_line.rb', line 24

def invoice_period
  @invoice_period
end

#quantity ⇒ Object

The number of items (may be fractional).



27
28
29
 
# File 'lib/storecove/models/invoice_line.rb', line 27

def quantity
  @quantity
end

#tax ⇒ Object

Returns the value of attribute tax.



32
33
34
 
# File 'lib/storecove/models/invoice_line.rb', line 32

def tax
  @tax
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/storecove/models/invoice_line.rb', line 41

def self.attribute_map
  {
    :'id' => :'id',
    :'description' => :'description',
    :'invoice_period' => :'invoicePeriod',
    :'quantity' => :'quantity',
    :'amount_excluding_vat' => :'amountExcludingVat',
    :'tax' => :'tax',
    :'accounting_cost_code' => :'accountingCostCode',
    :'image_url' => :'imageUrl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'description' => :'String',
    :'invoice_period' => :'String',
    :'quantity' => :'Float',
    :'amount_excluding_vat' => :'Float',
    :'tax' => :'Tax',
    :'accounting_cost_code' => :'AccountingCostCode',
    :'image_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/storecove/models/invoice_line.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      description == o.description &&
      invoice_period == o.invoice_period &&
      quantity == o.quantity &&
      amount_excluding_vat == o.amount_excluding_vat &&
      tax == o.tax &&
      accounting_cost_code == o.accounting_cost_code &&
      image_url == o.image_url
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



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
268
269
270
271
 
# File 'lib/storecove/models/invoice_line.rb', line 235

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 = StorecoveApi.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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/storecove/models/invoice_line.rb', line 301

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/storecove/models/invoice_line.rb', line 214

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


201
202
203
 
# File 'lib/storecove/models/invoice_line.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/storecove/models/invoice_line.rb', line 207

def hash
  [id, description, invoice_period, quantity, amount_excluding_vat, tax, accounting_cost_code, image_url].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/storecove/models/invoice_line.rb', line 112

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

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

  if @description.to_s.length < 1
    invalid_properties.push("invalid value for 'description', the character length must be great than or equal to 1.")
  end

  if !@invoice_period.nil? && @invoice_period !~ Regexp.new(/^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$/)
    invalid_properties.push("invalid value for 'invoice_period', must conform to the pattern /^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$/.")
  end

  if @amount_excluding_vat.nil?
    invalid_properties.push("invalid value for 'amount_excluding_vat', amount_excluding_vat cannot be nil.")
  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



281
282
283
 
# File 'lib/storecove/models/invoice_line.rb', line 281

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



287
288
289
290
291
292
293
294
295
 
# File 'lib/storecove/models/invoice_line.rb', line 287

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



275
276
277
 
# File 'lib/storecove/models/invoice_line.rb', line 275

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/storecove/models/invoice_line.rb', line 139

def valid?
  return false if !@id.nil? && @id.to_s.length < 1
  return false if @description.nil?
  return false if @description.to_s.length < 1
  return false if !@invoice_period.nil? && @invoice_period !~ Regexp.new(/^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$/)
  return false if @amount_excluding_vat.nil?
  return true
end