Class: Harvest::API::InvoiceMessages

Inherits:
Base
  • Object
show all
Defined in:
lib/harvest/api/invoice_messages.rb

Instance Attribute Summary

Attributes inherited from Base

#credentials

Instance Method Summary collapse

Methods inherited from Base

api_model, #initialize

Constructor Details

This class inherits a constructor from Harvest::API::Base

Instance Method Details

#all(invoice, query = {}) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/harvest/api/invoice_messages.rb', line 6

def all(invoice, query = {})
  response = request(:get, credentials, "/invoices/#{invoice.id}/messages", query: query)
  response_parsed = api_model.to_json(response.parsed_response)

  if response_parsed['total_pages'] > 1
    counter = response_parsed['page']

    while counter <= response_parsed['total_pages'] do
      counter += 1
      query = { 'page' => counter }

      response_page = request(:get, credentials,
        "/invoices/#{invoice.id}/messages",
        query: query)
      invoice_messages = api_model.to_json(response.parsed_response)
      response_parsed['invoice_messages']
        .concat(invoice_messages['invoice_messages'])
    end
  end

  api_model.parse(response_parsed)
end

#create(invoice, invoice_message) ⇒ Object 



29
30
31
32
33
 
# File 'lib/harvest/api/invoice_messages.rb', line 29

def create(invoice, invoice_message)
  invoice_message = api_model.wrap(invoice_message)
  response = request(:post, credentials, "/invoices/#{invoice.id}/messages", body: invoice_message.to_json)
  find(invoice_message.id)
end

#delete(invoice, invoice_message) ⇒ Object 



35
36
37
38
 
# File 'lib/harvest/api/invoice_messages.rb', line 35

def delete(invoice, invoice_message)
  request(:delete, credentials, "/invoices/#{invoice.id}/messages/#{invoice_message.id}")
  message.id
end

#mark_as_closed(invoice, invoice_message) ⇒ Harvest::InvoiceMessage

Create a message and mark an open invoice as closed (writing an invoice off)

Parameters:

Returns:



52
53
54
 
# File 'lib/harvest/api/invoice_messages.rb', line 52

def mark_as_closed(invoice, invoice_message)
  send_status_message(invoice, invoice_message, 'close')
end

#mark_as_draft(invoice_message) ⇒ Harvest::InvoiceMessage

Create a message for marking an open invoice as draft

Parameters:

Returns:



68
69
70
 
# File 'lib/harvest/api/invoice_messages.rb', line 68

def mark_as_draft(invoice_message)
  send_status_message(invoice, invoice_message, 'draft')
end

#mark_as_sent(invoice, invoice_message) ⇒ Harvest::InvoiceMessage

Create a message for marking an invoice as sent.

Parameters:

Returns:



44
45
46
 
# File 'lib/harvest/api/invoice_messages.rb', line 44

def mark_as_sent(invoice, invoice_message)
  send_status_message(invoice, invoice_message, 'send')
end

#re_open(invoice, invoice_message) ⇒ Harvest::InvoiceMessage

Create a message and mark a closed (written-off) invoice as open

Parameters:

Returns:



60
61
62
 
# File 'lib/harvest/api/invoice_messages.rb', line 60

def re_open(invoice, invoice_message)
  send_status_message(invoice, invoice_message, 're-open')
end