Class: Lago::Api::Resources::Invoice

Inherits:
Base
  • Object
show all
Defined in:
lib/lago/api/resources/invoice.rb

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#destroy, #get, #get_all, #initialize, #update

Constructor Details

This class inherits a constructor from Lago::Api::Resources::Base

Instance Method Details

#api_resource ⇒ Object 



7
8
9
 
# File 'lib/lago/api/resources/invoice.rb', line 7

def api_resource
  'invoices'
end

#create(params) ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/lago/api/resources/invoice.rb', line 15

def create(params)
  payload = one_off_params(params)
  response = connection.post(payload)[root_name]

  JSON.parse(response.to_json, object_class: OpenStruct)
end

#download(invoice_id) ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/lago/api/resources/invoice.rb', line 22

def download(invoice_id)
  path = "/api/v1/invoices/#{invoice_id}/download"
  response = connection.post({}, path)

  return response unless response.is_a?(Hash)

  JSON.parse(response.to_json, object_class: OpenStruct).invoice
end

#finalize(invoice_id) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/lago/api/resources/invoice.rb', line 38

def finalize(invoice_id)
  path = "/api/v1/invoices/#{invoice_id}/finalize"
  response = connection.put(path, identifier: nil, body: {})

  JSON.parse(response.to_json, object_class: OpenStruct).invoice
end

#one_off_params(params) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/lago/api/resources/invoice.rb', line 83

def one_off_params(params)
  result = {
    external_customer_id: params[:external_customer_id],
    currency: params[:currency],
    net_payment_term: params[:net_payment_term],
  }

  fees = whitelist_fees(params[:fees])
  result[:fees] = fees unless fees.empty?

  { root_name => result }
end

#payment_url(invoice_id) ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/lago/api/resources/invoice.rb', line 52

def payment_url(invoice_id)
  path = "/api/v1/invoices/#{invoice_id}/payment_url"
  response = connection.post({}, path)['invoice_payment_details']

  JSON.parse(response.to_json, object_class: OpenStruct)
end

#refresh(invoice_id) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/lago/api/resources/invoice.rb', line 31

def refresh(invoice_id)
  path = "/api/v1/invoices/#{invoice_id}/refresh"
  response = connection.put(path, identifier: nil, body: {})

  JSON.parse(response.to_json, object_class: OpenStruct).invoice
end

#retry_payment(invoice_id) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/lago/api/resources/invoice.rb', line 45

def retry_payment(invoice_id)
  path = "/api/v1/invoices/#{invoice_id}/retry_payment"
  response = connection.post({}, path)

  JSON.parse(response.to_json, object_class: OpenStruct)
end

#root_name ⇒ Object 



11
12
13
 
# File 'lib/lago/api/resources/invoice.rb', line 11

def root_name
  'invoice'
end

#whitelist_fees(fees) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/lago/api/resources/invoice.rb', line 96

def whitelist_fees(fees)
  processed_fees = []

  fees.each do |f|
    result = (f || {}).slice(
      :add_on_code,
      :unit_amount_cents,
      :units,
      :description,
      :tax_codes,
      :invoice_display_name,
    )

    processed_fees << result unless result.empty?
  end

  processed_fees
end

#whitelist_metadata(metadata) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/lago/api/resources/invoice.rb', line 71

def whitelist_metadata(metadata)
  processed_metadata = []

  metadata.each do |m|
    result = (m || {}).slice(:id, :key, :value)

    processed_metadata << result unless result.empty?
  end

  processed_metadata
end

#whitelist_params(params) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/lago/api/resources/invoice.rb', line 59

def whitelist_params(params)
  result = {
    payment_status: params[:payment_status],
    net_payment_term: params[:net_payment_term],
  }

  metadata = whitelist_metadata(params[:metadata])
  result[:metadata] = metadata unless metadata.empty?

  { root_name => result }
end