Class: ConnectWise::ConfigurationTypeQuestion

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/configuration_type_question.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationTypeQuestion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
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
122
123
124
125
126
127
128
129
130
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 84

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'configurationType')
    self.configuration_type = attributes[:'configurationType']
  end

  if attributes.has_key?(:'fieldType')
    self.field_type = attributes[:'fieldType']
  end

  if attributes.has_key?(:'entryType')
    self.entry_type = attributes[:'entryType']
  end

  if attributes.has_key?(:'sequenceNumber')
    self.sequence_number = attributes[:'sequenceNumber']
  end

  if attributes.has_key?(:'question')
    self.question = attributes[:'question']
  end

  if attributes.has_key?(:'numberOfDecimals')
    self.number_of_decimals = attributes[:'numberOfDecimals']
  end

  if attributes.has_key?(:'requiredFlag')
    self.required_flag = attributes[:'requiredFlag']
  end

  if attributes.has_key?(:'inactiveFlag')
    self.inactive_flag = attributes[:'inactiveFlag']
  end

  if attributes.has_key?(:'_info')
    self._info = attributes[:'_info']
  end

end

Instance Attribute Details

#_infoObject

Metadata of the entity



26
27
28
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 26

def _info
  @_info
end

#configuration_typeObject

Returns the value of attribute configuration_type.



9
10
11
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 9

def configuration_type
  @configuration_type
end

#entry_typeObject

Returns the value of attribute entry_type.



13
14
15
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 13

def entry_type
  @entry_type
end

#field_typeObject

Returns the value of attribute field_type.



11
12
13
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 11

def field_type
  @field_type
end

#idObject

Returns the value of attribute id.



7
8
9
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 7

def id
  @id
end

#inactive_flagObject

Returns the value of attribute inactive_flag.



23
24
25
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 23

def inactive_flag
  @inactive_flag
end

#number_of_decimalsObject

Returns the value of attribute number_of_decimals.



19
20
21
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 19

def number_of_decimals
  @number_of_decimals
end

#questionObject

Returns the value of attribute question.



17
18
19
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 17

def question
  @question
end

#required_flagObject

Returns the value of attribute required_flag.



21
22
23
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 21

def required_flag
  @required_flag
end

#sequence_numberObject

Returns the value of attribute sequence_number.



15
16
17
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 15

def sequence_number
  @sequence_number
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 51

def self.attribute_map
  {
    :'id' => :'id',
    :'configuration_type' => :'configurationType',
    :'field_type' => :'fieldType',
    :'entry_type' => :'entryType',
    :'sequence_number' => :'sequenceNumber',
    :'question' => :'question',
    :'number_of_decimals' => :'numberOfDecimals',
    :'required_flag' => :'requiredFlag',
    :'inactive_flag' => :'inactiveFlag',
    :'_info' => :'_info'
  }
end

.swagger_typesObject

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 67

def self.swagger_types
  {
    :'id' => :'Integer',
    :'configuration_type' => :'ConfigurationTypeReference',
    :'field_type' => :'String',
    :'entry_type' => :'String',
    :'sequence_number' => :'Float',
    :'question' => :'String',
    :'number_of_decimals' => :'Integer',
    :'required_flag' => :'BOOLEAN',
    :'inactive_flag' => :'BOOLEAN',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      configuration_type == o.configuration_type &&
      field_type == o.field_type &&
      entry_type == o.entry_type &&
      sequence_number == o.sequence_number &&
      question == o.question &&
      number_of_decimals == o.number_of_decimals &&
      required_flag == o.required_flag &&
      inactive_flag == o.inactive_flag &&
      _info == o._info
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



286
287
288
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
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 286

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
    temp_model = ConnectWise.const_get(type).new
    temp_model.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



352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 352

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


252
253
254
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 252

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



258
259
260
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 258

def hash
  [id, configuration_type, field_type, entry_type, sequence_number, question, number_of_decimals, required_flag, inactive_flag, _info].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies 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
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 134

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

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

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

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

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

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

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



332
333
334
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 332

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 338

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



326
327
328
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 326

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/connectwise-ruby-sdk/models/configuration_type_question.rb', line 169

def valid?
  return false if @field_type.nil?
  field_type_validator = EnumAttributeValidator.new('String', ["Button", "Checkbox", "Currency", "Date", "Hyperlink", "IPAddress", "Number", "Password", "Percent", "Text", "TextArea"])
  return false unless field_type_validator.valid?(@field_type)
  return false if @entry_type.nil?
  entry_type_validator = EnumAttributeValidator.new('String', ["EntryField", "List", "Option"])
  return false unless entry_type_validator.valid?(@entry_type)
  return false if @sequence_number.nil?
  return false if @question.nil?
  return false if @question.to_s.length > 1000
  return false if !@number_of_decimals.nil? && @number_of_decimals > 5
  return false if !@number_of_decimals.nil? && @number_of_decimals < 0
  return true
end