class ConnectWise::CatalogItem

Attributes

_info[RW]

Metadata of the entity

category[RW]
cost[RW]
custom_fields[RW]
customer_description[RW]
date_entered[RW]
description[RW]
id[RW]
identifier[RW]
inactive_flag[RW]
integration_x_ref[RW]
manufacturer[RW]
manufacturer_part_number[RW]
min_stock_level[RW]
notes[RW]
phase_product_flag[RW]
price[RW]
price_attribute[RW]
product_class[RW]

Defaults to Non-Inventory

serialized_cost_flag[RW]
serialized_flag[RW]
subcategory[RW]
taxable_flag[RW]
type[RW]
unit_of_measure[RW]
vendor[RW]
vendor_sku[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/catalog_item.rb, line 86
def self.attribute_map
  {
    :'id' => :'id',
    :'identifier' => :'identifier',
    :'description' => :'description',
    :'inactive_flag' => :'inactiveFlag',
    :'subcategory' => :'subcategory',
    :'type' => :'type',
    :'product_class' => :'productClass',
    :'serialized_flag' => :'serializedFlag',
    :'serialized_cost_flag' => :'serializedCostFlag',
    :'phase_product_flag' => :'phaseProductFlag',
    :'unit_of_measure' => :'unitOfMeasure',
    :'min_stock_level' => :'minStockLevel',
    :'price' => :'price',
    :'cost' => :'cost',
    :'price_attribute' => :'priceAttribute',
    :'taxable_flag' => :'taxableFlag',
    :'customer_description' => :'customerDescription',
    :'manufacturer' => :'manufacturer',
    :'manufacturer_part_number' => :'manufacturerPartNumber',
    :'vendor' => :'vendor',
    :'vendor_sku' => :'vendorSku',
    :'notes' => :'notes',
    :'integration_x_ref' => :'integrationXRef',
    :'date_entered' => :'dateEntered',
    :'category' => :'category',
    :'_info' => :'_info',
    :'custom_fields' => :'customFields'
  }
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/catalog_item.rb, line 153
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?(:'identifier')
    self.identifier = attributes[:'identifier']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/connectwise-ruby-sdk/models/catalog_item.rb, line 119
def self.swagger_types
  {
    :'id' => :'Integer',
    :'identifier' => :'String',
    :'description' => :'String',
    :'inactive_flag' => :'BOOLEAN',
    :'subcategory' => :'ProductSubCategoryReference',
    :'type' => :'ProductTypeReference',
    :'product_class' => :'String',
    :'serialized_flag' => :'BOOLEAN',
    :'serialized_cost_flag' => :'BOOLEAN',
    :'phase_product_flag' => :'BOOLEAN',
    :'unit_of_measure' => :'UnitOfMeasureReference',
    :'min_stock_level' => :'Integer',
    :'price' => :'Float',
    :'cost' => :'Float',
    :'price_attribute' => :'String',
    :'taxable_flag' => :'BOOLEAN',
    :'customer_description' => :'String',
    :'manufacturer' => :'ManufacturerReference',
    :'manufacturer_part_number' => :'String',
    :'vendor' => :'CompanyReference',
    :'vendor_sku' => :'String',
    :'notes' => :'String',
    :'integration_x_ref' => :'String',
    :'date_entered' => :'String',
    :'category' => :'ProductCategoryReference',
    :'_info' => :'Metadata',
    :'custom_fields' => :'Array<CustomFieldValue>'
  }
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/catalog_item.rb, line 440
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      identifier == o.identifier &&
      description == o.description &&
      inactive_flag == o.inactive_flag &&
      subcategory == o.subcategory &&
      type == o.type &&
      product_class == o.product_class &&
      serialized_flag == o.serialized_flag &&
      serialized_cost_flag == o.serialized_cost_flag &&
      phase_product_flag == o.phase_product_flag &&
      unit_of_measure == o.unit_of_measure &&
      min_stock_level == o.min_stock_level &&
      price == o.price &&
      cost == o.cost &&
      price_attribute == o.price_attribute &&
      taxable_flag == o.taxable_flag &&
      customer_description == o.customer_description &&
      manufacturer == o.manufacturer &&
      manufacturer_part_number == o.manufacturer_part_number &&
      vendor == o.vendor &&
      vendor_sku == o.vendor_sku &&
      notes == o.notes &&
      integration_x_ref == o.integration_x_ref &&
      date_entered == o.date_entered &&
      category == o.category &&
      _info == o._info &&
      custom_fields == o.custom_fields
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/catalog_item.rb, line 508
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/catalog_item.rb, line 574
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/catalog_item.rb, line 487
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
customer_description=(customer_description) click to toggle source

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

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

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

  @customer_description = customer_description
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/catalog_item.rb, line 359
def description=(description)
  if description.nil?
    fail ArgumentError, "description cannot be nil"
  end

  if description.to_s.length > 50
    fail ArgumentError, "invalid value for 'description', the character length must be smaller than or equal to 50."
  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/catalog_item.rb, line 474
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/catalog_item.rb, line 480
def hash
  [id, identifier, description, inactive_flag, subcategory, type, product_class, serialized_flag, serialized_cost_flag, phase_product_flag, unit_of_measure, min_stock_level, price, cost, price_attribute, taxable_flag, customer_description, manufacturer, manufacturer_part_number, vendor, vendor_sku, notes, integration_x_ref, date_entered, category, _info, custom_fields].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/catalog_item.rb, line 345
def identifier=(identifier)
  if identifier.nil?
    fail ArgumentError, "identifier cannot be nil"
  end

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

  @identifier = identifier
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/catalog_item.rb, line 429
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
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/catalog_item.rb, line 273
def list_invalid_properties
  invalid_properties = Array.new
  if @identifier.nil?
    invalid_properties.push("invalid value for 'identifier', identifier cannot be nil.")
  end

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

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

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

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

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

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

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

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

  if !@vendor_sku.nil? && @vendor_sku.to_s.length > 50
    invalid_properties.push("invalid value for 'vendor_sku', the character length must be smaller than or equal to 50.")
  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
manufacturer_part_number=(manufacturer_part_number) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/catalog_item.rb, line 407
def manufacturer_part_number=(manufacturer_part_number)

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

  @manufacturer_part_number = manufacturer_part_number
end
price_attribute=(price_attribute) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/catalog_item.rb, line 383
def price_attribute=(price_attribute)
  validator = EnumAttributeValidator.new('String', ["FixedFee", "NotToExceed", "TimeAndMaterials", "OverrideRate"])
  unless validator.valid?(price_attribute)
    fail ArgumentError, "invalid value for 'price_attribute', must be one of #{validator.allowable_values}."
  end
  @price_attribute = price_attribute
end
product_class=(product_class) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/catalog_item.rb, line 373
def product_class=(product_class)
  validator = EnumAttributeValidator.new('String', ["Agreement", "Bundle", "Inventory", "NonInventory", "Service"])
  unless validator.valid?(product_class)
    fail ArgumentError, "invalid value for 'product_class', must be one of #{validator.allowable_values}."
  end
  @product_class = product_class
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/catalog_item.rb, line 554
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/catalog_item.rb, line 560
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/catalog_item.rb, line 548
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/catalog_item.rb, line 324
def valid?
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 60
  return false if @description.nil?
  return false if @description.to_s.length > 50
  return false if @subcategory.nil?
  return false if @type.nil?
  product_class_validator = EnumAttributeValidator.new('String', ["Agreement", "Bundle", "Inventory", "NonInventory", "Service"])
  return false unless product_class_validator.valid?(@product_class)
  price_attribute_validator = EnumAttributeValidator.new('String', ["FixedFee", "NotToExceed", "TimeAndMaterials", "OverrideRate"])
  return false unless price_attribute_validator.valid?(@price_attribute)
  return false if @customer_description.nil?
  return false if @customer_description.to_s.length > 6000
  return false if !@manufacturer_part_number.nil? && @manufacturer_part_number.to_s.length > 50
  return false if !@vendor_sku.nil? && @vendor_sku.to_s.length > 50
  return false if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
  return true
end
vendor_sku=(vendor_sku) click to toggle source

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

# File lib/connectwise-ruby-sdk/models/catalog_item.rb, line 418
def vendor_sku=(vendor_sku)

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

  @vendor_sku = vendor_sku
end