class Octobat::CreditNote

Public Class Methods

pdf_export(params = {}, opts={}) click to toggle source
# File lib/octobat/credit_note.rb, line 8
def self.pdf_export(params = {}, opts={})
  api_key, headers = Util.parse_opts(opts)
  api_key ||= @api_key
  opts[:api_key] = api_key

  instance = self.new(nil, opts)

  response, api_key = Octobat.request(:post, url + '/pdf_export', api_key, params, headers)
  return true
end

Public Instance Methods

cancel(params = {}, opts = {}) click to toggle source
# File lib/octobat/credit_note.rb, line 31
def cancel(params = {}, opts = {})
  response, api_key = Octobat.request(:patch, cancel_url, @api_key, params, opts)
  refresh_from(response, api_key)
end
confirm(params = {}, opts = {}) click to toggle source
# File lib/octobat/credit_note.rb, line 25
def confirm(params = {}, opts = {})
  response, api_key = Octobat.request(:patch, confirm_url, @api_key, params, opts)
  refresh_from(response, api_key)
end
items(params = {}, opts = {}) click to toggle source
# File lib/octobat/credit_note.rb, line 38
def items(params = {}, opts = {})
  Item.list(params.merge({ credit_note: id }), {api_key: @api_key}.merge(opts))
end
send_by_email(params = {}, opts = {}) click to toggle source
# File lib/octobat/credit_note.rb, line 20
def send_by_email(params = {}, opts = {})
  response, api_key = Octobat.request(:post, send_url, @api_key, params, opts)
  refresh_from(response, api_key)
end
transactions(params = {}, opts = {}) click to toggle source
# File lib/octobat/credit_note.rb, line 42
def transactions(params = {}, opts = {})
  Transaction.list(params.merge(credit_note: id), {api_key: @api_key}.merge(opts))
end

Private Instance Methods

cancel_url() click to toggle source
# File lib/octobat/credit_note.rb, line 47
def cancel_url
  url + '/cancel'
end
confirm_url() click to toggle source
# File lib/octobat/credit_note.rb, line 55
def confirm_url
  url + '/confirm'
end
send_url() click to toggle source
# File lib/octobat/credit_note.rb, line 51
def send_url
  url + '/send'
end