class Plaid::BeaconReportCreateResponse

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.

Included Modules

Defined in:

plaid/models/beacon_report_create_response.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def _type : Plaid::BeaconReportType | Nil #

[View source]
def _type=(new_value : Plaid::BeaconReportType | Nil) #

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


[View source]
def audit_trail : BeaconAuditTrail | Nil #

[View source]
def audit_trail=(new_value : BeaconAuditTrail | Nil) #

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


[View source]
def beacon_user_id : String | Nil #

[View source]
def beacon_user_id=(new_value : String | Nil) #

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


[View source]
def created_at : Time | Nil #

[View source]
def created_at=(new_value : Time | Nil) #

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


[View source]
def fraud_amount : FraudAmount | Nil #

[View source]
def fraud_amount=(new_value : FraudAmount | Nil) #

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


[View source]
def fraud_date : Time | Nil #

[View source]
def fraud_date=(new_value : Time | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def request_id : String | Nil #

[View source]
def request_id=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]