Class: FreshBooks::Item

Inherits:

Object

• Object
• FreshBooks::Item

Defined in:

lib/freshbooks.rb

Constant Summary

TYPE_MAPPINGS =

{ 'item_id' => Fixnum, 'unit_cost' => Float, 
'quantity' => Fixnum, 'inventory' => Fixnum }

Class Method Summary

• .delete(item_id) ⇒ Object
• .get(item_id) ⇒ Object
• .list(options = {}) ⇒ Object

Instance Method Summary

• #create ⇒ Object
• #delete ⇒ Object
• #update ⇒ Object

Class Method Details

.delete(item_id) ⇒ Object

# File 'lib/freshbooks.rb', line 372

def self.delete(item_id)
  resp = FreshBooks::call_api('item.delete', 'item_id' => item_id)

  resp.success?
end

.get(item_id) ⇒ Object

# File 'lib/freshbooks.rb', line 366

def self.get(item_id)
  resp = FreshBooks::call_api('item.get', 'item_id' => item_id)

  resp.success? ? self.new_from_xml(resp.elements[1]) : nil
end

.list(options = {}) ⇒ Object

# File 'lib/freshbooks.rb', line 378

def self.list(options = {})
  resp = FreshBooks::call_api('item.list', options)
  
  return nil unless resp.success?

  item_elems = resp.elements[1].elements
  item_elems.map { |elem| self.new_from_xml(elem) }
end

Instance Method Details

#create ⇒ Object

# File 'lib/freshbooks.rb', line 347

def create
  resp = FreshBooks::call_api('item.create', 'item' => self)
  if resp.success?
    self.item_id = resp.elements[1].text.to_i
  end

  resp.success? ? self.item_id : nil
end

#delete ⇒ Object

# File 'lib/freshbooks.rb', line 362

def delete
  Item::delete(self.item_id)
end

#update ⇒ Object

# File 'lib/freshbooks.rb', line 356

def update
  resp = FreshBooks::call_api('item.update', 'item' => self)

  resp.success?
end