Class: CyberSourceMergedSpec::TravelInformation10

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/travel_information10.rb

Overview

TravelInformation10 Model.

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(legs: SKIP, number_of_passengers: SKIP, passengers: SKIP, additional_properties: nil) ⇒ TravelInformation10

Returns a new instance of TravelInformation10.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 53

def initialize(legs: SKIP, number_of_passengers: SKIP, passengers: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @legs = legs unless legs == SKIP
  @number_of_passengers = number_of_passengers unless number_of_passengers == SKIP
  @passengers = passengers unless passengers == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#legs ⇒ Array[Leg5]

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 14

def legs
  @legs
end

#number_of_passengers ⇒ Integer

Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 21

def number_of_passengers
  @number_of_passengers
end

#passengers ⇒ Array[Passenger3]

Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses a default value of 1. Required for American Express SafeKey (U.S.) for travel-related requests.

Returns:



28
29
30
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 28

def passengers
  @passengers
end

Class Method Details

.from_element(root) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 106

def self.from_element(root)
  legs = XmlUtilities.from_element_to_array(root, 'Leg5', Leg5)
  number_of_passengers = XmlUtilities.from_element(root,
                                                   'numberOfPassengers',
                                                   Integer)
  passengers = XmlUtilities.from_element_to_array(root, 'Passenger3',
                                                  Passenger3)

  new(legs: legs,
      number_of_passengers: number_of_passengers,
      passengers: passengers,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



65
66
67
68
69
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
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 65

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  legs = nil
  unless hash['legs'].nil?
    legs = []
    hash['legs'].each do |structure|
      legs << (Leg5.from_hash(structure) if structure)
    end
  end

  legs = SKIP unless hash.key?('legs')
  number_of_passengers =
    hash.key?('numberOfPassengers') ? hash['numberOfPassengers'] : SKIP
  # Parameter is an array, so we need to iterate through it
  passengers = nil
  unless hash['passengers'].nil?
    passengers = []
    hash['passengers'].each do |structure|
      passengers << (Passenger3.from_hash(structure) if structure)
    end
  end

  passengers = SKIP unless hash.key?('passengers')

  # 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.
  TravelInformation10.new(legs: legs,
                          number_of_passengers: number_of_passengers,
                          passengers: passengers,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 31

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['legs'] = 'legs'
  @_hash['number_of_passengers'] = 'numberOfPassengers'
  @_hash['passengers'] = 'passengers'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



40
41
42
43
44
45
46
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 40

def self.optionals
  %w[
    legs
    number_of_passengers
    passengers
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



141
142
143
144
145
146
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 141

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



134
135
136
137
138
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 134

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

#to_xml_element(doc, root_name) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cyber_source_merged_spec/models/travel_information10.rb', line 120

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_array_as_subelement(doc, root, 'Leg5', legs)
  XmlUtilities.add_as_subelement(doc, root, 'numberOfPassengers',
                                 number_of_passengers)
  XmlUtilities.add_array_as_subelement(doc, root, 'Passenger3', passengers)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end