class Plaid::BankTransferCreateRequest

Defines the request schema for ‘/bank_transfer/create`

Attributes

access_token[RW]

The Plaid ‘access_token` for the account that will be debited or credited.

account_id[RW]

The Plaid ‘account_id` for the account that will be debited or credited.

ach_class[RW]
amount[RW]

The amount of the bank transfer (decimal string with two digits of precision e.g. "10.00").

client_id[RW]

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

custom_tag[RW]

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

description[RW]

The transfer description. Maximum of 10 characters.

idempotency_key[RW]

A random key provided by the client, per unique bank transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

iso_currency_code[RW]

The currency of the transfer amount – should be set to "USD".

metadata[RW]

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters

network[RW]
origination_account_id[RW]

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.

secret[RW]

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

type[RW]
user[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/bank_transfer_create_request.rb, line 104
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/bank_transfer_create_request.rb, line 83
def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'idempotency_key' => :'idempotency_key',
    :'access_token' => :'access_token',
    :'account_id' => :'account_id',
    :'type' => :'type',
    :'network' => :'network',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'description' => :'description',
    :'ach_class' => :'ach_class',
    :'user' => :'user',
    :'custom_tag' => :'custom_tag',
    :'metadata' => :'metadata',
    :'origination_account_id' => :'origination_account_id'
  }
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/bank_transfer_create_request.rb, line 379
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/bank_transfer_create_request.rb, line 140
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BankTransferCreateRequest` 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::BankTransferCreateRequest`. 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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

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

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

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

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  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?(:'description')
    self.description = attributes[:'description']
  end

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

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

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

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

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

List of attributes with nullable: true

# File lib/plaid/models/bank_transfer_create_request.rb, line 130
def self.openapi_nullable
  Set.new([
    :'custom_tag',
    :'metadata',
    :'origination_account_id'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/bank_transfer_create_request.rb, line 109
def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'idempotency_key' => :'String',
    :'access_token' => :'String',
    :'account_id' => :'String',
    :'type' => :'BankTransferType',
    :'network' => :'BankTransferNetwork',
    :'amount' => :'String',
    :'iso_currency_code' => :'String',
    :'description' => :'String',
    :'ach_class' => :'ACHClass',
    :'user' => :'BankTransferUser',
    :'custom_tag' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'origination_account_id' => :'String'
  }
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/bank_transfer_create_request.rb, line 344
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      idempotency_key == o.idempotency_key &&
      access_token == o.access_token &&
      account_id == o.account_id &&
      type == o.type &&
      network == o.network &&
      amount == o.amount &&
      iso_currency_code == o.iso_currency_code &&
      description == o.description &&
      ach_class == o.ach_class &&
      user == o.user &&
      custom_tag == o.custom_tag &&
      metadata == o.metadata &&
      origination_account_id == o.origination_account_id
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/bank_transfer_create_request.rb, line 410
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/bank_transfer_create_request.rb, line 481
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/bank_transfer_create_request.rb, line 386
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
custom_tag=(custom_tag) click to toggle source

Custom attribute writer method with validation @param [Object] custom_tag Value to be assigned

# File lib/plaid/models/bank_transfer_create_request.rb, line 326
def custom_tag=(custom_tag)
  if !custom_tag.nil? && custom_tag.to_s.length > 100
    fail ArgumentError, 'invalid value for "custom_tag", the character length must be smaller than or equal to 100.'
  end


  @custom_tag = custom_tag
end
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/plaid/models/bank_transfer_create_request.rb, line 311
def description=(description)
  if description.nil?
    fail ArgumentError, 'description cannot be nil'
  end

  if description.to_s.length > 10
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 10.'
  end


  @description = description
end
eql?(o) click to toggle source

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

# File lib/plaid/models/bank_transfer_create_request.rb, line 366
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/bank_transfer_create_request.rb, line 372
def hash
  [client_id, secret, idempotency_key, access_token, account_id, type, network, amount, iso_currency_code, description, ach_class, user, custom_tag, metadata, origination_account_id].hash
end
idempotency_key=(idempotency_key) click to toggle source

Custom attribute writer method with validation @param [Object] idempotency_key Value to be assigned

# File lib/plaid/models/bank_transfer_create_request.rb, line 296
def idempotency_key=(idempotency_key)
  if idempotency_key.nil?
    fail ArgumentError, 'idempotency_key cannot be nil'
  end

  if idempotency_key.to_s.length > 50
    fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 50.'
  end


  @idempotency_key = idempotency_key
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/bank_transfer_create_request.rb, line 218
def list_invalid_properties
  invalid_properties = Array.new
  if @idempotency_key.nil?
    invalid_properties.push('invalid value for "idempotency_key", idempotency_key cannot be nil.')
  end

  if @idempotency_key.to_s.length > 50
    invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 50.')
  end


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

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

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

  if @network.nil?
    invalid_properties.push('invalid value for "network", network 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

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

  if @description.to_s.length > 10
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 10.')
  end


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

  if !@custom_tag.nil? && @custom_tag.to_s.length > 100
    invalid_properties.push('invalid value for "custom_tag", the character length must be smaller than or equal to 100.')
  end



  invalid_properties
end
metadata=(metadata) click to toggle source

Custom attribute writer method with validation @param [Object] metadata Value to be assigned

# File lib/plaid/models/bank_transfer_create_request.rb, line 337
def metadata=(metadata)

  @metadata = metadata
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/bank_transfer_create_request.rb, line 457
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/bank_transfer_create_request.rb, line 463
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/bank_transfer_create_request.rb, line 451
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/bank_transfer_create_request.rb, line 277
def valid?
  return false if @idempotency_key.nil?
  return false if @idempotency_key.to_s.length > 50
  return false if @access_token.nil?
  return false if @account_id.nil?
  return false if @type.nil?
  return false if @network.nil?
  return false if @amount.nil?
  return false if @iso_currency_code.nil?
  return false if @description.nil?
  return false if @description.to_s.length > 10
  return false if @user.nil?
  return false if !@custom_tag.nil? && @custom_tag.to_s.length > 100
  return false if !@metadata.nil? && @metadata.length > 50
  true
end