sharpfy-nextapi 0.2.0__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. {sharpfy_nextapi-0.2.0/sharpfy_nextapi.egg-info → sharpfy_nextapi-0.3.0}/PKG-INFO +24 -3
  2. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/README.md +23 -2
  3. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/pyproject.toml +1 -1
  4. sharpfy_nextapi-0.3.0/sharpfy_nextapi/_version.py +1 -0
  5. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/client.py +2 -0
  6. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/errors.py +8 -2
  7. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/models.py +39 -1
  8. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/base.py +3 -0
  9. sharpfy_nextapi-0.3.0/sharpfy_nextapi/resources/monitoramentos.py +40 -0
  10. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0/sharpfy_nextapi.egg-info}/PKG-INFO +24 -3
  11. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi.egg-info/SOURCES.txt +1 -0
  12. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/tests/test_contract.py +3 -2
  13. sharpfy_nextapi-0.2.0/sharpfy_nextapi/_version.py +0 -1
  14. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/LICENSE +0 -0
  15. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/setup.cfg +0 -0
  16. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/__init__.py +0 -0
  17. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/_transport.py +0 -0
  18. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/_validation.py +0 -0
  19. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/py.typed +0 -0
  20. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/__init__.py +0 -0
  21. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/ceps.py +0 -0
  22. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/cnpj.py +0 -0
  23. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/creditos.py +0 -0
  24. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/empresas.py +0 -0
  25. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/localidades.py +0 -0
  26. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/mercado.py +0 -0
  27. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi/resources/socios.py +0 -0
  28. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi.egg-info/dependency_links.txt +0 -0
  29. {sharpfy_nextapi-0.2.0 → sharpfy_nextapi-0.3.0}/sharpfy_nextapi.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sharpfy-nextapi
3
- Version: 0.2.0
3
+ Version: 0.3.0
4
4
  Summary: SDK oficial da NextAPI para Python: CNPJ (inclusive alfanumérico), Simples Nacional, CEP, sócios e mercado. Sem dependências.
5
5
  Author-email: Sharpfy <contato@sharpfy.com.br>
6
6
  License-Expression: MIT
@@ -185,6 +185,27 @@ creditos = nextapi.creditos.consultar()
185
185
  print(f"restam {creditos['totalRemainingCredits']} créditos")
186
186
  ```
187
187
 
188
+ ### Monitoramento de empresas
189
+
190
+ Cada CNPJ na carteira custa 2 créditos por mês, debitados na inclusão e a cada renovação da janela de créditos. Sem saldo para todos, ou acima de 10 CNPJs no plano gratuito, a inclusão é recusada e nada entra. A chave de teste (`nxa_test_`) não debita e informa quanto custaria. A inclusão nunca é repetida sozinha.
191
+
192
+ ```python
193
+ # Inclui na carteira (até 100 por chamada) e recebe o resultado CNPJ a CNPJ.
194
+ inclusao = nextapi.monitoramentos.incluir(["11222333000181", "45997418000153"], canais=["email"])
195
+ carteira = nextapi.monitoramentos.listar(page=1, page_size=100)
196
+ nextapi.monitoramentos.remover("45997418000153")
197
+
198
+ # Polling: guarde o cursor e continue de onde parou. Entrega pelo menos uma vez: deduplique pelo id.
199
+ cursor = None
200
+ while True:
201
+ pagina = nextapi.monitoramentos.listar_eventos(cursor=cursor)
202
+ for evento in pagina.get("items") or []:
203
+ print(evento["tipo"], evento["cnpj"], evento["dados"])
204
+ cursor = pagina.get("proximoCursor") or cursor
205
+ if not pagina.get("temMais"):
206
+ break
207
+ ```
208
+
188
209
  ## Erros
189
210
 
190
211
  Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código detalha.
@@ -192,8 +213,8 @@ Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código deta
192
213
  | Classe | Quando | Status / código | O que fazer |
193
214
  |---|---|---|---|
194
215
  | `NextApiAuthenticationError` | Chave ausente, inválida ou revogada | 401 / 1002, 400 / 1001 | Confira a chave e o ambiente |
195
- | `NextApiInsufficientCreditsError` | Créditos do período acabaram | 405 / 1004, 1006 | Aguarde a renovação ou compre créditos avulsos |
196
- | `NextApiPaidPlanRequiredError` | Recurso exige plano pago | 405 / 1012, 1005 | Mude de plano |
216
+ | `NextApiInsufficientCreditsError` | Créditos do período acabaram, ou o saldo não cobre o mês dos CNPJs monitorados | 405 / 1004, 1006; 402 / 1024 | Aguarde a renovação ou compre créditos avulsos |
217
+ | `NextApiPaidPlanRequiredError` | Recurso exige plano pago, ou passou de 10 CNPJs monitorados no plano gratuito | 405 / 1012, 1005; 402 / 1025 | Mude de plano |
197
218
  | `NextApiNotFoundError` | CNPJ, CEP ou município não existe | 404 / 1000 | Trate como resultado, não como falha |
198
219
  | `NextApiValidationError` | Entrada recusada pela API ou pelo SDK | 400 / 1007, ou status 0 | Corrija a entrada; não repita |
199
220
  | `NextApiRateLimitError` | Limite de requisições por minuto | 429 / 1003 | Já repetido sozinho; diminua o ritmo |
@@ -158,6 +158,27 @@ creditos = nextapi.creditos.consultar()
158
158
  print(f"restam {creditos['totalRemainingCredits']} créditos")
159
159
  ```
160
160
 
161
+ ### Monitoramento de empresas
162
+
163
+ Cada CNPJ na carteira custa 2 créditos por mês, debitados na inclusão e a cada renovação da janela de créditos. Sem saldo para todos, ou acima de 10 CNPJs no plano gratuito, a inclusão é recusada e nada entra. A chave de teste (`nxa_test_`) não debita e informa quanto custaria. A inclusão nunca é repetida sozinha.
164
+
165
+ ```python
166
+ # Inclui na carteira (até 100 por chamada) e recebe o resultado CNPJ a CNPJ.
167
+ inclusao = nextapi.monitoramentos.incluir(["11222333000181", "45997418000153"], canais=["email"])
168
+ carteira = nextapi.monitoramentos.listar(page=1, page_size=100)
169
+ nextapi.monitoramentos.remover("45997418000153")
170
+
171
+ # Polling: guarde o cursor e continue de onde parou. Entrega pelo menos uma vez: deduplique pelo id.
172
+ cursor = None
173
+ while True:
174
+ pagina = nextapi.monitoramentos.listar_eventos(cursor=cursor)
175
+ for evento in pagina.get("items") or []:
176
+ print(evento["tipo"], evento["cnpj"], evento["dados"])
177
+ cursor = pagina.get("proximoCursor") or cursor
178
+ if not pagina.get("temMais"):
179
+ break
180
+ ```
181
+
161
182
  ## Erros
162
183
 
163
184
  Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código detalha.
@@ -165,8 +186,8 @@ Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código deta
165
186
  | Classe | Quando | Status / código | O que fazer |
166
187
  |---|---|---|---|
167
188
  | `NextApiAuthenticationError` | Chave ausente, inválida ou revogada | 401 / 1002, 400 / 1001 | Confira a chave e o ambiente |
168
- | `NextApiInsufficientCreditsError` | Créditos do período acabaram | 405 / 1004, 1006 | Aguarde a renovação ou compre créditos avulsos |
169
- | `NextApiPaidPlanRequiredError` | Recurso exige plano pago | 405 / 1012, 1005 | Mude de plano |
189
+ | `NextApiInsufficientCreditsError` | Créditos do período acabaram, ou o saldo não cobre o mês dos CNPJs monitorados | 405 / 1004, 1006; 402 / 1024 | Aguarde a renovação ou compre créditos avulsos |
190
+ | `NextApiPaidPlanRequiredError` | Recurso exige plano pago, ou passou de 10 CNPJs monitorados no plano gratuito | 405 / 1012, 1005; 402 / 1025 | Mude de plano |
170
191
  | `NextApiNotFoundError` | CNPJ, CEP ou município não existe | 404 / 1000 | Trate como resultado, não como falha |
171
192
  | `NextApiValidationError` | Entrada recusada pela API ou pelo SDK | 400 / 1007, ou status 0 | Corrija a entrada; não repita |
172
193
  | `NextApiRateLimitError` | Limite de requisições por minuto | 429 / 1003 | Já repetido sozinho; diminua o ritmo |
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sharpfy-nextapi"
7
- version = "0.2.0"
7
+ version = "0.3.0"
8
8
  description = "SDK oficial da NextAPI para Python: CNPJ (inclusive alfanumérico), Simples Nacional, CEP, sócios e mercado. Sem dependências."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.11"
@@ -0,0 +1 @@
1
+ VERSION = "0.3.0"
@@ -19,6 +19,7 @@ from sharpfy_nextapi.resources.creditos import Creditos
19
19
  from sharpfy_nextapi.resources.empresas import Empresas
20
20
  from sharpfy_nextapi.resources.localidades import Cnaes, Estados, Municipios
21
21
  from sharpfy_nextapi.resources.mercado import Mercado
22
+ from sharpfy_nextapi.resources.monitoramentos import Monitoramentos
22
23
  from sharpfy_nextapi.resources.socios import Socios
23
24
 
24
25
  DEFAULT_BASE_URL = "https://api.nextapi.com.br"
@@ -66,6 +67,7 @@ class NextApiClient:
66
67
  self.municipios = Municipios(self)
67
68
  self.mercado = Mercado(self)
68
69
  self.creditos = Creditos(self)
70
+ self.monitoramentos = Monitoramentos(self)
69
71
 
70
72
  def __repr__(self) -> str: # nunca mostra a chave
71
73
  return f"NextApiClient(base_url={self.base_url!r}, environment={self.environment!r})"
@@ -19,6 +19,10 @@ class ErrorCodes:
19
19
  EXTERNAL_PROVIDER_FAILURE = 1014
20
20
  SANDBOX_DAILY_LIMIT = 1015
21
21
  SANDBOX_DISABLED = 1016
22
+ #: Monitoramento: o saldo não cobre o mês dos CNPJs novos (402). Nada foi incluído.
23
+ MONITORING_INSUFFICIENT_CREDITS = 1024
24
+ #: Monitoramento: o plano gratuito acompanha até 10 CNPJs (402). Nada foi incluído.
25
+ MONITORING_FREE_PLAN_LIMIT = 1025
22
26
 
23
27
 
24
28
  class NextApiError(Exception):
@@ -49,11 +53,11 @@ class NextApiAuthenticationError(NextApiError):
49
53
 
50
54
 
51
55
  class NextApiInsufficientCreditsError(NextApiError):
52
- """Sem créditos para a consulta (1004, 1006)."""
56
+ """Sem créditos para a consulta (1004, 1006) ou para o mês dos CNPJs monitorados (1024)."""
53
57
 
54
58
 
55
59
  class NextApiPaidPlanRequiredError(NextApiError):
56
- """O recurso exige plano pago ou créditos avulsos (1012, 1005)."""
60
+ """O recurso exige plano pago ou créditos avulsos (1012, 1005), ou passou do limite do plano gratuito (1025)."""
57
61
 
58
62
 
59
63
  class NextApiNotFoundError(NextApiError):
@@ -84,6 +88,8 @@ _BY_CODE = {
84
88
  ErrorCodes.LIVE_SEARCH_MISSING_CREDITS: NextApiInsufficientCreditsError,
85
89
  ErrorCodes.REQUIRES_PAID_PLAN: NextApiPaidPlanRequiredError,
86
90
  ErrorCodes.LIVE_SEARCH_NOT_ALLOWED: NextApiPaidPlanRequiredError,
91
+ ErrorCodes.MONITORING_INSUFFICIENT_CREDITS: NextApiInsufficientCreditsError,
92
+ ErrorCodes.MONITORING_FREE_PLAN_LIMIT: NextApiPaidPlanRequiredError,
87
93
  }
88
94
 
89
95
 
@@ -384,6 +384,44 @@ class MercadoMunicipioResponse(TypedDict, total=False):
384
384
  avisos: Optional[List[str]]
385
385
 
386
386
 
387
+ class MonitoramentoEventoResponse(TypedDict, total=False):
388
+ id: Optional[str]
389
+ tipo: Optional[str]
390
+ cnpj: Optional[str]
391
+ fonte: Optional[str]
392
+ referencia: Optional[str]
393
+ observadoEm: Optional[str]
394
+ versao: Optional[int]
395
+ dados: Optional[Any]
396
+
397
+
398
+ class MonitoramentoEventosResponse(TypedDict, total=False):
399
+ items: Optional[List["MonitoramentoEventoResponse"]]
400
+ proximoCursor: Optional[str]
401
+ temMais: Optional[bool]
402
+
403
+
404
+ class MonitoramentoInscricaoResponse(TypedDict, total=False):
405
+ inscritos: Optional[List[str]]
406
+ atualizados: Optional[List[str]]
407
+ invalidos: Optional[List[str]]
408
+ naoEncontrados: Optional[List[str]]
409
+ totalNaCarteira: Optional[int]
410
+ limiteDaCarteira: Optional[int]
411
+ creditosPorCnpj: Optional[int]
412
+ creditosDebitados: Optional[int]
413
+ creditosEstimados: Optional[int]
414
+
415
+
416
+ class MonitoramentoItemResponse(TypedDict, total=False):
417
+ cnpj: Optional[str]
418
+ eventos: Optional[List[str]]
419
+ cadencia: Optional[str]
420
+ canais: Optional[List[str]]
421
+ monitoradoDesde: Optional[str]
422
+ linhaDeBase: Optional[str]
423
+
424
+
387
425
  class MunicipioDetalhadoResponse(TypedDict, total=False):
388
426
  id: Optional[int]
389
427
  descricao: Optional[str]
@@ -466,4 +504,4 @@ class WorkspaceCreditsResponse(TypedDict, total=False):
466
504
  limits: Optional["LimitsInfo"]
467
505
 
468
506
 
469
- __all__ = ["Page", "CepCodigoIbgeResponse", "CepItemResponse", "CnaeItemResponse", "CnpjConformidadeResponse", "CnpjInscricaoEstadualResponse", "CnpjItemResponse", "CnpjItemResponseCode", "CnpjItemResponsePartner", "CnpjRelacionamentoAlvo", "CnpjRelacionamentoAtividadeResumo", "CnpjRelacionamentoEmpresa", "CnpjRelacionamentoGrafo", "CnpjRelacionamentoGrafoEdge", "CnpjRelacionamentoGrafoNode", "CnpjRelacionamentoResponse", "CnpjRelacionamentoResumo", "CnpjRelacionamentoSocio", "CnpjRelacionamentoSocioEmComum", "CnpjSimplesResponse", "CnpjSimplifiedResponse", "ConformidadeDividaAtiva", "ConformidadeOrigem", "ConformidadeSancao", "ConformidadeSancoes", "ConformidadeSoma", "EstadoItemResponse", "ExtraCreditsInfo", "IErrorCodeModel", "LimitsInfo", "MercadoCnaeMes", "MercadoCnaeMunicipio", "MercadoCnaeNacional", "MercadoCnaePorte", "MercadoCnaeResponse", "MercadoCnaeUf", "MercadoIndicadorPonto", "MercadoIndicadorResponse", "MercadoMunicipioDados", "MercadoMunicipioEconomia", "MercadoMunicipioEmpresas", "MercadoMunicipioResponse", "MunicipioDetalhadoResponse", "MunicipioHierarquiaResponse", "MunicipioItemResponse", "PlanCreditsInfo", "SocioEmpresaItemResponse", "SocioEmpresasResponse", "SocioInfoResponse", "SocioResumoResponse", "WorkspaceCreditsResponse"]
507
+ __all__ = ["Page", "CepCodigoIbgeResponse", "CepItemResponse", "CnaeItemResponse", "CnpjConformidadeResponse", "CnpjInscricaoEstadualResponse", "CnpjItemResponse", "CnpjItemResponseCode", "CnpjItemResponsePartner", "CnpjRelacionamentoAlvo", "CnpjRelacionamentoAtividadeResumo", "CnpjRelacionamentoEmpresa", "CnpjRelacionamentoGrafo", "CnpjRelacionamentoGrafoEdge", "CnpjRelacionamentoGrafoNode", "CnpjRelacionamentoResponse", "CnpjRelacionamentoResumo", "CnpjRelacionamentoSocio", "CnpjRelacionamentoSocioEmComum", "CnpjSimplesResponse", "CnpjSimplifiedResponse", "ConformidadeDividaAtiva", "ConformidadeOrigem", "ConformidadeSancao", "ConformidadeSancoes", "ConformidadeSoma", "EstadoItemResponse", "ExtraCreditsInfo", "IErrorCodeModel", "LimitsInfo", "MercadoCnaeMes", "MercadoCnaeMunicipio", "MercadoCnaeNacional", "MercadoCnaePorte", "MercadoCnaeResponse", "MercadoCnaeUf", "MercadoIndicadorPonto", "MercadoIndicadorResponse", "MercadoMunicipioDados", "MercadoMunicipioEconomia", "MercadoMunicipioEmpresas", "MercadoMunicipioResponse", "MonitoramentoEventoResponse", "MonitoramentoEventosResponse", "MonitoramentoInscricaoResponse", "MonitoramentoItemResponse", "MunicipioDetalhadoResponse", "MunicipioHierarquiaResponse", "MunicipioItemResponse", "PlanCreditsInfo", "SocioEmpresaItemResponse", "SocioEmpresasResponse", "SocioInfoResponse", "SocioResumoResponse", "WorkspaceCreditsResponse"]
@@ -13,3 +13,6 @@ class Resource:
13
13
 
14
14
  def _post(self, path: str, body):
15
15
  return self._client._request("POST", path, body)
16
+
17
+ def _delete(self, path: str):
18
+ return self._client._request("DELETE", path)
@@ -0,0 +1,40 @@
1
+ from typing import Iterable, List, Optional
2
+
3
+ from sharpfy_nextapi._validation import batch, normalize_cnpj, query
4
+ from sharpfy_nextapi.models import (MonitoramentoEventosResponse, MonitoramentoInscricaoResponse,
5
+ MonitoramentoItemResponse, Page)
6
+ from sharpfy_nextapi.resources.base import Resource
7
+
8
+
9
+ class Monitoramentos(Resource):
10
+ """Monitoramento de empresas: a carteira de CNPJs acompanhados e os eventos de mudança deles. Cada CNPJ custa
11
+ créditos por mês, debitados na inclusão; a chave de teste (``nxa_test_``) não debita."""
12
+
13
+ def incluir(self, cnpjs: Iterable[str], *, eventos: Optional[List[str]] = None, cadencia: Optional[str] = None,
14
+ canais: Optional[List[str]] = None) -> MonitoramentoInscricaoResponse:
15
+ """Inclui até 100 CNPJs na carteira; o resultado vem CNPJ a CNPJ. Sem saldo para todos, lança
16
+ ``NextApiInsufficientCreditsError`` e não inclui nenhum. Nunca é repetida sozinha (debita créditos)."""
17
+ body = {"cnpjs": batch(cnpjs)}
18
+ if eventos is not None:
19
+ body["eventos"] = list(eventos)
20
+ if cadencia is not None:
21
+ body["cadencia"] = cadencia
22
+ if canais is not None:
23
+ body["canais"] = list(canais)
24
+ return self._post("/v1/monitoramentos", body)
25
+
26
+ def listar(self, *, page: Optional[int] = None,
27
+ page_size: Optional[int] = None) -> "Page[MonitoramentoItemResponse]":
28
+ """CNPJs ativos na carteira, em ordem de CNPJ, paginados."""
29
+ return self._get("/v1/monitoramentos" + query({"page": page, "pageSize": page_size}))
30
+
31
+ def remover(self, cnpj: str) -> None:
32
+ """Tira o CNPJ da carteira. Os eventos já observados continuam no polling."""
33
+ self._delete(f"/v1/monitoramentos/{normalize_cnpj(cnpj)}")
34
+
35
+ def listar_eventos(self, *, cursor: Optional[str] = None, tipo: Optional[str] = None, desde: Optional[str] = None,
36
+ limite: Optional[int] = None) -> MonitoramentoEventosResponse:
37
+ """Eventos da carteira, em ordem. Guarde ``proximoCursor`` e envie em ``cursor`` na chamada seguinte.
38
+ Entrega pelo menos uma vez: deduplique pelo ``id``. ``tipo``: tipos separados por vírgula."""
39
+ return self._get("/v1/monitoramentos/eventos" + query({"cursor": cursor, "tipo": tipo, "desde": desde,
40
+ "limite": limite}))
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sharpfy-nextapi
3
- Version: 0.2.0
3
+ Version: 0.3.0
4
4
  Summary: SDK oficial da NextAPI para Python: CNPJ (inclusive alfanumérico), Simples Nacional, CEP, sócios e mercado. Sem dependências.
5
5
  Author-email: Sharpfy <contato@sharpfy.com.br>
6
6
  License-Expression: MIT
@@ -185,6 +185,27 @@ creditos = nextapi.creditos.consultar()
185
185
  print(f"restam {creditos['totalRemainingCredits']} créditos")
186
186
  ```
187
187
 
188
+ ### Monitoramento de empresas
189
+
190
+ Cada CNPJ na carteira custa 2 créditos por mês, debitados na inclusão e a cada renovação da janela de créditos. Sem saldo para todos, ou acima de 10 CNPJs no plano gratuito, a inclusão é recusada e nada entra. A chave de teste (`nxa_test_`) não debita e informa quanto custaria. A inclusão nunca é repetida sozinha.
191
+
192
+ ```python
193
+ # Inclui na carteira (até 100 por chamada) e recebe o resultado CNPJ a CNPJ.
194
+ inclusao = nextapi.monitoramentos.incluir(["11222333000181", "45997418000153"], canais=["email"])
195
+ carteira = nextapi.monitoramentos.listar(page=1, page_size=100)
196
+ nextapi.monitoramentos.remover("45997418000153")
197
+
198
+ # Polling: guarde o cursor e continue de onde parou. Entrega pelo menos uma vez: deduplique pelo id.
199
+ cursor = None
200
+ while True:
201
+ pagina = nextapi.monitoramentos.listar_eventos(cursor=cursor)
202
+ for evento in pagina.get("items") or []:
203
+ print(evento["tipo"], evento["cnpj"], evento["dados"])
204
+ cursor = pagina.get("proximoCursor") or cursor
205
+ if not pagina.get("temMais"):
206
+ break
207
+ ```
208
+
188
209
  ## Erros
189
210
 
190
211
  Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código detalha.
@@ -192,8 +213,8 @@ Toda falha vira uma exceção do SDK; a classe diz o que fazer, e o código deta
192
213
  | Classe | Quando | Status / código | O que fazer |
193
214
  |---|---|---|---|
194
215
  | `NextApiAuthenticationError` | Chave ausente, inválida ou revogada | 401 / 1002, 400 / 1001 | Confira a chave e o ambiente |
195
- | `NextApiInsufficientCreditsError` | Créditos do período acabaram | 405 / 1004, 1006 | Aguarde a renovação ou compre créditos avulsos |
196
- | `NextApiPaidPlanRequiredError` | Recurso exige plano pago | 405 / 1012, 1005 | Mude de plano |
216
+ | `NextApiInsufficientCreditsError` | Créditos do período acabaram, ou o saldo não cobre o mês dos CNPJs monitorados | 405 / 1004, 1006; 402 / 1024 | Aguarde a renovação ou compre créditos avulsos |
217
+ | `NextApiPaidPlanRequiredError` | Recurso exige plano pago, ou passou de 10 CNPJs monitorados no plano gratuito | 405 / 1012, 1005; 402 / 1025 | Mude de plano |
197
218
  | `NextApiNotFoundError` | CNPJ, CEP ou município não existe | 404 / 1000 | Trate como resultado, não como falha |
198
219
  | `NextApiValidationError` | Entrada recusada pela API ou pelo SDK | 400 / 1007, ou status 0 | Corrija a entrada; não repita |
199
220
  | `NextApiRateLimitError` | Limite de requisições por minuto | 429 / 1003 | Já repetido sozinho; diminua o ritmo |
@@ -21,5 +21,6 @@ sharpfy_nextapi/resources/creditos.py
21
21
  sharpfy_nextapi/resources/empresas.py
22
22
  sharpfy_nextapi/resources/localidades.py
23
23
  sharpfy_nextapi/resources/mercado.py
24
+ sharpfy_nextapi/resources/monitoramentos.py
24
25
  sharpfy_nextapi/resources/socios.py
25
26
  tests/test_contract.py
@@ -72,7 +72,8 @@ class ContractTests(unittest.TestCase):
72
72
  def test_cases(self):
73
73
  for case in CONTRACT["cases"]:
74
74
  with self.subTest(case["id"]):
75
- transport = FakeTransport(ok(case["response"]))
75
+ reply = Response(204, {}, b"") if case.get("status") == 204 else ok(case["response"])
76
+ transport = FakeTransport(reply)
76
77
  result = invoke(client(transport), case.get("call", case["id"]), case["args"])
77
78
  self.assertEqual(len(transport.calls), 1)
78
79
  call = transport.calls[0]
@@ -90,7 +91,7 @@ class ContractTests(unittest.TestCase):
90
91
  self.assertEqual(json.loads(call["body"]), case["body"])
91
92
  else:
92
93
  self.assertIsNone(call["body"])
93
- self.assertEqual(result, case["response"])
94
+ self.assertEqual(result, case.get("response"))
94
95
 
95
96
  def test_app_info_is_sanitized(self):
96
97
  spec = CONTRACT["headers"]["appInfo"]
@@ -1 +0,0 @@
1
- VERSION = "0.2.0"
File without changes