# Gocardlex

Elixir wrapper for the GoCardless API.

## Installation

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

```elixir
def deps do
  [{:gocardlex, "~> x.x.x"}]
end
```

then...

```elixir
mix deps.get
```


2. Ensure `gocardlex` is started before your application:

```elixir
def application do
  [applications: [:gocardlex]]
end
```

3. Add configuration to your app:

```elixir
config :gocardlex,
  api_base: "https://api-sandbox.gocardless.com/",
  api_version: "2015-07-06",
  access_token: "<your-token>"
```

4. Example usage:

```elixir
iex> params = %{
  customers: %{
    email: "name@email.com",
    given_name: "Firstname",
    family_name: "Lastname",
    country_code: "GB"
  }
}
iex> Gocardlex.Client.create_customer(params)
{:ok,
  %{"customers" => %{"address_line1" => nil, "address_line2" => nil,
      "address_line3" => nil, "city" => nil, "company_name" => nil,
      "country_code" => "GB", "created_at" => "2017-06-23T13:04:45.459Z",
      "email" => "name@email.com", "family_name" => "Lastname",
      "given_name" => "Firstname", "id" => "CU0009999999", "language" => "en",
      "metadata" => %{}, "postal_code" => nil, "region" => nil,
      "swedish_identity_number" => nil}}}
```

## For more information, see the Hex docs

You can read the docs [here](https://hexdocs.pm/gocardlex)

## Development Setup

If you are making changes to this codebase and want to test your code, you will need to copy the sample secret file.

```elixir
cp config/secret.sample.exs config/secret.exs
```

Then add your GoCardless token where the key is `access_token`.

## Implementation state

Resources that are implemented so far.

- [x] Customers
- [x] Customer Bank Accounts
- [x] Mandates
- [x] Payments
- [x] Creditors
- [x] Events
- [x] Creditor Bank Accounts
- [x] Payouts
- [x] Redirect Flows
- [x] Refunds
- [x] Subscriptions

Areas of the codebase that can be improved.

- [ ] Testing error cases

## License

The `gocardlex` lib is released under the [MIT License](http://www.opensource.org/licenses/MIT).