class Plaid::BeaconReportGetResponse
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.
Attributes
ID of the associated Beacon User.
An ISO8601 formatted timestamp.
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
ID of the associated Beacon Report.
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid
identifiers, is case sensitive.
Public Class Methods
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 81 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 66 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', :'request_id' => :'request_id' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 239 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BeaconReportGetResponse` 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::BeaconReportGetResponse`. 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 if attributes.key?(:'request_id') self.request_id = attributes[:'request_id'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 101 def self.openapi_nullable Set.new([ :'fraud_date', :'fraud_amount', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 86 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', :'request_id' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 210 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 && request_id == o.request_id end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 270 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 341 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 246 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 226 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 232 def hash [id, beacon_user_id, created_at, type, fraud_date, event_date, fraud_amount, audit_trail, request_id].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 162 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 if @request_id.nil? invalid_properties.push('invalid value for "request_id", request_id cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 323 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 311 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/beacon_report_get_response.rb, line 197 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? return false if @request_id.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid