class ConnectWise::CatalogComponent

Attributes

_info[RW]

Metadata of the entity

catalog_item[RW]
cost[RW]
hide_description_flag[RW]
hide_extended_price_flag[RW]
hide_item_identifier_flag[RW]
hide_price_flag[RW]
hide_quantity_flag[RW]
id[RW]
parent_catalog_item[RW]
price[RW]
quantity[RW]
sequence_number[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_component.rb, line 36
def self.attribute_map
  {
    :'id' => :'id',
    :'sequence_number' => :'sequenceNumber',
    :'quantity' => :'quantity',
    :'catalog_item' => :'catalogItem',
    :'hide_price_flag' => :'hidePriceFlag',
    :'hide_item_identifier_flag' => :'hideItemIdentifierFlag',
    :'hide_description_flag' => :'hideDescriptionFlag',
    :'hide_quantity_flag' => :'hideQuantityFlag',
    :'hide_extended_price_flag' => :'hideExtendedPriceFlag',
    :'parent_catalog_item' => :'parentCatalogItem',
    :'price' => :'price',
    :'cost' => :'cost',
    :'_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/catalog_component.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?(:'sequenceNumber')
    self.sequence_number = attributes[:'sequenceNumber']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'parentCatalogItem')
    self.parent_catalog_item = attributes[:'parentCatalogItem']
  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?(:'_info')
    self._info = attributes[:'_info']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/connectwise-ruby-sdk/models/catalog_component.rb, line 55
def self.swagger_types
  {
    :'id' => :'Integer',
    :'sequence_number' => :'Integer',
    :'quantity' => :'Float',
    :'catalog_item' => :'CatalogItemReference',
    :'hide_price_flag' => :'BOOLEAN',
    :'hide_item_identifier_flag' => :'BOOLEAN',
    :'hide_description_flag' => :'BOOLEAN',
    :'hide_quantity_flag' => :'BOOLEAN',
    :'hide_extended_price_flag' => :'BOOLEAN',
    :'parent_catalog_item' => :'CatalogItemReference',
    :'price' => :'Float',
    :'cost' => :'Float',
    :'_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/catalog_component.rb, line 160
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      sequence_number == o.sequence_number &&
      quantity == o.quantity &&
      catalog_item == o.catalog_item &&
      hide_price_flag == o.hide_price_flag &&
      hide_item_identifier_flag == o.hide_item_identifier_flag &&
      hide_description_flag == o.hide_description_flag &&
      hide_quantity_flag == o.hide_quantity_flag &&
      hide_extended_price_flag == o.hide_extended_price_flag &&
      parent_catalog_item == o.parent_catalog_item &&
      price == o.price &&
      cost == o.cost &&
      _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/catalog_component.rb, line 214
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_component.rb, line 280
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_component.rb, line 193
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/catalog_component.rb, line 180
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_component.rb, line 186
def hash
  [id, sequence_number, quantity, catalog_item, hide_price_flag, hide_item_identifier_flag, hide_description_flag, hide_quantity_flag, hide_extended_price_flag, parent_catalog_item, price, cost, _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/catalog_component.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if @quantity.nil?
    invalid_properties.push("invalid value for 'quantity', quantity cannot be nil.")
  end

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

  return invalid_properties
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_component.rb, line 260
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_component.rb, line 266
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_component.rb, line 254
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_component.rb, line 152
def valid?
  return false if @quantity.nil?
  return false if @catalog_item.nil?
  return true
end