https://github.com/sticksnleaves/ex_easypost

Elixir client for the EasyPost API
https://github.com/sticksnleaves/ex_easypost

easypost-api elixir-client

Last synced: about 1 month ago
JSON representation

Elixir client for the EasyPost API

• Host: GitHub
• URL: https://github.com/sticksnleaves/ex_easypost
• Owner: sticksnleaves
• License: mit
• Created: 2017-06-14T17:00:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T07:33:21.000Z (almost 2 years ago)
• Last Synced: 2024-03-14T23:47:58.476Z (9 months ago)
• Topics: easypost-api, elixir-client
• Language: Elixir
• Homepage: https://hex.pm/packages/ex_easypost
• Size: 151 KB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EasyPost for Elixir

## Installation

`ex_easypost` is publbished on [Hex](https://hex.pm/packages/ex_easypost). Add

it to your list of dependencies in `mix.exs`:

```elixir

defp deps do

  [

    { :ex_easypost, "~> 3.0" }

  ]

end

```

`ex_easypost` requires you to provide an HTTP client and a JSON codec. `hackney`

and `jason` are used by default. If you wish to use these defaults you will need

add `hackney` and `jason` as dependencies as well.

## Usage

You can send a request to the EasyPost API by building an `EasyPost.Operation`

struct and passing it as the first argument to `EasyPost.request/2` and passing

a configuration map as the second argument.

### Example

```elixir

iex> params

...> |> EasyPost.Shipment.create()

...> |> EasyPost.request(%{ api_key: "xxx" })

{ :ok, %EasyPost.Response{} }

```

An `EasyPost.Operation` struct can be built using either a resource module

(e.g. `EasyPost.Shipment`) or by building the struct manually.

`EasyPost.Operation` contains fields `:method`, `:params` and `:path`.

* `:method` - an HTTP method and can be one of `:delete`, `:get`, `:post` or

  `:put`

* `:params` - data to be sent as the body of the request

* `:path` - the path to send the request to. Must begin with a forward slash.

## Configuration

* `:api_key` - API key used when making authenticated requests

* `:host` - HTTP host to make requests to. Defaults to `api.easypost.com`.

* `:http_client` -  the HTTP client used for making requests. Defaults to

  `EasyPost.HTTP.Hackney`.

* `:http_client_opts` - additional options passed to `:http_client`. Defaults to

  `[]`.

* `:json_codec` - codec for encoding and decoding JSON payloads. Defaults to

  `Jason`.

* `:path` - path to prefix on each request. Defaults to `/v2`.

* `:port` - the HTTP port used when making a request

* `:protocol` - the HTTP protocol used when making a request. Defaults to

  `https`.

* `:retry` - whether to automatically retry failed API calls. May be `true` or

  `false`. Defaults to `false`.  

* `:retry_opts` - options used when performing retries. Defaults to `[]`.

  * `:max_attempts` - the maximum number of retry attempts. Defaults to `3`.