class Plaid::AssetReportCreateRequest
AssetReportCreateRequest
defines the request schema for ‘/asset_report/create`
Attributes
An array of access tokens corresponding to the Items that will be included in the report. The ‘assets` product must have been initialized for the Items during link; the Assets
product cannot be added after initialization.
Your Plaid
API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
The maximum integer number of days of history to include in the Asset
Report. If using Fannie Mae Day 1 Certainty, ‘days_requested` must be at least 61 for new originations or at least 31 for refinancings. An Asset
Report requested with "Additional History" (that is, with more than 61 days of transaction history) will incur an Additional History fee.
Your Plaid
API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
Public Class Methods
Source
# File lib/plaid/models/asset_report_create_request.rb, line 45 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.rb, line 34 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'access_tokens' => :'access_tokens', :'days_requested' => :'days_requested', :'options' => :'options' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/asset_report_create_request.rb, line 197 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.rb, line 68 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::AssetReportCreateRequest` 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::AssetReportCreateRequest`. 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_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'access_tokens') if (value = attributes[:'access_tokens']).is_a?(Array) self.access_tokens = value end end if attributes.key?(:'days_requested') self.days_requested = attributes[:'days_requested'] end if attributes.key?(:'options') self.options = attributes[:'options'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/asset_report_create_request.rb, line 61 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/asset_report_create_request.rb, line 50 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'access_tokens' => :'Array<String>', :'days_requested' => :'Integer', :'options' => :'AssetReportCreateRequestOptions' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/asset_report_create_request.rb, line 172 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && access_tokens == o.access_tokens && days_requested == o.days_requested && options == o.options end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_create_request.rb, line 228 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.rb, line 299 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.rb, line 142 def access_tokens=(access_tokens) if !access_tokens.nil? && access_tokens.length < 1 fail ArgumentError, 'invalid value for "access_tokens", number of items must be greater than or equal to 1.' end @access_tokens = access_tokens end
Custom attribute writer method with validation @param [Object] access_tokens
Value to be assigned
Source
# File lib/plaid/models/asset_report_create_request.rb, line 204 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.rb, line 153 def days_requested=(days_requested) if days_requested.nil? fail ArgumentError, 'days_requested cannot be nil' end if days_requested > 731 fail ArgumentError, 'invalid value for "days_requested", must be smaller than or equal to 731.' end if days_requested < 0 fail ArgumentError, 'invalid value for "days_requested", must be greater than or equal to 0.' end @days_requested = days_requested end
Custom attribute writer method with validation @param [Object] days_requested
Value to be assigned
Source
# File lib/plaid/models/asset_report_create_request.rb, line 184 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/asset_report_create_request.rb, line 190 def hash [client_id, secret, access_tokens, days_requested, options].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/asset_report_create_request.rb, line 106 def list_invalid_properties invalid_properties = Array.new if !@access_tokens.nil? && @access_tokens.length < 1 invalid_properties.push('invalid value for "access_tokens", number of items must be greater than or equal to 1.') end if @days_requested.nil? invalid_properties.push('invalid value for "days_requested", days_requested cannot be nil.') end if @days_requested > 731 invalid_properties.push('invalid value for "days_requested", must be smaller than or equal to 731.') end if @days_requested < 0 invalid_properties.push('invalid value for "days_requested", must be greater than or equal to 0.') 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/asset_report_create_request.rb, line 281 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.rb, line 269 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.rb, line 131 def valid? return false if !@access_tokens.nil? && @access_tokens.length > 99 return false if !@access_tokens.nil? && @access_tokens.length < 1 return false if @days_requested.nil? return false if @days_requested > 731 return false if @days_requested < 0 true end
Check to see if the all the properties in the model are valid @return true if the model is valid