class ConnectWise::ExpenseType

Attributes

_info[RW]

Metadata of the entity

advanced_amount_flag[RW]
amount_caption[RW]
bill_expenses[RW]
external_integration_x_ref[RW]
id[RW]
inactive_flag[RW]
integration_x_ref[RW]
invoice_markup_amount[RW]
invoice_markup_option[RW]
max_amount[RW]
mileage_flag[RW]
name[RW]
quantity_flag[RW]
reimbursement_rate[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/expense_type.rb, line 61
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'amount_caption' => :'amountCaption',
    :'reimbursement_rate' => :'reimbursementRate',
    :'bill_expenses' => :'billExpenses',
    :'invoice_markup_option' => :'invoiceMarkupOption',
    :'invoice_markup_amount' => :'invoiceMarkupAmount',
    :'advanced_amount_flag' => :'advancedAmountFlag',
    :'mileage_flag' => :'mileageFlag',
    :'quantity_flag' => :'quantityFlag',
    :'inactive_flag' => :'inactiveFlag',
    :'max_amount' => :'maxAmount',
    :'external_integration_x_ref' => :'externalIntegrationXRef',
    :'integration_x_ref' => :'integrationXRef',
    :'_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/expense_type.rb, line 104
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?(:'amountCaption')
    self.amount_caption = attributes[:'amountCaption']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'integrationXRef')
    self.integration_x_ref = attributes[:'integrationXRef']
  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/expense_type.rb, line 82
def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'amount_caption' => :'String',
    :'reimbursement_rate' => :'Float',
    :'bill_expenses' => :'String',
    :'invoice_markup_option' => :'String',
    :'invoice_markup_amount' => :'Float',
    :'advanced_amount_flag' => :'BOOLEAN',
    :'mileage_flag' => :'BOOLEAN',
    :'quantity_flag' => :'BOOLEAN',
    :'inactive_flag' => :'BOOLEAN',
    :'max_amount' => :'Float',
    :'external_integration_x_ref' => :'ExternalExpenseTypeIntegrationReference',
    :'integration_x_ref' => :'String',
    :'_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/expense_type.rb, line 266
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      amount_caption == o.amount_caption &&
      reimbursement_rate == o.reimbursement_rate &&
      bill_expenses == o.bill_expenses &&
      invoice_markup_option == o.invoice_markup_option &&
      invoice_markup_amount == o.invoice_markup_amount &&
      advanced_amount_flag == o.advanced_amount_flag &&
      mileage_flag == o.mileage_flag &&
      quantity_flag == o.quantity_flag &&
      inactive_flag == o.inactive_flag &&
      max_amount == o.max_amount &&
      external_integration_x_ref == o.external_integration_x_ref &&
      integration_x_ref == o.integration_x_ref &&
      _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/expense_type.rb, line 322
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/expense_type.rb, line 388
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
bill_expenses=(bill_expenses) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/expense_type.rb, line 235
def bill_expenses=(bill_expenses)
  validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge"])
  unless validator.valid?(bill_expenses)
    fail ArgumentError, "invalid value for 'bill_expenses', must be one of #{validator.allowable_values}."
  end
  @bill_expenses = bill_expenses
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/expense_type.rb, line 301
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) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/expense_type.rb, line 288
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/expense_type.rb, line 294
def hash
  [id, name, amount_caption, reimbursement_rate, bill_expenses, invoice_markup_option, invoice_markup_amount, advanced_amount_flag, mileage_flag, quantity_flag, inactive_flag, max_amount, external_integration_x_ref, integration_x_ref, _info].hash
end
integration_x_ref=(integration_x_ref) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/expense_type.rb, line 255
def integration_x_ref=(integration_x_ref)

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

  @integration_x_ref = integration_x_ref
end
invoice_markup_option=(invoice_markup_option) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/expense_type.rb, line 245
def invoice_markup_option=(invoice_markup_option)
  validator = EnumAttributeValidator.new('String', ["Percent", "Amount", "Mile"])
  unless validator.valid?(invoice_markup_option)
    fail ArgumentError, "invalid value for 'invoice_markup_option', must be one of #{validator.allowable_values}."
  end
  @invoice_markup_option = invoice_markup_option
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/expense_type.rb, line 174
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 > 30
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 30.")
  end

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

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

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

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

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

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

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

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

  @name = name
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/expense_type.rb, line 368
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/expense_type.rb, line 374
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/expense_type.rb, line 362
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/expense_type.rb, line 205
def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 30
  return false if @amount_caption.nil?
  return false if @bill_expenses.nil?
  bill_expenses_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge"])
  return false unless bill_expenses_validator.valid?(@bill_expenses)
  return false if @invoice_markup_option.nil?
  invoice_markup_option_validator = EnumAttributeValidator.new('String', ["Percent", "Amount", "Mile"])
  return false unless invoice_markup_option_validator.valid?(@invoice_markup_option)
  return false if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
  return true
end