Packages

plaid_elixir

2.1.0
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 link.ex
Raw

lib/plaid/link.ex 

defmodule Plaid.Link do

  @moduledoc """

  Functions for Plaid `link` endpoint.

  """



  import Plaid, only: [make_request_with_cred: 4, validate_cred: 1]



  alias Plaid.Utils



  @derive Jason.Encoder

  defstruct link_token: nil,

            expiration: nil,

            request_id: nil



  @type t :: %__MODULE__{

          link_token: String.t(),

          expiration: String.t(),

          request_id: String.t()

        }

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

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



  @endpoint :link



  @doc """

  Creates a Link Token.



  Parameters

  ```

  %{

    client_name: "",

    language: "",

    country_codes: "",

    user: %{client_user_id: ""}

  }

  ```

  """

  @spec create_link_token(params, config | nil) ::

          {:ok, Plaid.Link.t()} | {:error, Plaid.Error.t()}

  def create_link_token(params, config \\ %{}) do

    config = validate_cred(config)

    endpoint = "#{@endpoint}/token/create"



    make_request_with_cred(:post, endpoint, config, params)

    |> Utils.handle_resp(@endpoint)

  end

end