ApiBrasil.Data.Holidays (APIBrasil v0.0.1)

Copy Markdown View Source

Feriados (device-based): POST /holidays/{action}.

Além das funções nomeadas, request/4 aceita qualquer action do catálogo e queue/4 executa a mesma action por fila.

{:ok, envelope} = ApiBrasil.Data.Holidays.feriados(client, body)
ApiBrasil.Core.DeviceResponse.response(envelope)

Summary

Functions

Lista os feriados: POST /holidays/feriados.

Como feriados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

Executa a action de forma assíncrona, por fila: POST /holidays/{action}/queue.

Executa qualquer action do serviço: POST /holidays/{action}.

Serviço do gateway coberto por este módulo: holidays.

Types

result()

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

Functions

feriados(client, body \\ nil, opts \\ [])

@spec feriados(ApiBrasil.Client.t(), term(), keyword()) ::
  {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}

Lista os feriados: POST /holidays/feriados.

feriados!(client, body \\ nil, opts \\ [])

Como feriados/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.

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

Executa a action de forma assíncrona, por fila: POST /holidays/{action}/queue.

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

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

request(client, action_name, body \\ nil, opts \\ [])

Executa qualquer action do serviço: POST /holidays/{action}.

As actions conhecidas estão em ApiBrasil.Generated.Catalog.service_actions("holidays"); a documentação completa fica em https://doc.apibrasil.io.

request!(client, action_name, body \\ nil, opts \\ [])

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

service()

@spec service() :: String.t()

Serviço do gateway coberto por este módulo: holidays.