class Plaid::SimulatedTransferSweep
A sweep returned from the ‘/sandbox/transfer/sweep/simulate` endpoint. Can be null if there are no transfers to include in a sweep.
Attributes
Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00") If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid
are balanced.
The datetime when the sweep occurred, in RFC 3339 format.
The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.
The expected date when funds from a ledger deposit will be made available and can be withdrawn from the associated ledger balance. Only applies to deposits. This will be of the form YYYY-MM-DD.
The id of the funding account to use, available in the Plaid
Dashboard. This determines which of your business checking accounts will be credited or debited.
Identifier of the sweep.
The currency of the sweep, e.g. "USD".
Plaid’s unique identifier for a Plaid
Ledger Balance.
The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ‘ach` or `same-day-ach` transfers, this is the ACH trace number. For `rtp` transfers, this is the Transaction
Identification number. For `wire` transfers, this is the IMAD (Input Message Accountability Data) number.
The date when the sweep settled, in the YYYY-MM-DD format.
Public Class Methods
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 97 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 78 def self.attribute_map { :'id' => :'id', :'funding_account_id' => :'funding_account_id', :'ledger_id' => :'ledger_id', :'created' => :'created', :'amount' => :'amount', :'iso_currency_code' => :'iso_currency_code', :'settled' => :'settled', :'expected_funds_available_date' => :'expected_funds_available_date', :'status' => :'status', :'trigger' => :'trigger', :'description' => :'description', :'network_trace_id' => :'network_trace_id', :'failure_reason' => :'failure_reason' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 281 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/simulated_transfer_sweep.rb, line 142 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SimulatedTransferSweep` 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::SimulatedTransferSweep`. 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?(:'funding_account_id') self.funding_account_id = attributes[:'funding_account_id'] end if attributes.key?(:'ledger_id') self.ledger_id = attributes[:'ledger_id'] end if attributes.key?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'iso_currency_code') self.iso_currency_code = attributes[:'iso_currency_code'] end if attributes.key?(:'settled') self.settled = attributes[:'settled'] end if attributes.key?(:'expected_funds_available_date') self.expected_funds_available_date = attributes[:'expected_funds_available_date'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'trigger') self.trigger = attributes[:'trigger'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'network_trace_id') self.network_trace_id = attributes[:'network_trace_id'] end if attributes.key?(:'failure_reason') self.failure_reason = attributes[:'failure_reason'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 134 def self.openapi_all_of [ :'TransferSweep' ] end
List of class defined in allOf (OpenAPI v3)
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 121 def self.openapi_nullable Set.new([ :'ledger_id', :'settled', :'expected_funds_available_date', :'status', :'trigger', :'network_trace_id', :'failure_reason' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 102 def self.openapi_types { :'id' => :'String', :'funding_account_id' => :'String', :'ledger_id' => :'String', :'created' => :'Time', :'amount' => :'String', :'iso_currency_code' => :'String', :'settled' => :'Date', :'expected_funds_available_date' => :'Date', :'status' => :'SweepStatus', :'trigger' => :'SweepTrigger', :'description' => :'String', :'network_trace_id' => :'String', :'failure_reason' => :'SweepFailure' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 248 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && funding_account_id == o.funding_account_id && ledger_id == o.ledger_id && created == o.created && amount == o.amount && iso_currency_code == o.iso_currency_code && settled == o.settled && expected_funds_available_date == o.expected_funds_available_date && status == o.status && trigger == o.trigger && description == o.description && network_trace_id == o.network_trace_id && failure_reason == o.failure_reason end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 312 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/simulated_transfer_sweep.rb, line 383 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/simulated_transfer_sweep.rb, line 288 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/simulated_transfer_sweep.rb, line 268 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 274 def hash [id, funding_account_id, ledger_id, created, amount, iso_currency_code, settled, expected_funds_available_date, status, trigger, description, network_trace_id, failure_reason].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/simulated_transfer_sweep.rb, line 210 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @funding_account_id.nil? invalid_properties.push('invalid value for "funding_account_id", funding_account_id cannot be nil.') end if @created.nil? invalid_properties.push('invalid value for "created", created cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount 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
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/simulated_transfer_sweep.rb, line 365 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/simulated_transfer_sweep.rb, line 353 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/simulated_transfer_sweep.rb, line 237 def valid? return false if @id.nil? return false if @funding_account_id.nil? return false if @created.nil? return false if @amount.nil? return false if @iso_currency_code.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid