Class: CyberSource::RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RiskV1AddressVerificationsPost201ResponseAddressVerificationInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
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
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 69

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_type ⇒ Object

Contains the record type of the postal code with which the address was matched. #### U.S. Addresses Depending on the quantity and quality of the address information provided, this field contains one or two characters: - One character: sufficient correct information was provided to result in accurate matching. - Two characters: standardization would provide a better address if more or better input address information were available. The second character is D (default). Blank fields are unassigned. When an address cannot be standardized, how the input data was parsed determines the address type. In this case, standardization may indicate a street, rural route, highway contract, general delivery, or PO box. For possible values, see the description for the ‘dav_address_type` reply field in [CyberSource Verification Services Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/) #### All Other Countries This field contains one of the following values: - P: Post. - S: Street. - x: Unknown.



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

def address_type
  @address_type
end

#applicable_region ⇒ Object

Value can be - Canada - US - International The values of errorCode and statusCode mean different things depending on the applicable region. Refer to the guide for more info.



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

def applicable_region
  @applicable_region
end

#bar_code ⇒ Object

Returns the value of attribute bar_code.



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

def bar_code
  @bar_code
end

#care_of ⇒ Object

Care of data dropped from the standard address.



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

def care_of
  @care_of
end

#error_code ⇒ Object

Four-character error code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion.



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

def error_code
  @error_code
end

#match_score ⇒ Object

Indicates the probable correctness of the address match. Returned for U.S. and Canadian addresses. Returns a value from 0-9, where 0 is most likely to be correct and 9 is least likely to be correct, or -1 if there is no address match.



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

def match_score
  @match_score
end

#standard_address ⇒ Object

Returns the value of attribute standard_address.



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

def standard_address
  @standard_address
end

#status_code ⇒ Object

Four-to-ten character status code returned for Canadian, US and international addresses. For possible values, see Verification Services guide. The meaning of the errorCode depends on value of applicableRegion.



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

def status_code
  @status_code
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'address_type' => :'addressType',
    :'bar_code' => :'barCode',
    :'applicable_region' => :'applicableRegion',
    :'error_code' => :'errorCode',
    :'status_code' => :'statusCode',
    :'care_of' => :'careOf',
    :'match_score' => :'matchScore',
    :'standard_address' => :'standardAddress'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'address_type' => :'String',
    :'bar_code' => :'RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationBarCode',
    :'applicable_region' => :'String',
    :'error_code' => :'String',
    :'status_code' => :'String',
    :'care_of' => :'String',
    :'match_score' => :'Integer',
    :'standard_address' => :'RiskV1AddressVerificationsPost201ResponseAddressVerificationInformationStandardAddress'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_type == o.address_type &&
      bar_code == o.bar_code &&
      applicable_region == o.applicable_region &&
      error_code == o.error_code &&
      status_code == o.status_code &&
      care_of == o.care_of &&
      match_score == o.match_score &&
      standard_address == o.standard_address
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 247

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 313

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 226

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


213
214
215
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 219

def hash
  [address_type, bar_code, applicable_region, error_code, status_code, care_of, match_score, standard_address].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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 110

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

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

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

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

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



293
294
295
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 293

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



299
300
301
302
303
304
305
306
307
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 299

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



287
288
289
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 287

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



137
138
139
140
141
142
143
144
 
# File 'lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb', line 137

def valid?
  return false if !@address_type.nil? && @address_type.to_s.length > 255
  return false if !@applicable_region.nil? && @applicable_region.to_s.length > 255
  return false if !@error_code.nil? && @error_code.to_s.length > 255
  return false if !@status_code.nil? && @status_code.to_s.length > 255
  return false if !@care_of.nil? && @care_of.to_s.length > 255
  true
end