Class: SunshineConversationsClient::Conversation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Conversation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 108

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_switchboard_integration ⇒ Object

The current switchboard integration that is in control of the conversation. This field is omitted if no ‘activeSwitchboardIntegration` exists for the conversation.



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

def active_switchboard_integration
  @active_switchboard_integration
end

#business_last_read ⇒ Object

A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business.



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

def business_last_read
  @business_last_read
end

#created_at ⇒ Object

A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the creation time of the conversation.



47
48
49
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 47

def created_at
  @created_at
end

#description ⇒ Object

A short text describing the conversation.



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

def description
  @description
end

#display_name ⇒ Object

A friendly name for the conversation, may be displayed to the business or the user.



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

def display_name
  @display_name
end

#icon_url ⇒ Object

A custom conversation icon url. The image must be in either JPG, PNG, or GIF format



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

def icon_url
  @icon_url
end

#id ⇒ Object

The unique ID of the conversation.



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

def id
  @id
end

#is_default ⇒ Object

Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases.



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

def is_default
  @is_default
end

#last_updated_at ⇒ Object

A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet.



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

def last_updated_at
  @last_updated_at
end

#metadata ⇒ Object

Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.



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

def metadata
  @metadata
end

#pending_switchboard_integration ⇒ Object

The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control.



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

def pending_switchboard_integration
  @pending_switchboard_integration
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 50

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'metadata' => :'metadata',
    :'active_switchboard_integration' => :'activeSwitchboardIntegration',
    :'pending_switchboard_integration' => :'pendingSwitchboardIntegration',
    :'is_default' => :'isDefault',
    :'display_name' => :'displayName',
    :'description' => :'description',
    :'icon_url' => :'iconUrl',
    :'business_last_read' => :'businessLastRead',
    :'last_updated_at' => :'lastUpdatedAt',
    :'created_at' => :'createdAt'
  }
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



265
266
267
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 265

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'ConversationAllOf',
  :'ConversationTruncated'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
    :'metadata',
    :'active_switchboard_integration',
    :'pending_switchboard_integration',
    :'description',
    :'icon_url',
    :'business_last_read',
    :'last_updated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'ConversationType',
    :'metadata' => :'Object',
    :'active_switchboard_integration' => :'SwitchboardIntegrationWebhook',
    :'pending_switchboard_integration' => :'SwitchboardIntegrationWebhook',
    :'is_default' => :'Boolean',
    :'display_name' => :'String',
    :'description' => :'String',
    :'icon_url' => :'String',
    :'business_last_read' => :'String',
    :'last_updated_at' => :'String',
    :'created_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      metadata == o.metadata &&
      active_switchboard_integration == o.active_switchboard_integration &&
      pending_switchboard_integration == o.pending_switchboard_integration &&
      is_default == o.is_default &&
      display_name == o.display_name &&
      description == o.description &&
      icon_url == o.icon_url &&
      business_last_read == o.business_last_read &&
      last_updated_at == o.last_updated_at &&
      created_at == o.created_at
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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 293

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 362

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 272

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


252
253
254
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 258

def hash
  [id, type, metadata, active_switchboard_integration, pending_switchboard_integration, is_default, display_name, description, icon_url, business_last_read, last_updated_at, created_at].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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 100
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
  end

  if !@description.nil? && @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end

  if !@icon_url.nil? && @icon_url.to_s.length > 2048
    invalid_properties.push('invalid value for "icon_url", the character length must be smaller than or equal to 2048.')
  end

  if !@icon_url.nil? && @icon_url.to_s.length < 1
    invalid_properties.push('invalid value for "icon_url", the character length must be great than or equal to 1.')
  end

  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



338
339
340
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 344

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



332
333
334
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 332

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



195
196
197
198
199
200
201
 
# File 'lib/sunshine-conversations-client/models/conversation.rb', line 195

def valid?
  return false if !@description.nil? && @description.to_s.length > 100
  return false if !@description.nil? && @description.to_s.length < 1
  return false if !@icon_url.nil? && @icon_url.to_s.length > 2048
  return false if !@icon_url.nil? && @icon_url.to_s.length < 1
  true
end