defmodule PINXS.Transfers.Transfer do alias PINXS.HTTP.API alias __MODULE__ @moduledoc """ Proived functions for creating and working with transfers """ @derive [Poison.Encoder] defstruct [ :amount, :bank_account, :created_at, :currency, :description, :paid_at, :recipient, :reference, :status, :token, :total_credits, :total_debits ] @type t :: %__MODULE__{ amount: integer(), bank_account: nil | PINXS.BankAccounts.BankAccount, created_at: nil | String.t, currency: nil | String.t, description: nil | String.t, paid_at: nil | String.t, recipient: String.t, reference: nil | String.t, status: nil | String.t, token: nil | String.t, total_credits: nil | integer(), total_debits: nil | integer() } @doc """ Create a transfer """ @spec create(Transfer.t(), PINXS.t()) :: {:ok, Transfer.t} | {:error, PINXS.Error.t} def create(%Transfer{currency: "AUD"} = transfer, %PINXS{} = config) do API.post("/transfers", transfer, __MODULE__, config) end def create(%Transfer{} = transfer, %PINXS{} = config) do Map.put(transfer, :currency, "AUD") |> create(config) end @doc """ Gets a transfer """ @spec get(String.t(), PINXS.t()) :: {:ok, Transfer.t} | {:error, PINXS.Error.t} def get(transfer_token, %PINXS{} = config) do API.get("/transfers/#{transfer_token}", __MODULE__, config) end @doc """ Gets a paginated list of transfers """ @spec get_all(PINXS.t()) :: {:ok, [Transfer.t]} | {:error, PINXS.Error.t} def get_all(%PINXS{} = config) do API.get("/transfers", __MODULE__, config) end @doc """ Gets a specific pages of transfers """ @spec get_all(non_neg_integer(), PINXS.t()) :: {:ok, [Transfer.t]} | {:error, PINXS.Error.t} def get_all(page, %PINXS{} = config) when is_integer(page) do API.get("/transfers?page=#{page}", __MODULE__, config) end @spec get_line_items(String.t(), PINXS.t()) :: {:ok, [Transfer.t]} | {:error, PINXS.Error.t} def get_line_items(transfer_token, %PINXS{} = config) do API.get("/transfers/#{transfer_token}/line_items",__MODULE__, config) end @doc """ Retrieve transfers based on search criteria ## Search options ``` %{ query: "", start_date: "YYYY/MM/DD", # 2013/01/01 end_date: "YYYY/MM/DD", # 2013/12/25 sort: "", # field to sort by, default `created_at` direction: 1 # 1 or -1 } ``` """ @spec search(map(), PINXS.t()) :: {:ok, map()} | {:error, PINXS.Error.t()} def search(query_map, %PINXS{} = config) do API.search("/transfers/search", query_map, __MODULE__, config) end end