Class: Plaid::WatchlistScreeningEntityUpdateRequest

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

Overview

Request input for editing an entity watchlist screening

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatchlistScreeningEntityUpdateRequest

Initializes the object



106
107
108
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 106

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

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

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

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

  if attributes.key?(:'client_user_id')
    self.client_user_id = attributes[:'client_user_id']
  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?(:'reset_fields')
    if (value = attributes[:'reset_fields']).is_a?(Array)
      self.reset_fields = value
    end
  end
end

Instance Attribute Details

#assignee ⇒ Object

ID of the associated user.



25
26
27
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 25

def assignee
  @assignee
end

#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.



33
34
35
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 33

def client_id
  @client_id
end

#client_user_id ⇒ Object

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.



30
31
32
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 30

def client_user_id
  @client_user_id
end

#entity_watchlist_screening_id ⇒ Object

ID of the associated entity screening.



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

def entity_watchlist_screening_id
  @entity_watchlist_screening_id
end

#reset_fields ⇒ Object

A list of fields to reset back to null



39
40
41
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 39

def reset_fields
  @reset_fields
end

#search_terms ⇒ Object

Returns the value of attribute search_terms.



22
23
24
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 22

def search_terms
  @search_terms
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.



36
37
38
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 36

def secret
  @secret
end

#status ⇒ Object

Returns the value of attribute status.



27
28
29
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 27

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 64

def self.attribute_map
  {
    :'entity_watchlist_screening_id' => :'entity_watchlist_screening_id',
    :'search_terms' => :'search_terms',
    :'assignee' => :'assignee',
    :'status' => :'status',
    :'client_user_id' => :'client_user_id',
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'reset_fields' => :'reset_fields'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



219
220
221
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 219

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



97
98
99
100
101
102
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 97

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 83

def self.openapi_types
  {
    :'entity_watchlist_screening_id' => :'String',
    :'search_terms' => :'UpdateEntityScreeningRequestSearchTerms',
    :'assignee' => :'String',
    :'status' => :'WatchlistScreeningStatus',
    :'client_user_id' => :'String',
    :'client_id' => :'String',
    :'secret' => :'String',
    :'reset_fields' => :'Array<WatchlistScreeningEntityUpdateRequestResettableField>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entity_watchlist_screening_id == o.entity_watchlist_screening_id &&
      search_terms == o.search_terms &&
      assignee == o.assignee &&
      status == o.status &&
      client_user_id == o.client_user_id &&
      client_id == o.client_id &&
      secret == o.secret &&
      reset_fields == o.reset_fields
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
284
285
286
287
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 250

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 321

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


206
207
208
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



212
213
214
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 212

def hash
  [entity_watchlist_screening_id, search_terms, assignee, status, client_user_id, client_id, secret, reset_fields].hash
end

#list_invalid_properties ⇒ Object

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



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 156

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

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


  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



297
298
299
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 297

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 303

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



291
292
293
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 291

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



172
173
174
175
176
 
# File 'lib/plaid/models/watchlist_screening_entity_update_request.rb', line 172

def valid?
  return false if @entity_watchlist_screening_id.nil?
  return false if !@client_user_id.nil? && @client_user_id.to_s.length < 1
  true
end