Class: Buildium::LeaseLedgerCreditPostMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/lease_ledger_credit_post_message.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeaseLedgerCreditPostMessage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 90

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. = attributes[:'offsetting_gl_account_id']
  end

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

Instance Attribute Details

#credit_type ⇒ Object

Indicates how the credit should be applied. <ul><li>WaiveUnpaid - This credit type allows for reversing one or more charges without losing record of what has changed.</li><li>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.</li><li>PreviouslyDeposited - This credit type allows for issuing a credit against payments that have already been deposited.</li></ul>



25
26
27
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 25

def credit_type
  @credit_type
end

#date ⇒ Object

Date of the transaction. The date must be formatted as YYYY-MM-DD.



19
20
21
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 19

def date
  @date
end

#lines ⇒ Object

A collection of line items included in the credit. At least one line item is required.



31
32
33
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 31

def lines
  @lines
end

#memo ⇒ Object

Description of the transaction. The value cannot exceed 65 characters.



22
23
24
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 22

def memo
  @memo
end

#offsetting_gl_account_id ⇒ Object

Sets the offsetting general ledger account identifier for the credit. <br />This value must be provided when the ‘CreditType` field is set to `Exchange` or `PreviouslyDeposited`. <br />When the `CreditType` is `Exchange` this must be an expense general ledger account type. <br />When the `CreditType` is `PreviouslyDeposited` this must be an equity general ledger account type.



28
29
30
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 28

def 
  @offsetting_gl_account_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 56

def self.attribute_map
  {
    :'date' => :'Date',
    :'memo' => :'Memo',
    :'credit_type' => :'CreditType',
    :'offsetting_gl_account_id' => :'OffsettingGLAccountId',
    :'lines' => :'Lines'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



193
194
195
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 193

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 83

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 72

def self.openapi_types
  {
    :'date' => :'Date',
    :'memo' => :'String',
    :'credit_type' => :'String',
    :'offsetting_gl_account_id' => :'Integer',
    :'lines' => :'Array<LeaseLedgerCreditLinePostMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      memo == o.memo &&
      credit_type == o.credit_type &&
       == o. &&
      lines == o.lines
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 224

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 = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 295

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 200

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 186

def hash
  [date, memo, credit_type, , lines].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 128

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 271

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 277

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



265
266
267
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 265

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
150
151
152
153
154
 
# File 'lib/buildium-ruby/models/lease_ledger_credit_post_message.rb', line 147

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