class Yapstone::PayoutInstrumentResource

Payout Instrument resource contains information about the payout account.

Attributes

bank_account[RW]
capabilities[RW]

Set of capabilities the instrument can perform.

consents[RW]

list of consent responses

external_id[RW]

The partners externalId id for the Payout Instrument.

id[RW]

The resource identifier for the Payout Instrument.

owner[RW]
payment_card[RW]
products[RW]

Products requested by marketplace.

status[RW]
type[RW]

The type of finanancial instrument [BANK_ACCOUNT]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 67
def self.attribute_map
  {
    :'external_id' => :'externalId',
    :'bank_account' => :'bankAccount',
    :'payment_card' => :'paymentCard',
    :'type' => :'type',
    :'id' => :'id',
    :'status' => :'status',
    :'owner' => :'owner',
    :'consents' => :'consents',
    :'products' => :'products',
    :'capabilities' => :'capabilities'
  }
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/yapstone-so/models/payout_instrument_resource.rb, line 264
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/yapstone-so/models/payout_instrument_resource.rb, line 107
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::PayoutInstrumentResource` 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 `Yapstone::PayoutInstrumentResource`. 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?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

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

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

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

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

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

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

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

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

  if attributes.key?(:'capabilities')
    if (value = attributes[:'capabilities']).is_a?(Array)
      self.capabilities = value
    end
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 99
def self.openapi_all_of
  [
  :'PayoutInstrumentResourceCommonEntities'
  ]
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 83
def self.openapi_types
  {
    :'external_id' => :'String',
    :'bank_account' => :'BankAccountResource',
    :'payment_card' => :'CardDataResource',
    :'type' => :'String',
    :'id' => :'String',
    :'status' => :'EntityProductStatusResource',
    :'owner' => :'OwnerResource',
    :'consents' => :'Array<Consent>',
    :'products' => :'Array<Product>',
    :'capabilities' => :'Array<CapabilityResource>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
      bank_account == o.bank_account &&
      payment_card == o.payment_card &&
      type == o.type &&
      id == o.id &&
      status == o.status &&
      owner == o.owner &&
      consents == o.consents &&
      products == o.products &&
      capabilities == o.capabilities
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/yapstone-so/models/payout_instrument_resource.rb, line 292
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    Yapstone.const_get(type).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/yapstone-so/models/payout_instrument_resource.rb, line 357
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/yapstone-so/models/payout_instrument_resource.rb, line 271
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 251
def eql?(o)
  self == o
end
external_id=(external_id) click to toggle source

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

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 205
def external_id=(external_id)
  if !external_id.nil? && external_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 255.'
  end

  if !external_id.nil? && external_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 1.'
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !external_id.nil? && external_id !~ pattern
    fail ArgumentError, "invalid value for \"external_id\", must conform to the pattern #{pattern}."
  end

  @external_id = external_id
end
hash() click to toggle source

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

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 257
def hash
  [external_id, bank_account, payment_card, type, id, status, owner, consents, products, capabilities].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/yapstone-so/models/payout_instrument_resource.rb, line 169
def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 255
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 255.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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/yapstone-so/models/payout_instrument_resource.rb, line 337
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/yapstone-so/models/payout_instrument_resource.rb, line 343
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/yapstone-so/models/payout_instrument_resource.rb, line 331
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/yapstone-so/models/payout_instrument_resource.rb, line 224
def type=(type)
  validator = EnumAttributeValidator.new('String', ["BANK_ACCOUNT", "CARD", "CHECK"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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/yapstone-so/models/payout_instrument_resource.rb, line 193
def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 255
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@external_id.nil? && @external_id !~ Regexp.new(/.*[^\s].*/)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["BANK_ACCOUNT", "CARD", "CHECK"])
  return false unless type_validator.valid?(@type)
  true
end