class Plaid::PaymentInitiationMetadata

Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.

Attributes

maximum_payment_amount[RW]

A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution. Example: ‘{"GBP": "10000"}`

standing_order_metadata[RW]
supports_international_payments[RW]

Indicates whether the institution supports payments from a different country.

supports_payment_consents[RW]

Indicates whether the institution supports payment consents.

supports_refund_details[RW]

Indicates whether the institution supports returning refund details when initiating a payment.

supports_sepa_instant[RW]

Indicates whether the institution supports SEPA Instant payments.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/payment_initiation_metadata.rb, line 49
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/payment_initiation_metadata.rb, line 37
def self.attribute_map
  {
    :'supports_international_payments' => :'supports_international_payments',
    :'supports_sepa_instant' => :'supports_sepa_instant',
    :'maximum_payment_amount' => :'maximum_payment_amount',
    :'supports_refund_details' => :'supports_refund_details',
    :'standing_order_metadata' => :'standing_order_metadata',
    :'supports_payment_consents' => :'supports_payment_consents'
  }
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/payment_initiation_metadata.rb, line 180
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/payment_initiation_metadata.rb, line 74
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PaymentInitiationMetadata` 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::PaymentInitiationMetadata`. 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?(:'supports_international_payments')
    self.supports_international_payments = attributes[:'supports_international_payments']
  end

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/plaid/models/payment_initiation_metadata.rb, line 54
def self.openapi_types
  {
    :'supports_international_payments' => :'Boolean',
    :'supports_sepa_instant' => :'Boolean',
    :'maximum_payment_amount' => :'Hash<String, String>',
    :'supports_refund_details' => :'Boolean',
    :'standing_order_metadata' => :'PaymentInitiationStandingOrderMetadata',
    :'supports_payment_consents' => :'Boolean'
  }
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/payment_initiation_metadata.rb, line 154
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      supports_international_payments == o.supports_international_payments &&
      supports_sepa_instant == o.supports_sepa_instant &&
      maximum_payment_amount == o.maximum_payment_amount &&
      supports_refund_details == o.supports_refund_details &&
      standing_order_metadata == o.standing_order_metadata &&
      supports_payment_consents == o.supports_payment_consents
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/payment_initiation_metadata.rb, line 211
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/payment_initiation_metadata.rb, line 282
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/payment_initiation_metadata.rb, line 187
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/payment_initiation_metadata.rb, line 167
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/payment_initiation_metadata.rb, line 173
def hash
  [supports_international_payments, supports_sepa_instant, maximum_payment_amount, supports_refund_details, standing_order_metadata, supports_payment_consents].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/payment_initiation_metadata.rb, line 116
def list_invalid_properties
  invalid_properties = Array.new
  if @supports_international_payments.nil?
    invalid_properties.push('invalid value for "supports_international_payments", supports_international_payments cannot be nil.')
  end

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

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

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

  if @supports_payment_consents.nil?
    invalid_properties.push('invalid value for "supports_payment_consents", supports_payment_consents 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/payment_initiation_metadata.rb, line 258
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/payment_initiation_metadata.rb, line 264
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/payment_initiation_metadata.rb, line 252
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/payment_initiation_metadata.rb, line 143
def valid?
  return false if @supports_international_payments.nil?
  return false if @supports_sepa_instant.nil?
  return false if @maximum_payment_amount.nil?
  return false if @supports_refund_details.nil?
  return false if @supports_payment_consents.nil?
  true
end