Class: DevCycle::UserData

Inherits:
Object
  • Object
show all
Defined in:
lib/devcycle-server-sdk/models/user_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 145

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

  self.set_default_platform_info()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_build ⇒ Object

App Build number of the running application



37
38
39
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 37

def app_build
  @app_build
end

#app_version ⇒ Object

App Version of the running application



34
35
36
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 34

def app_version
  @app_version
end

#country ⇒ Object

User’s country in ISO 3166 alpha-2 format



31
32
33
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 31

def country
  @country
end

#created_date ⇒ Object

Date the user was created, Unix epoch timestamp format



46
47
48
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 46

def created_date
  @created_date
end

#custom_data ⇒ Object

User’s custom data to target the user with, data will be logged to DevCycle for use in dashboard.



40
41
42
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 40

def custom_data
  @custom_data
end

#device_model ⇒ Object

User’s device model



58
59
60
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 58

def device_model
  @device_model
end

#email ⇒ Object

User’s email used to identify the user on the dashboard / target audiences



22
23
24
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 22

def email
  @email
end

#language ⇒ Object

User’s language in ISO 639-1 format



28
29
30
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 28

def language
  @language
end

#last_seen_date ⇒ Object

Date the user was created, Unix epoch timestamp format



49
50
51
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 49

def last_seen_date
  @last_seen_date
end

#name ⇒ Object

User’s name used to identify the user on the dashboard / target audiences



25
26
27
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 25

def name
  @name
end

#platform ⇒ Object

Platform the Client SDK is running on



52
53
54
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 52

def platform
  @platform
end

#platform_version ⇒ Object

Version of the platform the Client SDK is running on



55
56
57
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 55

def platform_version
  @platform_version
end

#private_custom_data ⇒ Object

User’s custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing.



43
44
45
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 43

def private_custom_data
  @private_custom_data
end

#sdk_type ⇒ Object

DevCycle SDK type



61
62
63
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 61

def sdk_type
  @sdk_type
end

#sdk_version ⇒ Object

DevCycle SDK Version



64
65
66
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 64

def sdk_version
  @sdk_version
end

#user_id ⇒ Object

Unique id to identify the user



19
20
21
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 19

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 111

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 89

def self.attribute_map
  {
    :'user_id' => :'user_id',
    :'email' => :'email',
    :'name' => :'name',
    :'language' => :'language',
    :'country' => :'country',
    :'app_version' => :'appVersion',
    :'app_build' => :'appBuild',
    :'custom_data' => :'customData',
    :'private_custom_data' => :'privateCustomData',
    :'created_date' => :'createdDate',
    :'last_seen_date' => :'lastSeenDate',
    :'platform' => :'platform',
    :'platform_version' => :'platformVersion',
    :'device_model' => :'deviceModel',
    :'sdk_type' => :'sdkType',
    :'sdk_version' => :'sdkVersion'
  }
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
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 138

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 116

def self.openapi_types
  {
    :'user_id' => :'String',
    :'email' => :'String',
    :'name' => :'String',
    :'language' => :'String',
    :'country' => :'String',
    :'app_version' => :'String',
    :'app_build' => :'String',
    :'custom_data' => :'Object',
    :'private_custom_data' => :'Object',
    :'created_date' => :'Float',
    :'last_seen_date' => :'Float',
    :'platform' => :'String',
    :'platform_version' => :'String',
    :'device_model' => :'String',
    :'sdk_type' => :'String',
    :'sdk_version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      email == o.email &&
      name == o.name &&
      language == o.language &&
      country == o.country &&
      app_version == o.app_version &&
      app_build == o.app_build &&
      custom_data == o.custom_data &&
      private_custom_data == o.private_custom_data &&
      created_date == o.created_date &&
      last_seen_date == o.last_seen_date &&
      platform == o.platform &&
      platform_version == o.platform_version &&
      device_model == o.device_model &&
      sdk_type == o.sdk_type &&
      sdk_version == o.sdk_version
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



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
390
391
392
393
394
395
396
397
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 360

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = DevCycle.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 431

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 337

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 323

def hash
  [user_id, email, name, language, country, app_version, app_build, custom_data, private_custom_data, created_date, last_seen_date, platform, platform_version, device_model, sdk_type, sdk_version].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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 234

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

  if !@language.nil? && @language.to_s.length > 2
    invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 2.')
  end

  if !@country.nil? && @country.to_s.length > 2
    invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
  end

  invalid_properties
end

#set_default_platform_info ⇒ Object 



225
226
227
228
229
230
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 225

def set_default_platform_info
  self.sdk_type = 'server'
  self.sdk_version = VERSION
  self.platform = 'ruby'
  self.platform_version = RUBY_VERSION
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



407
408
409
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 413

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



401
402
403
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 401

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



253
254
255
256
257
258
259
260
 
# File 'lib/devcycle-server-sdk/models/user_data.rb', line 253

def valid?
  return false if @user_id.nil?
  return false if !@language.nil? && @language.to_s.length > 2
  return false if !@country.nil? && @country.to_s.length > 2
  sdk_type_validator = EnumAttributeValidator.new('String', ["api", "server"])
  return false unless sdk_type_validator.valid?(@sdk_type)
  true
end