fix(webhooks): CRUD account-scoped /v2/webhooks com envelope webHook#16
Merged
Conversation
O CRUD company-scoped (/v1/companies/{id}/webhooks) retorna 404 na API
atual (sondas ao vivo, 3 contas, 2026-07-02/03); o contrato havia sido
herdado por paridade de uma alucinacao do SDK Node. Contrato real:
account-scoped /v2/webhooks, envelope webHook nos dois sentidos.
- Novos metodos: list/create/retrieve/update/delete_account_webhook,
delete_all_account_webhooks (destrutivo, nome distinto),
ping_account_webhook e fetch_event_types (46+ event types ao vivo)
- Novo value object Nfe::AccountWebhook (shape real do fio + RBS);
contentType/status seguem o fio (String) e nao o enum int do spec
- Teste de alinhamento RSpec (Psych) amarrando o DTO ao schema de
/v2/webhooks em openapi/nf-servico-v1.yaml
- Deprecated (YARD, sem mudanca de comportamento): metodos
company-scoped, get_available_events/AVAILABLE_EVENTS (invoice.*
nao existe) e Nfe::WebhookSubscription
- Docs, samples, skill nfeio-ruby-sdk e CHANGELOG atualizados
- OpenSpec: change fix-account-webhooks-contract sincronizada
(entity-resources) e arquivada
Smoke ao vivo contra api.nfe.io: 14/14 checks (create ecoa secret,
retrieve omite, PUT integral, ping/delete 204, baseline preservado).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resumo
O CRUD de webhooks estava 100% quebrado contra a API real: as rotas company-scoped
/v1/companies/{id}/webhooksretornam 404 (confirmado por sondas ao vivo em 3 contas, 2026-07-02/03). O contrato havia sido herdado por "parity with Node" de um contrato que o SDK Node alucinou. O contrato real é account-scoped:/v2/webhooks, com envelope{ "webHook": {...} }obrigatório nos dois sentidos.Espelha o client-nodejs v5.1.0 (superfície) — mas o contrato vem do spec OpenAPI (
openapi/nf-servico-v1.yaml) + sonda ao vivo, nunca de SDK irmão.Mudanças
client.webhooks:list_account_webhooks,create_account_webhook,retrieve_account_webhook,update_account_webhook,delete_account_webhook,delete_all_account_webhooks(destrutivo, nome propositalmente distinto),ping_account_webhook,fetch_event_types— envelope no request (create/update), unwrap nas respostas (fallback defensivo para corpo cru)Nfe::AccountWebhook(Data.define+ RBS) com o shape real do fio;contentType/statuscomo String ("json"/"Active") — desvio deliberado vs enum int do spec, pinado no teste de alinhamentoget_available_events/AVAILABLE_EVENTS(literaisinvoice.*não existem na API) eNfe::WebhookSubscriptionurie exige 2xx;secret32–64 chars (ecoado só no create);PUTé substituição integral — update semstatusdesativa o webhook (confirmado ao vivo)docs/webhooks.md+ cookbook), samples, skillnfeio-ruby-sdke CHANGELOG atualizados; OpenSpec sincronizado e arquivadoSemVer
Minor — tudo aditivo; nada que funciona hoje muda (o CRUD antigo já retornava 404 incondicional). Entrada em
[Não lançado]; sem bump de versão neste PR (release único empacotará esta change +expand-service-invoice-dto).Testes
rakecompleto (Docker ruby34): 671 examples, 0 failures · RuboCop limpo · Steep limpo ·rbs validateok · cobertura 98,35%api.nfe.io: 14/14 checks — create ecoasecret/retrieve omite, envelope nos dois sentidos, PUT integral, ping/delete 204, retrieve pós-delete 404, webhooks pré-existentes intactos e baseline restaurado