Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 820 Bytes

README.md

File metadata and controls

39 lines (27 loc) · 820 Bytes

OneflowEx

Installation

The package can be installed by adding oneflow_ex to your list of dependencies in mix.exs:

def deps do
  [{:oneflow_ex, git: "https://github.com/gilacost/oneflow_ex.git"}}]
end

Configuration

config :oneflow_ex,
  token: "TOKEN",
  secret: "SECRET",
  log: true,
  endpoint: "https://API-URL/api",
  http: [] # these will be passed to hackney

Usage

Basic examples

{:ok, order} = OnflowEx.get("/order/ORDER-ID", %{})
{:ok, result} = OnflowEx.search("query", "shipments", ["status:shipped])

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/oneflow_ex.