Packages

plaid_elixir

2.3.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 webhook_verification_key.ex
Raw

lib/plaid/webhook_verification_key.ex 

defmodule Plaid.WebhookVerificationKey do

  @moduledoc """

  Functions for Plaid `webhook_verification_key` endpoint.

  """



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



  alias Plaid.Utils



  @derive Jason.Encoder

  defstruct key: %{},

            request_id: nil



  @type t :: %__MODULE__{

          key: map(),

          request_id: String.t()

        }

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

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



  @endpoint :webhook_verification_key



  @doc """

  Gets a webhook verification key (JWK).



  Parameters

  ```

  %{

    key_id: "The key ID (kid) from the webhook's JWT header."

  }

  ```

  """

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

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

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

    config = validate_cred(config)

    endpoint = "#{@endpoint}/get"



    make_request_with_cred(:post, endpoint, config, params)

    |> Utils.handle_resp(@endpoint)

  end

end