Class: Buildium::CreateAnnouncementRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAnnouncementRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
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
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 80

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

The content of the announcement. The value cannot exceed 65535 characters. Note: if your message is over 140 characters, the announcement will not be sent via SMS. Announcement texts are available for US numbers only.



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

def body
  @body
end

#expiration_date ⇒ Object

Optional date that indicates when the announcement should be removed from the Resident Center. If no date is provided the announcement will appear indefinitely The date must be formatted as YYYY-MM-DD.



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

def expiration_date
  @expiration_date
end

#include_alternate_email ⇒ Object

Indicates whether to send the announcement to alternate emails in addition to the main email addresses when publishing the announcement.



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

def include_alternate_email
  @include_alternate_email
end

#notify_association_tenants ⇒ Object

Indicates whether to include notifying the association tenants in addition to the association owners when publishing the announcement. Note this is only pertains to announcements sent to residents of ‘Association` properties.



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

def notify_association_tenants
  @notify_association_tenants
end

#property_ids ⇒ Object

A list of association and/or rental property unique identifiers whose residents should receive the announcement.



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

def property_ids
  @property_ids
end

#subject ⇒ Object

The subject of the announcement. Note, this will only show up in announcements sent via email and in the Resident Center. The value cannot exceed 100 characters.



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

def subject
  @subject
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 37

def self.attribute_map
  {
    :'subject' => :'Subject',
    :'body' => :'Body',
    :'expiration_date' => :'ExpirationDate',
    :'notify_association_tenants' => :'NotifyAssociationTenants',
    :'include_alternate_email' => :'IncludeAlternateEmail',
    :'property_ids' => :'PropertyIds'
  }
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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



72
73
74
75
76
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 72

def self.openapi_all_of
  [
  :'AnnouncementPostMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'subject' => :'String',
    :'body' => :'String',
    :'expiration_date' => :'Date',
    :'notify_association_tenants' => :'Boolean',
    :'include_alternate_email' => :'Boolean',
    :'property_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subject == o.subject &&
      body == o.body &&
      expiration_date == o.expiration_date &&
      notify_association_tenants == o.notify_association_tenants &&
      include_alternate_email == o.include_alternate_email &&
      property_ids == o.property_ids
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



255
256
257
258
259
260
261
262
263
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
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 255

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 326

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 231

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


211
212
213
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 217

def hash
  [subject, body, expiration_date, notify_association_tenants, include_alternate_email, property_ids].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



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
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 122

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

  if @subject.to_s.length < 1
    invalid_properties.push('invalid value for "subject", the character length must be great than or equal to 1.')
  end

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

  if @body.to_s.length < 1
    invalid_properties.push('invalid value for "body", the character length must be great than or equal to 1.')
  end

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

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

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



302
303
304
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 302

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 308

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



296
297
298
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 296

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



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/buildium-ruby/models/create_announcement_request.rb', line 157

def valid?
  return false if @subject.nil?
  return false if @subject.to_s.length < 1
  return false if @body.nil?
  return false if @body.to_s.length < 1
  return false if @notify_association_tenants.nil?
  return false if @include_alternate_email.nil?
  return false if @property_ids.nil?
  true
end