class

Plaid::BeaconReportCreateResponse

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, beacon_user_id : String | Nil = nil, created_at : Time | Nil = nil, _type : Plaid::BeaconReportType | Nil = nil, fraud_date : Time | Nil = nil, fraud_amount : FraudAmount | Nil = nil, audit_trail : BeaconAuditTrail | Nil = nil, request_id : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type
Source
_type=(new_value : Plaid::BeaconReportType | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
audit_trail
Source
audit_trail=(new_value : BeaconAuditTrail | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] audit_trail Object to be assigned

Source
beacon_user_id

ID of the associated Beacon User.

Source
beacon_user_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] beacon_user_id Object to be assigned

Source
created_at

An ISO8601 formatted timestamp.

Source
created_at=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created_at Object to be assigned

Source
fraud_amount
Source
fraud_amount=(new_value : FraudAmount | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fraud_amount Object to be assigned

Source
fraud_date

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

Source
fraud_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] fraud_date Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

ID of the associated Beacon Report.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
request_id

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Source
request_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_id Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source