ExPersona.Document (ex_persona v0.0.2) View Source

Module for getting a document's metadata and downloading its contents.

For instance:

doc = ExPersona.Document.get("an-id") |> ExPersona.request!()
if Document.has_file?(doc, "front_image") do
  {:ok, body} = Document.download_file(doc, "front_image")
  File.write("front_image.png", body)
end

Link to this section Summary

Types

t()

Functions

download_file(document, name)

Create an ExPersona.Client.Operation to then request for a file's contents.

get(id)

Get a specific ExPersona.Document.

has_file?(document, name)

Determind if the ExPersona.Document contains a file with the given name.

Link to this section Types

t()

Specs

t() :: %ExPersona.Document{data: map(), id: String.t()}

Link to this section Functions

download_file(document, name)

Specs

download_file(t(), String.t()) :: ExPersona.Client.Operation.t()

Create an ExPersona.Client.Operation to then request for a file's contents.

get(id)

Specs

get(String.t()) :: ExPersona.Client.Operation.t()

Get a specific ExPersona.Document.

has_file?(document, name)

Specs

has_file?(t(), String.t()) :: boolean()

Determind if the ExPersona.Document contains a file with the given name.