Class: Notifo::UserNotificationDto

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/models/user_notification_dto.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserNotificationDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/notifo/models/user_notification_dto.rb', line 141

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::UserNotificationDto` 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::UserNotificationDto`. 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
  }

  # call parent's initialize
  super(attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

The optional body text.



35
36
37
 
# File 'lib/notifo/models/user_notification_dto.rb', line 35

def body
  @body
end

#confirm_text ⇒ Object

The text for the confirm button.



56
57
58
 
# File 'lib/notifo/models/user_notification_dto.rb', line 56

def confirm_text
  @confirm_text
end

#confirm_url ⇒ Object

The tracking url that needs to be invoked to mark the notification as confirmed.



59
60
61
 
# File 'lib/notifo/models/user_notification_dto.rb', line 59

def confirm_url
  @confirm_url
end

#created ⇒ Object

The timestamp when the notification has been created.



26
27
28
 
# File 'lib/notifo/models/user_notification_dto.rb', line 26

def created
  @created
end

#data ⇒ Object

Optional data, usually a json object.



62
63
64
 
# File 'lib/notifo/models/user_notification_dto.rb', line 62

def data
  @data
end

#id ⇒ Object

The id of the notification.



17
18
19
 
# File 'lib/notifo/models/user_notification_dto.rb', line 17

def id
  @id
end

#image_large ⇒ Object

The optional link to the large image.



41
42
43
 
# File 'lib/notifo/models/user_notification_dto.rb', line 41

def image_large
  @image_large
end

#image_small ⇒ Object

The optional link to the small image.



38
39
40
 
# File 'lib/notifo/models/user_notification_dto.rb', line 38

def image_small
  @image_small
end

#is_confirmed ⇒ Object

True when the notification has been confirmed at least once.



70
71
72
 
# File 'lib/notifo/models/user_notification_dto.rb', line 70

def is_confirmed
  @is_confirmed
end

#is_seen ⇒ Object

True when the notification has been seen at least once.



67
68
69
 
# File 'lib/notifo/models/user_notification_dto.rb', line 67

def is_seen
  @is_seen
end

#link_text ⇒ Object

The link text.



53
54
55
 
# File 'lib/notifo/models/user_notification_dto.rb', line 53

def link_text
  @link_text
end

#link_url ⇒ Object

An optional link.



50
51
52
 
# File 'lib/notifo/models/user_notification_dto.rb', line 50

def link_url
  @link_url
end

#properties ⇒ Object

Returns the value of attribute properties.



64
65
66
 
# File 'lib/notifo/models/user_notification_dto.rb', line 64

def properties
  @properties
end

#silent ⇒ Object

True when the notification is silent.



23
24
25
 
# File 'lib/notifo/models/user_notification_dto.rb', line 23

def silent
  @silent
end

#subject ⇒ Object

The subject of the notification in the language of the user.



20
21
22
 
# File 'lib/notifo/models/user_notification_dto.rb', line 20

def subject
  @subject
end

#track_delivered_url ⇒ Object

The tracking url that needs to be invoked to mark the notification as delivered.



47
48
49
 
# File 'lib/notifo/models/user_notification_dto.rb', line 47

def track_delivered_url
  @track_delivered_url
end

#track_seen_url ⇒ Object

The tracking url that needs to be invoked to mark the notification as seen.



44
45
46
 
# File 'lib/notifo/models/user_notification_dto.rb', line 44

def track_seen_url
  @track_seen_url
end

#tracking_token ⇒ Object

The tracking token.



32
33
34
 
# File 'lib/notifo/models/user_notification_dto.rb', line 32

def tracking_token
  @tracking_token
end

#updated ⇒ Object

The timestamp when the notification has been updated.



29
30
31
 
# File 'lib/notifo/models/user_notification_dto.rb', line 29

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/notifo/models/user_notification_dto.rb', line 73

def self.attribute_map
  {
    :'id' => :'id',
    :'subject' => :'subject',
    :'silent' => :'silent',
    :'created' => :'created',
    :'updated' => :'updated',
    :'tracking_token' => :'trackingToken',
    :'body' => :'body',
    :'image_small' => :'imageSmall',
    :'image_large' => :'imageLarge',
    :'track_seen_url' => :'trackSeenUrl',
    :'track_delivered_url' => :'trackDeliveredUrl',
    :'link_url' => :'linkUrl',
    :'link_text' => :'linkText',
    :'confirm_text' => :'confirmText',
    :'confirm_url' => :'confirmUrl',
    :'data' => :'data',
    :'properties' => :'properties',
    :'is_seen' => :'isSeen',
    :'is_confirmed' => :'isConfirmed'
  }
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



323
324
325
 
# File 'lib/notifo/models/user_notification_dto.rb', line 323

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/notifo/models/user_notification_dto.rb', line 123

def self.openapi_nullable
  Set.new([
    :'tracking_token',
    :'body',
    :'image_small',
    :'image_large',
    :'track_seen_url',
    :'track_delivered_url',
    :'link_url',
    :'link_text',
    :'confirm_text',
    :'confirm_url',
    :'data',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/notifo/models/user_notification_dto.rb', line 98

def self.openapi_types
  {
    :'id' => :'',
    :'subject' => :'',
    :'silent' => :'',
    :'created' => :'',
    :'updated' => :'',
    :'tracking_token' => :'',
    :'body' => :'',
    :'image_small' => :'',
    :'image_large' => :'',
    :'track_seen_url' => :'',
    :'track_delivered_url' => :'',
    :'link_url' => :'',
    :'link_text' => :'',
    :'confirm_text' => :'',
    :'confirm_url' => :'',
    :'data' => :'',
    :'properties' => :'',
    :'is_seen' => :'',
    :'is_confirmed' => :''
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/notifo/models/user_notification_dto.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      subject == o.subject &&
      silent == o.silent &&
      created == o.created &&
      updated == o.updated &&
      tracking_token == o.tracking_token &&
      body == o.body &&
      image_small == o.image_small &&
      image_large == o.image_large &&
      track_seen_url == o.track_seen_url &&
      track_delivered_url == o.track_delivered_url &&
      link_url == o.link_url &&
      link_text == o.link_text &&
      confirm_text == o.confirm_text &&
      confirm_url == o.confirm_url &&
      data == o.data &&
      properties == o.properties &&
      is_seen == o.is_seen &&
      is_confirmed == o.is_confirmed && super(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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/notifo/models/user_notification_dto.rb', line 354

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/notifo/models/user_notification_dto.rb', line 423

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/notifo/models/user_notification_dto.rb', line 330

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


310
311
312
 
# File 'lib/notifo/models/user_notification_dto.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/notifo/models/user_notification_dto.rb', line 316

def hash
  [id, subject, silent, created, updated, tracking_token, body, image_small, image_large, track_seen_url, track_delivered_url, link_url, link_text, confirm_text, confirm_url, data, properties, is_seen, is_confirmed].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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/notifo/models/user_notification_dto.rb', line 236

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

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

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

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

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

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

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



399
400
401
 
# File 'lib/notifo/models/user_notification_dto.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/notifo/models/user_notification_dto.rb', line 405

def to_hash
  hash = super
  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



393
394
395
 
# File 'lib/notifo/models/user_notification_dto.rb', line 393

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



271
272
273
274
275
276
277
278
279
280
 
# File 'lib/notifo/models/user_notification_dto.rb', line 271

def valid?
  return false if @id.nil?
  return false if @subject.nil?
  return false if @silent.nil?
  return false if @created.nil?
  return false if @updated.nil?
  return false if @is_seen.nil?
  return false if @is_confirmed.nil?
  true
end