class TreezorClient::Payout

Attributes

amount[RW]
bankaccount_iban[RW]
bankaccount_id[RW]
beneficiary_id[RW]
created_date[RW]

Date YYYY-MM-DD HH:MM:SS

currency[RW]
label[RW]
modified_date[RW]

Date YYYY-MM-DD HH:MM:SS

partner_fee[RW]
payout_date[RW]

Date YYYY-MM-DD

payout_id[RW]
payout_status[RW]
payout_tag[RW]
payout_type[RW]
payout_type_id[RW]
total_rows[RW]
unique_mandate_reference[RW]
user_firstname[RW]
user_id[RW]
user_lastname[RW]
wallet_alias[RW]
wallet_event_name[RW]
wallet_id[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 89
def self.attribute_map
  {
    :'payout_id' => :'payoutId',
    :'payout_tag' => :'payoutTag',
    :'payout_status' => :'payoutStatus',
    :'payout_type_id' => :'payoutTypeId',
    :'payout_type' => :'payoutType',
    :'wallet_id' => :'walletId',
    :'payout_date' => :'payoutDate',
    :'wallet_event_name' => :'walletEventName',
    :'wallet_alias' => :'walletAlias',
    :'user_firstname' => :'userFirstname',
    :'user_lastname' => :'userLastname',
    :'user_id' => :'userId',
    :'bankaccount_id' => :'bankaccountId',
    :'beneficiary_id' => :'beneficiaryId',
    :'unique_mandate_reference' => :'uniqueMandateReference',
    :'bankaccount_iban' => :'bankaccountIBAN',
    :'label' => :'label',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'partner_fee' => :'partnerFee',
    :'created_date' => :'createdDate',
    :'modified_date' => :'modifiedDate',
    :'total_rows' => :'totalRows'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 148
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'payoutId')
    self.payout_id = attributes[:'payoutId']
  end

  if attributes.has_key?(:'payoutTag')
    self.payout_tag = attributes[:'payoutTag']
  end

  if attributes.has_key?(:'payoutStatus')
    self.payout_status = attributes[:'payoutStatus']
  end

  if attributes.has_key?(:'payoutTypeId')
    self.payout_type_id = attributes[:'payoutTypeId']
  end

  if attributes.has_key?(:'payoutType')
    self.payout_type = attributes[:'payoutType']
  end

  if attributes.has_key?(:'walletId')
    self.wallet_id = attributes[:'walletId']
  end

  if attributes.has_key?(:'payoutDate')
    self.payout_date = attributes[:'payoutDate']
  end

  if attributes.has_key?(:'walletEventName')
    self.wallet_event_name = attributes[:'walletEventName']
  end

  if attributes.has_key?(:'walletAlias')
    self.wallet_alias = attributes[:'walletAlias']
  end

  if attributes.has_key?(:'userFirstname')
    self.user_firstname = attributes[:'userFirstname']
  end

  if attributes.has_key?(:'userLastname')
    self.user_lastname = attributes[:'userLastname']
  end

  if attributes.has_key?(:'userId')
    self.user_id = attributes[:'userId']
  end

  if attributes.has_key?(:'bankaccountId')
    self.bankaccount_id = attributes[:'bankaccountId']
  end

  if attributes.has_key?(:'beneficiaryId')
    self.beneficiary_id = attributes[:'beneficiaryId']
  end

  if attributes.has_key?(:'uniqueMandateReference')
    self.unique_mandate_reference = attributes[:'uniqueMandateReference']
  end

  if attributes.has_key?(:'bankaccountIBAN')
    self.bankaccount_iban = attributes[:'bankaccountIBAN']
  end

  if attributes.has_key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

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

  if attributes.has_key?(:'partnerFee')
    self.partner_fee = attributes[:'partnerFee']
  end

  if attributes.has_key?(:'createdDate')
    self.created_date = attributes[:'createdDate']
  end

  if attributes.has_key?(:'modifiedDate')
    self.modified_date = attributes[:'modifiedDate']
  end

  if attributes.has_key?(:'totalRows')
    self.total_rows = attributes[:'totalRows']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/treezor_client/models/payout.rb, line 118
def self.swagger_types
  {
    :'payout_id' => :'Integer',
    :'payout_tag' => :'String',
    :'payout_status' => :'String',
    :'payout_type_id' => :'Integer',
    :'payout_type' => :'String',
    :'wallet_id' => :'Integer',
    :'payout_date' => :'String',
    :'wallet_event_name' => :'String',
    :'wallet_alias' => :'String',
    :'user_firstname' => :'String',
    :'user_lastname' => :'String',
    :'user_id' => :'Integer',
    :'bankaccount_id' => :'Integer',
    :'beneficiary_id' => :'Integer',
    :'unique_mandate_reference' => :'String',
    :'bankaccount_iban' => :'String',
    :'label' => :'String',
    :'amount' => :'String',
    :'currency' => :'String',
    :'partner_fee' => :'String',
    :'created_date' => :'String',
    :'modified_date' => :'String',
    :'total_rows' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 286
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payout_id == o.payout_id &&
      payout_tag == o.payout_tag &&
      payout_status == o.payout_status &&
      payout_type_id == o.payout_type_id &&
      payout_type == o.payout_type &&
      wallet_id == o.wallet_id &&
      payout_date == o.payout_date &&
      wallet_event_name == o.wallet_event_name &&
      wallet_alias == o.wallet_alias &&
      user_firstname == o.user_firstname &&
      user_lastname == o.user_lastname &&
      user_id == o.user_id &&
      bankaccount_id == o.bankaccount_id &&
      beneficiary_id == o.beneficiary_id &&
      unique_mandate_reference == o.unique_mandate_reference &&
      bankaccount_iban == o.bankaccount_iban &&
      label == o.label &&
      amount == o.amount &&
      currency == o.currency &&
      partner_fee == o.partner_fee &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      total_rows == o.total_rows
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/treezor_client/models/payout.rb, line 350
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
    temp_model = TreezorClient.const_get(type).new
    temp_model.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/treezor_client/models/payout.rb, line 416
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/treezor_client/models/payout.rb, line 329
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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/treezor_client/models/payout.rb, line 316
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 322
def hash
  [payout_id, payout_tag, payout_status, payout_type_id, payout_type, wallet_id, payout_date, wallet_event_name, wallet_alias, user_firstname, user_lastname, user_id, bankaccount_id, beneficiary_id, unique_mandate_reference, bankaccount_iban, label, amount, currency, partner_fee, created_date, modified_date, total_rows].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/treezor_client/models/payout.rb, line 249
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
payout_status=(payout_status) click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 266
def payout_status=(payout_status)
  validator = EnumAttributeValidator.new('String', ['PENDING', 'CANCELED', 'VALIDATED'])
  unless validator.valid?(payout_status)
    fail ArgumentError, 'invalid value for "payout_status", must be one of #{validator.allowable_values}.'
  end
  @payout_status = payout_status
end
payout_type=(payout_type) click to toggle source

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

# File lib/treezor_client/models/payout.rb, line 276
def payout_type=(payout_type)
  validator = EnumAttributeValidator.new('String', ['Credit Transfer', 'Direct Debit'])
  unless validator.valid?(payout_type)
    fail ArgumentError, 'invalid value for "payout_type", must be one of #{validator.allowable_values}.'
  end
  @payout_type = payout_type
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/treezor_client/models/payout.rb, line 396
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/treezor_client/models/payout.rb, line 402
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/treezor_client/models/payout.rb, line 390
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/treezor_client/models/payout.rb, line 256
def valid?
  payout_status_validator = EnumAttributeValidator.new('String', ['PENDING', 'CANCELED', 'VALIDATED'])
  return false unless payout_status_validator.valid?(@payout_status)
  payout_type_validator = EnumAttributeValidator.new('String', ['Credit Transfer', 'Direct Debit'])
  return false unless payout_type_validator.valid?(@payout_type)
  true
end