Class: Buildium::CreateEmailRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEmailRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 85

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

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

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

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

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

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

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

Instance Attribute Details

#exclude_delinquent_recipients ⇒ Object

Indicates whether to exclude sending emails to association owners that are flagged as delinquent. This only applies to association recipients.



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

def exclude_delinquent_recipients
  @exclude_delinquent_recipients
end

#include_alternate_emails ⇒ Object

Indicates whether to send the email to the recipient’s primary and alternate email addresses.



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

def include_alternate_emails
  @include_alternate_emails
end

#include_association_tenants ⇒ Object

Indicates whether to include association tenants. Only applies to association properties.



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

def include_association_tenants
  @include_association_tenants
end

#property_ids ⇒ Object

A list of association and/or rental property unique identifiers to send the email to. Cannot be populated if ‘RecipientIds’ is present.



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

def property_ids
  @property_ids
end

#recipient_ids ⇒ Object

A list of individual unique identifiers to send the email to. Cannot be populated if ‘PropertyIds’ is present.



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

def recipient_ids
  @recipient_ids
end

#subject ⇒ Object

Email subject.



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

def subject
  @subject
end

#template_id ⇒ Object

Unique identifier of the email template to use for the body of the email. Any tokens present in the template will be replaced based on the recipient(s) of the email. The following email templates cannot be used: <ul><li>1 (Tenant Statement)</li><li>2 (Homeowner Statement)</li><li>3 (Rental Owner Statement)</li><li>123 (Association Tenant Invoice)</li><li>124 (Rental Tenant Invoice)</li></ul>



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

def template_id
  @template_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 40

def self.attribute_map
  {
    :'template_id' => :'TemplateId',
    :'subject' => :'Subject',
    :'include_alternate_emails' => :'IncludeAlternateEmails',
    :'exclude_delinquent_recipients' => :'ExcludeDelinquentRecipients',
    :'include_association_tenants' => :'IncludeAssociationTenants',
    :'property_ids' => :'PropertyIds',
    :'recipient_ids' => :'RecipientIds'
  }
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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'EmailPostMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 58

def self.openapi_types
  {
    :'template_id' => :'Integer',
    :'subject' => :'String',
    :'include_alternate_emails' => :'Boolean',
    :'exclude_delinquent_recipients' => :'Boolean',
    :'include_association_tenants' => :'Boolean',
    :'property_ids' => :'Array<Integer>',
    :'recipient_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template_id == o.template_id &&
      subject == o.subject &&
      include_alternate_emails == o.include_alternate_emails &&
      exclude_delinquent_recipients == o.exclude_delinquent_recipients &&
      include_association_tenants == o.include_association_tenants &&
      property_ids == o.property_ids &&
      recipient_ids == o.recipient_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



248
249
250
251
252
253
254
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
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 248

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



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

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 224

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


204
205
206
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 210

def hash
  [template_id, subject, include_alternate_emails, exclude_delinquent_recipients, include_association_tenants, property_ids, recipient_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



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_email_request.rb', line 133

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

  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 @include_alternate_emails.nil?
    invalid_properties.push('invalid value for "include_alternate_emails", include_alternate_emails cannot be nil.')
  end

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

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



295
296
297
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 295

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 301

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



289
290
291
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 289

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



164
165
166
167
168
169
170
171
172
 
# File 'lib/buildium-ruby/models/create_email_request.rb', line 164

def valid?
  return false if @template_id.nil?
  return false if @subject.nil?
  return false if @subject.to_s.length < 1
  return false if @include_alternate_emails.nil?
  return false if @exclude_delinquent_recipients.nil?
  return false if @include_association_tenants.nil?
  true
end