Class: Buildium::CreateAssociationOwnershipAccountRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAssociationOwnershipAccountRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 112

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

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

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

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

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

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

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

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

Instance Attribute Details

#association_fee ⇒ Object

Recurring association fee charge. If provided, a recurring transaction will be created that adds a charge in the amount specified to the ownership account ledger with the frequency indicated in RecurringFrequency.



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

def association_fee
  @association_fee
end

#association_owner_ids ⇒ Object

Current or former association owners to assign to this ownership account. Values must be an active association owner identifiers. The request must include at least one owner in this property OR the ‘AssociationOwners` property.



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

def association_owner_ids
  @association_owner_ids
end

#association_owners ⇒ Object

Create new association owner(s) and assigns them to this new ownership account. The request must include at least one owner in this property OR the ‘AssociationOwnerIds` property.



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

def association_owners
  @association_owners
end

#date_of_purchase ⇒ Object

Date the unit was purchased by the owner. Must be formatted as YYYY-MM-DD. If an existing association ownership account is being replaced then this date must be after the existing ownership accounts date of sale.



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

def date_of_purchase
  @date_of_purchase
end

#recurring_frequency ⇒ Object

Indicates the frequency of the recurring association fee. This field is required if ‘AssociationFee` has a value.



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

def recurring_frequency
  @recurring_frequency
end

#replace_existing_ownership_account ⇒ Object

Indicates whether to replace an ownership account if one already exists for this unit. If this value is false and an ownership account exists the request will fail.This protects against inadvertently overwriting of an existing ownership account. If the value is true and an ownership account exists then the existing ownership account will be marked as with a status of Past and the newly created ownership account will be Active for the unit.



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

def 
  @replace_existing_ownership_account
end

#send_welcome_email ⇒ Object

Indicates whether to send an owner portal welcome email to all of the association owners assigned to this ownership account. Once the owners sign into the portal, they can make online payments, view important documents, submit requests, and more.



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

def send_welcome_email
  @send_welcome_email
end

#unit_id ⇒ Object

Association unit unique identifier that the ownership account is related to.



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

def unit_id
  @unit_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.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/create_association_ownership_account_request.rb', line 65

def self.attribute_map
  {
    :'unit_id' => :'UnitId',
    :'date_of_purchase' => :'DateOfPurchase',
    :'association_fee' => :'AssociationFee',
    :'recurring_frequency' => :'RecurringFrequency',
    :'association_owner_ids' => :'AssociationOwnerIds',
    :'association_owners' => :'AssociationOwners',
    :'send_welcome_email' => :'SendWelcomeEmail',
    :'replace_existing_ownership_account' => :'ReplaceExistingOwnershipAccount'
  }
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



237
238
239
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 237

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



104
105
106
107
108
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 104

def self.openapi_all_of
  [
  :'AssociationOwnershipAccountPostMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.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/create_association_ownership_account_request.rb', line 84

def self.openapi_types
  {
    :'unit_id' => :'Integer',
    :'date_of_purchase' => :'Date',
    :'association_fee' => :'Float',
    :'recurring_frequency' => :'String',
    :'association_owner_ids' => :'Array<Integer>',
    :'association_owners' => :'Array<AssociationOwnerPostMessage>',
    :'send_welcome_email' => :'Boolean',
    :'replace_existing_ownership_account' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      unit_id == o.unit_id &&
      date_of_purchase == o.date_of_purchase &&
      association_fee == o.association_fee &&
      recurring_frequency == o.recurring_frequency &&
      association_owner_ids == o.association_owner_ids &&
      association_owners == o.association_owners &&
      send_welcome_email == o.send_welcome_email &&
       == 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



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
302
303
304
305
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 268

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 339

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 244

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


224
225
226
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 230

def hash
  [unit_id, date_of_purchase, association_fee, recurring_frequency, association_owner_ids, association_owners, send_welcome_email, ].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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 164

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

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

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

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



315
316
317
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 315

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 321

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



309
310
311
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 309

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



187
188
189
190
191
192
193
194
195
 
# File 'lib/buildium-ruby/models/create_association_ownership_account_request.rb', line 187

def valid?
  return false if @unit_id.nil?
  return false if @date_of_purchase.nil?
  recurring_frequency_validator = EnumAttributeValidator.new('String', ["Monthly", "Weekly", "Every2Weeks", "Quarterly", "Yearly", "Every2Months", "Daily", "Every6Months", "OneTime"])
  return false unless recurring_frequency_validator.valid?(@recurring_frequency)
  return false if @send_welcome_email.nil?
  return false if @replace_existing_ownership_account.nil?
  true
end