Class: Buildium::GLAccountPostMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GLAccountPostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::GLAccountPostMessage` 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::GLAccountPostMessage`. 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?(:'sub_type')
    self.sub_type = attributes[:'sub_type']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

General ledger account number. The account number cannot exceed 12 characters and must be unique across all general ledger accounts.



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

def 
  @account_number
end

#cash_flow_classification ⇒ Object

Describes the cash flow classification for the general ledger account. Must be null if ‘IsCashAsset` field is set to true.



37
38
39
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 37

def cash_flow_classification
  @cash_flow_classification
end

#description ⇒ Object

Description of the general ledger account. The description cannot exceed 250 characters.



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

def description
  @description
end

#is_cash_asset ⇒ Object

Indicates if an account is a Cash Asset. Can only have a value if SubType is ‘CurrentAsset`



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

def is_cash_asset
  @is_cash_asset
end

#is_contra_account ⇒ Object

Indicates whether the account is a contra account. Must be null if ‘IsCashAsset` field is set to true.



34
35
36
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 34

def 
  @is_contra_account
end

#name ⇒ Object

Name of the general ledger account. The name cannot exceed 50 characters and must be unique across all general ledger accounts.



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

def name
  @name
end

#parent_gl_account_id ⇒ Object

Unique identifier of the parent general ledger account. Indicates if this is a sub general ledger account.



40
41
42
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 40

def 
  @parent_gl_account_id
end

#sub_type ⇒ Object

Describes the subtype of the general ledger account.



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

def sub_type
  @sub_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 65

def self.attribute_map
  {
    :'sub_type' => :'SubType',
    :'is_cash_asset' => :'IsCashAsset',
    :'name' => :'Name',
    :'account_number' => :'AccountNumber',
    :'description' => :'Description',
    :'is_contra_account' => :'IsContraAccount',
    :'cash_flow_classification' => :'CashFlowClassification',
    :'parent_gl_account_id' => :'ParentGLAccountId'
  }
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



233
234
235
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 233

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 84

def self.openapi_types
  {
    :'sub_type' => :'String',
    :'is_cash_asset' => :'Boolean',
    :'name' => :'String',
    :'account_number' => :'String',
    :'description' => :'String',
    :'is_contra_account' => :'Boolean',
    :'cash_flow_classification' => :'String',
    :'parent_gl_account_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sub_type == o.sub_type &&
      is_cash_asset == o.is_cash_asset &&
      name == o.name &&
       == o. &&
      description == o.description &&
       == o. &&
      cash_flow_classification == o.cash_flow_classification &&
       == o.
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 264

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 335

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 240

def build_from_hash(attributes)
  return nil 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


220
221
222
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 226

def hash
  [sub_type, is_cash_asset, name, , description, , cash_flow_classification, ].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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  if @sub_type.nil?
    invalid_properties.push('invalid value for "sub_type", sub_type cannot be nil.')
  end

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

  if @account_number.nil?
    invalid_properties.push('invalid value for "account_number", account_number 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



311
312
313
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 317

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



305
306
307
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 305

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



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/buildium-ruby/models/gl_account_post_message.rb', line 172

def valid?
  return false if @sub_type.nil?
  sub_type_validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
  return false unless sub_type_validator.valid?(@sub_type)
  return false if @name.nil?
  return false if @account_number.nil?
  cash_flow_classification_validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
  return false unless cash_flow_classification_validator.valid?(@cash_flow_classification)
  true
end