Class: ConnectWise::Category

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Category

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 59

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

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

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

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

  if attributes.has_key?(:'locationIds')
    if (value = attributes[:'locationIds']).is_a?(Array)
      self.location_ids = value
    end
  end

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



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

def _info
  @_info
end

#add_all_locations ⇒ Object

Returns the value of attribute add_all_locations.



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

def add_all_locations
  @add_all_locations
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



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

def inactive_flag
  @inactive_flag
end

#integration_xref ⇒ Object

Returns the value of attribute integration_xref.



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

def integration_xref
  @integration_xref
end

#location_ids ⇒ Object

Returns the value of attribute location_ids.



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

def location_ids
  @location_ids
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#price_level_xref ⇒ Object

Returns the value of attribute price_level_xref.



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

def price_level_xref
  @price_level_xref
end

#remove_all_locations ⇒ Object

Returns the value of attribute remove_all_locations.



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

def remove_all_locations
  @remove_all_locations
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 28

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'inactive_flag' => :'inactiveFlag',
    :'price_level_xref' => :'priceLevelXref',
    :'integration_xref' => :'integrationXref',
    :'location_ids' => :'locationIds',
    :'add_all_locations' => :'addAllLocations',
    :'remove_all_locations' => :'removeAllLocations',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 43

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'inactive_flag' => :'BOOLEAN',
    :'price_level_xref' => :'String',
    :'integration_xref' => :'String',
    :'location_ids' => :'Array<Integer>',
    :'add_all_locations' => :'BOOLEAN',
    :'remove_all_locations' => :'BOOLEAN',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      inactive_flag == o.inactive_flag &&
      price_level_xref == o.price_level_xref &&
      integration_xref == o.integration_xref &&
      location_ids == o.location_ids &&
      add_all_locations == o.add_all_locations &&
      remove_all_locations == o.remove_all_locations &&
      _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



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
258
259
260
261
262
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 226

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 292

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



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

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


192
193
194
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 198

def hash
  [id, name, inactive_flag, price_level_xref, integration_xref, location_ids, add_all_locations, remove_all_locations, _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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 107

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

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

  if !@integration_xref.nil? && @integration_xref.to_s.length > 50
    invalid_properties.push("invalid value for 'integration_xref', 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



272
273
274
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 272

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



278
279
280
281
282
283
284
285
286
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 278

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



266
267
268
 
# File 'lib/connectwise-ruby-sdk/models/category.rb', line 266

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



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

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if !@price_level_xref.nil? && @price_level_xref.to_s.length > 10
  return false if !@integration_xref.nil? && @integration_xref.to_s.length > 50
  return true
end