Class: Plaid::WatchlistScreeningIndividualReviewCreateRequest

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

Overview

Request input for creating a screening review

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatchlistScreeningIndividualReviewCreateRequest

Initializes the object



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
107
108
109
110
111
112
113
114
115
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 75

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::WatchlistScreeningIndividualReviewCreateRequest` 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::WatchlistScreeningIndividualReviewCreateRequest`. 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?(:'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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

Instance Attribute Details

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



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

def client_id
  @client_id
end

#comment ⇒ Object

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



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

def comment
  @comment
end

#confirmed_hits ⇒ Object

Hits to mark 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.



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

def confirmed_hits
  @confirmed_hits
end

#dismissed_hits ⇒ Object

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



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

def dismissed_hits
  @dismissed_hits
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



32
33
34
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 32

def secret
  @secret
end

#watchlist_screening_id ⇒ Object

ID of the associated screening.



35
36
37
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 35

def watchlist_screening_id
  @watchlist_screening_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 38

def self.attribute_map
  {
    :'confirmed_hits' => :'confirmed_hits',
    :'dismissed_hits' => :'dismissed_hits',
    :'comment' => :'comment',
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'watchlist_screening_id' => :'watchlist_screening_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



190
191
192
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 190

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
71
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 55

def self.openapi_types
  {
    :'confirmed_hits' => :'Array<String>',
    :'dismissed_hits' => :'Array<String>',
    :'comment' => :'String',
    :'client_id' => :'String',
    :'secret' => :'String',
    :'watchlist_screening_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      confirmed_hits == o.confirmed_hits &&
      dismissed_hits == o.dismissed_hits &&
      comment == o.comment &&
      client_id == o.client_id &&
      secret == o.secret &&
      watchlist_screening_id == o.watchlist_screening_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
252
253
254
255
256
257
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 220

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 291

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 197

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

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



183
184
185
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 183

def hash
  [confirmed_hits, dismissed_hits, comment, client_id, secret, watchlist_screening_id].hash
end

#list_invalid_properties ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 119

def list_invalid_properties
  invalid_properties = Array.new
  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.nil? && @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 @watchlist_screening_id.nil?
    invalid_properties.push('invalid value for "watchlist_screening_id", watchlist_screening_id cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



267
268
269
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 273

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



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

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



143
144
145
146
147
148
149
 
# File 'lib/plaid/models/watchlist_screening_individual_review_create_request.rb', line 143

def valid?
  return false if @confirmed_hits.nil?
  return false if @dismissed_hits.nil?
  return false if !@comment.nil? && @comment.to_s.length < 1
  return false if @watchlist_screening_id.nil?
  true
end