Class: CyberSource::Ptsv2paymentsWatchlistScreeningInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsWatchlistScreeningInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 59

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

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

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

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

Instance Attribute Details

#address_operatorObject

Parts of the customer’s information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customer’s name or company and the customer’s address must appear in the database. - OR: The customer’s name must appear in the database. - IGNORE: You want the service to detect a match only of the customer’s name or company but not of the address.


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

def address_operator
  @address_operator
end

#proceed_on_matchObject

Indicates whether the transaction should proceed if there is a match. Possible values: - ‘true`: Transaction proceeds even when match is found in the Denied Parties List. The match is noted in the response. - `false`: Normal watchlist screening behavior occurs. (Transaction stops if a match to DPL occurs. Transaction proceeds if no match.)


25
26
27
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 25

def proceed_on_match
  @proceed_on_match
end

#sanction_listsObject

Use this field to specify which list(s) you want checked with the request. The reply will include the list name as well as the response data. To check against multiple lists, enter multiple list codes separated by a caret (^). For more information, see "Restricted and Denied Parties List," page 68.


22
23
24
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 22

def sanction_lists
  @sanction_lists
end

#weightsObject

Returns the value of attribute weights.


19
20
21
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 19

def weights
  @weights
end

Class Method Details

.attribute_mapObject

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

[View source]

28
29
30
31
32
33
34
35
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 28

def self.attribute_map
  {
    :'address_operator' => :'addressOperator',
    :'weights' => :'weights',
    :'sanction_lists' => :'sanctionLists',
    :'proceed_on_match' => :'proceedOnMatch'
  }
end

.json_mapObject

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

[View source]

38
39
40
41
42
43
44
45
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 38

def self.json_map
  {
    :'address_operator' => :'address_operator',
    :'weights' => :'weights',
    :'sanction_lists' => :'sanction_lists',
    :'proceed_on_match' => :'proceed_on_match'
  }
end

.swagger_typesObject

Attribute type mapping.

[View source]

48
49
50
51
52
53
54
55
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 48

def self.swagger_types
  {
    :'address_operator' => :'String',
    :'weights' => :'Ptsv2paymentsWatchlistScreeningInformationWeights',
    :'sanction_lists' => :'Array<String>',
    :'proceed_on_match' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared

[View source]

99
100
101
102
103
104
105
106
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 99

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_operator == o.address_operator &&
      weights == o.weights &&
      sanction_lists == o.sanction_lists &&
      proceed_on_match == o.proceed_on_match
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

[View source]

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
177
178
179
180
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 144

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

[View source]

210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 210

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

[View source]

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 123

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
[View source]

110
111
112
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 110

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code

[View source]

116
117
118
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 116

def hash
  [address_operator, weights, sanction_lists, proceed_on_match].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons

[View source]

86
87
88
89
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 86

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

[View source]

190
191
192
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 190

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

[View source]

196
197
198
199
200
201
202
203
204
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 196

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

[View source]

184
185
186
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 184

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

[View source]

93
94
95
# File 'lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb', line 93

def valid?
  true
end