class Plaid::ClientProvidedTransaction
A client-provided transaction for Plaid
to enrich.
Attributes
The account subtype associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](plaid.com/docs/api/accounts#account-type-schema).
The account type associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](plaid.com/docs/api/accounts#account-type-schema).
The absolute value of the transaction (>= 0). When testing Enrich, note that ‘amount` data should be realistic. Unrealistic or inaccurate `amount` data may result in reduced quality output.
A unique account id used to group transactions for a given account, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_account_id.
A unique user id used to group transactions for a given user, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
The date the transaction posted, in [ISO 8601](wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.
The raw description of the transaction. If you have location data in available an unstructured format, it may be appended to the ‘description` field.
A unique ID for the transaction used to help you tie data back to your systems.
The ISO-4217 currency code of the transaction e.g. USD.
Merchant category codes (MCCs) are four-digit numbers that describe a merchant’s primary business activities.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/client_provided_transaction.rb, line 94 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/client_provided_transaction.rb, line 76 def self.attribute_map { :'id' => :'id', :'client_user_id' => :'client_user_id', :'client_account_id' => :'client_account_id', :'account_type' => :'account_type', :'account_subtype' => :'account_subtype', :'description' => :'description', :'amount' => :'amount', :'direction' => :'direction', :'iso_currency_code' => :'iso_currency_code', :'location' => :'location', :'mcc' => :'mcc', :'date_posted' => :'date_posted' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/client_provided_transaction.rb, line 258 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/client_provided_transaction.rb, line 124 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ClientProvidedTransaction` 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::ClientProvidedTransaction`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'client_user_id') self.client_user_id = attributes[:'client_user_id'] end if attributes.key?(:'client_account_id') self.client_account_id = attributes[:'client_account_id'] end if attributes.key?(:'account_type') self.account_type = attributes[:'account_type'] end if attributes.key?(:'account_subtype') self.account_subtype = attributes[:'account_subtype'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'direction') self.direction = attributes[:'direction'] end if attributes.key?(:'iso_currency_code') self.iso_currency_code = attributes[:'iso_currency_code'] end if attributes.key?(:'location') self.location = attributes[:'location'] end if attributes.key?(:'mcc') self.mcc = attributes[:'mcc'] end if attributes.key?(:'date_posted') self.date_posted = attributes[:'date_posted'] end end
List of attributes with nullable: true
# File lib/plaid/models/client_provided_transaction.rb, line 117 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/plaid/models/client_provided_transaction.rb, line 99 def self.openapi_types { :'id' => :'String', :'client_user_id' => :'String', :'client_account_id' => :'String', :'account_type' => :'String', :'account_subtype' => :'String', :'description' => :'String', :'amount' => :'Float', :'direction' => :'EnrichTransactionDirection', :'iso_currency_code' => :'String', :'location' => :'ClientProvidedTransactionLocation', :'mcc' => :'String', :'date_posted' => :'Date' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/client_provided_transaction.rb, line 226 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && client_user_id == o.client_user_id && client_account_id == o.client_account_id && account_type == o.account_type && account_subtype == o.account_subtype && description == o.description && amount == o.amount && direction == o.direction && iso_currency_code == o.iso_currency_code && location == o.location && mcc == o.mcc && date_posted == o.date_posted end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/client_provided_transaction.rb, line 289 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
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
# File lib/plaid/models/client_provided_transaction.rb, line 360 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/client_provided_transaction.rb, line 265 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/client_provided_transaction.rb, line 245 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/client_provided_transaction.rb, line 251 def hash [id, client_user_id, client_account_id, account_type, account_subtype, description, amount, direction, iso_currency_code, location, mcc, date_posted].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/client_provided_transaction.rb, line 188 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @direction.nil? invalid_properties.push('invalid value for "direction", direction cannot be nil.') end if @iso_currency_code.nil? invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/client_provided_transaction.rb, line 342 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 string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/client_provided_transaction.rb, line 330 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/client_provided_transaction.rb, line 215 def valid? return false if @id.nil? return false if @description.nil? return false if @amount.nil? return false if @direction.nil? return false if @iso_currency_code.nil? true end