class Plaid::CraVoeReportAccount
VOE Report information about an account.
Attributes
Plaid’s unique identifier for the account. This value will not change unless Plaid
can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new ‘account_id` will be assigned to the account. If an account with a specific `account_id` disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid
API. Like all Plaid
identifiers, the `account_id` is case sensitive.
The name of the account, either assigned by the user or by the financial institution itself.
The official name of the account as given by the financial institution.
Transaction
history associated with the account for the VOE Report. Note that this transaction differs from a Base Report transaction in that it will only be deposits, and the amounts will be omitted.
Public Class Methods
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 70 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 58 def self.attribute_map { :'account_id' => :'account_id', :'name' => :'name', :'official_name' => :'official_name', :'type' => :'type', :'subtype' => :'subtype', :'transactions' => :'transactions' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/cra_voe_report_account.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/cra_voe_report_account.rb, line 96 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraVoeReportAccount` 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::CraVoeReportAccount`. 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?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'official_name') self.official_name = attributes[:'official_name'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'subtype') self.subtype = attributes[:'subtype'] end if attributes.key?(:'transactions') if (value = attributes[:'transactions']).is_a?(Array) self.transactions = value end end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 87 def self.openapi_nullable Set.new([ :'official_name', :'subtype', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 75 def self.openapi_types { :'account_id' => :'String', :'name' => :'String', :'official_name' => :'String', :'type' => :'AccountType', :'subtype' => :'AccountSubtype', :'transactions' => :'Array<CraVoeReportTransaction>' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 171 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && name == o.name && official_name == o.official_name && type == o.type && subtype == o.subtype && transactions == o.transactions end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_voe_report_account.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/cra_voe_report_account.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/cra_voe_report_account.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/cra_voe_report_account.rb, line 184 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 190 def hash [account_id, name, official_name, type, subtype, transactions].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/cra_voe_report_account.rb, line 138 def list_invalid_properties invalid_properties = Array.new if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @transactions.nil? invalid_properties.push('invalid value for "transactions", transactions 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/cra_voe_report_account.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/cra_voe_report_account.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/cra_voe_report_account.rb, line 161 def valid? return false if @account_id.nil? return false if @name.nil? return false if @type.nil? return false if @transactions.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid