Increase.LockboxRecipients (Increase v1.0.0)

Copy Markdown View Source

Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.

See https://increase.com/documentation/api/lockbox-recipients for the full API reference for this resource.

Summary

Functions

create(client, params \\ %{}, opts \\ [])

Create a Lockbox Recipient

list(client, params \\ %{}, opts \\ [])

List Lockbox Recipients

retrieve(client, lockbox_recipient_id, opts \\ [])

Retrieve a Lockbox Recipient

update(client, lockbox_recipient_id, params \\ %{}, opts \\ [])

Update a Lockbox Recipient

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.LockboxRecipients.LockboxRecipient.t()}
  | {:error, Increase.Error.t()}

Create a Lockbox Recipient

POST /lockbox_recipients

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Lockbox Recipients

Returns a %Increase.Page{} whose data is a list of %__MODULE__. LockboxRecipient{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /lockbox_recipients

retrieve(client, lockbox_recipient_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.LockboxRecipients.LockboxRecipient.t()}
  | {:error, Increase.Error.t()}

Retrieve a Lockbox Recipient

GET /lockbox_recipients/{lockbox_recipient_id}

update(client, lockbox_recipient_id, params \\ %{}, opts \\ [])

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.LockboxRecipients.LockboxRecipient.t()}
  | {:error, Increase.Error.t()}

Update a Lockbox Recipient

PATCH /lockbox_recipients/{lockbox_recipient_id}