Class: Notifo::UserDto

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/notifo/models/user_dto.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_key ⇒ Object

The unique api key for the user.



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

def api_key
  @api_key
end

#counters ⇒ Object

The statistics counters.



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

def counters
  @counters
end

#created ⇒ Object

The date time (ISO 8601) when the user has been created.



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

def created
  @created
end

#email_address ⇒ Object

The email of the user.



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

def email_address
  @email_address
end

#full_name ⇒ Object

The full name of the user.



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

def full_name
  @full_name
end

#id ⇒ Object

The id of the user.



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

def id
  @id
end

#last_notification ⇒ Object

The date time (ISO 8601) when the user has been received the last notification.



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

def last_notification
  @last_notification
end

#last_update ⇒ Object

The date time (ISO 8601) when the user has been updated.



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

def last_update
  @last_update
end

#mobile_push_tokens ⇒ Object

The mobile push tokens.



65
66
67
 
# File 'lib/notifo/models/user_dto.rb', line 65

def mobile_push_tokens
  @mobile_push_tokens
end

#number_of_mobile_push_tokens ⇒ Object

The number of web hook tokens.



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

def number_of_mobile_push_tokens
  @number_of_mobile_push_tokens
end

#number_of_web_push_tokens ⇒ Object

The number of web hook tokens.



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

def number_of_web_push_tokens
  @number_of_web_push_tokens
end

#phone_number ⇒ Object

The phone number.



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

def phone_number
  @phone_number
end

#preferred_language ⇒ Object

The preferred language of the user.



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

def preferred_language
  @preferred_language
end

#preferred_timezone ⇒ Object

The timezone of the user.



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

def preferred_timezone
  @preferred_timezone
end

#properties ⇒ Object

The user properties.



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

def properties
  @properties
end

#requires_whitelisted_topics ⇒ Object

True when only whitelisted topic are allowed.



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

def requires_whitelisted_topics
  @requires_whitelisted_topics
end

#settings ⇒ Object

Notification settings per channel.



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

def settings
  @settings
end

#user_properties ⇒ Object

The supported user properties.



68
69
70
 
# File 'lib/notifo/models/user_dto.rb', line 68

def user_properties
  @user_properties
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'api_key' => :'apiKey',
    :'full_name' => :'fullName',
    :'email_address' => :'emailAddress',
    :'phone_number' => :'phoneNumber',
    :'preferred_language' => :'preferredLanguage',
    :'preferred_timezone' => :'preferredTimezone',
    :'created' => :'created',
    :'last_update' => :'lastUpdate',
    :'last_notification' => :'lastNotification',
    :'number_of_web_push_tokens' => :'numberOfWebPushTokens',
    :'number_of_mobile_push_tokens' => :'numberOfMobilePushTokens',
    :'requires_whitelisted_topics' => :'requiresWhitelistedTopics',
    :'properties' => :'properties',
    :'settings' => :'settings',
    :'counters' => :'counters',
    :'mobile_push_tokens' => :'mobilePushTokens',
    :'user_properties' => :'userProperties'
  }
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



333
334
335
 
# File 'lib/notifo/models/user_dto.rb', line 333

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/notifo/models/user_dto.rb', line 119

def self.openapi_nullable
  Set.new([
    :'full_name',
    :'email_address',
    :'phone_number',
    :'preferred_language',
    :'preferred_timezone',
    :'last_notification',
    :'properties',
    :'user_properties'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/notifo/models/user_dto.rb', line 95

def self.openapi_types
  {
    :'id' => :'Object',
    :'api_key' => :'Object',
    :'full_name' => :'Object',
    :'email_address' => :'Object',
    :'phone_number' => :'Object',
    :'preferred_language' => :'Object',
    :'preferred_timezone' => :'Object',
    :'created' => :'Object',
    :'last_update' => :'Object',
    :'last_notification' => :'Object',
    :'number_of_web_push_tokens' => :'Object',
    :'number_of_mobile_push_tokens' => :'Object',
    :'requires_whitelisted_topics' => :'Object',
    :'properties' => :'Object',
    :'settings' => :'Object',
    :'counters' => :'Object',
    :'mobile_push_tokens' => :'Object',
    :'user_properties' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      api_key == o.api_key &&
      full_name == o.full_name &&
      email_address == o.email_address &&
      phone_number == o.phone_number &&
      preferred_language == o.preferred_language &&
      preferred_timezone == o.preferred_timezone &&
      created == o.created &&
      last_update == o.last_update &&
      last_notification == o.last_notification &&
      number_of_web_push_tokens == o.number_of_web_push_tokens &&
      number_of_mobile_push_tokens == o.number_of_mobile_push_tokens &&
      requires_whitelisted_topics == o.requires_whitelisted_topics &&
      properties == o.properties &&
      settings == o.settings &&
      counters == o.counters &&
      mobile_push_tokens == o.mobile_push_tokens &&
      user_properties == o.user_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



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
390
391
392
393
394
395
396
397
398
 
# File 'lib/notifo/models/user_dto.rb', line 363

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/notifo/models/user_dto.rb', line 432

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/notifo/models/user_dto.rb', line 340

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


320
321
322
 
# File 'lib/notifo/models/user_dto.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



326
327
328
 
# File 'lib/notifo/models/user_dto.rb', line 326

def hash
  [id, api_key, full_name, email_address, phone_number, preferred_language, preferred_timezone, created, last_update, last_notification, number_of_web_push_tokens, number_of_mobile_push_tokens, requires_whitelisted_topics, properties, settings, counters, mobile_push_tokens, user_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



232
233
234
235
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
268
269
270
271
272
273
274
275
 
# File 'lib/notifo/models/user_dto.rb', line 232

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

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

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

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

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

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

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

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

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

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



408
409
410
 
# File 'lib/notifo/models/user_dto.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/notifo/models/user_dto.rb', line 414

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



402
403
404
 
# File 'lib/notifo/models/user_dto.rb', line 402

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/notifo/models/user_dto.rb', line 279

def valid?
  return false if @id.nil?
  return false if @api_key.nil?
  return false if @created.nil?
  return false if @last_update.nil?
  return false if @number_of_web_push_tokens.nil?
  return false if @number_of_mobile_push_tokens.nil?
  return false if @requires_whitelisted_topics.nil?
  return false if @settings.nil?
  return false if @counters.nil?
  return false if @mobile_push_tokens.nil?
  true
end