Class: MastercardMerchantCheckout::ShippingAddress

Inherits:
Object
  • Object
show all
Includes:
ROXML
Defined in:
lib/mastercard_merchant_checkout/models/shipping_address.rb

Overview

This class contains shipping address information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShippingAddress

Returns a new instance of ShippingAddress.



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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 81

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes.has_key?(:recipient_info)
    self.recipient_info = attributes[:recipient_info]
  end
  
  if attributes.has_key?(:address_id)
    self.address_id = attributes[:address_id]
  end
  
  if attributes.has_key?(:default)
    self.default = attributes[:default]
  end
  
  if attributes.has_key?(:city)
    self.city = attributes[:city]
  end
  
  if attributes.has_key?(:country)
    self.country = attributes[:country]
  end
  
  if attributes.has_key?(:subdivision)
    self.subdivision = attributes[:subdivision]
  end
  
  if attributes.has_key?(:line1)
    self.line1 = attributes[:line1]
  end
  
  if attributes.has_key?(:line2)
    self.line2 = attributes[:line2]
  end
  
  if attributes.has_key?(:line3)
    self.line3 = attributes[:line3]
  end
  
  if attributes.has_key?(:line4)
    self.line4 = attributes[:line4]
  end
  
  if attributes.has_key?(:line5)
    self.line5 = attributes[:line5]
  end
  
  if attributes.has_key?(:postal_code)
    self.postal_code = attributes[:postal_code]
  end
  
end

Instance Attribute Details

#address_id ⇒ String

Returns the address id.

Returns:

  • (String) —

    the address id.



19
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 19

xml_accessor :address_id, :from =>"addressId"

#city ⇒ String

Returns the cardholder’s city.

Returns:

  • (String) —

    the cardholder’s city.



27
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 27

xml_accessor :city, :from =>"city"

#country ⇒ String

Returns the cardholder’s country as defined by ISO 3166-1 alpha-2 digit country codes; for example, US is the United States, AU is Australia, CA is Canada, GB is the United Kingdom, and so on.

Returns:

  • (String) —

    the cardholder’s country as defined by ISO 3166-1 alpha-2 digit country codes; for example, US is the United States, AU is Australia, CA is Canada, GB is the United Kingdom, and so on.



31
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 31

xml_accessor :country, :from =>"country"

#default ⇒ BOOLEAN

Returns the default selection.

Returns:

  • (BOOLEAN) —

    the default selection.



23
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 23

xml_accessor :default, :from =>"default"

#line1 ⇒ String

Returns the address in line 1 is used for the street number and the street name.

Returns:

  • (String) —

    the address in line 1 is used for the street number and the street name.



39
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 39

xml_accessor :line1, :from =>"line1"

#line2 ⇒ String

Returns the address in line 2 is used for the apartment number, suite Number, and so on.

Returns:

  • (String) —

    the address in line 2 is used for the apartment number, suite Number, and so on.



43
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 43

xml_accessor :line2, :from =>"line2"

#line3 ⇒ String

Returns the address in line 3 is used to enter the remaining address information if it does not fit in lines 1 and 2.

Returns:

  • (String) —

    the address in line 3 is used to enter the remaining address information if it does not fit in lines 1 and 2.



47
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 47

xml_accessor :line3, :from =>"line3"

#line4 ⇒ String

Returns the address in line 4 is used to enter the remaining address information if it does not fit in lines 1, 2 and 3.

Returns:

  • (String) —

    the address in line 4 is used to enter the remaining address information if it does not fit in lines 1, 2 and 3.



51
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 51

xml_accessor :line4, :from =>"line4"

#line5 ⇒ String

Returns the address in line 5 is used to enter the remaining address information if it does not fit in line 1,2,3 and 4.

Returns:

  • (String) —

    the address in line 5 is used to enter the remaining address information if it does not fit in line 1,2,3 and 4.



55
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 55

xml_accessor :line5, :from =>"line5"

#postal_code ⇒ String

Returns the postal code or zip code appended to the mailing address for the purpose of sorting mail.

Returns:

  • (String) —

    the postal code or zip code appended to the mailing address for the purpose of sorting mail.



59
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 59

xml_accessor :postal_code, :from =>"postalCode"

#recipient_info ⇒ RecipientInfo

Returns the recipient information.

Returns:



15
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 15

xml_accessor :recipient_info, :from =>"recipientInfo",:as => RecipientInfo

#subdivision ⇒ String

Returns the cardholder’s country’s subdivision as defined by ISO 3166-1 alpha-2 digit code; for example, US-VA is Virginia, US-OH is Ohio, and so on.

Returns:

  • (String) —

    the cardholder’s country’s subdivision as defined by ISO 3166-1 alpha-2 digit code; for example, US-VA is Virginia, US-OH is Ohio, and so on.



35
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 35

xml_accessor :subdivision, :from =>"subdivision"

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 63

def self.attribute_map
  {
    :recipient_info => :recipientInfo ,
    :address_id => :addressId ,
    :default => :default ,
    :city => :city ,
    :country => :country ,
    :subdivision => :subdivision ,
    :line1 => :line1 ,
    :line2 => :line2 ,
    :line3 => :line3 ,
    :line4 => :line4 ,
    :line5 => :line5 ,
    :postal_code => :postalCode 
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recipient_info == o.recipient_info &&
      address_id == o.address_id &&
      default == o.default &&
      city == o.city &&
      country == o.country &&
      subdivision == o.subdivision &&
      line1 == o.line1 &&
      line2 == o.line2 &&
      line3 == o.line3 &&
      line4 == o.line4 &&
      line5 == o.line5 &&
      postal_code == o.postal_code
end

#_deserialize(type, value) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 189

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 /\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
    _model = MastercardMerchantCheckout.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 248

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

build the object from hash



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 170

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.datatype_map.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


160
161
162
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



165
166
167
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 165

def hash
  [recipient_info, address_id, default, city, country, subdivision, line1, line2, line3, line4, line5, postal_code].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



229
230
231
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 229

def to_body
  to_hash
end

#to_hash(include_root = false) ⇒ Object

return the object in the form of hash



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 234

def to_hash(include_root = false)
  attributes_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
  attributes_hash = include_root ? { "ShippingAddress" => hash } : hash  
  return attributes_hash
end

#to_s ⇒ Object 



224
225
226
 
# File 'lib/mastercard_merchant_checkout/models/shipping_address.rb', line 224

def to_s
  to_hash.to_s
end