class SunshineConversationsClient::Device
Attributes
Version of the mobile app in which the SDK is embedded. Not applicable for devices of type web.
The id of the client to which this device is associated.
A unique identifier for the device, generated client-side by the SDK.
The unique ID of the device.
A flat curated object with properties that vary for each SDK platform. All keys are optional and not guaranteed to be available.
The ID of the integration that the device was created for.
A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the last time the user interacted with this device.
The token used for push notifications on Android
and iOS devices.
The device status. Indicates if the device will receive push notifications or not.
The type of integration that the device represents.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/device.rb, line 67 def self.attribute_map { :'id' => :'id', :'type' => :'type', :'guid' => :'guid', :'client_id' => :'clientId', :'status' => :'status', :'integration_id' => :'integrationId', :'last_seen' => :'lastSeen', :'push_notification_token' => :'pushNotificationToken', :'info' => :'info', :'app_version' => :'appVersion' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/device.rb, line 232 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/device.rb, line 109 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Device` 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 `SunshineConversationsClient::Device`. 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?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'guid') self.guid = attributes[:'guid'] end if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'integration_id') self.integration_id = attributes[:'integration_id'] end if attributes.key?(:'last_seen') self.last_seen = attributes[:'last_seen'] end if attributes.key?(:'push_notification_token') self.push_notification_token = attributes[:'push_notification_token'] end if attributes.key?(:'info') self.info = attributes[:'info'] end if attributes.key?(:'app_version') self.app_version = attributes[:'app_version'] end end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/device.rb, line 99 def self.openapi_nullable Set.new([ :'push_notification_token', :'info', :'app_version' ]) end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/device.rb, line 83 def self.openapi_types { :'id' => :'String', :'type' => :'String', :'guid' => :'String', :'client_id' => :'String', :'status' => :'String', :'integration_id' => :'String', :'last_seen' => :'String', :'push_notification_token' => :'String', :'info' => :'Object', :'app_version' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/device.rb, line 202 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && type == o.type && guid == o.guid && client_id == o.client_id && status == o.status && integration_id == o.integration_id && last_seen == o.last_seen && push_notification_token == o.push_notification_token && info == o.info && app_version == o.app_version end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/sunshine-conversations-client/models/device.rb, line 260 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 SunshineConversationsClient.const_get(type).build_from_hash(value) end end
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/sunshine-conversations-client/models/device.rb, line 329 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/device.rb, line 239 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]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/device.rb, line 219 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/device.rb, line 225 def hash [id, type, guid, client_id, status, integration_id, last_seen, push_notification_token, info, app_version].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sunshine-conversations-client/models/device.rb, line 165 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom
attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/sunshine-conversations-client/models/device.rb, line 192 def status=(status) validator = EnumAttributeValidator.new('String', ["active", "inactive"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/device.rb, line 311 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/device.rb, line 299 def to_s to_hash.to_s end
Custom
attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/sunshine-conversations-client/models/device.rb, line 182 def type=(type) validator = EnumAttributeValidator.new('String', ["android", "ios", "web"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/sunshine-conversations-client/models/device.rb, line 172 def valid? type_validator = EnumAttributeValidator.new('String', ["android", "ios", "web"]) return false unless type_validator.valid?(@type) status_validator = EnumAttributeValidator.new('String', ["active", "inactive"]) return false unless status_validator.valid?(@status) true end