Class: SmoochApi::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/smooch-api/models/client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Client

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/smooch-api/models/client.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#active ⇒ Object

Deprecated - use the status property instead.



28
29
30
 
# File 'lib/smooch-api/models/client.rb', line 28

def active
  @active
end

#appVersion ⇒ Object

A reserved string field for reporting the app version running on the device.



43
44
45
 
# File 'lib/smooch-api/models/client.rb', line 43

def appVersion
  @appVersion
end

#displayName ⇒ Object

The client’s display name.



46
47
48
 
# File 'lib/smooch-api/models/client.rb', line 46

def displayName
  @displayName
end

#externalId ⇒ Object

The ID of the user on an external channel. For example, the user’s phone number for Twilio, or their page-scoped user ID for Facebook Messenger. Applies only to non-SDK clients.



25
26
27
 
# File 'lib/smooch-api/models/client.rb', line 25

def externalId
  @externalId
end

#id ⇒ Object

An identifier for the client. Must be globally unique.



19
20
21
 
# File 'lib/smooch-api/models/client.rb', line 19

def id
  @id
end

#info ⇒ Object

Returns the value of attribute info.



48
49
50
 
# File 'lib/smooch-api/models/client.rb', line 48

def info
  @info
end

#integrationId ⇒ Object

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



37
38
39
 
# File 'lib/smooch-api/models/client.rb', line 37

def integrationId
  @integrationId
end

#lastSeen ⇒ Object

The date time the client was last seen.



31
32
33
 
# File 'lib/smooch-api/models/client.rb', line 31

def lastSeen
  @lastSeen
end

#platform ⇒ Object

The client’s platform. See [IntegrationTypeEnum](Enums.md#IntegrationTypeEnum) for available values.



34
35
36
 
# File 'lib/smooch-api/models/client.rb', line 34

def platform
  @platform
end

#pushNotificationToken ⇒ Object

The GCM or APN token to be used for sending push notifications to the device. Applies to only android and ios clients.



40
41
42
 
# File 'lib/smooch-api/models/client.rb', line 40

def pushNotificationToken
  @pushNotificationToken
end

#raw ⇒ Object

An Object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available.



51
52
53
 
# File 'lib/smooch-api/models/client.rb', line 51

def raw
  @raw
end

#status ⇒ Object

The client status. Indicates if the client is able to receive messages or not. See [ClientStatusEnum](Enums.md#ClientStatusEnum) for available values.



22
23
24
 
# File 'lib/smooch-api/models/client.rb', line 22

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/smooch-api/models/client.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'status' => :'status',
    :'externalId' => :'externalId',
    :'active' => :'active',
    :'lastSeen' => :'lastSeen',
    :'platform' => :'platform',
    :'integrationId' => :'integrationId',
    :'pushNotificationToken' => :'pushNotificationToken',
    :'appVersion' => :'appVersion',
    :'displayName' => :'displayName',
    :'info' => :'info',
    :'raw' => :'raw'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/smooch-api/models/client.rb', line 73

def self.swagger_types
  {
    :'id' => :'String',
    :'status' => :'String',
    :'externalId' => :'String',
    :'active' => :'BOOLEAN',
    :'lastSeen' => :'String',
    :'platform' => :'String',
    :'integrationId' => :'String',
    :'pushNotificationToken' => :'String',
    :'appVersion' => :'String',
    :'displayName' => :'String',
    :'info' => :'ClientInfo',
    :'raw' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/smooch-api/models/client.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      status == o.status &&
      externalId == o.externalId &&
      active == o.active &&
      lastSeen == o.lastSeen &&
      platform == o.platform &&
      integrationId == o.integrationId &&
      pushNotificationToken == o.pushNotificationToken &&
      appVersion == o.appVersion &&
      displayName == o.displayName &&
      info == o.info &&
      raw == o.raw
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/smooch-api/models/client.rb', line 226

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) ⇒ 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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/smooch-api/models/client.rb', line 292

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/smooch-api/models/client.rb', line 205

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


192
193
194
 
# File 'lib/smooch-api/models/client.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/smooch-api/models/client.rb', line 198

def hash
  [id, status, externalId, active, lastSeen, platform, integrationId, pushNotificationToken, appVersion, displayName, info, raw].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/smooch-api/models/client.rb', line 150

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

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

  return 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



272
273
274
 
# File 'lib/smooch-api/models/client.rb', line 272

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



278
279
280
281
282
283
284
285
286
 
# File 'lib/smooch-api/models/client.rb', line 278

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



266
267
268
 
# File 'lib/smooch-api/models/client.rb', line 266

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



165
166
167
168
169
 
# File 'lib/smooch-api/models/client.rb', line 165

def valid?
  return false if @id.nil?
  return false if @platform.nil?
  return true
end