class Plaid::ClientProvidedTransactionLocation
A representation of where a transaction took place. Use this field to pass in structured location information you may have about your transactions. Providing location data is optional but can increase result quality. If you have unstructured location information, it may be appended to the ‘description` field.
Attributes
The street address where the transaction occurred.
The city where the transaction occurred.
The country where the transaction occurred.
The postal code where the transaction occurred.
The region or state where the transaction occurred.
Public Class Methods
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 46 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 35 def self.attribute_map { :'country' => :'country', :'region' => :'region', :'city' => :'city', :'address' => :'address', :'postal_code' => :'postal_code' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 143 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/client_provided_transaction_location.rb, line 69 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ClientProvidedTransactionLocation` 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::ClientProvidedTransactionLocation`. 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?(:'country') self.country = attributes[:'country'] end if attributes.key?(:'region') self.region = attributes[:'region'] end if attributes.key?(:'city') self.city = attributes[:'city'] end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'postal_code') self.postal_code = attributes[:'postal_code'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 62 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 51 def self.openapi_types { :'country' => :'String', :'region' => :'String', :'city' => :'String', :'address' => :'String', :'postal_code' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 118 def ==(o) return true if self.equal?(o) self.class == o.class && country == o.country && region == o.region && city == o.city && address == o.address && postal_code == o.postal_code end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 174 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/client_provided_transaction_location.rb, line 245 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/client_provided_transaction_location.rb, line 150 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/client_provided_transaction_location.rb, line 130 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 136 def hash [country, region, city, address, postal_code].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/client_provided_transaction_location.rb, line 105 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/client_provided_transaction_location.rb, line 227 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/client_provided_transaction_location.rb, line 215 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/client_provided_transaction_location.rb, line 112 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid