Class: CyberSource::PtsV2PaymentsPost201ResponseWatchlistScreeningInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponseWatchlistScreeningInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 54

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

  if attributes.has_key?(:'infoCodes')
    if (value = attributes[:'infoCodes']).is_a?(Array)
      self.info_codes = value
    end
  end

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

Instance Attribute Details

#info_codesObject

Returned when the Denied Parties List check (first two codes) or the export service (all others) would have declined the transaction. This field can contain one or more of these values: - ‘MATCH-DPC`: Denied Parties List match. - `UNV-DPC`: Denied Parties List unavailable. - `MATCH-BCO`: Billing country restricted. - `MATCH-EMCO`: Email country restricted. - `MATCH-HCO`: Host name country restricted. - `MATCH-IPCO`: IP country restricted. - `MATCH-SCO`: Shipping country restricted.



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

def info_codes
  @info_codes
end

#ip_country_confidenceObject

Likelihood that the country associated with the customer’s IP address was identified correctly. Returns a value from 1–100, where 100 indicates the highest likelihood. If the country cannot be determined, the value is –1.



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

def ip_country_confidence
  @ip_country_confidence
end

#watch_listObject

Returns the value of attribute watch_list.



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

def watch_list
  @watch_list
end

Class Method Details

.attribute_mapObject

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



26
27
28
29
30
31
32
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 26

def self.attribute_map
  {
    :'ip_country_confidence' => :'ipCountryConfidence',
    :'info_codes' => :'infoCodes',
    :'watch_list' => :'watchList'
  }
end

.json_mapObject

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



35
36
37
38
39
40
41
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 35

def self.json_map
  {
    :'ip_country_confidence' => :'ip_country_confidence',
    :'info_codes' => :'info_codes',
    :'watch_list' => :'watch_list'
  }
end

.swagger_typesObject

Attribute type mapping.



44
45
46
47
48
49
50
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 44

def self.swagger_types
  {
    :'ip_country_confidence' => :'Integer',
    :'info_codes' => :'Array<String>',
    :'watch_list' => :'PtsV2PaymentsPost201ResponseWatchlistScreeningInformationWatchList'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



96
97
98
99
100
101
102
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 96

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ip_country_confidence == o.ip_country_confidence &&
      info_codes == o.info_codes &&
      watch_list == o.watch_list
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 140

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



206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 206

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 119

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


106
107
108
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 106

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



112
113
114
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 112

def hash
  [ip_country_confidence, info_codes, watch_list].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



77
78
79
80
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 77

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



186
187
188
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 186

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



192
193
194
195
196
197
198
199
200
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 192

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



180
181
182
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 180

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



84
85
86
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb', line 84

def valid?
  true
end