=begin
#Open API, powered by Buildium
#GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
The version of the OpenAPI document: v1
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.0.1
=end
require 'date'
require 'time'
module Buildium
class LeaseLedgerCreditPostMessage
# Date of the transaction. The date must be formatted as YYYY-MM-DD.
attr_accessor :date
# Description of the transaction. The value cannot exceed 65 characters.
attr_accessor :memo
# Indicates how the credit should be applied.
- WaiveUnpaid - This credit type allows for reversing one or more charges without losing record of what has changed.
- Exchange - This credit type allows for one of the following: 1) Reimburse a resident for a out-of-pocket expense, 2) Compensate for a service, 3) Write-off a resident balance considered uncollectable.
- PreviouslyDeposited - This credit type allows for issuing a credit against payments that have already been deposited.
attr_accessor :credit_type
# Sets the offsetting general ledger account identifier for the credit.
This value must be provided when the `CreditType` field is set to `Exchange` or `PreviouslyDeposited`.
When the `CreditType` is `Exchange` this must be an *expense* general ledger account type.
When the `CreditType` is `PreviouslyDeposited` this must be an *equity* general ledger account type.
attr_accessor :offsetting_gl_account_id
# A collection of line items included in the credit. At least one line item is required.
attr_accessor :lines
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'date' => :'Date',
:'memo' => :'Memo',
:'credit_type' => :'CreditType',
:'offsetting_gl_account_id' => :'OffsettingGLAccountId',
:'lines' => :'Lines'
}
end
# Returns all the JSON keys this model knows about
def self.acceptable_attributes
attribute_map.values
end
# Attribute type mapping.
def self.openapi_types
{
:'date' => :'Date',
:'memo' => :'String',
:'credit_type' => :'String',
:'offsetting_gl_account_id' => :'Integer',
:'lines' => :'Array'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::LeaseLedgerCreditPostMessage` 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 `Buildium::LeaseLedgerCreditPostMessage`. 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?(:'date')
self.date = attributes[:'date']
end
if attributes.key?(:'memo')
self.memo = attributes[:'memo']
end
if attributes.key?(:'credit_type')
self.credit_type = attributes[:'credit_type']
end
if attributes.key?(:'offsetting_gl_account_id')
self.offsetting_gl_account_id = attributes[:'offsetting_gl_account_id']
end
if attributes.key?(:'lines')
if (value = attributes[:'lines']).is_a?(Array)
self.lines = value
end
end
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
def list_invalid_properties
invalid_properties = Array.new
if @date.nil?
invalid_properties.push('invalid value for "date", date cannot be nil.')
end
if @credit_type.nil?
invalid_properties.push('invalid value for "credit_type", credit_type cannot be nil.')
end
if @lines.nil?
invalid_properties.push('invalid value for "lines", lines cannot be nil.')
end
invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
return false if @date.nil?
return false if @credit_type.nil?
credit_type_validator = EnumAttributeValidator.new('String', ["WaiveUnpaid", "Exchange", "PreviouslyDeposited"])
return false unless credit_type_validator.valid?(@credit_type)
return false if @lines.nil?
true
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] credit_type Object to be assigned
def credit_type=(credit_type)
validator = EnumAttributeValidator.new('String', ["WaiveUnpaid", "Exchange", "PreviouslyDeposited"])
unless validator.valid?(credit_type)
fail ArgumentError, "invalid value #{ credit_type.inspect } for \"credit_type\", must be one of #{validator.allowable_values}."
end
@credit_type = credit_type
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
date == o.date &&
memo == o.memo &&
credit_type == o.credit_type &&
offsetting_gl_account_id == o.offsetting_gl_account_id &&
lines == o.lines
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[date, memo, credit_type, offsetting_gl_account_id, lines].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def build_from_hash(attributes)
return 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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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 = Buildium.const_get(type)
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
end
end
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# 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
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
end
end