Class: Plaid::BeaconUserRequestData

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

Overview

A Beacon User’s data which is used to check against duplicate records and the Beacon Fraud Network. In order to create a Beacon User, in addition to the ‘name`, either the `date_of_birth` or the `depository_accounts` field must be provided.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeaconUserRequestData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 85

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



24
25
26
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 24

def address
  @address
end

#date_of_birth ⇒ Object

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).



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

def date_of_birth
  @date_of_birth
end

#depository_accounts ⇒ Object

Provide a list of bank accounts that are associated with this Beacon User. These accounts will be scanned across the Beacon Network and used to find duplicate records. Note: These accounts will not have Bank Account Insights. To receive Bank Account Insights please supply ‘access_tokens`.



38
39
40
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 38

def depository_accounts
  @depository_accounts
end

#email_address ⇒ Object

A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see [RFC 3696](datatracker.ietf.org/doc/html/rfc3696).



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

def email_address
  @email_address
end

#id_number ⇒ Object

Returns the value of attribute id_number.



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

def id_number
  @id_number
end

#ip_address ⇒ Object

An IPv4 or IPV6 address.



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

def ip_address
  @ip_address
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#phone_number ⇒ Object

A phone number in E.164 format.



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

def phone_number
  @phone_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 55

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 41

def self.attribute_map
  {
    :'date_of_birth' => :'date_of_birth',
    :'name' => :'name',
    :'address' => :'address',
    :'email_address' => :'email_address',
    :'phone_number' => :'phone_number',
    :'id_number' => :'id_number',
    :'ip_address' => :'ip_address',
    :'depository_accounts' => :'depository_accounts'
  }
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



181
182
183
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
78
79
80
81
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 74

def self.openapi_nullable
  Set.new([
    :'address',
    :'phone_number',
    :'id_number',
    :'ip_address',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'date_of_birth' => :'Date',
    :'name' => :'BeaconUserName',
    :'address' => :'BeaconUserRequestAddress',
    :'email_address' => :'String',
    :'phone_number' => :'String',
    :'id_number' => :'BeaconUserIDNumber',
    :'ip_address' => :'String',
    :'depository_accounts' => :'Array<BeaconUserRequestDepositoryAccount>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_of_birth == o.date_of_birth &&
      name == o.name &&
      address == o.address &&
      email_address == o.email_address &&
      phone_number == o.phone_number &&
      id_number == o.id_number &&
      ip_address == o.ip_address &&
      depository_accounts == o.depository_accounts
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



212
213
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
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 212

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 283

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 188

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


168
169
170
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 174

def hash
  [date_of_birth, name, address, email_address, phone_number, id_number, ip_address, depository_accounts].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



135
136
137
138
139
140
141
142
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 135

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



259
260
261
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 259

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



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 265

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



253
254
255
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 253

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



146
147
148
149
 
# File 'lib/plaid/models/beacon_user_request_data.rb', line 146

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