Class: CyberSource::Tmsv2customersEmbeddedDefaultShippingAddressShipTo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tmsv2customersEmbeddedDefaultShippingAddressShipTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
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
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of the shipping address.



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

def address1
  @address1
end

#address2 ⇒ Object

Second line of the shipping address.



30
31
32
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 30

def address2
  @address2
end

#administrative_area ⇒ Object

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



36
37
38
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 36

def administrative_area
  @administrative_area
end

#company ⇒ Object

Company associated with the shipping address.



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

def company
  @company
end

#country ⇒ Object

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



42
43
44
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 42

def country
  @country
end

#email ⇒ Object

Email associated with the shipping address.



45
46
47
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 45

def email
  @email
end

#first_name ⇒ Object

First name of the recipient.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of the recipient.



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

def last_name
  @last_name
end

#locality ⇒ Object

City of the shipping address.



33
34
35
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 33

def locality
  @locality
end

#phone_number ⇒ Object

Phone number associated with the shipping address.



48
49
50
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 48

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, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, truncates the value starting from the right side.



39
40
41
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 39

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 51

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

.json_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 68

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

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 85

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 235

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



287
288
289
290
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
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 287

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 353

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 266

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


253
254
255
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 259

def hash
  [first_name, last_name, company, address1, address2, locality, administrative_area, postal_code, country, email, phone_number].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



156
157
158
159
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 156

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



333
334
335
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 339

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



327
328
329
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 327

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



163
164
165
 
# File 'lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address_ship_to.rb', line 163

def valid?
  true
end