Packages

plaid_elixir

1.7.4
3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.1 1.9.0 1.8.1 1.8.0 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.0 1.5.2 1.5.1 1.5.0 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.0 1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0 0.3.0 0.2.0 0.1.0

An Elixir Library for Plaid's V2 API

HexDocs

Current section

Files

Jump to
Readme
41 Versions
3 Dependencies
Dependants
Files
Activity
plaid_elixir lib plaid categories.ex
Raw

lib/plaid/categories.ex 

defmodule Plaid.Categories do

  @moduledoc """

  Functions for Plaid `categories` endpoint.

  """



  @derive Jason.Encoder

  defstruct categories: [], request_id: nil



  @type t :: %__MODULE__{categories: [Plaid.Categories.Category.t()], request_id: String.t()}

  @type config :: %{required(atom) => String.t()}



  @endpoint :categories



  defmodule Category do

    @moduledoc """

    Plaid Category data structure.

    """



    @derive Jason.Encoder

    defstruct category_id: nil, hierarchy: [], group: nil

    @type t :: %__MODULE__{category_id: String.t(), hierarchy: list, group: String.t()}

  end



  @doc """

  Gets all categories.

  """

  @spec get(config | nil) :: {:ok, Plaid.Categories.t()} | {:error, Plaid.Error.t()}

  def get(config \\ %{}) do

    config = Map.drop(config, [:public_key, :client_id, :secret])

    endpoint = "#{@endpoint}/get"



    Plaid.make_request_with_cred(:post, endpoint, config)

    |> Plaid.Utils.handle_resp(@endpoint)

  end

end