Class: SunshineConversationsClient::ConversationAllOf

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 73

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

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



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

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.



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

def created_at
  @created_at
end

#description ⇒ Object

A short text describing the conversation.



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

def description
  @description
end

#display_name ⇒ Object

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



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

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



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

def icon_url
  @icon_url
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.



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

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.



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

def last_updated_at
  @last_updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 36

def self.attribute_map
  {
    :'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



205
206
207
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 205

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
68
69
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 49

def self.openapi_types
  {
    :'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



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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



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
263
264
265
266
267
268
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 233

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 302

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 212

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


192
193
194
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 198

def hash
  [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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 117

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



278
279
280
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 278

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 284

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



272
273
274
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 272

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



140
141
142
143
144
145
146
 
# File 'lib/sunshine-conversations-client/models/conversation_all_of.rb', line 140

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