ApiBrasil.Data.ChipVirtual (APIBrasil v0.0.1)

Copy Markdown View Source

Chip virtual: POST /chip/virtual/*.

Fluxo típico: liste as operadoras e os serviços disponíveis, compre um número e acompanhe a ativação.

{:ok, _operadoras} = ApiBrasil.Data.ChipVirtual.operators(client)
{:ok, compra} = ApiBrasil.Data.ChipVirtual.buy(client, %{"service" => "whatsapp"})
{:ok, _ativacao} = ApiBrasil.Data.ChipVirtual.activation(client, %{"id" => compra["id"]})

Summary

Functions

Consulta a ativação: POST /chip/virtual/activation.

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

Compra um número: POST /chip/virtual/buy.

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

Lista as operadoras: POST /chip/virtual/operators.

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

Lista os serviços disponíveis: POST /chip/virtual/services.

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

Types

result()

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

Functions

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

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

Consulta a ativação: POST /chip/virtual/activation.

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

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

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

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

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

Compra um número: POST /chip/virtual/buy.

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

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

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

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

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

Lista as operadoras: POST /chip/virtual/operators.

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

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

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

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

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

Lista os serviços disponíveis: POST /chip/virtual/services.

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

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

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