summaryrefslogtreecommitdiffstats
path: root/cepis.lua
diff options
context:
space:
mode:
Diffstat (limited to 'cepis.lua')
-rw-r--r--cepis.lua5
1 files changed, 5 insertions, 0 deletions
diff --git a/cepis.lua b/cepis.lua
index e120af1..1027db3 100644
--- a/cepis.lua
+++ b/cepis.lua
@@ -65,6 +65,9 @@ M.Address = models.Address
--- The `Geo` metatable.
M.Geo = models.Geo
+--- The `Faixa` metatable, for the `faixa` a `not_found` error may carry.
+M.Faixa = models.Faixa
+
--- The `Health` metatable.
M.Health = models.Health
@@ -72,6 +75,8 @@ M.Health = models.Health
M.INVALID_CEP = errors.INVALID_CEP
--- Error kind: well-formed, but absent from the DNE database.
+--
+-- `err.faixa` may name the municipality the CEP would have belonged to.
M.NOT_FOUND = errors.NOT_FOUND
--- Error kind: 429 on every attempt. `err.retry_after` may hold seconds.