ApiBrasil.Data.Bulk (APIBrasil v0.0.1)

Copy Markdown View Source

Execução em lote: POST /bulk/direct/{action} e POST /bulk/queue/{action}.

direct/4 executa o lote de forma síncrona e queue/4 apenas o enfileira, devolvendo o protocolo do processamento.

{:ok, _resultado} = ApiBrasil.Data.Bulk.direct(client, "cpf", %{"items" => items})
{:ok, _protocolo} = ApiBrasil.Data.Bulk.queue(client, "cpf", %{"items" => items})

Summary

Functions

Executa um lote de forma síncrona: POST /bulk/direct/{action}.

Enfileira um lote: POST /bulk/queue/{action}.

Types

result()

@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}

Functions

direct(client, action, body \\ nil, opts \\ [])

@spec direct(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: result()

Executa um lote de forma síncrona: POST /bulk/direct/{action}.

direct!(client, action, body \\ nil, opts \\ [])

@spec direct!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: map()

Como direct/4, mas levanta ApiBrasil.Core.Error em caso de falha.

queue(client, action, body \\ nil, opts \\ [])

@spec queue(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: result()

Enfileira um lote: POST /bulk/queue/{action}.

queue!(client, action, body \\ nil, opts \\ [])

@spec queue!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: map()

Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.