Class: Notifo::PublishDto
- Inherits:
-
Object
- Object
- Notifo::PublishDto
- Defined in:
- lib/notifo/models/publish_dto.rb
Instance Attribute Summary collapse
-
#correlation_id ⇒ Object
The correlation ID, that can be used to query notifications.
-
#creator_id ⇒ Object
A custom id to identity the creator.
-
#data ⇒ Object
Additional user defined data.
-
#preformatted ⇒ Object
Returns the value of attribute preformatted.
-
#properties ⇒ Object
Returns the value of attribute properties.
-
#scheduling ⇒ Object
Returns the value of attribute scheduling.
-
#settings ⇒ Object
The notification settings.
-
#silent ⇒ Object
True when silent.
-
#template_code ⇒ Object
The template code.
-
#template_variants ⇒ Object
The template variants with propability.
-
#test ⇒ Object
True when using test integrations.
-
#time_to_live_in_seconds ⇒ Object
The time to live in seconds.
-
#timestamp ⇒ Object
A custom timestamp.
-
#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 = {}) ⇒ PublishDto
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 = {}) ⇒ PublishDto
Initializes the object
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 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/notifo/models/publish_dto.rb', line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::PublishDto` 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::PublishDto`. 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?(:'topic') self.topic = attributes[:'topic'] end if attributes.key?(:'creator_id') self.creator_id = attributes[:'creator_id'] end if attributes.key?(:'template_code') self.template_code = attributes[:'template_code'] end if attributes.key?(:'correlation_id') self.correlation_id = attributes[:'correlation_id'] end if attributes.key?(:'template_variants') if (value = attributes[:'template_variants']).is_a?(Hash) self.template_variants = value end end if attributes.key?(:'data') self.data = attributes[:'data'] end if attributes.key?(:'timestamp') self. = attributes[:'timestamp'] end if attributes.key?(:'preformatted') self.preformatted = attributes[:'preformatted'] end if attributes.key?(:'settings') if (value = attributes[:'settings']).is_a?(Hash) self.settings = value end end if attributes.key?(:'properties') self.properties = attributes[:'properties'] end if attributes.key?(:'scheduling') self.scheduling = attributes[:'scheduling'] end if attributes.key?(:'silent') self.silent = attributes[:'silent'] end if attributes.key?(:'test') self.test = attributes[:'test'] 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
#correlation_id ⇒ Object
The correlation ID, that can be used to query notifications.
26 27 28 |
# File 'lib/notifo/models/publish_dto.rb', line 26 def correlation_id @correlation_id end |
#creator_id ⇒ Object
A custom id to identity the creator.
20 21 22 |
# File 'lib/notifo/models/publish_dto.rb', line 20 def creator_id @creator_id end |
#data ⇒ Object
Additional user defined data.
32 33 34 |
# File 'lib/notifo/models/publish_dto.rb', line 32 def data @data end |
#preformatted ⇒ Object
Returns the value of attribute preformatted.
37 38 39 |
# File 'lib/notifo/models/publish_dto.rb', line 37 def preformatted @preformatted end |
#properties ⇒ Object
Returns the value of attribute properties.
42 43 44 |
# File 'lib/notifo/models/publish_dto.rb', line 42 def properties @properties end |
#scheduling ⇒ Object
Returns the value of attribute scheduling.
44 45 46 |
# File 'lib/notifo/models/publish_dto.rb', line 44 def scheduling @scheduling end |
#settings ⇒ Object
The notification settings.
40 41 42 |
# File 'lib/notifo/models/publish_dto.rb', line 40 def settings @settings end |
#silent ⇒ Object
True when silent.
47 48 49 |
# File 'lib/notifo/models/publish_dto.rb', line 47 def silent @silent end |
#template_code ⇒ Object
The template code.
23 24 25 |
# File 'lib/notifo/models/publish_dto.rb', line 23 def template_code @template_code end |
#template_variants ⇒ Object
The template variants with propability.
29 30 31 |
# File 'lib/notifo/models/publish_dto.rb', line 29 def template_variants @template_variants end |
#test ⇒ Object
True when using test integrations.
50 51 52 |
# File 'lib/notifo/models/publish_dto.rb', line 50 def test @test end |
#time_to_live_in_seconds ⇒ Object
The time to live in seconds.
53 54 55 |
# File 'lib/notifo/models/publish_dto.rb', line 53 def time_to_live_in_seconds @time_to_live_in_seconds end |
#timestamp ⇒ Object
A custom timestamp.
35 36 37 |
# File 'lib/notifo/models/publish_dto.rb', line 35 def @timestamp end |
#topic ⇒ Object
The topic path.
17 18 19 |
# File 'lib/notifo/models/publish_dto.rb', line 17 def topic @topic end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/notifo/models/publish_dto.rb', line 56 def self.attribute_map { :'topic' => :'topic', :'creator_id' => :'creatorId', :'template_code' => :'templateCode', :'correlation_id' => :'correlationId', :'template_variants' => :'templateVariants', :'data' => :'data', :'timestamp' => :'timestamp', :'preformatted' => :'preformatted', :'settings' => :'settings', :'properties' => :'properties', :'scheduling' => :'scheduling', :'silent' => :'silent', :'test' => :'test', :'time_to_live_in_seconds' => :'timeToLiveInSeconds' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
238 239 240 |
# File 'lib/notifo/models/publish_dto.rb', line 238 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/notifo/models/publish_dto.rb', line 96 def self.openapi_nullable Set.new([ :'creator_id', :'template_code', :'correlation_id', :'template_variants', :'data', :'settings', :'time_to_live_in_seconds' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/notifo/models/publish_dto.rb', line 76 def self.openapi_types { :'topic' => :'Object', :'creator_id' => :'Object', :'template_code' => :'Object', :'correlation_id' => :'Object', :'template_variants' => :'Object', :'data' => :'Object', :'timestamp' => :'Object', :'preformatted' => :'Object', :'settings' => :'Object', :'properties' => :'Object', :'scheduling' => :'Object', :'silent' => :'Object', :'test' => :'Object', :'time_to_live_in_seconds' => :'Object' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/notifo/models/publish_dto.rb', line 204 def ==(o) return true if self.equal?(o) self.class == o.class && topic == o.topic && creator_id == o.creator_id && template_code == o.template_code && correlation_id == o.correlation_id && template_variants == o.template_variants && data == o.data && == o. && preformatted == o.preformatted && settings == o.settings && properties == o.properties && scheduling == o.scheduling && silent == o.silent && test == o.test && time_to_live_in_seconds == o.time_to_live_in_seconds end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/notifo/models/publish_dto.rb', line 268 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
337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/notifo/models/publish_dto.rb', line 337 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
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/notifo/models/publish_dto.rb', line 245 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
225 226 227 |
# File 'lib/notifo/models/publish_dto.rb', line 225 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
231 232 233 |
# File 'lib/notifo/models/publish_dto.rb', line 231 def hash [topic, creator_id, template_code, correlation_id, template_variants, data, , preformatted, settings, properties, scheduling, silent, test, time_to_live_in_seconds].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
186 187 188 189 190 191 192 193 |
# File 'lib/notifo/models/publish_dto.rb', line 186 def list_invalid_properties invalid_properties = Array.new if @topic.nil? invalid_properties.push('invalid value for "topic", topic cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
313 314 315 |
# File 'lib/notifo/models/publish_dto.rb', line 313 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/notifo/models/publish_dto.rb', line 319 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
307 308 309 |
# File 'lib/notifo/models/publish_dto.rb', line 307 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
197 198 199 200 |
# File 'lib/notifo/models/publish_dto.rb', line 197 def valid? return false if @topic.nil? true end |