Class: CyberSource::Riskv1decisionsTravelInformationLegs

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsTravelInformationLegs

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 66

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

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

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

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

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

Instance Attribute Details

#carrier_code ⇒ Object

International Air Transport Association (IATA) code for the carrier for this leg of the trip. Required for each leg. Required for American Express SafeKey (U.S.) for travel-related requests.



23
24
25
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 23

def carrier_code
  @carrier_code
end

#departure_date ⇒ Object

Departure date for the first leg of the trip. Format: YYYYMMDD. Required for American Express SafeKey (U.S.) for travel-related requests.



26
27
28
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 26

def departure_date
  @departure_date
end

#departure_time ⇒ Object

Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be ‘00-23` and the minutes must be `00-59`. Format: English characters only. Optional request field for travel legs.



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

def departure_time
  @departure_time
end

#destination ⇒ Object

Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see [IATA Airline and Airport Code Search](www.iata.org/publications/Pages/code-search.aspx). The leg number can be a positive integer from 0 to N. For example: ‘travelInformation.legs.0.destination=SFO` `travelInformation.legs.1.destination=SFO` Note In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_dest` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



20
21
22
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 20

def destination
  @destination
end

#origination ⇒ Object

Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: ‘travelInformation.legs.0.origination=SFO` `travelInformation.legs.1.origination=SFO` Note In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you send all the fields, the complete route takes precedence over the individual legs. For details, see the `decision_manager_travel_leg#_orig` field description in _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



17
18
19
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 17

def origination
  @origination
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_legs.rb', line 32

def self.attribute_map
  {
    :'origination' => :'origination',
    :'destination' => :'destination',
    :'carrier_code' => :'carrierCode',
    :'departure_date' => :'departureDate',
    :'departure_time' => :'departureTime'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'origination' => :'origination',
    :'destination' => :'destination',
    :'carrier_code' => :'carrier_code',
    :'departure_date' => :'departure_date',
    :'departure_time' => :'departure_time'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 54

def self.swagger_types
  {
    :'origination' => :'String',
    :'destination' => :'String',
    :'carrier_code' => :'String',
    :'departure_date' => :'String',
    :'departure_time' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      origination == o.origination &&
      destination == o.destination &&
      carrier_code == o.carrier_code &&
      departure_date == o.departure_date &&
      departure_time == o.departure_time
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 172

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 238

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 151

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


138
139
140
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 144

def hash
  [origination, destination, carrier_code, departure_date, departure_time].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



95
96
97
98
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 95

def list_invalid_properties
  invalid_properties = Array.new
  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



218
219
220
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 218

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



224
225
226
227
228
229
230
231
232
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 224

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



212
213
214
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 212

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



102
103
104
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb', line 102

def valid?
  true
end