Class: DevCycle::UserData

Inherits:
Object
  • Object
show all
Defined in:
lib/devcycle-ruby-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



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

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
  }

  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?(:'appVersion')
    self.appVersion = attributes[:'appVersion']
  end

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

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

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

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

  # set read-only instance variables
  default_platform_data = PlatformData.new.default
  @sdkType = default_platform_data.sdkType
  @sdkVersion = default_platform_data.sdkVersion
  @platform = default_platform_data.platform
  @platformVersion = default_platform_data.platformVersion
  @createdDate = Time.now.utc.iso8601
  @lastSeenDate = Time.now.utc.iso8601
end

Instance Attribute Details

#appBuild ⇒ Object

App Build number of the running application



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

def appBuild
  @appBuild
end

#appVersion ⇒ Object

App Version of the running application



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

def appVersion
  @appVersion
end

#country ⇒ Object

User’s country in ISO 3166 alpha-2 format



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

def country
  @country
end

#createdDate ⇒ Object (readonly)

Date the user was created, Unix epoch timestamp format



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

def createdDate
  @createdDate
end

#customData ⇒ Object

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



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

def customData
  @customData
end

#deviceModel ⇒ Object

User’s device model



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

def deviceModel
  @deviceModel
end

#email ⇒ Object

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



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

def email
  @email
end

#language ⇒ Object

User’s language in ISO 639-1 format



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

def language
  @language
end

#lastSeenDate ⇒ Object (readonly)

Date the user was created, Unix epoch timestamp format



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

def lastSeenDate
  @lastSeenDate
end

#name ⇒ Object

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



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

def name
  @name
end

#platform ⇒ Object (readonly)

Platform the Client SDK is running on



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

def platform
  @platform
end

#platformVersion ⇒ Object (readonly)

Version of the platform the Client SDK is running on



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

def platformVersion
  @platformVersion
end

#privateCustomData ⇒ Object

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



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

def privateCustomData
  @privateCustomData
end

#sdkType ⇒ Object (readonly)

DevCycle SDK type



68
69
70
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 68

def sdkType
  @sdkType
end

#sdkVersion ⇒ Object (readonly)

DevCycle SDK Version



71
72
73
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 71

def sdkVersion
  @sdkVersion
end

#user_id ⇒ Object

Unique id to identify the user



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

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



118
119
120
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 118

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 96

def self.attribute_map
  {
    :'user_id' => :'user_id',
    :'email' => :'email',
    :'name' => :'name',
    :'language' => :'language',
    :'country' => :'country',
    :'appVersion' => :'appVersion',
    :'appBuild' => :'appBuild',
    :'customData' => :'customData',
    :'privateCustomData' => :'privateCustomData',
    :'createdDate' => :'createdDate',
    :'lastSeenDate' => :'lastSeenDate',
    :'platform' => :'platform',
    :'platformVersion' => :'platformVersion',
    :'deviceModel' => :'deviceModel',
    :'sdkType' => :'sdkType',
    :'sdkVersion' => :'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



302
303
304
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 302

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



145
146
147
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 145

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

.openapi_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 123

def self.openapi_types
  {
    :'user_id' => :'String',
    :'email' => :'String',
    :'name' => :'String',
    :'language' => :'String',
    :'country' => :'String',
    :'appVersion' => :'String',
    :'appBuild' => :'String',
    :'customData' => :'Object',
    :'privateCustomData' => :'Object',
    :'createdDate' => :'Float',
    :'lastSeenDate' => :'Float',
    :'platform' => :'String',
    :'platformVersion' => :'String',
    :'deviceModel' => :'String',
    :'sdkType' => :'String',
    :'sdkVersion' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 266

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 &&
    appVersion == o.appVersion &&
    appBuild == o.appBuild &&
    customData == o.customData &&
    privateCustomData == o.privateCustomData &&
    createdDate == o.createdDate &&
    lastSeenDate == o.lastSeenDate &&
    platform == o.platform &&
    platformVersion == o.platformVersion &&
    deviceModel == o.deviceModel &&
    sdkType == o.sdkType &&
    sdkVersion == o.sdkVersion
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 332

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



404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 404

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 309

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


289
290
291
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



295
296
297
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 295

def hash
  [user_id, email, name, language, country, appVersion, appBuild, customData, privateCustomData, createdDate, lastSeenDate, platform, platformVersion, deviceModel, sdkType, sdkVersion].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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 216

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



380
381
382
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 380

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 386

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_json ⇒ Object 



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

def to_json
  Oj.dump(self)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



374
375
376
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 374

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



235
236
237
238
239
240
241
242
 
# File 'lib/devcycle-ruby-server-sdk/models/user_data.rb', line 235

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