tiagopog / iugu-elixir

Elixir client for the Iugu's API

Iugu

Elixir client library to work with the Iugu's REST API.

Since the lib is still in its early days one may find some missing endpoints, so please check the Endpoint Coverage wiki page for more details.

Installation

If available in Hex, the package can be installed as:

1. Add iugu to your list of dependencies in mix.exs:

def deps do
  [{:iugu, "~> 0.1.0"}]
 end

2. Ensure iugu is started before your application:

def application do
  [applications: [:iugu]]
end

Usage

Credentials

1. Get your Iugu's API KEY;

2. Set the key on your project:

Via config

Directly:

# config/config.exs
config :iugu,
  api_key: "foobar"

Or export the key to your environment and access it via System.get_env/1 (recommended):

# .env
IUGU_API_KEY=foobar

# config/config.exs
config :iugu,
  api_key: System.get_env("IUGU_API_KEY")

This way you can call the resource actions with no need to pass the %Iugu.Resource{} as argument:

Iugu.Customer.list() #=> {:ok, [...], 42}

Via struct

It's also possible to set the key into a %Iugu.Request{} struct:

%Iugu.Request{api_key: "foobar"} |> Iugu.Customer.list()

Resources

The CRUD actions are present in almost all the resources, here's an example for "customers":

Create

%Iugu.Customer{name: "Foobar", email: "[e-mail]"} |> Iugu.Customer.create()
#=> {:ok, %Iugu.Customer{name: "Foobar", email: "[e-mail]",...}}

Show

Iugu.Customer.show("6DB324B6859D4D46A3B8689AC745A943")
#=> {:ok, %Iugu.Customer{cc_emails: nil, city: "Campo Mourão", complement: "Cobertura",...}}

List

Iugu.Customer.list()
#=> {:ok, [%Iugu.Customer{cc_emails: nil, city: "Campo Mourão", complement: "Cobertura",...}], 128}

For more usage examples, please check the Usage wiki page.