Increase.InboundMailItems (Increase v1.0.0)

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.

See https://increase.com/documentation/api/inbound-mail-items for the full API reference for this resource.

Summary

Functions

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

Action an Inbound Mail Item

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

List Inbound Mail Items

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

Retrieve an Inbound Mail Item

Functions

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

@spec action(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.InboundMailItems.InboundMailItem.t()}
  | {:error, Increase.Error.t()}

Action an Inbound Mail Item

POST /inbound_mail_items/{inbound_mail_item_id}/action

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

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

List Inbound Mail Items

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

GET /inbound_mail_items

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

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

Retrieve an Inbound Mail Item

GET /inbound_mail_items/{inbound_mail_item_id}