class Plaid::TransactionsGetResponse
TransactionsGetResponse
defines the response schema for ‘/transactions/get`
Attributes
An array containing the ‘accounts` associated with the Item
for which transactions are being returned. Each transaction can be mapped to its corresponding account via the `account_id` field.
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid
identifiers, is case sensitive.
The total number of transactions available within the date range specified. If ‘total_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter.
An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the ‘count` parameter.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/transactions_get_response.rb, line 45 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/transactions_get_response.rb, line 34 def self.attribute_map { :'accounts' => :'accounts', :'transactions' => :'transactions', :'total_transactions' => :'total_transactions', :'item' => :'item', :'request_id' => :'request_id' } 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/transactions_get_response.rb, line 171 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/transactions_get_response.rb, line 68 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionsGetResponse` 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::TransactionsGetResponse`. 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?(:'accounts') if (value = attributes[:'accounts']).is_a?(Array) self.accounts = value end end if attributes.key?(:'transactions') if (value = attributes[:'transactions']).is_a?(Array) self.transactions = value end end if attributes.key?(:'total_transactions') self.total_transactions = attributes[:'total_transactions'] end if attributes.key?(:'item') self.item = attributes[:'item'] end if attributes.key?(:'request_id') self.request_id = attributes[:'request_id'] end end
List of attributes with nullable: true
# File lib/plaid/models/transactions_get_response.rb, line 61 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/plaid/models/transactions_get_response.rb, line 50 def self.openapi_types { :'accounts' => :'Array<AccountBase>', :'transactions' => :'Array<Transaction>', :'total_transactions' => :'Integer', :'item' => :'Item', :'request_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/transactions_get_response.rb, line 146 def ==(o) return true if self.equal?(o) self.class == o.class && accounts == o.accounts && transactions == o.transactions && total_transactions == o.total_transactions && item == o.item && request_id == o.request_id 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/transactions_get_response.rb, line 202 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/transactions_get_response.rb, line 273 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/transactions_get_response.rb, line 178 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/transactions_get_response.rb, line 158 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/transactions_get_response.rb, line 164 def hash [accounts, transactions, total_transactions, item, request_id].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/transactions_get_response.rb, line 108 def list_invalid_properties invalid_properties = Array.new if @accounts.nil? invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') end if @transactions.nil? invalid_properties.push('invalid value for "transactions", transactions cannot be nil.') end if @total_transactions.nil? invalid_properties.push('invalid value for "total_transactions", total_transactions cannot be nil.') end if @item.nil? invalid_properties.push('invalid value for "item", item cannot be nil.') end if @request_id.nil? invalid_properties.push('invalid value for "request_id", request_id 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/transactions_get_response.rb, line 255 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/transactions_get_response.rb, line 243 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/transactions_get_response.rb, line 135 def valid? return false if @accounts.nil? return false if @transactions.nil? return false if @total_transactions.nil? return false if @item.nil? return false if @request_id.nil? true end