class Bitpesa::Debit

Debits are used to fund transactions from your internal BitPesa balance.

Attributes

amount[RW]

The amount to be debited from your account. The “amount” parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction.

created_at[RW]

Date and time that the debit was created

currency[RW]

The currency of the amount in 3-character alpha ISO 4217 currency format

errors[RW]

The fields that have some problems and don't pass validation

id[RW]
metadata[RW]

Metadata of account debit

running_balance[RW]

The total amount remaining in your account after the debit call

to_id[RW]

The ID of the resource the debit is funding

to_type[RW]

Describes what the debit is funding

usd_amount[RW]

The amount to be debited from your account converted to USD

Public Class Methods

attribute_map() click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 48
def self.attribute_map
  {
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'to_type' => :'to_type',
    :'to_id' => :'to_id',
    :'metadata' => :'metadata',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'usd_amount' => :'usd_amount',
    :'running_balance' => :'running_balance',
    :'errors' => :'errors'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 81
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?(:'amount')
    self.amount = attributes[:'amount']
  end

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Hash)
      self.errors = value
    end
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/bitpesa-sdk/models/debit.rb, line 64
def self.openapi_types
  {
    :'amount' => :'Float',
    :'currency' => :'String',
    :'to_type' => :'String',
    :'to_id' => :'String',
    :'metadata' => :'Object',
    :'id' => :'String',
    :'created_at' => :'DateTime',
    :'usd_amount' => :'Float',
    :'running_balance' => :'Float',
    :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 160
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      currency == o.currency &&
      to_type == o.to_type &&
      to_id == o.to_id &&
      metadata == o.metadata &&
      id == o.id &&
      created_at == o.created_at &&
      usd_amount == o.usd_amount &&
      running_balance == o.running_balance &&
      errors == o.errors
end
[](key) click to toggle source
# File lib/bitpesa-sdk/models/debit.rb, line 275
def [](key)
  to_hash[key]
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/bitpesa-sdk/models/debit.rb, line 213
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 = Bitpesa.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/bitpesa-sdk/models/debit.rb, line 287
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/bitpesa-sdk/models/debit.rb, line 192
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 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
dig(*args) click to toggle source
# File lib/bitpesa-sdk/models/debit.rb, line 279
def dig(*args)
  to_hash.dig(*args)
end
eql?(o) click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 177
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 183
def hash
  [amount, currency, to_type, to_id, metadata, id, created_at, usd_amount, running_balance, errors].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/bitpesa-sdk/models/debit.rb, line 132
def list_invalid_properties
  invalid_properties = Array.new
  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

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

  if @to_id.nil?
    invalid_properties.push('invalid value for "to_id", to_id 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/bitpesa-sdk/models/debit.rb, line 259
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/bitpesa-sdk/models/debit.rb, line 265
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
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end
to_s() click to toggle source

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

# File lib/bitpesa-sdk/models/debit.rb, line 253
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/bitpesa-sdk/models/debit.rb, line 151
def valid?
  return false if @currency.nil?
  return false if @to_type.nil?
  return false if @to_id.nil?
  true
end