class SmoochApi::AppUser

Attributes

clients[RW]

List of clients associated with the app user.

conversationStarted[RW]

Flag indicating if the conversation has started for the app user.

email[RW]

The app user's email.

givenName[RW]

The app user's given name.

id[RW]

The app user's ID, generated automatically.

pendingClients[RW]

As clients, but containing linked clients which have not been confirmed yet (i.e. Twilio SMS).

properties[RW]

Custom properties for the app user.

signedUpAt[RW]

A datetime string with the format yyyy-mm-ddThh:mm:ssZ representing the moment an appUser was created.

surname[RW]

The app user's surname.

userId[RW]

The app user's userId. This ID is specified by the appMaker.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 50
def self.attribute_map
  {
    :'id' => :'_id',
    :'userId' => :'userId',
    :'givenName' => :'givenName',
    :'surname' => :'surname',
    :'email' => :'email',
    :'signedUpAt' => :'signedUpAt',
    :'properties' => :'properties',
    :'conversationStarted' => :'conversationStarted',
    :'clients' => :'clients',
    :'pendingClients' => :'pendingClients'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 83
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'_id')
    self.id = attributes[:'_id']
  end

  if attributes.has_key?(:'userId')
    self.userId = attributes[:'userId']
  end

  if attributes.has_key?(:'givenName')
    self.givenName = attributes[:'givenName']
  end

  if attributes.has_key?(:'surname')
    self.surname = attributes[:'surname']
  end

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

  if attributes.has_key?(:'signedUpAt')
    self.signedUpAt = attributes[:'signedUpAt']
  end

  if attributes.has_key?(:'properties')
    self.properties = attributes[:'properties']
  end

  if attributes.has_key?(:'conversationStarted')
    self.conversationStarted = attributes[:'conversationStarted']
  end

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/smooch-api/models/app_user.rb, line 66
def self.swagger_types
  {
    :'id' => :'String',
    :'userId' => :'String',
    :'givenName' => :'String',
    :'surname' => :'String',
    :'email' => :'String',
    :'signedUpAt' => :'String',
    :'properties' => :'Object',
    :'conversationStarted' => :'BOOLEAN',
    :'clients' => :'Array<Client>',
    :'pendingClients' => :'Array<Client>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 165
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      userId == o.userId &&
      givenName == o.givenName &&
      surname == o.surname &&
      email == o.email &&
      signedUpAt == o.signedUpAt &&
      properties == o.properties &&
      conversationStarted == o.conversationStarted &&
      clients == o.clients &&
      pendingClients == o.pendingClients
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/smooch-api/models/app_user.rb, line 216
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
    temp_model = SmoochApi.const_get(type).new
    temp_model.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/smooch-api/models/app_user.rb, line 282
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/smooch-api/models/app_user.rb, line 195
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 182
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 188
def hash
  [id, userId, givenName, surname, email, signedUpAt, properties, conversationStarted, clients, pendingClients].hash
end
list_invalid_properties() click to toggle source

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

# File lib/smooch-api/models/app_user.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

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

  return invalid_properties
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/smooch-api/models/app_user.rb, line 262
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/smooch-api/models/app_user.rb, line 268
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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/smooch-api/models/app_user.rb, line 256
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/smooch-api/models/app_user.rb, line 156
def valid?
  return false if @id.nil?
  return false if @properties.nil?
  return false if @conversationStarted.nil?
  return true
end