class

Plaid::AssetReportCreateRequestOptions

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

An optional object to filter /asset_report/create results. If provided, must be non-null. The optional user object is required for the report to be eligible for Fannie Mae's Day 1 Certainty program.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_report_id : String | Nil = nil, webhook : String | Nil = nil, include_fast_report : Bool | Nil = nil, products : Array(String) | Nil = nil, add_ons : Array(AssetReportAddOns) | Nil = nil, user : AssetReportUser | 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

add_ons

Use this field to request a fast_asset report. When Fast Assets is requested, Plaid will create two versions of the Asset Report: first, the Fast Asset Report, which will contain only current identity and balance information, and later, the Full Asset Report, which will also contain historical balance information and transaction data. A PRODUCT_READY webhook will be fired for each Asset Report when it is ready, and the report_type field will indicate whether the webhook is firing for the full or fast Asset Report. To retrieve the Fast Asset Report, call /asset_report/get with fast_report set to true. There is no additional charge for using Fast Assets.

Source
add_ons=(new_value : Array(AssetReportAddOns) | Nil)

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

Source
client_report_id

Client-generated identifier, which can be used by lenders to track loan applications.

Source
client_report_id=(new_value : String | Nil)

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

Source
client_report_id_present=(client_report_id_present : Bool)
Source
client_report_id_present?
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

include_fast_report

true to return balance and identity earlier as a fast report. Defaults to false if omitted.

Source
include_fast_report=(new_value : Bool | Nil)

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

Source
include_fast_report_present=(include_fast_report_present : Bool)
Source
include_fast_report_present?
Source
list_invalid_properties

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

Source
products

Additional information that can be included in the asset report. Possible values: \"investments\"

Source
products=(new_value : Array(String) | Nil)

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

Source
user
Source
user=(new_value : AssetReportUser | Nil)

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

URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.

Source
webhook=(new_value : String | Nil)

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

Source
webhook_present=(webhook_present : Bool)
Source
webhook_present?
Source