Class: Plaid::WatchlistScreeningReview

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/watchlist_screening_review.rb

Overview

A review submitted by a team member for an individual watchlist screening. A review can be either a comment on the current screening state, actions taken against hits attached to the watchlist screening, or both.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatchlistScreeningReview

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
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::WatchlistScreeningReview` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::WatchlistScreeningReview`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'confirmed_hits')
    if (value = attributes[:'confirmed_hits']).is_a?(Array)
      self.confirmed_hits = value
    end
  end

  if attributes.key?(:'dismissed_hits')
    if (value = attributes[:'dismissed_hits']).is_a?(Array)
      self.dismissed_hits = value
    end
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.key?(:'audit_trail')
    self.audit_trail = attributes[:'audit_trail']
  end
end

Instance Attribute Details

#audit_trail ⇒ Object

Returns the value of attribute audit_trail.



31
32
33
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 31

def audit_trail
  @audit_trail
end

#comment ⇒ Object

A comment submitted by a team member as part of reviewing a watchlist screening.



29
30
31
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 29

def comment
  @comment
end

#confirmed_hits ⇒ Object

Hits marked as a true positive after thorough manual review. These hits will never recur or be updated once dismissed. In most cases, confirmed hits indicate that the customer should be rejected.



23
24
25
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 23

def confirmed_hits
  @confirmed_hits
end

#dismissed_hits ⇒ Object

Hits marked as a false positive after thorough manual review. These hits will never recur or be updated once dismissed.



26
27
28
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 26

def dismissed_hits
  @dismissed_hits
end

#id ⇒ Object

ID of the associated review.



20
21
22
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 20

def id
  @id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 34

def self.attribute_map
  {
    :'id' => :'id',
    :'confirmed_hits' => :'confirmed_hits',
    :'dismissed_hits' => :'dismissed_hits',
    :'comment' => :'comment',
    :'audit_trail' => :'audit_trail'
  }
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



184
185
186
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 184

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
65
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 61

def self.openapi_nullable
  Set.new([
    :'comment',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 50

def self.openapi_types
  {
    :'id' => :'String',
    :'confirmed_hits' => :'Array<String>',
    :'dismissed_hits' => :'Array<String>',
    :'comment' => :'String',
    :'audit_trail' => :'WatchlistScreeningAuditTrail'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      confirmed_hits == o.confirmed_hits &&
      dismissed_hits == o.dismissed_hits &&
      comment == o.comment &&
      audit_trail == o.audit_trail
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 214

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 285

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 191

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 177

def hash
  [id, confirmed_hits, dismissed_hits, comment, audit_trail].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



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
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @confirmed_hits.nil?
    invalid_properties.push('invalid value for "confirmed_hits", confirmed_hits cannot be nil.')
  end

  if @dismissed_hits.nil?
    invalid_properties.push('invalid value for "dismissed_hits", dismissed_hits cannot be nil.')
  end

  if @comment.to_s.length < 1
    invalid_properties.push('invalid value for "comment", the character length must be great than or equal to 1.')
  end


  if @audit_trail.nil?
    invalid_properties.push('invalid value for "audit_trail", audit_trail cannot be nil.')
  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



261
262
263
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 261

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 267

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



255
256
257
 
# File 'lib/plaid/models/watchlist_screening_review.rb', line 255

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/plaid/models/watchlist_screening_review.rb', line 137

def valid?
  return false if @id.nil?
  return false if @confirmed_hits.nil?
  return false if @dismissed_hits.nil?
  return false if @comment.to_s.length < 1
  return false if @audit_trail.nil?
  true
end