Humaans.Documents (Humaans v0.6.0)

This module provides functions for managing document resources in the Humaans API.

Summary

Types

delete_response()

list_response()

response()

Functions

create(client, params)

Creates a new document.

delete(client, id)

Deletes a specific document by ID.

list(client, params \\ %{})

Lists all documents.

retrieve(client, id)

Retrieves a specific document by ID.

update(client, id, params)

Updates a specific document by ID.

Types

delete_response()

@type delete_response() ::
  {:ok, %{id: String.t(), deleted: bool()}} | {:error, Humaans.Error.t()}

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.Document{
       company_id: term(),
       created_at: term(),
       created_by: term(),
       document_type_id: term(),
       file: term(),
       file_id: term(),
       folder_id: term(),
       id: term(),
       issue_date: term(),
       link: term(),
       name: term(),
       person_id: term(),
       source: term(),
       source_id: term(),
       updated_at: term()
     }
   ]}
  | {:error, Humaans.Error.t()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.Document{
     company_id: term(),
     created_at: term(),
     created_by: term(),
     document_type_id: term(),
     file: term(),
     file_id: term(),
     folder_id: term(),
     id: term(),
     issue_date: term(),
     link: term(),
     name: term(),
     person_id: term(),
     source: term(),
     source_id: term(),
     updated_at: term()
   }}
  | {:error, Humaans.Error.t()}

Functions

create(client, params)

@spec create(client :: map(), params :: map() | keyword()) ::
  {:ok, Humaans.Resources.Document.t()} | {:error, Humaans.Error.t()}

Creates a new document.

Parameters

client - Client created with Humaans.new/1
params - Map of attributes for the new document

Examples

client = Humaans.new(access_token: "your_access_token")
params = %{personId: "person_abc", documentTypeId: "type_abc", name: "Passport", link: "https://example.com/passport.pdf"}
{:ok, document} = Humaans.Documents.create(client, params)

delete(client, id)

@spec delete(client :: map(), id :: String.t()) ::
  {:ok, %{id: String.t(), deleted: boolean()}} | {:error, Humaans.Error.t()}

Deletes a specific document by ID.

Parameters

client - Client created with Humaans.new/1
id - String ID of the document to delete

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, %{id: "document_id", deleted: true}} = Humaans.Documents.delete(client, "document_id")

list(client, params \\ %{})

@spec list(client :: map(), params :: map() | keyword() | [{String.t(), term()}]) ::
  {:ok, [Humaans.Resources.Document.t()]} | {:error, Humaans.Error.t()}

Lists all documents.

Returns a list of documents matching the optional filter params.

Parameters

client - Client created with Humaans.new/1
params - Optional map of filter parameters (default: %{})

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, documents} = Humaans.Documents.list(client)
{:ok, documents} = Humaans.Documents.list(client, %{})

retrieve(client, id)

@spec retrieve(client :: map(), id :: String.t()) ::
  {:ok, Humaans.Resources.Document.t()} | {:error, Humaans.Error.t()}

Retrieves a specific document by ID.

Parameters

client - Client created with Humaans.new/1
id - String ID of the document to retrieve

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, document} = Humaans.Documents.retrieve(client, "document_id")

update(client, id, params)

@spec update(client :: map(), id :: String.t(), params :: map() | keyword()) ::
  {:ok, Humaans.Resources.Document.t()} | {:error, Humaans.Error.t()}

Updates a specific document by ID.

Parameters

client - Client created with Humaans.new/1
id - String ID of the document to update
params - Map of attributes to update

Examples

client = Humaans.new(access_token: "your_access_token")
params = %{name: "Passport (renewed)"}
{:ok, document} = Humaans.Documents.update(client, "document_id", params)