Class: TripletexRubyClient::MileageAllowance

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/mileage_allowance.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MileageAllowance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



41
42
43
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 41

def amount
  @amount
end

#changes ⇒ Object

Returns the value of attribute changes.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 21

def changes
  @changes
end

#date ⇒ Object

Returns the value of attribute date.



31
32
33
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 31

def date
  @date
end

#departure_location ⇒ Object

Returns the value of attribute departure_location.



33
34
35
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 33

def departure_location
  @departure_location
end

#destination ⇒ Object

Returns the value of attribute destination.



35
36
37
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 35

def destination
  @destination
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 17

def id
  @id
end

#is_company_car ⇒ Object

Returns the value of attribute is_company_car.



43
44
45
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 43

def is_company_car
  @is_company_car
end

#km ⇒ Object

Returns the value of attribute km.



37
38
39
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 37

def km
  @km
end

#passenger_supplement ⇒ Object

Passenger mileage allowance associated with this mileage allowance.



49
50
51
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 49

def passenger_supplement
  @passenger_supplement
end

#passengers ⇒ Object

Link to individual passengers.



46
47
48
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 46

def passengers
  @passengers
end

#rate ⇒ Object

Returns the value of attribute rate.



39
40
41
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 39

def rate
  @rate
end

#rate_category ⇒ Object

Returns the value of attribute rate_category.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 29

def rate_category
  @rate_category
end

#rate_type ⇒ Object

Returns the value of attribute rate_type.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 27

def rate_type
  @rate_type
end

#toll_cost ⇒ Object

Toll cost associated with this mileage allowance.



52
53
54
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 52

def toll_cost
  @toll_cost
end

#travel_expense ⇒ Object

Returns the value of attribute travel_expense.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 25

def travel_expense
  @travel_expense
end

#url ⇒ Object

Returns the value of attribute url.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 23

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 19

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'travel_expense' => :'travelExpense',
    :'rate_type' => :'rateType',
    :'rate_category' => :'rateCategory',
    :'date' => :'date',
    :'departure_location' => :'departureLocation',
    :'destination' => :'destination',
    :'km' => :'km',
    :'rate' => :'rate',
    :'amount' => :'amount',
    :'is_company_car' => :'isCompanyCar',
    :'passengers' => :'passengers',
    :'passenger_supplement' => :'passengerSupplement',
    :'toll_cost' => :'tollCost'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 78

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'travel_expense' => :'TravelExpense',
    :'rate_type' => :'TravelExpenseRate',
    :'rate_category' => :'TravelExpenseRateCategory',
    :'date' => :'String',
    :'departure_location' => :'String',
    :'destination' => :'String',
    :'km' => :'Float',
    :'rate' => :'Float',
    :'amount' => :'Float',
    :'is_company_car' => :'BOOLEAN',
    :'passengers' => :'Array<Passenger>',
    :'passenger_supplement' => :'MileageAllowance',
    :'toll_cost' => :'Cost'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      rate_type == o.rate_type &&
      rate_category == o.rate_category &&
      date == o.date &&
      departure_location == o.departure_location &&
      destination == o.destination &&
      km == o.km &&
      rate == o.rate &&
      amount == o.amount &&
      is_company_car == o.is_company_car &&
      passengers == o.passengers &&
      passenger_supplement == o.passenger_supplement &&
      toll_cost == o.toll_cost
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



269
270
271
272
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
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 269

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 335

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 248

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


235
236
237
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 241

def hash
  [id, version, changes, url, travel_expense, rate_type, rate_category, date, departure_location, destination, km, rate, amount, is_company_car, passengers, passenger_supplement, toll_cost].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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 183

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

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

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



315
316
317
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 321

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



309
310
311
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 309

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



202
203
204
205
206
207
 
# File 'lib/tripletex_ruby_client/models/mileage_allowance.rb', line 202

def valid?
  return false if @date.nil?
  return false if @departure_location.nil?
  return false if @destination.nil?
  true
end