Class: Plaid::WatchlistScreeningEntityListRequest

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

Overview

Request input for listing entity watchlist screenings

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WatchlistScreeningEntityListRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
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
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 101

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

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

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

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

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

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

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

Instance Attribute Details

#assignee ⇒ Object

ID of the associated user. To retrieve the email address or other details of the person corresponding to this id, use ‘/dashboard_user/get`.



34
35
36
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 34

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.



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

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



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

def client_user_id
  @client_user_id
end

#cursor ⇒ Object

An identifier that determines which page of results you receive.



37
38
39
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 37

def cursor
  @cursor
end

#entity_watchlist_program_id ⇒ Object

ID of the associated entity program.



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

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



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

def secret
  @secret
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 62

def self.attribute_map
  {
    :'secret' => :'secret',
    :'client_id' => :'client_id',
    :'entity_watchlist_program_id' => :'entity_watchlist_program_id',
    :'client_user_id' => :'client_user_id',
    :'status' => :'status',
    :'assignee' => :'assignee',
    :'cursor' => :'cursor'
  }
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



190
191
192
 
# File 'lib/plaid/models/watchlist_screening_entity_list_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



93
94
95
96
97
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 80

def self.openapi_types
  {
    :'secret' => :'String',
    :'client_id' => :'String',
    :'entity_watchlist_program_id' => :'String',
    :'client_user_id' => :'String',
    :'status' => :'WatchlistScreeningStatus',
    :'assignee' => :'String',
    :'cursor' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      secret == o.secret &&
      client_id == o.client_id &&
      entity_watchlist_program_id == o.entity_watchlist_program_id &&
      client_user_id == o.client_user_id &&
      status == o.status &&
      assignee == o.assignee &&
      cursor == o.cursor
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



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
258
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 221

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



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

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



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

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [secret, client_id, entity_watchlist_program_id, client_user_id, status, assignee, cursor].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



145
146
147
148
149
150
151
152
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @entity_watchlist_program_id.nil?
    invalid_properties.push('invalid value for "entity_watchlist_program_id", entity_watchlist_program_id 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



268
269
270
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 268

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



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

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



262
263
264
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 262

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



156
157
158
159
 
# File 'lib/plaid/models/watchlist_screening_entity_list_request.rb', line 156

def valid?
  return false if @entity_watchlist_program_id.nil?
  true
end