class ConnectWise::Adjustment

Attributes

_info[RW]

Metadata of the entity

agreement_id[RW]
amount[RW]
closed_by[RW]
closed_date[RW]
closed_flag[RW]
description[RW]
effective_date[RW]
id[RW]
identifier[RW]
notes[RW]
reason[RW]
type[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/adjustment.rb, line 36
def self.attribute_map
  {
    :'id' => :'id',
    :'amount' => :'amount',
    :'description' => :'description',
    :'effective_date' => :'effectiveDate',
    :'agreement_id' => :'agreementId',
    :'_info' => :'_info',
    :'identifier' => :'identifier',
    :'type' => :'type',
    :'reason' => :'reason',
    :'notes' => :'notes',
    :'closed_flag' => :'closedFlag',
    :'closed_by' => :'closedBy',
    :'closed_date' => :'closedDate'
  }
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/adjustment.rb, line 75
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?(:'amount')
    self.amount = attributes[:'amount']
  end

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/connectwise-ruby-sdk/models/adjustment.rb, line 55
def self.swagger_types
  {
    :'id' => :'Integer',
    :'amount' => :'Float',
    :'description' => :'String',
    :'effective_date' => :'DateTime',
    :'agreement_id' => :'Integer',
    :'_info' => :'Metadata',
    :'identifier' => :'String',
    :'type' => :'AdjustmentTypeReference',
    :'reason' => :'String',
    :'notes' => :'String',
    :'closed_flag' => :'BOOLEAN',
    :'closed_by' => :'String',
    :'closed_date' => :'DateTime'
  }
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/adjustment.rb, line 211
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      amount == o.amount &&
      description == o.description &&
      effective_date == o.effective_date &&
      agreement_id == o.agreement_id &&
      _info == o._info &&
      identifier == o.identifier &&
      type == o.type &&
      reason == o.reason &&
      notes == o.notes &&
      closed_flag == o.closed_flag &&
      closed_by == o.closed_by &&
      closed_date == o.closed_date
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/adjustment.rb, line 265
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/adjustment.rb, line 331
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) 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/adjustment.rb, line 244
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
description=(description) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/adjustment.rb, line 175
def description=(description)

  if !description.nil? && description.to_s.length > 1000
    fail ArgumentError, "invalid value for 'description', the character length must be smaller than or equal to 1000."
  end

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

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

# File lib/connectwise-ruby-sdk/models/adjustment.rb, line 231
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/adjustment.rb, line 237
def hash
  [id, amount, description, effective_date, agreement_id, _info, identifier, type, reason, notes, closed_flag, closed_by, closed_date].hash
end
identifier=(identifier) click to toggle source

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

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

  if identifier.to_s.length > 50
    fail ArgumentError, "invalid value for 'identifier', the character length must be smaller than or equal to 50."
  end

  @identifier = identifier
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/adjustment.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 1000
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 1000.")
  end

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

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

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

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

  return invalid_properties
end
reason=(reason) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/adjustment.rb, line 200
def reason=(reason)

  if !reason.nil? && reason.to_s.length > 100
    fail ArgumentError, "invalid value for 'reason', the character length must be smaller than or equal to 100."
  end

  @reason = reason
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/adjustment.rb, line 311
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/adjustment.rb, line 317
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/adjustment.rb, line 305
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/adjustment.rb, line 164
def valid?
  return false if !@description.nil? && @description.to_s.length > 1000
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @type.nil?
  return false if !@reason.nil? && @reason.to_s.length > 100
  return true
end