Class: SunshineConversationsClient::Item

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.key?(:'actions')
  end

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

Instance Attribute Details

#actions ⇒ Object

An array of objects representing the actions associated with the item.



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

def actions
  @actions
end

#alt_text ⇒ Object

An optional description of the media for accessibility purposes. The field will be saved by default with the file name as the value.



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

def alt_text
  @alt_text
end

#description ⇒ Object

The description of the item.



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

def description
  @description
end

#media_type ⇒ Object

The MIME type for any image attached in the mediaUrl.



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

def media_type
  @media_type
end

#media_url ⇒ Object

The image url attached to the item.



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

def media_url
  @media_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.



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

def metadata
  @metadata
end

#size ⇒ Object

The size of the image.



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

def size
  @size
end

#title ⇒ Object

The title of the item.



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

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 61

def self.attribute_map
  {
    :'title' => :'title',
    :'description' => :'description',
    :'media_url' => :'mediaUrl',
    :'media_type' => :'mediaType',
    :'alt_text' => :'altText',
    :'size' => :'size',
    :'actions' => :'actions',
    :'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



295
296
297
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 295

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 89

def self.openapi_nullable
  Set.new([
    :'metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 75

def self.openapi_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'media_url' => :'String',
    :'media_type' => :'String',
    :'alt_text' => :'String',
    :'size' => :'String',
    :'actions' => :'Array<ActionSubset>',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      media_url == o.media_url &&
      media_type == o.media_type &&
      alt_text == o.alt_text &&
      size == o.size &&
      actions == o.actions &&
      metadata == o.metadata
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 323

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 392

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



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

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


282
283
284
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



288
289
290
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 288

def hash
  [title, description, media_url, media_type, alt_text, size, actions, metadata].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



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
175
176
177
178
179
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 144

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

  if @title.to_s.length > 128
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 128.')
  end

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

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

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

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

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

  if @actions.nil?
    invalid_properties.push('invalid value for "actions", actions cannot be nil.')
  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



368
369
370
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 368

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 374

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



362
363
364
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 362

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



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/sunshine-conversations-client/models/item.rb', line 183

def valid?
  return false if @title.nil?
  return false if @title.to_s.length > 128
  return false if @title.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length > 128
  return false if !@media_url.nil? && @media_url.to_s.length > 2048
  return false if !@media_type.nil? && @media_type.to_s.length > 128
  return false if !@alt_text.nil? && @alt_text.to_s.length > 128
  size_validator = EnumAttributeValidator.new('String', ["compact", "large"])
  return false unless size_validator.valid?(@size)
  return false if @actions.nil?
  true
end