Class: SunshineConversationsClient::Client

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 118

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Client` 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::Client`. 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?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'integration_id')
    self.integration_id = attributes[:'integration_id']
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.key?(:'last_seen')
    self.last_seen = attributes[:'last_seen']
  end

  if attributes.key?(:'linked_at')
    self.linked_at = attributes[:'linked_at']
  end

  if attributes.key?(:'display_name')
    self.display_name = attributes[:'display_name']
  end

  if attributes.key?(:'avatar_url')
    self.avatar_url = attributes[:'avatar_url']
  end

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

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

Instance Attribute Details

#avatar_url ⇒ Object

The URL for the user’s avatar on the channel.



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

def avatar_url
  @avatar_url
end

#display_name ⇒ Object

The user’s display name on the channel.



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

def display_name
  @display_name
end

#external_id ⇒ 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.



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

def external_id
  @external_id
end

#id ⇒ Object

The unique ID of the client.



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

def id
  @id
end

#info ⇒ Object

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



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

def info
  @info
end

#integration_id ⇒ Object

The ID of the integration that the client was created for. Unused for clients of type sdk, as they incorporate multiple integrations.



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

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 client.



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

def last_seen
  @last_seen
end

#linked_at ⇒ Object

A timestamp signifying when the client was added to the user. Formatted as ‘YYYY-MM-DDThh:mm:ss.SSSZ`.



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

def linked_at
  @linked_at
end

#raw ⇒ Object

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



44
45
46
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 44

def raw
  @raw
end

#status ⇒ Object

The client status. Indicates if the client is able to receive messages or not. Can be pending, inactive, active, or blocked.



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

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'status' => :'status',
    :'integration_id' => :'integrationId',
    :'external_id' => :'externalId',
    :'last_seen' => :'lastSeen',
    :'linked_at' => :'linkedAt',
    :'display_name' => :'displayName',
    :'avatar_url' => :'avatarUrl',
    :'info' => :'info',
    :'raw' => :'raw'
  }
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



234
235
236
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 234

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 103

def self.openapi_nullable
  Set.new([
    :'integration_id',
    :'external_id',
    :'last_seen',
    :'linked_at',
    :'display_name',
    :'avatar_url',
    :'info',
    :'raw'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'ClientType',
    :'status' => :'String',
    :'integration_id' => :'String',
    :'external_id' => :'String',
    :'last_seen' => :'String',
    :'linked_at' => :'String',
    :'display_name' => :'String',
    :'avatar_url' => :'String',
    :'info' => :'Object',
    :'raw' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      status == o.status &&
      integration_id == o.integration_id &&
      external_id == o.external_id &&
      last_seen == o.last_seen &&
      linked_at == o.linked_at &&
      display_name == o.display_name &&
      avatar_url == o.avatar_url &&
      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



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
296
297
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 262

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 331

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 241

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


221
222
223
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 227

def hash
  [id, type, status, integration_id, external_id, last_seen, linked_at, display_name, avatar_url, info, raw].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



178
179
180
181
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 178

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



307
308
309
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 313

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



301
302
303
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 301

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



185
186
187
188
189
 
# File 'lib/sunshine-conversations-client/models/client.rb', line 185

def valid?
  status_validator = EnumAttributeValidator.new('String', ["active", "blocked", "inactive", "pending"])
  return false unless status_validator.valid?(@status)
  true
end