class Plaid::Enrichments
A grouping of the Plaid
produced transaction enrichment fields.
Attributes
The check number of the transaction. This field is only populated for check transactions.
The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid
from the raw description.
A unique, stable, Plaid-generated ID that maps to the primary counterparty.
A hierarchical array of the legacy categories to which this transaction belongs. For a full list of legacy categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). We recommend using the `personal_finance_category` for transaction categorization to obtain the best results.
The ID of the legacy category to which this transaction belongs. For a full list of legacy categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). We recommend using the `personal_finance_category` for transaction categorization to obtain the best results.
The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.
The name of the primary counterparty, such as the merchant or the financial institution, as extracted by Plaid
from the raw description.
The URL of an icon associated with the primary personal finance category. The icon will always be 100×100 pixel PNG file.
The phone number associated with the counterparty in E. 164 format. If there is a location match (i.e. a street address is returned in the location object), the phone number will be location specific.
The website associated with this transaction.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/enrichments.rb, line 100 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/enrichments.rb, line 80 def self.attribute_map { :'check_number' => :'check_number', :'counterparties' => :'counterparties', :'entity_id' => :'entity_id', :'legacy_category_id' => :'legacy_category_id', :'legacy_category' => :'legacy_category', :'location' => :'location', :'logo_url' => :'logo_url', :'merchant_name' => :'merchant_name', :'payment_channel' => :'payment_channel', :'phone_number' => :'phone_number', :'personal_finance_category' => :'personal_finance_category', :'personal_finance_category_icon_url' => :'personal_finance_category_icon_url', :'recurrence' => :'recurrence', :'website' => :'website' } 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/enrichments.rb, line 284 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/enrichments.rb, line 141 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Enrichments` 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::Enrichments`. 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?(:'check_number') self.check_number = attributes[:'check_number'] end if attributes.key?(:'counterparties') if (value = attributes[:'counterparties']).is_a?(Array) self.counterparties = value end end if attributes.key?(:'entity_id') self.entity_id = attributes[:'entity_id'] end if attributes.key?(:'legacy_category_id') self.legacy_category_id = attributes[:'legacy_category_id'] end if attributes.key?(:'legacy_category') if (value = attributes[:'legacy_category']).is_a?(Array) self.legacy_category = value end end if attributes.key?(:'location') self.location = attributes[:'location'] end if attributes.key?(:'logo_url') self.logo_url = attributes[:'logo_url'] end if attributes.key?(:'merchant_name') self.merchant_name = attributes[:'merchant_name'] end if attributes.key?(:'payment_channel') self.payment_channel = attributes[:'payment_channel'] end if attributes.key?(:'phone_number') self.phone_number = attributes[:'phone_number'] end if attributes.key?(:'personal_finance_category') self.personal_finance_category = attributes[:'personal_finance_category'] end if attributes.key?(:'personal_finance_category_icon_url') self.personal_finance_category_icon_url = attributes[:'personal_finance_category_icon_url'] end if attributes.key?(:'recurrence') self.recurrence = attributes[:'recurrence'] end if attributes.key?(:'website') self.website = attributes[:'website'] end end
List of attributes with nullable: true
# File lib/plaid/models/enrichments.rb, line 125 def self.openapi_nullable Set.new([ :'check_number', :'entity_id', :'legacy_category_id', :'logo_url', :'merchant_name', :'phone_number', :'personal_finance_category', :'recurrence', :'website' ]) end
Attribute type mapping.
# File lib/plaid/models/enrichments.rb, line 105 def self.openapi_types { :'check_number' => :'String', :'counterparties' => :'Array<Counterparty>', :'entity_id' => :'String', :'legacy_category_id' => :'String', :'legacy_category' => :'Array<String>', :'location' => :'Location', :'logo_url' => :'String', :'merchant_name' => :'String', :'payment_channel' => :'PaymentChannel', :'phone_number' => :'String', :'personal_finance_category' => :'PersonalFinanceCategory', :'personal_finance_category_icon_url' => :'String', :'recurrence' => :'Recurrence', :'website' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/enrichments.rb, line 250 def ==(o) return true if self.equal?(o) self.class == o.class && check_number == o.check_number && counterparties == o.counterparties && entity_id == o.entity_id && legacy_category_id == o.legacy_category_id && legacy_category == o.legacy_category && location == o.location && logo_url == o.logo_url && merchant_name == o.merchant_name && payment_channel == o.payment_channel && phone_number == o.phone_number && personal_finance_category == o.personal_finance_category && personal_finance_category_icon_url == o.personal_finance_category_icon_url && recurrence == o.recurrence && website == o.website 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/enrichments.rb, line 315 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/enrichments.rb, line 386 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/enrichments.rb, line 291 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/enrichments.rb, line 271 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/enrichments.rb, line 277 def hash [check_number, counterparties, entity_id, legacy_category_id, legacy_category, location, logo_url, merchant_name, payment_channel, phone_number, personal_finance_category, personal_finance_category_icon_url, recurrence, website].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/enrichments.rb, line 217 def list_invalid_properties invalid_properties = Array.new if @counterparties.nil? invalid_properties.push('invalid value for "counterparties", counterparties cannot be nil.') end if @location.nil? invalid_properties.push('invalid value for "location", location cannot be nil.') end if @payment_channel.nil? invalid_properties.push('invalid value for "payment_channel", payment_channel cannot be nil.') end if @personal_finance_category_icon_url.nil? invalid_properties.push('invalid value for "personal_finance_category_icon_url", personal_finance_category_icon_url 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/enrichments.rb, line 368 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/enrichments.rb, line 356 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/enrichments.rb, line 240 def valid? return false if @counterparties.nil? return false if @location.nil? return false if @payment_channel.nil? return false if @personal_finance_category_icon_url.nil? true end