Coffrify. Resources. Coffres
(Coffrify v0.9.0)
View Source
Coffres — mini document vaults bundling transfers + external links.
Summary
Functions
Read the access log entries for a coffre. Requires audit:read.
Add an item (transfer or external URL).
Add a section.
Create a coffre.
Delete a coffre.
Get a coffre by id (with sections + items).
List coffres.
List items of a coffre.
List sections of a coffre.
Remove an item.
Remove a section.
Update a coffre.
Update an item.
Update a section.
Functions
@spec access_log(Coffrify.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Exception.t()}
Read the access log entries for a coffre. Requires audit:read.
@spec add_item(Coffrify.t(), String.t(), map() | keyword()) :: {:ok, map()} | {:error, Exception.t()}
Add an item (transfer or external URL).
@spec add_section(Coffrify.t(), String.t(), map() | keyword()) :: {:ok, map()} | {:error, Exception.t()}
Add a section.
@spec create(Coffrify.t(), map() | keyword()) :: {:ok, map()} | {:error, Exception.t()}
Create a coffre.
@spec delete(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Delete a coffre.
@spec get(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Get a coffre by id (with sections + items).
@spec list(Coffrify.t()) :: {:ok, map()} | {:error, Exception.t()}
List coffres.
@spec list_items(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
List items of a coffre.
@spec list_sections(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
List sections of a coffre.
@spec remove_item(Coffrify.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Remove an item.
@spec remove_section(Coffrify.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}
Remove a section.
@spec update(Coffrify.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Update a coffre.
@spec update_item(Coffrify.t(), String.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Update an item.
@spec update_section(Coffrify.t(), String.t(), String.t(), map()) :: {:ok, map()} | {:error, Exception.t()}
Update a section.