Coffrify.Resources.Requests (Coffrify v0.9.0)

View Source

Request inboxes — drop-box endpoints that collect files from third parties.

Summary

Functions

Create a request inbox. Returns the share URL.

Delete a request inbox.

Get a request inbox.

List request inboxes.

List submissions received on an inbox.

Update a request inbox.

Functions

create(client, opts)

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

Create a request inbox. Returns the share URL.

delete(client, id)

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

Delete a request inbox.

get(client, id)

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

Get a request inbox.

list(client)

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

List request inboxes.

list_submissions(client, id)

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

List submissions received on an inbox.

update(client, id, patch)

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

Update a request inbox.