Class: FreshBooks::Task

Inherits:

Object

• Object
• FreshBooks::Task

Defined in:

lib/freshbooks.rb

Constant Summary

TYPE_MAPPINGS =

{ 'task_id' => Fixnum, 'rate' => Float }

Class Method Summary

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

Instance Method Summary

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

Class Method Details

.delete(task_id) ⇒ Object

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

def self.delete(task_id)
  resp = FreshBooks::call_api('task.delete', 'task_id' => task_id)

  resp.success?
end

.get(task_id) ⇒ Object

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

def self.get(task_id)
  resp = FreshBooks::call_api('task.get', 'task_id' => task_id)

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

.list(options = {}) ⇒ Object

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

def self.list(options = {})
  resp = FreshBooks::call_api('task.list', options)

  return nil unless resp.success?

  task_elems = resp.elements[1].elements

  task_elems.map { |elem| self.new_from_xml(elem) }
end

Instance Method Details

#create ⇒ Object

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

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

  resp.success? ? self.task_id : nil
end

#delete ⇒ Object

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

def delete
  Task::delete(self.task_id)
end

#update ⇒ Object

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

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

  resp.success?
end