class DevCycle::UserData

Attributes

app_build[RW]

App Build number of the running application

app_version[RW]

App Version of the running application

country[RW]

User’s country in ISO 3166 alpha-2 format

created_date[RW]

Date the user was created, Unix epoch timestamp format

custom_data[RW]

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

device_model[RW]

User’s device model

email[RW]

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

language[RW]

User’s language in ISO 639-1 format

last_seen_date[RW]

Date the user was created, Unix epoch timestamp format

name[RW]

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

platform[RW]

Platform the Client SDK is running on

platform_version[RW]

Version of the platform the Client SDK is running on

private_custom_data[RW]

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

sdk_type[RW]

DevCycle SDK type

sdk_version[RW]

DevCycle SDK Version

user_id[RW]

Unique id to identify the user

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/ruby-server-sdk/models/user_data.rb, line 111
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/ruby-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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ruby-server-sdk/models/user_data.rb, line 330
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ruby-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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/ruby-server-sdk/models/user_data.rb, line 138
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/ruby-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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ruby-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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ruby-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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ruby-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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ruby-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
country=(country) click to toggle source

Custom attribute writer method with validation @param [Object] country Value to be assigned

# File lib/ruby-server-sdk/models/user_data.rb, line 274
def country=(country)
  if !country.nil? && country.to_s.length > 2
    fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
  end

  @country = country
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/ruby-server-sdk/models/user_data.rb, line 317
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/ruby-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
language=(language) click to toggle source

Custom attribute writer method with validation @param [Object] language Value to be assigned

# File lib/ruby-server-sdk/models/user_data.rb, line 264
def language=(language)
  if !language.nil? && language.to_s.length > 2
    fail ArgumentError, 'invalid value for "language", the character length must be smaller than or equal to 2.'
  end

  @language = language
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ruby-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
sdk_type=(sdk_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] sdk_type Object to be assigned

# File lib/ruby-server-sdk/models/user_data.rb, line 284
def sdk_type=(sdk_type)
  validator = EnumAttributeValidator.new('String', ["api", "server"])
  unless validator.valid?(sdk_type)
    fail ArgumentError, "invalid value for \"sdk_type\", must be one of #{validator.allowable_values}."
  end
  @sdk_type = sdk_type
end
set_default_platform_info() click to toggle source
# File lib/ruby-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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ruby-server-sdk/models/user_data.rb, line 407
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ruby-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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ruby-server-sdk/models/user_data.rb, line 401
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ruby-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