Class: Propertyware::SavePortfolio

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/models/save_portfolio.rb

Overview

Save Portfolio

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SavePortfolio

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/propertyware/models/save_portfolio.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#abbreviation ⇒ Object

Abbreviated name assigned to the portfolio.



20
21
22
 
# File 'lib/propertyware/models/save_portfolio.rb', line 20

def abbreviation
  @abbreviation
end

#cash_accrual ⇒ Object

Cash or accrual accounting basis.



23
24
25
 
# File 'lib/propertyware/models/save_portfolio.rb', line 23

def cash_accrual
  @cash_accrual
end

#closing_date ⇒ Object

Date when the accounting period for the portfolio will close.



26
27
28
 
# File 'lib/propertyware/models/save_portfolio.rb', line 26

def closing_date
  @closing_date
end

#do_not_pay_owner_draw ⇒ Object

Indicates that the owner should not be paid owner draws.



29
30
31
 
# File 'lib/propertyware/models/save_portfolio.rb', line 29

def do_not_pay_owner_draw
  @do_not_pay_owner_draw
end

#maintenance_spending_limit ⇒ Object

Monthly or yearly Maintenance Spending Limit set for the portfolio for maintenance bills created by work orders.



32
33
34
 
# File 'lib/propertyware/models/save_portfolio.rb', line 32

def maintenance_spending_limit
  @maintenance_spending_limit
end

#maintenance_spending_limit_time ⇒ Object

Monthly or Yearly Maintenance Spending Limit Time set for the portfolio for maintenance bills created by work orders.



35
36
37
 
# File 'lib/propertyware/models/save_portfolio.rb', line 35

def maintenance_spending_limit_time
  @maintenance_spending_limit_time
end

#name ⇒ Object

Name of the portfolio.



38
39
40
 
# File 'lib/propertyware/models/save_portfolio.rb', line 38

def name
  @name
end

#owner_ids ⇒ Object

Portfolio owner Ids



41
42
43
 
# File 'lib/propertyware/models/save_portfolio.rb', line 41

def owner_ids
  @owner_ids
end

#owners ⇒ Object

Portfolio owners.



44
45
46
 
# File 'lib/propertyware/models/save_portfolio.rb', line 44

def owners
  @owners
end

#sticky_note ⇒ Object

Sticky notes. Maximum 500 characters.



47
48
49
 
# File 'lib/propertyware/models/save_portfolio.rb', line 47

def sticky_note
  @sticky_note
end

#target_operating_reserve ⇒ Object

Minimum balance to be maintained within the portfolio at all times.



50
51
52
 
# File 'lib/propertyware/models/save_portfolio.rb', line 50

def target_operating_reserve
  @target_operating_reserve
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/propertyware/models/save_portfolio.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/propertyware/models/save_portfolio.rb', line 75

def self.attribute_map
  {
    :'abbreviation' => :'abbreviation',
    :'cash_accrual' => :'cashAccrual',
    :'closing_date' => :'closingDate',
    :'do_not_pay_owner_draw' => :'doNotPayOwnerDraw',
    :'maintenance_spending_limit' => :'maintenanceSpendingLimit',
    :'maintenance_spending_limit_time' => :'maintenanceSpendingLimitTime',
    :'name' => :'name',
    :'owner_ids' => :'ownerIds',
    :'owners' => :'owners',
    :'sticky_note' => :'stickyNote',
    :'target_operating_reserve' => :'targetOperatingReserve'
  }
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



263
264
265
 
# File 'lib/propertyware/models/save_portfolio.rb', line 263

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/propertyware/models/save_portfolio.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/propertyware/models/save_portfolio.rb', line 97

def self.openapi_types
  {
    :'abbreviation' => :'String',
    :'cash_accrual' => :'String',
    :'closing_date' => :'Date',
    :'do_not_pay_owner_draw' => :'Boolean',
    :'maintenance_spending_limit' => :'Float',
    :'maintenance_spending_limit_time' => :'String',
    :'name' => :'String',
    :'owner_ids' => :'Array<Integer>',
    :'owners' => :'Array<SaveOwner>',
    :'sticky_note' => :'String',
    :'target_operating_reserve' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/propertyware/models/save_portfolio.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      abbreviation == o.abbreviation &&
      cash_accrual == o.cash_accrual &&
      closing_date == o.closing_date &&
      do_not_pay_owner_draw == o.do_not_pay_owner_draw &&
      maintenance_spending_limit == o.maintenance_spending_limit &&
      maintenance_spending_limit_time == o.maintenance_spending_limit_time &&
      name == o.name &&
      owner_ids == o.owner_ids &&
      owners == o.owners &&
      sticky_note == o.sticky_note &&
      target_operating_reserve == o.target_operating_reserve
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/propertyware/models/save_portfolio.rb', line 294

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 = Propertyware.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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/propertyware/models/save_portfolio.rb', line 365

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/propertyware/models/save_portfolio.rb', line 270

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


250
251
252
 
# File 'lib/propertyware/models/save_portfolio.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/propertyware/models/save_portfolio.rb', line 256

def hash
  [abbreviation, cash_accrual, closing_date, do_not_pay_owner_draw, maintenance_spending_limit, maintenance_spending_limit_time, name, owner_ids, owners, sticky_note, target_operating_reserve].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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/propertyware/models/save_portfolio.rb', line 185

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

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



341
342
343
 
# File 'lib/propertyware/models/save_portfolio.rb', line 341

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/propertyware/models/save_portfolio.rb', line 347

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



335
336
337
 
# File 'lib/propertyware/models/save_portfolio.rb', line 335

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



200
201
202
203
204
205
206
207
208
 
# File 'lib/propertyware/models/save_portfolio.rb', line 200

def valid?
  return false if @abbreviation.nil?
  cash_accrual_validator = EnumAttributeValidator.new('String', ["COMPANY_DEFAULT", "CASH", "ACCRUAL"])
  return false unless cash_accrual_validator.valid?(@cash_accrual)
  maintenance_spending_limit_time_validator = EnumAttributeValidator.new('String', ["NO_LIMIT", "DOLLAR_PER_MONTH", "DOLLAR_PER_YEAR"])
  return false unless maintenance_spending_limit_time_validator.valid?(@maintenance_spending_limit_time)
  return false if @name.nil?
  true
end