Class: ConnectWise::TimeAccrualDetail

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeAccrualDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
104
105
106
107
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 73

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

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

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

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

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

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

end

Instance Attribute Details

#_infoObject

Metadata of the entity



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

def _info
  @_info
end

#accrual_typeObject

Available types are: Holiday, PTO, Sick and Vacation.



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

def accrual_type
  @accrual_type
end

#end_yearObject

Returns the value of attribute end_year.



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

def end_year
  @end_year
end

#hoursObject

Returns the value of attribute hours.



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

def hours
  @hours
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#start_yearObject

Returns the value of attribute start_year.



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

def start_year
  @start_year
end

#time_accrualObject

Returns the value of attribute time_accrual.



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

def time_accrual
  @time_accrual
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'accrual_type' => :'accrualType',
    :'start_year' => :'startYear',
    :'end_year' => :'endYear',
    :'hours' => :'hours',
    :'time_accrual' => :'timeAccrual',
    :'_info' => :'_info'
  }
end

.swagger_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 59

def self.swagger_types
  {
    :'id' => :'Integer',
    :'accrual_type' => :'String',
    :'start_year' => :'Integer',
    :'end_year' => :'Integer',
    :'hours' => :'Float',
    :'time_accrual' => :'TimeAccrualReference',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



212
213
214
215
216
217
218
219
220
221
222
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      accrual_type == o.accrual_type &&
      start_year == o.start_year &&
      end_year == o.end_year &&
      hours == o.hours &&
      time_accrual == o.time_accrual &&
      _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



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
292
293
294
295
296
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 260

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



326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 239

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


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

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



232
233
234
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 232

def hash
  [id, accrual_type, start_year, end_year, hours, time_accrual, _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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 111

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

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

  if @start_year > 50
    invalid_properties.push("invalid value for 'start_year', must be smaller than or equal to 50.")
  end

  if @start_year < 1
    invalid_properties.push("invalid value for 'start_year', must be greater than or equal to 1.")
  end

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

  if @end_year > 50
    invalid_properties.push("invalid value for 'end_year', must be smaller than or equal to 50.")
  end

  if @end_year < 1
    invalid_properties.push("invalid value for 'end_year', must be greater than or equal to 1.")
  end

  if @hours.nil?
    invalid_properties.push("invalid value for 'hours', hours cannot be nil.")
  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



306
307
308
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 306

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



312
313
314
315
316
317
318
319
320
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 312

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



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

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



150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/connectwise-ruby-sdk/models/time_accrual_detail.rb', line 150

def valid?
  return false if @accrual_type.nil?
  accrual_type_validator = EnumAttributeValidator.new('String', ["Holiday", "PTO", "Sick", "Vacation"])
  return false unless accrual_type_validator.valid?(@accrual_type)
  return false if @start_year.nil?
  return false if @start_year > 50
  return false if @start_year < 1
  return false if @end_year.nil?
  return false if @end_year > 50
  return false if @end_year < 1
  return false if @hours.nil?
  return true
end