class Plaid::AssetReportCreateRequestOptions
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.
Attributes
A list of add-ons that should be included in the Asset
Report. When Fast Assets
is requested, Plaid
will create two versions of the Asset
Report: the Fast Asset
Report, which will contain only Identity and Balance information, and the Full Asset
Report, which will also contain Transactions information. 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
. To create a Fast Asset
Report, Plaid
must successfully retrieve both Identity and Balance data; if Plaid
encounters an error obtaining this data, the Fast Asset
Report will not be created. However, as long as Plaid
can obtain Transactions data, the Full Asset
Report will still be available. When Investments is requested, `investments` must be specified in the `optional_products` array when initializing Link.
Client-generated identifier, which can be used by lenders to track loan applications.
true to return balance and identity earlier as a fast report. Defaults to false if omitted.
Additional information that can be included in the asset report. Possible values: ‘"investments"`
If set to false, only 1 item must be healthy at the time of report creation. The default value is true, which would require all items to be healthy at the time of report creation.
Public Class Methods
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 53 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 40 def self.attribute_map { :'client_report_id' => :'client_report_id', :'webhook' => :'webhook', :'include_fast_report' => :'include_fast_report', :'products' => :'products', :'add_ons' => :'add_ons', :'user' => :'user', :'require_all_items' => :'require_all_items' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 172 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/asset_report_create_request_options.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportCreateRequestOptions` 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::AssetReportCreateRequestOptions`. 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?(:'client_report_id') self.client_report_id = attributes[:'client_report_id'] end if attributes.key?(:'webhook') self.webhook = attributes[:'webhook'] end if attributes.key?(:'include_fast_report') self.include_fast_report = attributes[:'include_fast_report'] end if attributes.key?(:'products') if (value = attributes[:'products']).is_a?(Array) self.products = value end end if attributes.key?(:'add_ons') if (value = attributes[:'add_ons']).is_a?(Array) self.add_ons = value end end if attributes.key?(:'user') self.user = attributes[:'user'] end if attributes.key?(:'require_all_items') self.require_all_items = attributes[:'require_all_items'] else self.require_all_items = true end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 71 def self.openapi_nullable Set.new([ :'client_report_id', :'webhook', :'include_fast_report', :'require_all_items' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 58 def self.openapi_types { :'client_report_id' => :'String', :'webhook' => :'String', :'include_fast_report' => :'Boolean', :'products' => :'Array<String>', :'add_ons' => :'Array<AssetReportAddOns>', :'user' => :'AssetReportUser', :'require_all_items' => :'Boolean' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 145 def ==(o) return true if self.equal?(o) self.class == o.class && client_report_id == o.client_report_id && webhook == o.webhook && include_fast_report == o.include_fast_report && products == o.products && add_ons == o.add_ons && user == o.user && require_all_items == o.require_all_items end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 203 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/asset_report_create_request_options.rb, line 274 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/asset_report_create_request_options.rb, line 179 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/asset_report_create_request_options.rb, line 159 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 165 def hash [client_report_id, webhook, include_fast_report, products, add_ons, user, require_all_items].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/asset_report_create_request_options.rb, line 132 def list_invalid_properties invalid_properties = Array.new 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/asset_report_create_request_options.rb, line 256 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/asset_report_create_request_options.rb, line 244 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/asset_report_create_request_options.rb, line 139 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid