Class: SunshineConversationsClient::Field

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Field

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
114
115
116
117
118
119
120
121
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 86

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

Specifies the response for a email field.



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

def email
  @email
end

#label ⇒ Object

The label of the field. What the field is displayed as on Web Messenger.



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

def label
  @label
end

#name ⇒ Object

The name of the field. Must be unique per form or formResponse.



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

def name
  @name
end

#select ⇒ Object

Array of objects representing the response for a field of type select. Form and formResponse messages only.



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

def select
  @select
end

#text ⇒ Object

Specifies the response for a text field.



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

def text
  @text
end

#type ⇒ Object

The field type.



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

def type
  @type
end

Class Method Details

.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/field.rb', line 55

def self.attribute_map
  {
    :'type' => :'type',
    :'name' => :'name',
    :'label' => :'label',
    :'text' => :'text',
    :'email' => :'email',
    :'select' => :'select'
  }
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/field.rb', line 295

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'type' => :'String',
    :'name' => :'String',
    :'label' => :'String',
    :'text' => :'String',
    :'email' => :'String',
    :'select' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      name == o.name &&
      label == o.label &&
      text == o.text &&
      email == o.email &&
      select == o.select
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/field.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/field.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/field.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/field.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/field.rb', line 288

def hash
  [type, name, label, text, email, select].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



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
169
170
171
172
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 125

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

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

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

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

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

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

  if !@email.nil? && @email.to_s.length < 1
    invalid_properties.push('invalid value for "email", 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



368
369
370
 
# File 'lib/sunshine-conversations-client/models/field.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/field.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/field.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



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

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["email", "select", "text"])
  return false unless type_validator.valid?(@type)
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if @name.to_s.length < 1
  return false if @label.nil?
  return false if @label.to_s.length > 128
  return false if @label.to_s.length < 1
  return false if !@text.nil? && @text.to_s.length > 256
  return false if !@text.nil? && @text.to_s.length < 1
  return false if !@email.nil? && @email.to_s.length > 128
  return false if !@email.nil? && @email.to_s.length < 1
  true
end