Class: SunshineConversationsClient::FormMessageFieldAllOf

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

Overview

Properties that can be expected to receive inside a form message field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormMessageFieldAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 55

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

  if attributes.key?(:'min_size')
    self.min_size = attributes[:'min_size']
  else
    self.min_size = 1
  end

  if attributes.key?(:'max_size')
    self.max_size = attributes[:'max_size']
  else
    self.max_size = 128
  end

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

Instance Attribute Details

#max_size ⇒ Object

The maximum allowed length for the response for a field of type text. Form message only.



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

def max_size
  @max_size
end

#min_size ⇒ Object

The minimum allowed length for the response for a field of type text. Form message only.



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

def min_size
  @min_size
end

#options ⇒ Object

Array of objects representing options for a field of type select.



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

def options
  @options
end

#placeholder ⇒ Object

Placeholder text for the field. Form message only.



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

def placeholder
  @placeholder
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 28

def self.attribute_map
  {
    :'placeholder' => :'placeholder',
    :'min_size' => :'minSize',
    :'max_size' => :'maxSize',
    :'options' => :'options'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
51
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 48

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'placeholder' => :'String',
    :'min_size' => :'Integer',
    :'max_size' => :'Integer',
    :'options' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



227
228
229
230
231
232
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
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 227

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 296

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 206

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [placeholder, min_size, max_size, options].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



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

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

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

  if !@min_size.nil? && @min_size > 256
    invalid_properties.push('invalid value for "min_size", must be smaller than or equal to 256.')
  end

  if !@min_size.nil? && @min_size < 1
    invalid_properties.push('invalid value for "min_size", must be greater than or equal to 1.')
  end

  if !@max_size.nil? && @max_size > 256
    invalid_properties.push('invalid value for "max_size", must be smaller than or equal to 256.')
  end

  if !@max_size.nil? && @max_size < 1
    invalid_properties.push('invalid value for "max_size", must be greater 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



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

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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 278

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



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

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



121
122
123
124
125
126
127
128
129
 
# File 'lib/sunshine-conversations-client/models/form_message_field_all_of.rb', line 121

def valid?
  return false if !@placeholder.nil? && @placeholder.to_s.length > 128
  return false if !@placeholder.nil? && @placeholder.to_s.length < 1
  return false if !@min_size.nil? && @min_size > 256
  return false if !@min_size.nil? && @min_size < 1
  return false if !@max_size.nil? && @max_size > 256
  return false if !@max_size.nil? && @max_size < 1
  true
end