Class: CyberSource::Riskv1decisionsTravelInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsTravelInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 55

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

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

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

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

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

Instance Attribute Details

#actual_final_destination ⇒ Object

IATA Code for the actual final destination that the customer intends to travel to. It should be a destination on the completeRoute.



18
19
20
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 18

def actual_final_destination
  @actual_final_destination
end

#complete_route ⇒ Object

Concatenation of individual travel legs in the format ORIG1-DEST1, for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields.



21
22
23
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 21

def complete_route
  @complete_route
end

#departure_time ⇒ Object

Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset.



24
25
26
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 24

def departure_time
  @departure_time
end

#journey_type ⇒ Object

Type of travel, for example one way or round trip.



27
28
29
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 27

def journey_type
  @journey_type
end

#legs ⇒ Object

Returns the value of attribute legs.



29
30
31
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 29

def legs
  @legs
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 32

def self.attribute_map
  {
    :'actual_final_destination' => :'actualFinalDestination',
    :'complete_route' => :'completeRoute',
    :'departure_time' => :'departureTime',
    :'journey_type' => :'journeyType',
    :'legs' => :'legs'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 43

def self.swagger_types
  {
    :'actual_final_destination' => :'String',
    :'complete_route' => :'String',
    :'departure_time' => :'String',
    :'journey_type' => :'String',
    :'legs' => :'Array<Riskv1decisionsTravelInformationLegs>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actual_final_destination == o.actual_final_destination &&
      complete_route == o.complete_route &&
      departure_time == o.departure_time &&
      journey_type == o.journey_type &&
      legs == o.legs
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 205

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 271

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



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

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


171
172
173
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 177

def hash
  [actual_final_destination, complete_route, departure_time, journey_type, legs].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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 86

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

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

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

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



251
252
253
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 251

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



257
258
259
260
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 257

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



245
246
247
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 245

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



109
110
111
112
113
114
115
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb', line 109

def valid?
  return false if !@actual_final_destination.nil? && @actual_final_destination.to_s.length > 3
  return false if !@complete_route.nil? && @complete_route.to_s.length > 255
  return false if !@departure_time.nil? && @departure_time.to_s.length > 25
  return false if !@journey_type.nil? && @journey_type.to_s.length > 32
  true
end