class ConnectWise::TimeAccrualDetail

Attributes

_info[RW]

Metadata of the entity

accrual_type[RW]

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

end_year[RW]
hours[RW]
id[RW]
start_year[RW]
time_accrual[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
accrual_type=(accrual_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] accrual_type Object to be assigned

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 166
def accrual_type=(accrual_type)
  validator = EnumAttributeValidator.new('String', ["Holiday", "PTO", "Sick", "Vacation"])
  unless validator.valid?(accrual_type)
    fail ArgumentError, "invalid value for 'accrual_type', must be one of #{validator.allowable_values}."
  end
  @accrual_type = accrual_type
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
end_year=(end_year) click to toggle source

Custom attribute writer method with validation @param [Object] end_year Value to be assigned

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 194
def end_year=(end_year)
  if end_year.nil?
    fail ArgumentError, "end_year cannot be nil"
  end

  if end_year > 50
    fail ArgumentError, "invalid value for 'end_year', must be smaller than or equal to 50."
  end

  if end_year < 1
    fail ArgumentError, "invalid value for 'end_year', must be greater than or equal to 1."
  end

  @end_year = end_year
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 226
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# 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
start_year=(start_year) click to toggle source

Custom attribute writer method with validation @param [Object] start_year Value to be assigned

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 176
def start_year=(start_year)
  if start_year.nil?
    fail ArgumentError, "start_year cannot be nil"
  end

  if start_year > 50
    fail ArgumentError, "invalid value for 'start_year', must be smaller than or equal to 50."
  end

  if start_year < 1
    fail ArgumentError, "invalid value for 'start_year', must be greater than or equal to 1."
  end

  @start_year = start_year
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 306
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/connectwise-ruby-sdk/models/time_accrual_detail.rb, line 300
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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