Class: OpenapiClient::CarRental

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

Overview

Additional data specific to the car rental industry.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CarRental

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
110
111
112
113
114
115
116
117
118
 
# File 'lib/openapi_client/models/car_rental.rb', line 72

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CarRental` 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::CarRental`. 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?(:'agreement_number')
    self.agreement_number = attributes[:'agreement_number']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#agreement_number ⇒ Object

The car rental agreement number.



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

def agreement_number
  @agreement_number
end

#extra_charges ⇒ Object

Array containing information about charges other than the rental rate.



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

def extra_charges
  @extra_charges
end

#no_show_indicator ⇒ Object

Indicates if the transaction is related to a no-show charge.



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

def no_show_indicator
  @no_show_indicator
end

#pickup_date ⇒ Object

The date the car rental begins.



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

def pickup_date
  @pickup_date
end

#rental_class_id ⇒ Object

The classification of the rental car.



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

def rental_class_id
  @rental_class_id
end

#renter_name ⇒ Object

The name of the person renting the car.



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

def renter_name
  @renter_name
end

#return_city ⇒ Object

The city where the rental ends and the car is returned.



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

def return_city
  @return_city
end

#return_date ⇒ Object

The date the car rental ends and the car is returned.



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

def return_date
  @return_date
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/car_rental.rb', line 43

def self.attribute_map
  {
    :'agreement_number' => :'agreementNumber',
    :'renter_name' => :'renterName',
    :'return_city' => :'returnCity',
    :'return_date' => :'returnDate',
    :'pickup_date' => :'pickupDate',
    :'rental_class_id' => :'rentalClassId',
    :'extra_charges' => :'extraCharges',
    :'no_show_indicator' => :'noShowIndicator'
  }
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



223
224
225
 
# File 'lib/openapi_client/models/car_rental.rb', line 223

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'agreement_number' => :'String',
    :'renter_name' => :'String',
    :'return_city' => :'String',
    :'return_date' => :'Date',
    :'pickup_date' => :'Date',
    :'rental_class_id' => :'String',
    :'extra_charges' => :'Array<CarRentalExtraCharges>',
    :'no_show_indicator' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/openapi_client/models/car_rental.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agreement_number == o.agreement_number &&
      renter_name == o.renter_name &&
      return_city == o.return_city &&
      return_date == o.return_date &&
      pickup_date == o.pickup_date &&
      rental_class_id == o.rental_class_id &&
      extra_charges == o.extra_charges &&
      no_show_indicator == o.no_show_indicator
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/openapi_client/models/car_rental.rb', line 251

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/openapi_client/models/car_rental.rb', line 325

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/openapi_client/models/car_rental.rb', line 230

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


210
211
212
 
# File 'lib/openapi_client/models/car_rental.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/openapi_client/models/car_rental.rb', line 216

def hash
  [agreement_number, renter_name, return_city, return_date, pickup_date, rental_class_id, extra_charges, no_show_indicator].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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/openapi_client/models/car_rental.rb', line 122

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

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

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

  if !@rental_class_id.nil? && @rental_class_id.to_s.length > 6
    invalid_properties.push('invalid value for "rental_class_id", the character length must be smaller than or equal to 6.')
  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



301
302
303
 
# File 'lib/openapi_client/models/car_rental.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/openapi_client/models/car_rental.rb', line 307

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



295
296
297
 
# File 'lib/openapi_client/models/car_rental.rb', line 295

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



145
146
147
148
149
150
151
 
# File 'lib/openapi_client/models/car_rental.rb', line 145

def valid?
  return false if !@agreement_number.nil? && @agreement_number.to_s.length > 20
  return false if !@renter_name.nil? && @renter_name.to_s.length > 20
  return false if !@return_city.nil? && @return_city.to_s.length > 20
  return false if !@rental_class_id.nil? && @rental_class_id.to_s.length > 6
  true
end