Conta: saldo, faturas, notificações e tickets.
alias ApiBrasil.Platform.Account
{:ok, saldo} = Account.balance(client)
{:ok, _} = Account.create_ticket(client, %{"subject" => "Dúvida", "message" => "Olá!"})Summary
Functions
Responde um ticket: POST /ticket/{id}/messages.
Como add_ticket_message/4, mas levanta ApiBrasil.Core.Error em caso de
falha.
Histórico de requisições por API: POST /api/requests.
Como api_requests/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Saldo/créditos da conta: GET /balance.
Como balance/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Abre um ticket: POST /ticket.
Como create_ticket/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Credenciais do usuário: GET /credentials.
Como credentials/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Indicações do usuário: GET /indications.
Como indications/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Notas fiscais das faturas: GET /invoices/notes.
Como invoice_notes/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as faturas: GET /invoices.
Como invoices/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Jobs em fila do usuário: GET /jobs.
Como jobs/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Marca todas as notificações como lidas: POST /notifications/mark-all-read.
Como mark_all_notifications_read/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Marca uma notificação como lida: PATCH /notifications/{id}/read.
Como mark_notification_read/3, mas levanta ApiBrasil.Core.Error em caso
de falha.
Lista as notificações: GET /notifications.
Como notifications/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Paga uma fatura: POST /invoices/pay.
Como pay_invoice/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Plano atual: GET /plan.
Como plan/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Histórico de requisições da conta: POST /requests.
Como requests/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista as mensagens de um ticket: GET /ticket/{id}/messages.
Como ticket_messages/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Lista os tickets de suporte: GET /tickets.
Como tickets/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Atualiza um ticket: PUT /ticket/{id}.
Como update_ticket/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec add_ticket_message( ApiBrasil.Client.t(), String.t() | integer(), term(), keyword() ) :: result()
Responde um ticket: POST /ticket/{id}/messages.
@spec add_ticket_message!( ApiBrasil.Client.t(), String.t() | integer(), term(), keyword() ) :: map()
Como add_ticket_message/4, mas levanta ApiBrasil.Core.Error em caso de
falha.
@spec api_requests(ApiBrasil.Client.t(), term(), keyword()) :: result()
Histórico de requisições por API: POST /api/requests.
@spec api_requests!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como api_requests/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec balance( ApiBrasil.Client.t(), keyword() ) :: result()
Saldo/créditos da conta: GET /balance.
@spec balance!( ApiBrasil.Client.t(), keyword() ) :: map()
Como balance/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec create_ticket(ApiBrasil.Client.t(), term(), keyword()) :: result()
Abre um ticket: POST /ticket.
@spec create_ticket!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como create_ticket/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec credentials( ApiBrasil.Client.t(), keyword() ) :: result()
Credenciais do usuário: GET /credentials.
@spec credentials!( ApiBrasil.Client.t(), keyword() ) :: map()
Como credentials/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec indications( ApiBrasil.Client.t(), keyword() ) :: result()
Indicações do usuário: GET /indications.
@spec indications!( ApiBrasil.Client.t(), keyword() ) :: map()
Como indications/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec invoice_notes( ApiBrasil.Client.t(), keyword() ) :: result()
Notas fiscais das faturas: GET /invoices/notes.
@spec invoice_notes!( ApiBrasil.Client.t(), keyword() ) :: map()
Como invoice_notes/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec invoices( ApiBrasil.Client.t(), keyword() ) :: result()
Lista as faturas: GET /invoices.
@spec invoices!( ApiBrasil.Client.t(), keyword() ) :: map()
Como invoices/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec jobs( ApiBrasil.Client.t(), keyword() ) :: result()
Jobs em fila do usuário: GET /jobs.
@spec jobs!( ApiBrasil.Client.t(), keyword() ) :: map()
Como jobs/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec mark_all_notifications_read( ApiBrasil.Client.t(), keyword() ) :: result()
Marca todas as notificações como lidas: POST /notifications/mark-all-read.
@spec mark_all_notifications_read!( ApiBrasil.Client.t(), keyword() ) :: map()
Como mark_all_notifications_read/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec mark_notification_read(ApiBrasil.Client.t(), String.t() | integer(), keyword()) :: result()
Marca uma notificação como lida: PATCH /notifications/{id}/read.
@spec mark_notification_read!(ApiBrasil.Client.t(), String.t() | integer(), keyword()) :: map()
Como mark_notification_read/3, mas levanta ApiBrasil.Core.Error em caso
de falha.
@spec notifications( ApiBrasil.Client.t(), keyword() ) :: result()
Lista as notificações: GET /notifications.
@spec notifications!( ApiBrasil.Client.t(), keyword() ) :: map()
Como notifications/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec pay_invoice(ApiBrasil.Client.t(), term(), keyword()) :: result()
Paga uma fatura: POST /invoices/pay.
@spec pay_invoice!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como pay_invoice/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec plan( ApiBrasil.Client.t(), keyword() ) :: result()
Plano atual: GET /plan.
@spec plan!( ApiBrasil.Client.t(), keyword() ) :: map()
Como plan/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec requests(ApiBrasil.Client.t(), term(), keyword()) :: result()
Histórico de requisições da conta: POST /requests.
@spec requests!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como requests/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec ticket_messages(ApiBrasil.Client.t(), String.t() | integer(), keyword()) :: result()
Lista as mensagens de um ticket: GET /ticket/{id}/messages.
@spec ticket_messages!(ApiBrasil.Client.t(), String.t() | integer(), keyword()) :: map()
Como ticket_messages/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec tickets( ApiBrasil.Client.t(), keyword() ) :: result()
Lista os tickets de suporte: GET /tickets.
@spec tickets!( ApiBrasil.Client.t(), keyword() ) :: map()
Como tickets/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Atualiza um ticket: PUT /ticket/{id}.
Como update_ticket/4, mas levanta ApiBrasil.Core.Error em caso de falha.