Class: Notifo::EventDto
- Inherits:
-
Object
- Object
- Notifo::EventDto
- Defined in:
- lib/notifo/models/event_dto.rb
Instance Attribute Summary collapse
-
#counters ⇒ Object
The statistics counters.
-
#created ⇒ Object
The time when the event has been created.
-
#creator_id ⇒ Object
A custom id to identity the creator.
-
#data ⇒ Object
Additional user defined data.
-
#display_name ⇒ Object
The display name.
-
#formatting ⇒ Object
Returns the value of attribute formatting.
-
#id ⇒ Object
The id of the event.
-
#properties ⇒ Object
User defined properties.
-
#scheduling ⇒ Object
Returns the value of attribute scheduling.
-
#settings ⇒ Object
Notification settings per channel.
-
#silent ⇒ Object
True when silent.
-
#time_to_live_in_seconds ⇒ Object
The time to live in seconds.
-
#topic ⇒ Object
The topic path.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EventDto
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EventDto
Initializes the object
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 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 |
# File 'lib/notifo/models/event_dto.rb', line 102 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::EventDto` 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 `Notifo::EventDto`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'topic') self.topic = attributes[:'topic'] end if attributes.key?(:'creator_id') self.creator_id = attributes[:'creator_id'] end if attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] end if attributes.key?(:'data') self.data = attributes[:'data'] end if attributes.key?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'formatting') self.formatting = attributes[:'formatting'] end if attributes.key?(:'settings') if (value = attributes[:'settings']).is_a?(Hash) self.settings = value end end if attributes.key?(:'properties') if (value = attributes[:'properties']).is_a?(Hash) self.properties = value end end if attributes.key?(:'scheduling') self.scheduling = attributes[:'scheduling'] end if attributes.key?(:'counters') if (value = attributes[:'counters']).is_a?(Hash) self.counters = value end end if attributes.key?(:'silent') self.silent = attributes[:'silent'] end if attributes.key?(:'time_to_live_in_seconds') self.time_to_live_in_seconds = attributes[:'time_to_live_in_seconds'] end end |
Instance Attribute Details
#counters ⇒ Object
The statistics counters.
45 46 47 |
# File 'lib/notifo/models/event_dto.rb', line 45 def counters @counters end |
#created ⇒ Object
The time when the event has been created.
32 33 34 |
# File 'lib/notifo/models/event_dto.rb', line 32 def created @created end |
#creator_id ⇒ Object
A custom id to identity the creator.
23 24 25 |
# File 'lib/notifo/models/event_dto.rb', line 23 def creator_id @creator_id end |
#data ⇒ Object
Additional user defined data.
29 30 31 |
# File 'lib/notifo/models/event_dto.rb', line 29 def data @data end |
#display_name ⇒ Object
The display name.
26 27 28 |
# File 'lib/notifo/models/event_dto.rb', line 26 def display_name @display_name end |
#formatting ⇒ Object
Returns the value of attribute formatting.
34 35 36 |
# File 'lib/notifo/models/event_dto.rb', line 34 def formatting @formatting end |
#id ⇒ Object
The id of the event.
17 18 19 |
# File 'lib/notifo/models/event_dto.rb', line 17 def id @id end |
#properties ⇒ Object
User defined properties.
40 41 42 |
# File 'lib/notifo/models/event_dto.rb', line 40 def properties @properties end |
#scheduling ⇒ Object
Returns the value of attribute scheduling.
42 43 44 |
# File 'lib/notifo/models/event_dto.rb', line 42 def scheduling @scheduling end |
#settings ⇒ Object
Notification settings per channel.
37 38 39 |
# File 'lib/notifo/models/event_dto.rb', line 37 def settings @settings end |
#silent ⇒ Object
True when silent.
48 49 50 |
# File 'lib/notifo/models/event_dto.rb', line 48 def silent @silent end |
#time_to_live_in_seconds ⇒ Object
The time to live in seconds.
51 52 53 |
# File 'lib/notifo/models/event_dto.rb', line 51 def time_to_live_in_seconds @time_to_live_in_seconds end |
#topic ⇒ Object
The topic path.
20 21 22 |
# File 'lib/notifo/models/event_dto.rb', line 20 def topic @topic end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/notifo/models/event_dto.rb', line 54 def self.attribute_map { :'id' => :'id', :'topic' => :'topic', :'creator_id' => :'creatorId', :'display_name' => :'displayName', :'data' => :'data', :'created' => :'created', :'formatting' => :'formatting', :'settings' => :'settings', :'properties' => :'properties', :'scheduling' => :'scheduling', :'counters' => :'counters', :'silent' => :'silent', :'time_to_live_in_seconds' => :'timeToLiveInSeconds' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
267 268 269 |
# File 'lib/notifo/models/event_dto.rb', line 267 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
92 93 94 95 96 97 98 |
# File 'lib/notifo/models/event_dto.rb', line 92 def self.openapi_nullable Set.new([ :'creator_id', :'data', :'time_to_live_in_seconds' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/notifo/models/event_dto.rb', line 73 def self.openapi_types { :'id' => :'Object', :'topic' => :'Object', :'creator_id' => :'Object', :'display_name' => :'Object', :'data' => :'Object', :'created' => :'Object', :'formatting' => :'Object', :'settings' => :'Object', :'properties' => :'Object', :'scheduling' => :'Object', :'counters' => :'Object', :'silent' => :'Object', :'time_to_live_in_seconds' => :'Object' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/notifo/models/event_dto.rb', line 234 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && topic == o.topic && creator_id == o.creator_id && display_name == o.display_name && data == o.data && created == o.created && formatting == o.formatting && settings == o.settings && properties == o.properties && scheduling == o.scheduling && counters == o.counters && silent == o.silent && time_to_live_in_seconds == o.time_to_live_in_seconds end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 332 |
# File 'lib/notifo/models/event_dto.rb', line 297 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 Notifo.const_get(type).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
366 367 368 369 370 371 372 373 374 375 376 377 378 |
# File 'lib/notifo/models/event_dto.rb', line 366 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
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/notifo/models/event_dto.rb', line 274 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end |
#eql?(o) ⇒ Boolean
254 255 256 |
# File 'lib/notifo/models/event_dto.rb', line 254 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
260 261 262 |
# File 'lib/notifo/models/event_dto.rb', line 260 def hash [id, topic, creator_id, display_name, data, created, formatting, settings, properties, scheduling, counters, silent, time_to_live_in_seconds].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/notifo/models/event_dto.rb', line 176 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @topic.nil? invalid_properties.push('invalid value for "topic", topic cannot be nil.') end if @display_name.nil? invalid_properties.push('invalid value for "display_name", display_name cannot be nil.') end if @created.nil? invalid_properties.push('invalid value for "created", created cannot be nil.') end if @formatting.nil? invalid_properties.push('invalid value for "formatting", formatting cannot be nil.') end if @settings.nil? invalid_properties.push('invalid value for "settings", settings cannot be nil.') end if @properties.nil? invalid_properties.push('invalid value for "properties", properties cannot be nil.') end if @counters.nil? invalid_properties.push('invalid value for "counters", counters cannot be nil.') end if @silent.nil? invalid_properties.push('invalid value for "silent", silent cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
342 343 344 |
# File 'lib/notifo/models/event_dto.rb', line 342 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/notifo/models/event_dto.rb', line 348 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
336 337 338 |
# File 'lib/notifo/models/event_dto.rb', line 336 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/notifo/models/event_dto.rb', line 219 def valid? return false if @id.nil? return false if @topic.nil? return false if @display_name.nil? return false if @created.nil? return false if @formatting.nil? return false if @settings.nil? return false if @properties.nil? return false if @counters.nil? return false if @silent.nil? true end |