Class: Plaid::BeaconReport

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

Overview

A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud incident. This information is used to block similar fraud attempts on your platform as well as alert other companies who screen a user with matching identity information. Other companies will not receive any new identity information, just what matched, plus information such as industry, type of fraud, and date of fraud. You can manage your fraud reports by adding, deleting, or editing reports as you get additional information on fraudulent users.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeaconReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
 
# File 'lib/plaid/models/beacon_report.rb', line 105

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

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

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

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

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

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

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



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

def audit_trail
  @audit_trail
end

#beacon_user_id ⇒ Object

ID of the associated Beacon User.



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

def beacon_user_id
  @beacon_user_id
end

#created_at ⇒ Object

An ISO8601 formatted timestamp.



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

def created_at
  @created_at
end

#event_date ⇒ Object

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



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

def event_date
  @event_date
end

#fraud_amount ⇒ Object

Returns the value of attribute fraud_amount.



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

def fraud_amount
  @fraud_amount
end

#fraud_date ⇒ Object

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



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

def fraud_date
  @fraud_date
end

#id ⇒ Object

ID of the associated Beacon Report.



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

def id
  @id
end

#type ⇒ Object

Returns the value of attribute type.



28
29
30
 
# File 'lib/plaid/models/beacon_report.rb', line 28

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/plaid/models/beacon_report.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'beacon_user_id' => :'beacon_user_id',
    :'created_at' => :'created_at',
    :'type' => :'type',
    :'fraud_date' => :'fraud_date',
    :'event_date' => :'event_date',
    :'fraud_amount' => :'fraud_amount',
    :'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



224
225
226
 
# File 'lib/plaid/models/beacon_report.rb', line 224

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'beacon_user_id' => :'String',
    :'created_at' => :'Time',
    :'type' => :'BeaconReportType',
    :'fraud_date' => :'Date',
    :'event_date' => :'Date',
    :'fraud_amount' => :'FraudAmount',
    :'audit_trail' => :'BeaconAuditTrail'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/plaid/models/beacon_report.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      beacon_user_id == o.beacon_user_id &&
      created_at == o.created_at &&
      type == o.type &&
      fraud_date == o.fraud_date &&
      event_date == o.event_date &&
      fraud_amount == o.fraud_amount &&
      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



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
288
289
290
291
292
 
# File 'lib/plaid/models/beacon_report.rb', line 255

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/plaid/models/beacon_report.rb', line 326

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/plaid/models/beacon_report.rb', line 231

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


211
212
213
 
# File 'lib/plaid/models/beacon_report.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/plaid/models/beacon_report.rb', line 217

def hash
  [id, beacon_user_id, created_at, type, fraud_date, event_date, fraud_amount, 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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/plaid/models/beacon_report.rb', line 153

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

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

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

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

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



302
303
304
 
# File 'lib/plaid/models/beacon_report.rb', line 302

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/plaid/models/beacon_report.rb', line 308

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



296
297
298
 
# File 'lib/plaid/models/beacon_report.rb', line 296

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



184
185
186
187
188
189
190
191
192
 
# File 'lib/plaid/models/beacon_report.rb', line 184

def valid?
  return false if @id.nil?
  return false if @beacon_user_id.nil?
  return false if @created_at.nil?
  return false if @type.nil?
  return false if @event_date.nil?
  return false if @audit_trail.nil?
  true
end