Class: ConnectWise::SetupScreen

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SetupScreen

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 55

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



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

def _info
  @_info
end

#category ⇒ Object

Returns the value of attribute category.



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

def category
  @category
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#module_description ⇒ Object

Returns the value of attribute module_description.



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

def module_description
  @module_description
end

#module_identifier ⇒ Object

Returns the value of attribute module_identifier.



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

def module_identifier
  @module_identifier
end

#module_name ⇒ Object

Returns the value of attribute module_name.



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

def module_name
  @module_name
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 26

def self.attribute_map
  {
    :'id' => :'id',
    :'category' => :'category',
    :'name' => :'name',
    :'description' => :'Description',
    :'module_description' => :'moduleDescription',
    :'module_identifier' => :'moduleIdentifier',
    :'module_name' => :'moduleName',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 40

def self.swagger_types
  {
    :'id' => :'Integer',
    :'category' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'module_description' => :'String',
    :'module_identifier' => :'String',
    :'module_name' => :'String',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      category == o.category &&
      name == o.name &&
      description == o.description &&
      module_description == o.module_description &&
      module_identifier == o.module_identifier &&
      module_name == o.module_name &&
      _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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 255

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 321

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



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

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


221
222
223
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 227

def hash
  [id, category, name, description, module_description, module_identifier, module_name, _info].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 97

def list_invalid_properties
  invalid_properties = Array.new
  if !@category.nil? && @category.to_s.length > 30
    invalid_properties.push("invalid value for 'category', the character length must be smaller than or equal to 30.")
  end

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

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

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

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

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

  return 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



301
302
303
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 301

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



307
308
309
310
311
312
313
314
315
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 307

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



295
296
297
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 295

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



128
129
130
131
132
133
134
135
136
 
# File 'lib/connectwise-ruby-sdk/models/setup_screen.rb', line 128

def valid?
  return false if !@category.nil? && @category.to_s.length > 30
  return false if !@name.nil? && @name.to_s.length > 50
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@module_description.nil? && @module_description.to_s.length > 50
  return false if !@module_identifier.nil? && @module_identifier.to_s.length > 20
  return false if !@module_name.nil? && @module_name.to_s.length > 50
  return true
end