Class: SunshineConversationsClient::Device

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/device.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Device

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# 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

Instance Attribute Details

#app_version ⇒ Object

Version of the mobile app in which the SDK is embedded. Not applicable for devices of type web.



42
43
44
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 42

def app_version
  @app_version
end

#client_id ⇒ Object

The id of the client to which this device is associated.



24
25
26
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 24

def client_id
  @client_id
end

#guid ⇒ Object

A unique identifier for the device, generated client-side by the SDK.



21
22
23
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 21

def guid
  @guid
end

#id ⇒ Object

The unique ID of the device.



15
16
17
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 15

def id
  @id
end

#info ⇒ Object

A flat curated object with properties that vary for each SDK platform. All keys are optional and not guaranteed to be available.



39
40
41
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 39

def info
  @info
end

#integration_id ⇒ Object

The ID of the integration that the device was created for.



30
31
32
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 30

def integration_id
  @integration_id
end

#last_seen ⇒ Object

A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the last time the user interacted with this device.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 33

def last_seen
  @last_seen
end

#push_notification_token ⇒ Object

The token used for push notifications on Android and iOS devices.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 36

def push_notification_token
  @push_notification_token
end

#status ⇒ Object

The device status. Indicates if the device will receive push notifications or not.



27
28
29
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 27

def status
  @status
end

#type ⇒ Object

The type of integration that the device represents.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# 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

.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



232
233
234
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 232

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 99

def self.openapi_nullable
  Set.new([
    :'push_notification_token',
    :'info',
    :'app_version'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# 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

#_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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# 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

#_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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# 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

#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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


219
220
221
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# 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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



165
166
167
168
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  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



305
306
307
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



299
300
301
 
# File 'lib/sunshine-conversations-client/models/device.rb', line 299

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



172
173
174
175
176
177
178
 
# 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