Class: ConnectWise::ConfigurationTypeQuestion

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/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

Raises:

  • (ArgumentError)


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
# File 'lib/connect_wise/models/configuration_type_question.rb', line 93

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ConfigurationTypeQuestion` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::ConfigurationTypeQuestion`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.field_type = attributes[:field_type] if attributes.key?(:field_type)

  self.entry_type = attributes[:entry_type] if attributes.key?(:entry_type)

  self.sequence_number = attributes[:sequence_number] if attributes.key?(:sequence_number)

  self.question = attributes[:question] if attributes.key?(:question)

  self.id = attributes[:id] if attributes.key?(:id)

  self.configuration_type = attributes[:configuration_type] if attributes.key?(:configuration_type)

  self.number_of_decimals = attributes[:number_of_decimals] if attributes.key?(:number_of_decimals)

  self.required_flag = attributes[:required_flag] if attributes.key?(:required_flag)

  self.inactive_flag = attributes[:inactive_flag] if attributes.key?(:inactive_flag)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_infoObject

Returns the value of attribute _info.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def _info
  @_info
end

#configuration_typeObject

Returns the value of attribute configuration_type.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def configuration_type
  @configuration_type
end

#entry_typeObject

Returns the value of attribute entry_type.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def entry_type
  @entry_type
end

#field_typeObject

Returns the value of attribute field_type.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def field_type
  @field_type
end

#idObject

Returns the value of attribute id.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def id
  @id
end

#inactive_flagObject

Returns the value of attribute inactive_flag.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def inactive_flag
  @inactive_flag
end

#number_of_decimalsObject

Returns the value of attribute number_of_decimals.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def number_of_decimals
  @number_of_decimals
end

#questionObject

Max length: 1000;



19
20
21
# File 'lib/connect_wise/models/configuration_type_question.rb', line 19

def question
  @question
end

#required_flagObject

Returns the value of attribute required_flag.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def required_flag
  @required_flag
end

#sequence_numberObject

Returns the value of attribute sequence_number.



16
17
18
# File 'lib/connect_wise/models/configuration_type_question.rb', line 16

def sequence_number
  @sequence_number
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



59
60
61
# File 'lib/connect_wise/models/configuration_type_question.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/connect_wise/models/configuration_type_question.rb', line 43

def self.attribute_map
  {
    field_type: :fieldType,
    entry_type: :entryType,
    sequence_number: :sequenceNumber,
    question: :question,
    id: :id,
    configuration_type: :configurationType,
    number_of_decimals: :numberOfDecimals,
    required_flag: :requiredFlag,
    inactive_flag: :inactiveFlag,
    _info: :_info
  }
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



200
201
202
# File 'lib/connect_wise/models/configuration_type_question.rb', line 200

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

.openapi_nullableObject

List of attributes with nullable: true



80
81
82
83
84
85
86
87
88
89
# File 'lib/connect_wise/models/configuration_type_question.rb', line 80

def self.openapi_nullable
  Set.new(i[
            field_type
            entry_type
            sequence_number
            number_of_decimals
            required_flag
            inactive_flag
          ])
end

.openapi_typesObject

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/connect_wise/models/configuration_type_question.rb', line 64

def self.openapi_types
  {
    field_type: :String,
    entry_type: :String,
    sequence_number: :Float,
    question: :String,
    id: :Integer,
    configuration_type: :ConfigurationTypeReference,
    number_of_decimals: :Integer,
    required_flag: :Boolean,
    inactive_flag: :Boolean,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    field_type == other.field_type &&
    entry_type == other.entry_type &&
    sequence_number == other.sequence_number &&
    question == other.question &&
    id == other.id &&
    configuration_type == other.configuration_type &&
    number_of_decimals == other.number_of_decimals &&
    required_flag == other.required_flag &&
    inactive_flag == other.inactive_flag &&
    _info == other._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



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
263
264
265
266
267
# File 'lib/connect_wise/models/configuration_type_question.rb', line 230

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/connect_wise/models/configuration_type_question.rb', line 301

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/connect_wise/models/configuration_type_question.rb', line 207

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif 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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
# File 'lib/connect_wise/models/configuration_type_question.rb', line 187

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



193
194
195
# File 'lib/connect_wise/models/configuration_type_question.rb', line 193

def hash
  [field_type, entry_type, sequence_number, question, id, configuration_type, 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 properties with the reasons



129
130
131
132
133
134
# File 'lib/connect_wise/models/configuration_type_question.rb', line 129

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "question", question cannot be nil.') if @question.nil?

  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



277
278
279
# File 'lib/connect_wise/models/configuration_type_question.rb', line 277

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



283
284
285
286
287
288
289
290
291
292
293
294
295
# File 'lib/connect_wise/models/configuration_type_question.rb', line 283

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



271
272
273
# File 'lib/connect_wise/models/configuration_type_question.rb', line 271

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



138
139
140
141
142
143
144
145
146
147
# File 'lib/connect_wise/models/configuration_type_question.rb', line 138

def valid?
  field_type_validator = EnumAttributeValidator.new('String', %w[TextArea Currency Date Hyperlink IPAddress Checkbox Number Percent Text Password])
  return false unless field_type_validator.valid?(@field_type)

  entry_type_validator = EnumAttributeValidator.new('String', %w[Date EntryField List Option])
  return false unless entry_type_validator.valid?(@entry_type)
  return false if @question.nil?

  true
end