Class: Io::Flow::V0::Clients::ConsumerInvoices

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ConsumerInvoices

Returns a new instance of ConsumerInvoices.



5288
5289
5290
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5288

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_key(organization, key) ⇒ Object 



5365
5366
5367
5368
5369
5370
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5365

def delete_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(key)}").delete
  nil
end

#delete_credit_and_memos_by_invoice_key_and_key(organization, invoice_key, key) ⇒ Object 



5342
5343
5344
5345
5346
5347
5348
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5342

def delete_credit_and_memos_by_invoice_key_and_key(organization, invoice_key, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('invoice_key', invoice_key, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(invoice_key)}/credit/memos/#{CGI.escape(key)}").delete
  nil
end

#get(organization, incoming = {}) ⇒ Object 



5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5292

def get(organization, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  query = {
    :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
    :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String)),
    :order_number => (x = opts.delete(:order_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('order_number', x, String)),
    :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
    :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
    :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
  }.delete_if { |k, v| v.nil? }
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ConsumerInvoice.new(x) }
end

#get_by_key(organization, key) ⇒ Object 



5350
5351
5352
5353
5354
5355
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5350

def get_by_key(organization, key)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(key)}").get
  ::Io::Flow::V0::Models::ConsumerInvoice.new(r)
end

#post_credit_and_memos_by_invoice_key(organization, invoice_key, credit_memo_form) ⇒ Object

Creates a credit memo against this invoice



5324
5325
5326
5327
5328
5329
5330
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5324

def post_credit_and_memos_by_invoice_key(organization, invoice_key, credit_memo_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('invoice_key', invoice_key, String)
  (x = credit_memo_form; x.is_a?(::Io::Flow::V0::Models::CreditMemoForm) ? x : ::Io::Flow::V0::Models::CreditMemoForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(invoice_key)}/credit/memos").with_json(credit_memo_form.to_json).post
  ::Io::Flow::V0::Models::ConsumerInvoice.new(r)
end

#post_exports(organization, invoice_export_form) ⇒ Object

Creates an export of the consumer/invoices



5308
5309
5310
5311
5312
5313
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5308

def post_exports(organization, invoice_export_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = invoice_export_form; x.is_a?(::Io::Flow::V0::Models::InvoiceExportForm) ? x : ::Io::Flow::V0::Models::InvoiceExportForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/exports").with_json(invoice_export_form.to_json).post
  ::Io::Flow::V0::Models::InvoiceExport.new(r)
end

#put_by_key(organization, key, consumer_invoice_form) ⇒ Object 



5357
5358
5359
5360
5361
5362
5363
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5357

def put_by_key(organization, key, consumer_invoice_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  (x = consumer_invoice_form; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceForm) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(key)}").with_json(consumer_invoice_form.to_json).put
  ::Io::Flow::V0::Models::ConsumerInvoice.new(r)
end

#put_credit_and_memos_by_invoice_key_and_key(organization, invoice_key, key, credit_memo_form) ⇒ Object

Upserts a credit memo against this invoice



5333
5334
5335
5336
5337
5338
5339
5340
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5333

def put_credit_and_memos_by_invoice_key_and_key(organization, invoice_key, key, credit_memo_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('invoice_key', invoice_key, String)
  HttpClient::Preconditions.assert_class('key', key, String)
  (x = credit_memo_form; x.is_a?(::Io::Flow::V0::Models::CreditMemoForm) ? x : ::Io::Flow::V0::Models::CreditMemoForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/#{CGI.escape(invoice_key)}/credit/memos/#{CGI.escape(key)}").with_json(credit_memo_form.to_json).put
  ::Io::Flow::V0::Models::ConsumerInvoice.new(r)
end

#put_order_by_number(organization, number, consumer_invoice_form_by_order) ⇒ Object 



5315
5316
5317
5318
5319
5320
5321
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 5315

def put_order_by_number(organization, number, consumer_invoice_form_by_order)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  (x = consumer_invoice_form_by_order; x.is_a?(::Io::Flow::V0::Models::ConsumerInvoiceFormByOrder) ? x : ::Io::Flow::V0::Models::ConsumerInvoiceFormByOrder.new(x))
  r = @client.request("/#{CGI.escape(organization)}/consumer/invoices/order/#{CGI.escape(number)}").with_json(consumer_invoice_form_by_order.to_json).put
  ::Io::Flow::V0::Models::ConsumerInvoice.new(r)
end