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).

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.

Update a coffre.

Functions

access_log(client, coffre_id, opts \\ [])

@spec access_log(Coffrify.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Exception.t()}

Read the access log entries for a coffre. Requires audit:read.

add_item(client, coffre_id, opts)

@spec add_item(Coffrify.t(), String.t(), map() | keyword()) ::
  {:ok, map()} | {:error, Exception.t()}

Add an item (transfer or external URL).

add_section(client, coffre_id, opts)

@spec add_section(Coffrify.t(), String.t(), map() | keyword()) ::
  {:ok, map()} | {:error, Exception.t()}

Add a section.

create(client, opts)

@spec create(Coffrify.t(), map() | keyword()) ::
  {:ok, map()} | {:error, Exception.t()}

Create a coffre.

delete(client, id)

@spec delete(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}

Delete a coffre.

get(client, id)

@spec get(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}

Get a coffre by id (with sections + items).

list(client)

@spec list(Coffrify.t()) :: {:ok, map()} | {:error, Exception.t()}

List coffres.

list_items(client, coffre_id)

@spec list_items(Coffrify.t(), String.t()) :: {:ok, map()} | {:error, Exception.t()}

List items of a coffre.

list_sections(client, coffre_id)

@spec list_sections(Coffrify.t(), String.t()) ::
  {:ok, map()} | {:error, Exception.t()}

List sections of a coffre.

remove_item(client, coffre_id, item_id)

@spec remove_item(Coffrify.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Exception.t()}

Remove an item.

remove_section(client, coffre_id, section_id)

@spec remove_section(Coffrify.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Exception.t()}

Remove a section.

update(client, id, patch)

@spec update(Coffrify.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Exception.t()}

Update a coffre.

update_item(client, coffre_id, item_id, patch)

@spec update_item(Coffrify.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Exception.t()}

Update an item.

update_section(client, coffre_id, section_id, patch)

@spec update_section(Coffrify.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Exception.t()}

Update a section.