Class: Plaid::BeaconUser

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

Overview

A Beacon User represents an end user that has been scanned against the Beacon Network.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeaconUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/plaid/models/beacon_user.rb', line 113

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

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

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

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

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

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

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

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

  if attributes.key?(:'user')
    self.user = attributes[:'user']
  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.



44
45
46
 
# File 'lib/plaid/models/beacon_user.rb', line 44

def audit_trail
  @audit_trail
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`.



40
41
42
 
# File 'lib/plaid/models/beacon_user.rb', line 40

def client_user_id
  @client_user_id
end

#created_at ⇒ Object

An ISO8601 formatted timestamp.



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

def created_at
  @created_at
end

#id ⇒ Object

ID of the associated Beacon User.



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

def id
  @id
end

#item_ids ⇒ Object

An array of Plaid Item IDs corresponding to the Accounts associated with this Beacon User.



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

def item_ids
  @item_ids
end

#program_id ⇒ Object

ID of the associated Beacon Program.



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

def program_id
  @program_id
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.



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

def updated_at
  @updated_at
end

#user ⇒ Object

Returns the value of attribute user.



42
43
44
 
# File 'lib/plaid/models/beacon_user.rb', line 42

def user
  @user
end

#version ⇒ Object

The ‘version` field begins with 1 and increments each time the user is updated.



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

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/plaid/models/beacon_user.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/plaid/models/beacon_user.rb', line 69

def self.attribute_map
  {
    :'item_ids' => :'item_ids',
    :'id' => :'id',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'status' => :'status',
    :'program_id' => :'program_id',
    :'client_user_id' => :'client_user_id',
    :'user' => :'user',
    :'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



276
277
278
 
# File 'lib/plaid/models/beacon_user.rb', line 276

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/plaid/models/beacon_user.rb', line 106

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/plaid/models/beacon_user.rb', line 90

def self.openapi_types
  {
    :'item_ids' => :'Array<String>',
    :'id' => :'String',
    :'version' => :'Integer',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'status' => :'BeaconUserStatus',
    :'program_id' => :'String',
    :'client_user_id' => :'String',
    :'user' => :'BeaconUserData',
    :'audit_trail' => :'BeaconAuditTrail'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/plaid/models/beacon_user.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_ids == o.item_ids &&
      id == o.id &&
      version == o.version &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      status == o.status &&
      program_id == o.program_id &&
      client_user_id == o.client_user_id &&
      user == o.user &&
      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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/plaid/models/beacon_user.rb', line 307

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/plaid/models/beacon_user.rb', line 378

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/plaid/models/beacon_user.rb', line 283

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


263
264
265
 
# File 'lib/plaid/models/beacon_user.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



269
270
271
 
# File 'lib/plaid/models/beacon_user.rb', line 269

def hash
  [item_ids, id, version, created_at, updated_at, status, program_id, client_user_id, user, 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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/plaid/models/beacon_user.rb', line 171

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


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

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

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

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

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

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

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

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



354
355
356
 
# File 'lib/plaid/models/beacon_user.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/plaid/models/beacon_user.rb', line 360

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



348
349
350
 
# File 'lib/plaid/models/beacon_user.rb', line 348

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/plaid/models/beacon_user.rb', line 219

def valid?
  return false if @item_ids.nil?
  return false if @id.nil?
  return false if @version.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @status.nil?
  return false if @program_id.nil?
  return false if @client_user_id.nil?
  return false if @user.nil?
  return false if @audit_trail.nil?
  true
end