Class: SunshineConversationsClient::ConversationCreateBody

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationCreateBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
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
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 90

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

  if attributes.key?(:'participants')
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
  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?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end
end

Instance Attribute Details

#description ⇒ Object

A short text describing the conversation.



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

def description
  @description
end

#display_name ⇒ Object

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



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

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



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

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



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

def metadata
  @metadata
end

#participants ⇒ Object

The users participating in the conversation. For ‘personal` conversations, this field is required with a length of exactly 1. For `sdkGroup` conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is `sdkGroup`.



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

def participants
  @participants
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

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



289
290
291
292
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
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 289

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SunshineConversationsClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 55

def self.attribute_map
  {
    :'type' => :'type',
    :'participants' => :'participants',
    :'display_name' => :'displayName',
    :'description' => :'description',
    :'icon_url' => :'iconUrl',
    :'metadata' => :'metadata'
  }
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 265

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
83
84
85
86
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 67

def self.openapi_types
  {
    :'type' => :'ConversationType',
    :'participants' => :'Array<ParticipantSubSchema>',
    :'display_name' => :'String',
    :'description' => :'String',
    :'icon_url' => :'String',
    :'metadata' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      participants == o.participants &&
      display_name == o.display_name &&
      description == o.description &&
      icon_url == o.icon_url &&
      metadata == o.metadata
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



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

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.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_create_body.rb', line 258

def hash
  [typeparticipantsdisplay_namedescriptionicon_urlmetadata].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



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

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

  if !@participants.nil? && @participants.length > 10
    invalid_properties.push('invalid value for "participants", number of items must be less than or equal to 10.')
  end

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

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

  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



336
337
338
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 336

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



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

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



330
331
332
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 330

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



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/sunshine-conversations-client/models/conversation_create_body.rb', line 173

def valid?
  return false if @type.nil?
  return false if !@participants.nil? && @participants.length > 10
  return false if !@display_name.nil? && @display_name.to_s.length > 100
  return false if !@display_name.nil? && @display_name.to_s.length < 1
  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