Class: ConnectWise::ServiceSurveyQuestion

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/service_survey_question.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceSurveyQuestion

Initializes the object

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

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ServiceSurveyQuestion` 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::ServiceSurveyQuestion`. 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.type = attributes[:type] if attributes.key?(:type)

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

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

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

  if attributes.key?(:options) && (value = attributes[:options]).is_a?(Array)
    self.options = value
  end

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

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

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

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

  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/service_survey_question.rb', line 16

def _info
  @_info
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#include_flagObject

Returns the value of attribute include_flag.



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

def include_flag
  @include_flag
end

#no_answer_pointsObject

Returns the value of attribute no_answer_points.



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

def no_answer_points
  @no_answer_points
end

#optionsObject

Returns the value of attribute options.



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

def options
  @options
end

#questionObject

Max length: 1000;



19
20
21
# File 'lib/connect_wise/models/service_survey_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/service_survey_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/service_survey_question.rb', line 16

def sequence_number
  @sequence_number
end

#survey_idObject

Returns the value of attribute survey_id.



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

def survey_id
  @survey_id
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



59
60
61
# File 'lib/connect_wise/models/service_survey_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/service_survey_question.rb', line 43

def self.attribute_map
  {
    type: :type,
    question: :question,
    id: :id,
    sequence_number: :sequenceNumber,
    options: :options,
    include_flag: :includeFlag,
    required_flag: :requiredFlag,
    no_answer_points: :noAnswerPoints,
    survey_id: :surveyId,
    _info: :_info
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



190
191
192
# File 'lib/connect_wise/models/service_survey_question.rb', line 190

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/service_survey_question.rb', line 80

def self.openapi_nullable
  Set.new(i[
            type
            sequence_number
            include_flag
            required_flag
            no_answer_points
            survey_id
          ])
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/service_survey_question.rb', line 64

def self.openapi_types
  {
    type: :String,
    question: :String,
    id: :Integer,
    sequence_number: :Integer,
    options: :'Array<ServiceSurveyQuestionOption>',
    include_flag: :Boolean,
    required_flag: :Boolean,
    no_answer_points: :Integer,
    survey_id: :Integer,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/connect_wise/models/service_survey_question.rb', line 159

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

  self.class == other.class &&
    type == other.type &&
    question == other.question &&
    id == other.id &&
    sequence_number == other.sequence_number &&
    options == other.options &&
    include_flag == other.include_flag &&
    required_flag == other.required_flag &&
    no_answer_points == other.no_answer_points &&
    survey_id == other.survey_id &&
    _info == other._info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



220
221
222
223
224
225
226
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
# File 'lib/connect_wise/models/service_survey_question.rb', line 220

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



291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/connect_wise/models/service_survey_question.rb', line 291

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/connect_wise/models/service_survey_question.rb', line 197

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

See Also:

  • `==` method


177
178
179
# File 'lib/connect_wise/models/service_survey_question.rb', line 177

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.



183
184
185
# File 'lib/connect_wise/models/service_survey_question.rb', line 183

def hash
  [type, question, id, sequence_number, options, include_flag, required_flag, no_answer_points, survey_id, _info].hash
end

#list_invalid_propertiesObject

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



131
132
133
134
135
136
# File 'lib/connect_wise/models/service_survey_question.rb', line 131

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)



267
268
269
# File 'lib/connect_wise/models/service_survey_question.rb', line 267

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/connect_wise/models/service_survey_question.rb', line 273

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



261
262
263
# File 'lib/connect_wise/models/service_survey_question.rb', line 261

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



140
141
142
143
144
145
146
# File 'lib/connect_wise/models/service_survey_question.rb', line 140

def valid?
  type_validator = EnumAttributeValidator.new('String', %w[OpenEnded Selection])
  return false unless type_validator.valid?(@type)
  return false if @question.nil?

  true
end