Pluggy.Items (PluggyAI v0.1.0)

Copy Markdown View Source

Functions for interacting with the Pluggy Items API.

An item represents a connection to a financial institution.

Summary

Functions

create(client, attrs)

Creates a new item (connection to a financial institution).

create!(client, attrs)
delete(client, id)

Deletes an item.

delete!(client, id)
disable_auto_sync(client, id)

Disables automatic sync for an item.

disable_auto_sync!(client, id)
get(client, id)

Gets an item by ID.

get!(client, id)
send_mfa(client, id, params)

Sends MFA (multi-factor authentication) response for an item.

send_mfa!(client, id, params)
update(client, id, attrs)

Updates an item.

update!(client, id, attrs)

Functions

create(client, attrs)

@spec create(Pluggy.Client.t(), map()) :: {:ok, term()} | {:error, Pluggy.Error.t()}

Creates a new item (connection to a financial institution).

create!(client, attrs)

@spec create!(Pluggy.Client.t(), map()) :: term()

delete(client, id)

@spec delete(Pluggy.Client.t(), String.t()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Deletes an item.

delete!(client, id)

@spec delete!(Pluggy.Client.t(), String.t()) :: term()

disable_auto_sync(client, id)

@spec disable_auto_sync(Pluggy.Client.t(), String.t()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Disables automatic sync for an item.

disable_auto_sync!(client, id)

@spec disable_auto_sync!(Pluggy.Client.t(), String.t()) :: term()

get(client, id)

@spec get(Pluggy.Client.t(), String.t()) :: {:ok, term()} | {:error, Pluggy.Error.t()}

Gets an item by ID.

get!(client, id)

@spec get!(Pluggy.Client.t(), String.t()) :: term()

send_mfa(client, id, params)

@spec send_mfa(Pluggy.Client.t(), String.t(), map()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Sends MFA (multi-factor authentication) response for an item.

send_mfa!(client, id, params)

@spec send_mfa!(Pluggy.Client.t(), String.t(), map()) :: term()

update(client, id, attrs)

@spec update(Pluggy.Client.t(), String.t(), map()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Updates an item.

update!(client, id, attrs)

@spec update!(Pluggy.Client.t(), String.t(), map()) :: term()