elixir_plaid v1.2.1

View Source Plaid.Employer (elixir_plaid v1.2.1)

Plaid Employer API calls and schema.

🏗 I haven't tested this yet against the actual plaid API because I can't get the deposit_switch product in plaid yet. If you test it, let me know and I can take off the in-progress status!

Link to this section Summary

Types

t()

Functions

search(query, products, config)

Search employers information.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Plaid.Employer{
  address: Plaid.Address.t() | nil,
  confidence_score: number() | nil,
  employer_id: String.t(),
  name: String.t()
}

Link to this section Functions

Link to this function

search(query, products, config)

View Source

Specs

search(String.t(), [String.t()], Plaid.config()) ::
  {:ok, Plaid.Employer.SearchResponse.t()} | {:error, Plaid.Error.t()}

Search employers information.

Does a POST /employers/search call to search Plaid’s database of known employers, for use with Deposit Switch

Params:

  • query - The employer name to be searched for.
  • products - The Plaid products the returned employers should support.

Currently in the Plaid API, products must be set to ["deposit_switch"].

examples

 Examples 

Employer.search("Plaid", ["deposit_switch"], client_id: "123", secret: "abc")
{:ok, %Employer.SearchResponse{}}