Class: Octobat::CreditNote
- Inherits:
-
APIResource
- Object
- OctobatObject
- APIResource
- Octobat::CreditNote
- Extended by:
- APIOperations::List
- Includes:
- APIOperations::Create, APIOperations::Update
- Defined in:
- lib/octobat/credit_note.rb
Instance Attribute Summary
Attributes inherited from OctobatObject
Class Method Summary collapse
Instance Method Summary collapse
- #confirm(confirmation_data = {}) ⇒ Object
- #items(params = {}) ⇒ Object
- #send_by_email(email_data = {}) ⇒ Object
- #transactions(params = {}) ⇒ Object
Methods included from APIOperations::List
Methods included from APIOperations::Update
#save, #serialize_metadata, #serialize_params
Methods included from APIOperations::Create
Methods inherited from APIResource
class_name, #refresh, retrieve, url, #url
Methods inherited from OctobatObject
#[], #[]=, #_dump, _load, #as_json, construct_from, #each, #initialize, #inspect, #keys, #refresh_from, #respond_to?, #to_hash, #to_json, #to_s, #values
Constructor Details
This class inherits a constructor from Octobat::OctobatObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Octobat::OctobatObject
Class Method Details
.pdf_export(params = {}, opts = {}) ⇒ Object
8 9 10 11 12 13 14 15 16 17 |
# 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) return true end |
Instance Method Details
#confirm(confirmation_data = {}) ⇒ Object
25 26 27 28 |
# File 'lib/octobat/credit_note.rb', line 25 def confirm(confirmation_data = {}) response, api_key = Octobat.request(:patch, confirm_url, @api_key, confirmation_data) refresh_from(response, api_key) end |
#items(params = {}) ⇒ Object
30 31 32 |
# File 'lib/octobat/credit_note.rb', line 30 def items(params = {}) Item.list(params.merge({credit_note: id }), @api_key) end |
#send_by_email(email_data = {}) ⇒ Object
20 21 22 23 |
# File 'lib/octobat/credit_note.rb', line 20 def send_by_email(email_data = {}) response, api_key = Octobat.request(:post, send_url, @api_key, email_data) refresh_from(response, api_key) end |
#transactions(params = {}) ⇒ Object
34 35 36 |
# File 'lib/octobat/credit_note.rb', line 34 def transactions(params = {}) Transaction.list(params.merge(credit_note: id), @api_key) end |