class Plaid::BeaconReportSyndication

Overview

A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you've created. The #analysis field in the response indicates which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to. The #report field in the response contains a subset of information from the original report.

Included Modules

Defined in:

plaid/models/beacon_report_syndication.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, report : BeaconReportSyndicationOriginalReport | Nil = nil, analysis : BeaconReportSyndicationAnalysis | 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 analysis : BeaconReportSyndicationAnalysis | Nil #

[View source]
def analysis=(new_value : BeaconReportSyndicationAnalysis | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] analysis 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 report : BeaconReportSyndicationOriginalReport | Nil #

[View source]
def report=(new_value : BeaconReportSyndicationOriginalReport | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] report 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]