Class: Lago::Api::Resources::Customer

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

Instance Attribute Summary

Attributes inherited from Base

#client

Instance Method Summary collapse

Methods inherited from Base

#create, #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/customer.rb', line 9

def api_resource
  'customers'
end

#checkout_url(external_customer_id) ⇒ Object 



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

def checkout_url(external_customer_id)
  uri = URI(
    "#{client.base_api_url}#{api_resource}/#{external_customer_id}/checkout_url",
  )

  response = connection.post({}, uri)[root_name]

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

#current_usage(external_customer_id, external_subscription_id, apply_taxes: nil) ⇒ Object 



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

def current_usage(external_customer_id, external_subscription_id, apply_taxes: nil)
  query_params = { external_subscription_id: external_subscription_id }
  query_params[:apply_taxes] = apply_taxes unless apply_taxes.nil?
  query_string = URI.encode_www_form(query_params)

  uri = URI("#{client.base_api_url}#{api_resource}/#{external_customer_id}/current_usage?#{query_string}")
  connection.get(uri, identifier: nil)
end

#past_usage(external_customer_id, external_subscription_id, options = {}) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/lago/api/resources/customer.rb', line 26

def past_usage(external_customer_id, external_subscription_id, options = {})
  uri = URI(
    "#{client.base_api_url}#{api_resource}/#{external_customer_id}/past_usage",
  )

  connection.get_all(
    options.merge(external_subscription_id: external_subscription_id),
    uri,
  )
end

#portal_url(external_customer_id) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/lago/api/resources/customer.rb', line 37

def portal_url(external_customer_id)
  uri = URI(
    "#{client.base_api_url}#{api_resource}/#{external_customer_id}/portal_url",
  )

  response = connection.get(uri, identifier: nil)[root_name]

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

#root_name ⇒ Object 



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

def root_name
  'customer'
end

#whitelist_billing_configuration(billing_params) ⇒ Object 



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

def whitelist_billing_configuration(billing_params)
  (billing_params || {}).slice(
    :invoice_grace_period,
    :payment_provider,
    :payment_provider_code,
    :provider_customer_id,
    :sync,
    :sync_with_provider,
    :document_locale,
    :provider_payment_methods,
  )
end

#whitelist_integration_customers(integration_customers) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/lago/api/resources/customer.rb', line 128

def whitelist_integration_customers(integration_customers)
  processed_integration_customers = []

  (integration_customers || []).each do |m|
    result = (m || {})
      .slice(:id,
             :external_customer_id,
             :integration_type,
             :integration_code,
             :subsidiary_id,
             :sync_with_provider)

    processed_integration_customers << result unless result.empty?
  end

  processed_integration_customers
end

#whitelist_metadata(metadata) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/lago/api/resources/customer.rb', line 146

def whitelist_metadata(metadata)
  processed_metadata = []

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

    processed_metadata << result unless result.empty?
  end

  processed_metadata
end

#whitelist_params(params) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/lago/api/resources/customer.rb', line 57

def whitelist_params(params)
  result_hash = {
    external_id: params[:external_id],
    address_line1: params[:address_line1],
    address_line2: params[:address_line2],
    city: params[:city],
    country: params[:country],
    email: params[:email],
    legal_name: params[:legal_name],
    legal_number: params[:legal_number],
    net_payment_term: params[:net_payment_term],
    tax_identification_number: params[:tax_identification_number],
    logo_url: params[:logo_url],
    name: params[:name],
    firstname: params[:firstname],
    lastname: params[:lastname],
    customer_type: params[:customer_type],
    phone: params[:phone],
    state: params[:state],
    url: params[:url],
    zipcode: params[:zipcode],
    currency: params[:currency],
    tax_codes: params[:tax_codes],
    invoice_custom_section_codes: params[:invoice_custom_section_codes],
    timezone: params[:timezone],
    finalize_zero_amount_invoice: params[:finalize_zero_amount_invoice],
    skip_invoice_custom_sections: params[:skip_invoice_custom_sections],
    billing_entity_code: params[:billing_entity_code],
  }

  whitelist_billing_configuration(params[:billing_configuration]).tap do |config|
    result_hash[:billing_configuration] = config unless config.empty?
  end

  whitelist_shipping_address(params[:shipping_address]).tap do |address|
    result_hash[:shipping_address] = address unless address.empty?
  end

  integration_customers = whitelist_integration_customers(params[:integration_customers])
  result_hash[:integration_customers] = integration_customers unless integration_customers.empty?

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

  { root_name => result_hash }
end

#whitelist_shipping_address(address) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/lago/api/resources/customer.rb', line 117

def whitelist_shipping_address(address)
  (address || {}).slice(
    :address_line1,
    :address_line2,
    :city,
    :zipcode,
    :state,
    :country,
  )
end