Packages

accounting

0.10.5
0.11.0 0.10.5 0.10.4 0.10.3 0.10.2 0.10.1 0.10.0 0.9.0 0.8.0 0.7.1 0.7.0 0.6.0 0.5.0 0.4.2 0.4.1 0.4.0 0.3.3 0.3.2 0.3.1 0.3.0 0.2.2 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0

Accounting.

HexDocs

Current section

Files

Jump to
Readme
26 Versions
3 Dependencies
Dependants
Files
Activity
accounting lib accounting adapters xero_adapter http_client.ex
Raw

lib/accounting/adapters/xero_adapter/http_client.ex 

defmodule Accounting.XeroAdapter.HTTPClient do

  @moduledoc """

  A behaviour module for implementing a Xero HTTP client.

  """



  @type credentials :: %OAuther.Credentials{}

  @type endpoint :: String.t

  @type params :: keyword

  @type xml :: String.t



  @callback get(endpoint, timeout, credentials) :: {:ok, HTTPoison.Response.t} | {:error, HTTPoison.Error.t}

  @callback get(endpoint, timeout, credentials, params) :: {:ok, HTTPoison.Response.t} | {:error, HTTPoison.Error.t}

  @callback put(xml, endpoint, timeout, credentials) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}

  @callback put(xml, endpoint, timeout, credentials, params) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}

  @callback post(xml, endpoint, timeout, credentials) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}

  @callback post(xml, endpoint, timeout, credentials, params) :: {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} | {:error, HTTPoison.Error.t}

end