Class: CyberSource::Riskv1decisionsOrderInformationShipTo

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

Overview

Contains recipient shipping information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsOrderInformationShipTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 77

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the shipping address.



19
20
21
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 19

def address1
  @address1
end

#address2 ⇒ Object

Second line of the shipping address.



22
23
24
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 22

def address2
  @address2
end

#administrative_area ⇒ Object

State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.



25
26
27
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 25

def administrative_area
  @administrative_area
end

#country ⇒ Object

Country of the shipping address. Use the two-character ISO Standard Country Codes.



28
29
30
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 28

def country
  @country
end

#first_name ⇒ Object

First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60



34
35
36
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 34

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60



37
38
39
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 37

def last_name
  @last_name
end

#locality ⇒ Object

City of the shipping address.



31
32
33
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 31

def locality
  @locality
end

#phone_number ⇒ Object

Phone number associated with the shipping address.



40
41
42
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 40

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha][numeric][numeric] Example A1B 2C3 **American Express Direct**\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.



43
44
45
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 43

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 46

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'administrative_area' => :'administrativeArea',
    :'country' => :'country',
    :'locality' => :'locality',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'phone_number' => :'phoneNumber',
    :'postal_code' => :'postalCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 61

def self.swagger_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'administrative_area' => :'String',
    :'country' => :'String',
    :'locality' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'String',
    :'postal_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      administrative_area == o.administrative_area &&
      country == o.country &&
      locality == o.locality &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      phone_number == o.phone_number &&
      postal_code == o.postal_code
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 320

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 386

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 299

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


286
287
288
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 292

def hash
  [address1, address2, administrative_area, country, locality, first_name, last_name, phone_number, postal_code].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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 122

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

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

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

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

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

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

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

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

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



366
367
368
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 366

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



372
373
374
375
376
377
378
379
380
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 372

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



360
361
362
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 360

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



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb', line 165

def valid?
  return false if !@address1.nil? && @address1.to_s.length > 60
  return false if !@address2.nil? && @address2.to_s.length > 60
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 2
  return false if !@country.nil? && @country.to_s.length > 2
  return false if !@locality.nil? && @locality.to_s.length > 50
  return false if !@first_name.nil? && @first_name.to_s.length > 60
  return false if !@last_name.nil? && @last_name.to_s.length > 60
  return false if !@phone_number.nil? && @phone_number.to_s.length > 15
  return false if !@postal_code.nil? && @postal_code.to_s.length > 10
  true
end