Class: GoogleMapsPlatform::Fare

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/google_maps_platform/models/fare.rb

Overview

The total fare for the route. “‘ { “currency” : “USD”, “value” : 6, “text” : “$6.00” } “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(currency:, value:, text:, additional_properties: nil) ⇒ Fare

Returns a new instance of Fare.



45
46
47
48
49
50
51
52
53
 
# File 'lib/google_maps_platform/models/fare.rb', line 45

def initialize(currency:, value:, text:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @currency = currency
  @value = value
  @text = text
  @additional_properties = additional_properties
end

Instance Attribute Details

#currency ⇒ String

An [ISO 4217 currency code](en.wikipedia.org/wiki/ISO_4217) indicating the currency that the amount is expressed in.

Returns:

  • (String) 


16
17
18
 
# File 'lib/google_maps_platform/models/fare.rb', line 16

def currency
  @currency
end

#text ⇒ String

The total fare amount, formatted in the requested language.

Returns:

  • (String) 


24
25
26
 
# File 'lib/google_maps_platform/models/fare.rb', line 24

def text
  @text
end

#value ⇒ Float

The total fare amount, in the currency specified.

Returns:

  • (Float) 


20
21
22
 
# File 'lib/google_maps_platform/models/fare.rb', line 20

def value
  @value
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  currency = hash.key?('currency') ? hash['currency'] : nil
  value = hash.key?('value') ? hash['value'] : nil
  text = hash.key?('text') ? hash['text'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Fare.new(currency: currency,
           value: value,
           text: text,
           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



27
28
29
30
31
32
33
 
# File 'lib/google_maps_platform/models/fare.rb', line 27

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['currency'] = 'currency'
  @_hash['value'] = 'value'
  @_hash['text'] = 'text'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/google_maps_platform/models/fare.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
 
# File 'lib/google_maps_platform/models/fare.rb', line 36

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



86
87
88
89
90
 
# File 'lib/google_maps_platform/models/fare.rb', line 86

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} currency: #{@currency.inspect}, value: #{@value.inspect}, text:"\
  " #{@text.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



79
80
81
82
83
 
# File 'lib/google_maps_platform/models/fare.rb', line 79

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} currency: #{@currency}, value: #{@value}, text: #{@text},"\
  " additional_properties: #{@additional_properties}>"
end