Class: CyberSource::Upv1capturecontextsOrderInformationShipTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upv1capturecontextsOrderInformationShipTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
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/upv1capturecontexts_order_information_ship_to.rb', line 108

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the shipping address.



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

def address1
  @address1
end

#address2 ⇒ Object

Second line of the shipping address.



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

def address2
  @address2
end

#address3 ⇒ Object

Third line of the shipping address.



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

def address3
  @address3
end

#address4 ⇒ Object

Fourth line of the shipping address.



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

def address4
  @address4
end

#administrative_area ⇒ Object

State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf)



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

def administrative_area
  @administrative_area
end

#building_number ⇒ Object

Building number in the street address.



32
33
34
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 32

def building_number
  @building_number
end

#country ⇒ Object

Country of the shipping address. Use the two-character [ISO Standard Country Codes.](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)



35
36
37
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 35

def country
  @country
end

#district ⇒ Object

Neighborhood, community, or region within a city or municipality.



38
39
40
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 38

def district
  @district
end

#first_name ⇒ Object

First name of the recipient



47
48
49
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 47

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of the recipient.



50
51
52
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 50

def last_name
  @last_name
end

#locality ⇒ Object

City of the shipping address.



41
42
43
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 41

def locality
  @locality
end

#postal_code ⇒ Object

Postal code for the shipping address. The postal code must consist of 5 to 9 digits.



44
45
46
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 44

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 53

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'address4' => :'address4',
    :'administrative_area' => :'administrativeArea',
    :'building_number' => :'buildingNumber',
    :'country' => :'country',
    :'district' => :'district',
    :'locality' => :'locality',
    :'postal_code' => :'postalCode',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName'
  }
end

.json_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 71

def self.json_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'address3' => :'address3',
    :'address4' => :'address4',
    :'administrative_area' => :'administrative_area',
    :'building_number' => :'building_number',
    :'country' => :'country',
    :'district' => :'district',
    :'locality' => :'locality',
    :'postal_code' => :'postal_code',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 291

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 357

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



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

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


257
258
259
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 263

def hash
  [address1, address2, address3, address4, administrative_area, building_number, country, district, locality, postal_code, first_name, last_name].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



165
166
167
168
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 165

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



337
338
339
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 337

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



343
344
345
346
347
348
349
350
351
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 343

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



331
332
333
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 331

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



172
173
174
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_order_information_ship_to.rb', line 172

def valid?
  true
end