Class: TripletexApi::Cost

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/cost.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Cost

Initializes the object

Parameters:

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

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/tripletex_api/models/cost.rb', line 113

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

  if attributes.has_key?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'isPaidByEmployee')
    self.is_paid_by_employee = attributes[:'isPaidByEmployee']
  else
    self.is_paid_by_employee = false
  end

  if attributes.has_key?(:'isChargeable')
    self.is_chargeable = attributes[:'isChargeable']
  else
    self.is_chargeable = false
  end

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

end

Instance Attribute Details

#amount_currency_inc_vatObject

Returns the value of attribute amount_currency_inc_vat.



42
43
44
# File 'lib/tripletex_api/models/cost.rb', line 42

def amount_currency_inc_vat
  @amount_currency_inc_vat
end

#amount_nok_incl_vatObject

Returns the value of attribute amount_nok_incl_vat.



44
45
46
# File 'lib/tripletex_api/models/cost.rb', line 44

def amount_nok_incl_vat
  @amount_nok_incl_vat
end

#amount_nok_incl_vat_highObject

Returns the value of attribute amount_nok_incl_vat_high.



50
51
52
# File 'lib/tripletex_api/models/cost.rb', line 50

def amount_nok_incl_vat_high
  @amount_nok_incl_vat_high
end

#amount_nok_incl_vat_lowObject

Returns the value of attribute amount_nok_incl_vat_low.



46
47
48
# File 'lib/tripletex_api/models/cost.rb', line 46

def amount_nok_incl_vat_low
  @amount_nok_incl_vat_low
end

#amount_nok_incl_vat_mediumObject

Returns the value of attribute amount_nok_incl_vat_medium.



48
49
50
# File 'lib/tripletex_api/models/cost.rb', line 48

def amount_nok_incl_vat_medium
  @amount_nok_incl_vat_medium
end

#categoryObject

Returns the value of attribute category.



36
37
38
# File 'lib/tripletex_api/models/cost.rb', line 36

def category
  @category
end

#changesObject

Returns the value of attribute changes.



22
23
24
# File 'lib/tripletex_api/models/cost.rb', line 22

def changes
  @changes
end

#commentsObject

Returns the value of attribute comments.



38
39
40
# File 'lib/tripletex_api/models/cost.rb', line 38

def comments
  @comments
end

#cost_categoryObject

Returns the value of attribute cost_category.



32
33
34
# File 'lib/tripletex_api/models/cost.rb', line 32

def cost_category
  @cost_category
end

#currencyObject

Returns the value of attribute currency.



30
31
32
# File 'lib/tripletex_api/models/cost.rb', line 30

def currency
  @currency
end

#dateObject

Returns the value of attribute date.



56
57
58
# File 'lib/tripletex_api/models/cost.rb', line 56

def date
  @date
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/tripletex_api/models/cost.rb', line 18

def id
  @id
end

#is_chargeableObject

Returns the value of attribute is_chargeable.



54
55
56
# File 'lib/tripletex_api/models/cost.rb', line 54

def is_chargeable
  @is_chargeable
end

#is_paid_by_employeeObject

Returns the value of attribute is_paid_by_employee.



52
53
54
# File 'lib/tripletex_api/models/cost.rb', line 52

def is_paid_by_employee
  @is_paid_by_employee
end

#payment_typeObject

Returns the value of attribute payment_type.



34
35
36
# File 'lib/tripletex_api/models/cost.rb', line 34

def payment_type
  @payment_type
end

#rateObject

Returns the value of attribute rate.



40
41
42
# File 'lib/tripletex_api/models/cost.rb', line 40

def rate
  @rate
end

#travel_expenseObject

Returns the value of attribute travel_expense.



26
27
28
# File 'lib/tripletex_api/models/cost.rb', line 26

def travel_expense
  @travel_expense
end

#urlObject

Returns the value of attribute url.



24
25
26
# File 'lib/tripletex_api/models/cost.rb', line 24

def url
  @url
end

#vat_typeObject

Returns the value of attribute vat_type.



28
29
30
# File 'lib/tripletex_api/models/cost.rb', line 28

def vat_type
  @vat_type
end

#versionObject

Returns the value of attribute version.



20
21
22
# File 'lib/tripletex_api/models/cost.rb', line 20

def version
  @version
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/tripletex_api/models/cost.rb', line 60

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'travel_expense' => :'travelExpense',
    :'vat_type' => :'vatType',
    :'currency' => :'currency',
    :'cost_category' => :'costCategory',
    :'payment_type' => :'paymentType',
    :'category' => :'category',
    :'comments' => :'comments',
    :'rate' => :'rate',
    :'amount_currency_inc_vat' => :'amountCurrencyIncVat',
    :'amount_nok_incl_vat' => :'amountNOKInclVAT',
    :'amount_nok_incl_vat_low' => :'amountNOKInclVATLow',
    :'amount_nok_incl_vat_medium' => :'amountNOKInclVATMedium',
    :'amount_nok_incl_vat_high' => :'amountNOKInclVATHigh',
    :'is_paid_by_employee' => :'isPaidByEmployee',
    :'is_chargeable' => :'isChargeable',
    :'date' => :'date'
  }
end

.swagger_typesObject

Attribute type mapping.



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/tripletex_api/models/cost.rb', line 86

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'travel_expense' => :'TravelExpense',
    :'vat_type' => :'VatType',
    :'currency' => :'Currency',
    :'cost_category' => :'TravelCostCategory',
    :'payment_type' => :'TravelPaymentType',
    :'category' => :'String',
    :'comments' => :'String',
    :'rate' => :'Float',
    :'amount_currency_inc_vat' => :'Float',
    :'amount_nok_incl_vat' => :'Float',
    :'amount_nok_incl_vat_low' => :'Float',
    :'amount_nok_incl_vat_medium' => :'Float',
    :'amount_nok_incl_vat_high' => :'Float',
    :'is_paid_by_employee' => :'BOOLEAN',
    :'is_chargeable' => :'BOOLEAN',
    :'date' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/tripletex_api/models/cost.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      travel_expense == o.travel_expense &&
      vat_type == o.vat_type &&
      currency == o.currency &&
      cost_category == o.cost_category &&
      payment_type == o.payment_type &&
      category == o.category &&
      comments == o.comments &&
      rate == o.rate &&
      amount_currency_inc_vat == o.amount_currency_inc_vat &&
      amount_nok_incl_vat == o.amount_nok_incl_vat &&
      amount_nok_incl_vat_low == o.amount_nok_incl_vat_low &&
      amount_nok_incl_vat_medium == o.amount_nok_incl_vat_medium &&
      amount_nok_incl_vat_high == o.amount_nok_incl_vat_high &&
      is_paid_by_employee == o.is_paid_by_employee &&
      is_chargeable == o.is_chargeable &&
      date == o.date
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/tripletex_api/models/cost.rb', line 319

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



385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/tripletex_api/models/cost.rb', line 385

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/tripletex_api/models/cost.rb', line 298

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


285
286
287
# File 'lib/tripletex_api/models/cost.rb', line 285

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



291
292
293
# File 'lib/tripletex_api/models/cost.rb', line 291

def hash
  [id, version, changes, url, travel_expense, vat_type, currency, cost_category, payment_type, category, comments, rate, amount_currency_inc_vat, amount_nok_incl_vat, amount_nok_incl_vat_low, amount_nok_incl_vat_medium, amount_nok_incl_vat_high, is_paid_by_employee, is_chargeable, date].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/tripletex_api/models/cost.rb', line 209

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

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

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

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

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



365
366
367
# File 'lib/tripletex_api/models/cost.rb', line 365

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



371
372
373
374
375
376
377
378
379
# File 'lib/tripletex_api/models/cost.rb', line 371

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



359
360
361
# File 'lib/tripletex_api/models/cost.rb', line 359

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



236
237
238
239
240
241
242
243
# File 'lib/tripletex_api/models/cost.rb', line 236

def valid?
  return false if @cost_category.nil?
  return false if @payment_type.nil?
  return false if !@category.nil? && @category.to_s.length > 100
  return false if @amount_currency_inc_vat.nil?
  return false if @date.nil?
  return true
end