Class: SunshineConversationsClient::Field

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

Overview

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

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



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 107

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?(:'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?(:'text')
    self.text = attributes[:'text']
  end

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

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

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

Instance Attribute Details

#email ⇒ Object

Specifies the response for a email field.



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

def email
  @email
end

#label ⇒ Object

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



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

def label
  @label
end

#max_size ⇒ Object

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



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

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.



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

def min_size
  @min_size
end

#name ⇒ Object

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



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

def name
  @name
end

#options ⇒ Object

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



43
44
45
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 43

def options
  @options
end

#placeholder ⇒ Object

Placeholder text for the field. Form message only.



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

def placeholder
  @placeholder
end

#select ⇒ Object

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



40
41
42
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 40

def select
  @select
end

#text ⇒ Object

Specifies the response for a text field.



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

def text
  @text
end

#type ⇒ Object

The field type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'type' => :'type',
    :'name' => :'name',
    :'label' => :'label',
    :'placeholder' => :'placeholder',
    :'min_size' => :'minSize',
    :'max_size' => :'maxSize',
    :'text' => :'text',
    :'email' => :'email',
    :'select' => :'select',
    :'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



411
412
413
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 411

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 84

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 381

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      name == o.name &&
      label == o.label &&
      placeholder == o.placeholder &&
      min_size == o.min_size &&
      max_size == o.max_size &&
      text == o.text &&
      email == o.email &&
      select == o.select &&
      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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 439

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



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 508

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 418

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


398
399
400
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 398

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



404
405
406
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 404

def hash
  [type, name, label, placeholder, min_size, max_size, text, email, select, 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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 165

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 !@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 > 128
    invalid_properties.push('invalid value for "min_size", must be smaller than or equal to 128.')
  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 > 128
    invalid_properties.push('invalid value for "max_size", must be smaller than or equal to 128.')
  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

  if !@text.nil? && @text.to_s.length > 128
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 128.')
  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



484
485
486
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 484

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



490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 490

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



478
479
480
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 478

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/sunshine-conversations-client/models/field.rb', line 240

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 !@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 > 128
  return false if !@min_size.nil? && @min_size < 1
  return false if !@max_size.nil? && @max_size > 128
  return false if !@max_size.nil? && @max_size < 1
  return false if !@text.nil? && @text.to_s.length > 128
  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