class Plaid::OverrideAccounts

Data to use to set values of test accounts. Some values cannot be specified in the schema and will instead will be calculated from other test data in order to achieve more consistent, realistic test data.

Attributes

currency[RW]

ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default.

force_available_balance[RW]

If provided, the account will always have this amount as its available balance, regardless of current balance or changes in transactions over time.

holdings[RW]
identity[RW]
income[RW]
inflow_model[RW]
investment_transactions[RW]
liability[RW]
meta[RW]
numbers[RW]
starting_balance[RW]

If provided, the account will start with this amount as the current balance.

subtype[RW]
transactions[RW]

Specify the list of transactions on the account.

type[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/override_accounts.rb, line 94
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/plaid/models/override_accounts.rb, line 74
def self.attribute_map
  {
    :'type' => :'type',
    :'subtype' => :'subtype',
    :'starting_balance' => :'starting_balance',
    :'force_available_balance' => :'force_available_balance',
    :'currency' => :'currency',
    :'meta' => :'meta',
    :'numbers' => :'numbers',
    :'transactions' => :'transactions',
    :'holdings' => :'holdings',
    :'investment_transactions' => :'investment_transactions',
    :'identity' => :'identity',
    :'liability' => :'liability',
    :'inflow_model' => :'inflow_model',
    :'income' => :'income'
  }
end
build_from_hash(attributes) click to toggle source

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/override_accounts.rb, line 298
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/override_accounts.rb, line 127
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::OverrideAccounts` 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::OverrideAccounts`. 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?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'subtype')
    self.subtype = attributes[:'subtype']
  end

  if attributes.key?(:'starting_balance')
    self.starting_balance = attributes[:'starting_balance']
  end

  if attributes.key?(:'force_available_balance')
    self.force_available_balance = attributes[:'force_available_balance']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'meta')
    self.meta = attributes[:'meta']
  end

  if attributes.key?(:'numbers')
    self.numbers = attributes[:'numbers']
  end

  if attributes.key?(:'transactions')
    if (value = attributes[:'transactions']).is_a?(Array)
      self.transactions = value
    end
  end

  if attributes.key?(:'holdings')
    self.holdings = attributes[:'holdings']
  end

  if attributes.key?(:'investment_transactions')
    self.investment_transactions = attributes[:'investment_transactions']
  end

  if attributes.key?(:'identity')
    self.identity = attributes[:'identity']
  end

  if attributes.key?(:'liability')
    self.liability = attributes[:'liability']
  end

  if attributes.key?(:'inflow_model')
    self.inflow_model = attributes[:'inflow_model']
  end

  if attributes.key?(:'income')
    self.income = attributes[:'income']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/override_accounts.rb, line 119
def self.openapi_nullable
  Set.new([
    :'subtype',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/override_accounts.rb, line 99
def self.openapi_types
  {
    :'type' => :'OverrideAccountType',
    :'subtype' => :'AccountSubtype',
    :'starting_balance' => :'Float',
    :'force_available_balance' => :'Float',
    :'currency' => :'String',
    :'meta' => :'Meta',
    :'numbers' => :'Numbers',
    :'transactions' => :'Array<TransactionOverride>',
    :'holdings' => :'HoldingsOverride',
    :'investment_transactions' => :'InvestmentsTransactionsOverride',
    :'identity' => :'OwnerOverride',
    :'liability' => :'LiabilityOverride',
    :'inflow_model' => :'InflowModel',
    :'income' => :'IncomeOverride'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/override_accounts.rb, line 264
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      subtype == o.subtype &&
      starting_balance == o.starting_balance &&
      force_available_balance == o.force_available_balance &&
      currency == o.currency &&
      meta == o.meta &&
      numbers == o.numbers &&
      transactions == o.transactions &&
      holdings == o.holdings &&
      investment_transactions == o.investment_transactions &&
      identity == o.identity &&
      liability == o.liability &&
      inflow_model == o.inflow_model &&
      income == o.income
end
_deserialize(type, value) click to toggle source

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/override_accounts.rb, line 329
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
_to_hash(value) click to toggle source

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/override_accounts.rb, line 400
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
build_from_hash(attributes) click to toggle source

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/override_accounts.rb, line 305
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
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/override_accounts.rb, line 285
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/override_accounts.rb, line 291
def hash
  [type, subtype, starting_balance, force_available_balance, currency, meta, numbers, transactions, holdings, investment_transactions, identity, liability, inflow_model, income].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/override_accounts.rb, line 201
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @starting_balance.nil?
    invalid_properties.push('invalid value for "starting_balance", starting_balance cannot be nil.')
  end

  if @force_available_balance.nil?
    invalid_properties.push('invalid value for "force_available_balance", force_available_balance cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @meta.nil?
    invalid_properties.push('invalid value for "meta", meta cannot be nil.')
  end

  if @numbers.nil?
    invalid_properties.push('invalid value for "numbers", numbers cannot be nil.')
  end

  if @transactions.nil?
    invalid_properties.push('invalid value for "transactions", transactions cannot be nil.')
  end

  if @identity.nil?
    invalid_properties.push('invalid value for "identity", identity cannot be nil.')
  end

  if @liability.nil?
    invalid_properties.push('invalid value for "liability", liability cannot be nil.')
  end

  if @inflow_model.nil?
    invalid_properties.push('invalid value for "inflow_model", inflow_model cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/override_accounts.rb, line 376
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/override_accounts.rb, line 382
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/override_accounts.rb, line 370
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/override_accounts.rb, line 248
def valid?
  return false if @type.nil?
  return false if @starting_balance.nil?
  return false if @force_available_balance.nil?
  return false if @currency.nil?
  return false if @meta.nil?
  return false if @numbers.nil?
  return false if @transactions.nil?
  return false if @identity.nil?
  return false if @liability.nil?
  return false if @inflow_model.nil?
  true
end