class Plaid::BankTransferEvent
Represents an event in the Bank Transfers API.
Attributes
The account ID associated with the bank transfer.
The bank transfer amount.
Plaid’s unique identifier for a bank transfer.
The currency of the bank transfer amount.
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
The ID of the origination account that this balance belongs to.
The datetime when this event occurred. This will be of the form ‘2006-01-02T15:04:05Z`.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/bank_transfer_event.rb, line 88 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/bank_transfer_event.rb, line 71 def self.attribute_map { :'event_id' => :'event_id', :'timestamp' => :'timestamp', :'event_type' => :'event_type', :'account_id' => :'account_id', :'bank_transfer_id' => :'bank_transfer_id', :'origination_account_id' => :'origination_account_id', :'bank_transfer_type' => :'bank_transfer_type', :'bank_transfer_amount' => :'bank_transfer_amount', :'bank_transfer_iso_currency_code' => :'bank_transfer_iso_currency_code', :'failure_reason' => :'failure_reason', :'direction' => :'direction' } 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/bank_transfer_event.rb, line 285 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/bank_transfer_event.rb, line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BankTransferEvent` 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::BankTransferEvent`. 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?(:'event_id') self.event_id = attributes[:'event_id'] end if attributes.key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.key?(:'event_type') self.event_type = attributes[:'event_type'] end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'bank_transfer_id') self.bank_transfer_id = attributes[:'bank_transfer_id'] end if attributes.key?(:'origination_account_id') self.origination_account_id = attributes[:'origination_account_id'] end if attributes.key?(:'bank_transfer_type') self.bank_transfer_type = attributes[:'bank_transfer_type'] end if attributes.key?(:'bank_transfer_amount') self.bank_transfer_amount = attributes[:'bank_transfer_amount'] end if attributes.key?(:'bank_transfer_iso_currency_code') self.bank_transfer_iso_currency_code = attributes[:'bank_transfer_iso_currency_code'] end if attributes.key?(:'failure_reason') self.failure_reason = attributes[:'failure_reason'] end if attributes.key?(:'direction') self.direction = attributes[:'direction'] end end
List of attributes with nullable: true
# File lib/plaid/models/bank_transfer_event.rb, line 110 def self.openapi_nullable Set.new([ :'origination_account_id', :'failure_reason', :'direction' ]) end
Attribute type mapping.
# File lib/plaid/models/bank_transfer_event.rb, line 93 def self.openapi_types { :'event_id' => :'Integer', :'timestamp' => :'Time', :'event_type' => :'BankTransferEventType', :'account_id' => :'String', :'bank_transfer_id' => :'String', :'origination_account_id' => :'String', :'bank_transfer_type' => :'BankTransferType', :'bank_transfer_amount' => :'String', :'bank_transfer_iso_currency_code' => :'String', :'failure_reason' => :'BankTransferFailure', :'direction' => :'BankTransferDirection' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/bank_transfer_event.rb, line 254 def ==(o) return true if self.equal?(o) self.class == o.class && event_id == o.event_id && timestamp == o.timestamp && event_type == o.event_type && account_id == o.account_id && bank_transfer_id == o.bank_transfer_id && origination_account_id == o.origination_account_id && bank_transfer_type == o.bank_transfer_type && bank_transfer_amount == o.bank_transfer_amount && bank_transfer_iso_currency_code == o.bank_transfer_iso_currency_code && failure_reason == o.failure_reason && direction == o.direction 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/bank_transfer_event.rb, line 316 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/bank_transfer_event.rb, line 387 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/bank_transfer_event.rb, line 292 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/bank_transfer_event.rb, line 272 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] event_id
Value to be assigned
# File lib/plaid/models/bank_transfer_event.rb, line 239 def event_id=(event_id) if event_id.nil? fail ArgumentError, 'event_id cannot be nil' end if event_id < 0 fail ArgumentError, 'invalid value for "event_id", must be greater than or equal to 0.' end @event_id = event_id end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/bank_transfer_event.rb, line 278 def hash [event_id, timestamp, event_type, account_id, bank_transfer_id, origination_account_id, bank_transfer_type, bank_transfer_amount, bank_transfer_iso_currency_code, failure_reason, direction].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/bank_transfer_event.rb, line 180 def list_invalid_properties invalid_properties = Array.new if @event_id.nil? invalid_properties.push('invalid value for "event_id", event_id cannot be nil.') end if @event_id < 0 invalid_properties.push('invalid value for "event_id", must be greater than or equal to 0.') end if @timestamp.nil? invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.') end if @event_type.nil? invalid_properties.push('invalid value for "event_type", event_type cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @bank_transfer_id.nil? invalid_properties.push('invalid value for "bank_transfer_id", bank_transfer_id cannot be nil.') end if @bank_transfer_type.nil? invalid_properties.push('invalid value for "bank_transfer_type", bank_transfer_type cannot be nil.') end if @bank_transfer_amount.nil? invalid_properties.push('invalid value for "bank_transfer_amount", bank_transfer_amount cannot be nil.') end if @bank_transfer_iso_currency_code.nil? invalid_properties.push('invalid value for "bank_transfer_iso_currency_code", bank_transfer_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/bank_transfer_event.rb, line 369 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/bank_transfer_event.rb, line 357 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/bank_transfer_event.rb, line 224 def valid? return false if @event_id.nil? return false if @event_id < 0 return false if @timestamp.nil? return false if @event_type.nil? return false if @account_id.nil? return false if @bank_transfer_id.nil? return false if @bank_transfer_type.nil? return false if @bank_transfer_amount.nil? return false if @bank_transfer_iso_currency_code.nil? true end