Class: Notifo::UserNotificationBaseDto

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserNotificationBaseDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 131

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

Instance Attribute Details

#body ⇒ Object

The optional body text.



35
36
37
 
# File 'lib/notifo/models/user_notification_base_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_base_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_base_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_base_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_base_dto.rb', line 62

def data
  @data
end

#id ⇒ Object

The id of the notification.



17
18
19
 
# File 'lib/notifo/models/user_notification_base_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_base_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_base_dto.rb', line 38

def image_small
  @image_small
end

#link_text ⇒ Object

The link text.



53
54
55
 
# File 'lib/notifo/models/user_notification_base_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_base_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_base_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_base_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_base_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_base_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_base_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_base_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_base_dto.rb', line 29

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 67

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'
  }
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



290
291
292
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 290

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 113

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.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 90

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 253

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
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 320

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 389

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 297

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


277
278
279
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 283

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].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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 215

def list_invalid_properties
  invalid_properties = Array.new
  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

  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



365
366
367
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 365

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 371

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



359
360
361
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 359

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



242
243
244
245
246
247
248
249
 
# File 'lib/notifo/models/user_notification_base_dto.rb', line 242

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?
  true
end