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 



9
10
11
 
# File 'lib/lago/api/resources/invoice.rb', line 9

def api_resource
  'invoices'
end

#create(params) ⇒ Object 



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

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 



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

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 



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

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

#lose_dispute(invoice_id) ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/lago/api/resources/invoice.rb', line 55

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

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

#one_off_params(params) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/lago/api/resources/invoice.rb', line 120

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

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

  { root_name => result }
end

#payment_url(invoice_id) ⇒ Object 



76
77
78
79
80
81
 
# File 'lib/lago/api/resources/invoice.rb', line 76

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

#preview(params) ⇒ Object 



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

def preview(params)
  path = "/api/v1/invoices/preview"
  payload = params.slice(
    :customer, :plan_code, :subscription_at, :billing_time, :coupons, :subscriptions
  )
  response = connection.post(payload, path)[root_name]

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

#refresh(invoice_id) ⇒ Object 



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

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(invoice_id) ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/lago/api/resources/invoice.rb', line 69

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

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

#retry_payment(invoice_id) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/lago/api/resources/invoice.rb', line 62

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 



13
14
15
 
# File 'lib/lago/api/resources/invoice.rb', line 13

def root_name
  'invoice'
end

#void(invoice_id, params = {}) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/lago/api/resources/invoice.rb', line 47

def void(invoice_id, params = {})
  path = "/api/v1/invoices/#{invoice_id}/void"
  payload = whitelist_void_params(params)
  response = connection.post(payload, path)

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

#whitelist_fees(fees) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/lago/api/resources/invoice.rb', line 134

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,
      :from_datetime,
      :to_datetime,
    )

    processed_fees << result unless result.empty?
  end

  processed_fees
end

#whitelist_metadata(metadata) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/lago/api/resources/invoice.rb', line 104

def whitelist_metadata(metadata)
  processed_metadata = []

  metadata.each do |m|
    raise ArgumentError, "metadata item must be a hash" unless m.is_a?(Hash)

    result = m.slice(:id, :key, :value)
    raise ArgumentError, "metadata must have key" unless result.key?(:key)
    raise ArgumentError, "metadata must have value" unless result.key?(:value)

    processed_metadata << result
  end

  processed_metadata
end

#whitelist_params(params) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/lago/api/resources/invoice.rb', line 93

def whitelist_params(params)
  result = params.slice(:payment_status, :net_payment_term)

  if params.key?(:metadata)
    metadata = whitelist_metadata(params[:metadata])
    result[:metadata] = metadata
  end

  { root_name => result }
end

#whitelist_void_params(params) ⇒ Object 



155
156
157
158
159
160
161
162
163
 
# File 'lib/lago/api/resources/invoice.rb', line 155

def whitelist_void_params(params)
  return {} unless params[:generate_credit_note]

  {
    generate_credit_note: params[:generate_credit_note],
    refund_amount: params[:refund_amount],
    credit_amount: params[:credit_amount]
  }.compact
end