sharpfy-nextapi 0.2.0__py3-none-any.whl
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.
- sharpfy_nextapi/__init__.py +15 -0
- sharpfy_nextapi/_transport.py +40 -0
- sharpfy_nextapi/_validation.py +94 -0
- sharpfy_nextapi/_version.py +1 -0
- sharpfy_nextapi/client.py +170 -0
- sharpfy_nextapi/errors.py +103 -0
- sharpfy_nextapi/models.py +469 -0
- sharpfy_nextapi/py.typed +1 -0
- sharpfy_nextapi/resources/__init__.py +0 -0
- sharpfy_nextapi/resources/base.py +15 -0
- sharpfy_nextapi/resources/ceps.py +36 -0
- sharpfy_nextapi/resources/cnpj.py +47 -0
- sharpfy_nextapi/resources/creditos.py +8 -0
- sharpfy_nextapi/resources/empresas.py +21 -0
- sharpfy_nextapi/resources/localidades.py +26 -0
- sharpfy_nextapi/resources/mercado.py +24 -0
- sharpfy_nextapi/resources/socios.py +14 -0
- sharpfy_nextapi-0.2.0.dist-info/METADATA +283 -0
- sharpfy_nextapi-0.2.0.dist-info/RECORD +22 -0
- sharpfy_nextapi-0.2.0.dist-info/WHEEL +5 -0
- sharpfy_nextapi-0.2.0.dist-info/licenses/LICENSE +21 -0
- sharpfy_nextapi-0.2.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,469 @@
|
|
|
1
|
+
"""Gerado por sdks/contract/generate.py a partir de sdks/contract/openapi.json. Não edite."""
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, Generic, List, Optional, TypedDict, TypeVar
|
|
4
|
+
|
|
5
|
+
T = TypeVar("T")
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Page(TypedDict, Generic[T]):
|
|
9
|
+
"""Página de resultados das rotas de listagem."""
|
|
10
|
+
|
|
11
|
+
page: int
|
|
12
|
+
pageSize: int
|
|
13
|
+
total: int
|
|
14
|
+
items: List[T]
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class CepCodigoIbgeResponse(TypedDict, total=False):
|
|
18
|
+
municipio: Optional[int]
|
|
19
|
+
estado: Optional[int]
|
|
20
|
+
pais: Optional[int]
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class CepItemResponse(TypedDict, total=False):
|
|
24
|
+
cep: Optional[str]
|
|
25
|
+
logradouro: Optional[str]
|
|
26
|
+
localidade: Optional[str]
|
|
27
|
+
idMunicipio: Optional[int]
|
|
28
|
+
nomeMunicipio: Optional[str]
|
|
29
|
+
uf: Optional[str]
|
|
30
|
+
latitude: Optional[float]
|
|
31
|
+
longitude: Optional[float]
|
|
32
|
+
dataAtualizacao: Optional[str]
|
|
33
|
+
codigoIbge: Optional["CepCodigoIbgeResponse"]
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class CnaeItemResponse(TypedDict, total=False):
|
|
37
|
+
codigo: Optional[str]
|
|
38
|
+
descricao: Optional[str]
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
class CnpjConformidadeResponse(TypedDict, total=False):
|
|
42
|
+
cnpj: Optional[str]
|
|
43
|
+
cnpjRaiz: Optional[str]
|
|
44
|
+
consultadoEm: Optional[str]
|
|
45
|
+
sancoes: Optional["ConformidadeSancoes"]
|
|
46
|
+
dividaAtiva: Optional["ConformidadeDividaAtiva"]
|
|
47
|
+
avisos: Optional[List[str]]
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
class CnpjInscricaoEstadualResponse(TypedDict, total=False):
|
|
51
|
+
cnpj: Optional[str]
|
|
52
|
+
inscricaoEstadual: Optional[str]
|
|
53
|
+
uf: Optional[str]
|
|
54
|
+
situacao: Optional[str]
|
|
55
|
+
cnae: Optional[str]
|
|
56
|
+
municipio: Optional[str]
|
|
57
|
+
dataAtualizacao: Optional[str]
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
class CnpjItemResponse(TypedDict, total=False):
|
|
61
|
+
cnpj: Optional[str]
|
|
62
|
+
razaoSocial: Optional[str]
|
|
63
|
+
nomeFantasia: Optional[str]
|
|
64
|
+
tipo: Optional[str]
|
|
65
|
+
dataAbertura: Optional[str]
|
|
66
|
+
situacaoCadastral: Optional[str]
|
|
67
|
+
dataSituacaoCadastral: Optional[str]
|
|
68
|
+
motivoSituacaoCadastral: Optional[str]
|
|
69
|
+
porte: Optional[str]
|
|
70
|
+
capitalSocial: Optional[float]
|
|
71
|
+
naturezaJuridica: Optional[str]
|
|
72
|
+
logradouro: Optional[str]
|
|
73
|
+
numero: Optional[str]
|
|
74
|
+
complemento: Optional[str]
|
|
75
|
+
cep: Optional[str]
|
|
76
|
+
bairro: Optional[str]
|
|
77
|
+
municipio: Optional[str]
|
|
78
|
+
uf: Optional[str]
|
|
79
|
+
email: Optional[str]
|
|
80
|
+
telefone: Optional[str]
|
|
81
|
+
situacaoEspecial: Optional[str]
|
|
82
|
+
dataSituacaoEspecial: Optional[str]
|
|
83
|
+
atividadePrincipal: Optional["CnpjItemResponseCode"]
|
|
84
|
+
atividadeSecundaria: Optional[List["CnpjItemResponseCode"]]
|
|
85
|
+
quadroDeSocios: Optional[List["CnpjItemResponsePartner"]]
|
|
86
|
+
dataAtualizacao: Optional[str]
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
class CnpjItemResponseCode(TypedDict, total=False):
|
|
90
|
+
codigo: Optional[str]
|
|
91
|
+
descricao: Optional[str]
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
class CnpjItemResponsePartner(TypedDict, total=False):
|
|
95
|
+
nome: Optional[str]
|
|
96
|
+
qualificacao: Optional[str]
|
|
97
|
+
representanteLegal: Optional[str]
|
|
98
|
+
qualificacaoRepresentanteLegal: Optional[str]
|
|
99
|
+
paisOrigem: Optional[str]
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
class CnpjRelacionamentoAlvo(TypedDict, total=False):
|
|
103
|
+
cnpj: Optional[str]
|
|
104
|
+
cnpjRaiz: Optional[str]
|
|
105
|
+
razaoSocial: Optional[str]
|
|
106
|
+
nomeFantasia: Optional[str]
|
|
107
|
+
situacaoCadastral: Optional[str]
|
|
108
|
+
capitalSocial: Optional[float]
|
|
109
|
+
uf: Optional[str]
|
|
110
|
+
municipio: Optional[str]
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
class CnpjRelacionamentoAtividadeResumo(TypedDict, total=False):
|
|
114
|
+
codigo: Optional[str]
|
|
115
|
+
descricao: Optional[str]
|
|
116
|
+
quantidade: Optional[int]
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
class CnpjRelacionamentoEmpresa(TypedDict, total=False):
|
|
120
|
+
cnpj: Optional[str]
|
|
121
|
+
cnpjRaiz: Optional[str]
|
|
122
|
+
razaoSocial: Optional[str]
|
|
123
|
+
nomeFantasia: Optional[str]
|
|
124
|
+
situacaoCadastral: Optional[str]
|
|
125
|
+
dataAbertura: Optional[str]
|
|
126
|
+
porte: Optional[str]
|
|
127
|
+
capitalSocial: Optional[float]
|
|
128
|
+
uf: Optional[str]
|
|
129
|
+
municipio: Optional[str]
|
|
130
|
+
atividadePrincipal: Optional["CnpjItemResponseCode"]
|
|
131
|
+
sociosEmComum: Optional[List["CnpjRelacionamentoSocioEmComum"]]
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
class CnpjRelacionamentoGrafo(TypedDict, total=False):
|
|
135
|
+
nodes: Optional[List["CnpjRelacionamentoGrafoNode"]]
|
|
136
|
+
edges: Optional[List["CnpjRelacionamentoGrafoEdge"]]
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
class CnpjRelacionamentoGrafoEdge(TypedDict, total=False):
|
|
140
|
+
source: Optional[str]
|
|
141
|
+
target: Optional[str]
|
|
142
|
+
papel: Optional[str]
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
class CnpjRelacionamentoGrafoNode(TypedDict, total=False):
|
|
146
|
+
id: Optional[str]
|
|
147
|
+
tipo: Optional[str]
|
|
148
|
+
label: Optional[str]
|
|
149
|
+
cnpjRaiz: Optional[str]
|
|
150
|
+
hashSocio: Optional[str]
|
|
151
|
+
isAlvo: Optional[bool]
|
|
152
|
+
situacao: Optional[str]
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
class CnpjRelacionamentoResponse(TypedDict, total=False):
|
|
156
|
+
alvo: Optional["CnpjRelacionamentoAlvo"]
|
|
157
|
+
resumo: Optional["CnpjRelacionamentoResumo"]
|
|
158
|
+
socios: Optional[List["CnpjRelacionamentoSocio"]]
|
|
159
|
+
empresasRelacionadas: Optional["Page[CnpjRelacionamentoEmpresa]"]
|
|
160
|
+
grafo: Optional["CnpjRelacionamentoGrafo"]
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
class CnpjRelacionamentoResumo(TypedDict, total=False):
|
|
164
|
+
totalSocios: Optional[int]
|
|
165
|
+
totalEmpresasRelacionadas: Optional[int]
|
|
166
|
+
totalEmpresasAtivas: Optional[int]
|
|
167
|
+
totalEmpresasInativas: Optional[int]
|
|
168
|
+
capitalSocialConsolidado: Optional[float]
|
|
169
|
+
ufs: Optional[List[str]]
|
|
170
|
+
atividadesPrincipais: Optional[List["CnpjRelacionamentoAtividadeResumo"]]
|
|
171
|
+
totalSociosVerificaveis: Optional[int]
|
|
172
|
+
vinculosCompletos: Optional[bool]
|
|
173
|
+
avisos: Optional[List[str]]
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
class CnpjRelacionamentoSocio(TypedDict, total=False):
|
|
177
|
+
hashSocio: Optional[str]
|
|
178
|
+
nome: Optional[str]
|
|
179
|
+
tipo: Optional[str]
|
|
180
|
+
documento: Optional[str]
|
|
181
|
+
qualificacao: Optional[str]
|
|
182
|
+
faixaEtaria: Optional[str]
|
|
183
|
+
totalEmpresas: Optional[int]
|
|
184
|
+
vinculoVerificavel: Optional[bool]
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
class CnpjRelacionamentoSocioEmComum(TypedDict, total=False):
|
|
188
|
+
hashSocio: Optional[str]
|
|
189
|
+
nome: Optional[str]
|
|
190
|
+
qualificacao: Optional[str]
|
|
191
|
+
dataEntradaSociedade: Optional[str]
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
class CnpjSimplesResponse(TypedDict, total=False):
|
|
195
|
+
cnpj: Optional[str]
|
|
196
|
+
opcaoPeloSimples: Optional[bool]
|
|
197
|
+
dataOpcaoPeloSimples: Optional[str]
|
|
198
|
+
dataExclusaoDoSimples: Optional[str]
|
|
199
|
+
opcaoPeloMEI: Optional[bool]
|
|
200
|
+
dataOpcaoPeloMEI: Optional[str]
|
|
201
|
+
dataExclusaoDoMEI: Optional[str]
|
|
202
|
+
dataAtualizacao: Optional[str]
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
class CnpjSimplifiedResponse(TypedDict, total=False):
|
|
206
|
+
cnpj: Optional[str]
|
|
207
|
+
razaoSocial: Optional[str]
|
|
208
|
+
situacaoCadastral: Optional[str]
|
|
209
|
+
uf: Optional[str]
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
class ConformidadeDividaAtiva(TypedDict, total=False):
|
|
213
|
+
fonte: Optional[str]
|
|
214
|
+
disponivel: Optional[bool]
|
|
215
|
+
referencia: Optional[str]
|
|
216
|
+
consta: Optional[bool]
|
|
217
|
+
total: Optional["ConformidadeSoma"]
|
|
218
|
+
emCobranca: Optional["ConformidadeSoma"]
|
|
219
|
+
regularizada: Optional["ConformidadeSoma"]
|
|
220
|
+
ajuizada: Optional["ConformidadeSoma"]
|
|
221
|
+
origem: Optional["ConformidadeOrigem"]
|
|
222
|
+
corresponsavel: Optional["ConformidadeSoma"]
|
|
223
|
+
inscricaoMaisAntiga: Optional[str]
|
|
224
|
+
inscricaoMaisRecente: Optional[str]
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
class ConformidadeOrigem(TypedDict, total=False):
|
|
228
|
+
tributaria: Optional["ConformidadeSoma"]
|
|
229
|
+
previdenciaria: Optional["ConformidadeSoma"]
|
|
230
|
+
fgts: Optional["ConformidadeSoma"]
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
class ConformidadeSancao(TypedDict, total=False):
|
|
234
|
+
cadastro: Optional[str]
|
|
235
|
+
cadastroDescricao: Optional[str]
|
|
236
|
+
cnpj: Optional[str]
|
|
237
|
+
codigo: Optional[str]
|
|
238
|
+
categoria: Optional[str]
|
|
239
|
+
inicio: Optional[str]
|
|
240
|
+
fim: Optional[str]
|
|
241
|
+
vigente: Optional[bool]
|
|
242
|
+
orgao: Optional[str]
|
|
243
|
+
uf: Optional[str]
|
|
244
|
+
esfera: Optional[str]
|
|
245
|
+
abrangencia: Optional[str]
|
|
246
|
+
processo: Optional[str]
|
|
247
|
+
valorMulta: Optional[float]
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
class ConformidadeSancoes(TypedDict, total=False):
|
|
251
|
+
fonte: Optional[str]
|
|
252
|
+
disponivel: Optional[bool]
|
|
253
|
+
referencia: Optional[str]
|
|
254
|
+
consta: Optional[bool]
|
|
255
|
+
vigente: Optional[bool]
|
|
256
|
+
cadastrosVigentes: Optional[List[str]]
|
|
257
|
+
registros: Optional[List["ConformidadeSancao"]]
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
class ConformidadeSoma(TypedDict, total=False):
|
|
261
|
+
valor: Optional[float]
|
|
262
|
+
inscricoes: Optional[int]
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
class EstadoItemResponse(TypedDict, total=False):
|
|
266
|
+
uf: Optional[str]
|
|
267
|
+
nome: Optional[str]
|
|
268
|
+
totalEstabelecimentos: Optional[int]
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
class ExtraCreditsInfo(TypedDict, total=False):
|
|
272
|
+
remaining: Optional[int]
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
class IErrorCodeModel(TypedDict, total=False):
|
|
276
|
+
status: Optional[str]
|
|
277
|
+
code: Optional[int]
|
|
278
|
+
message: Optional[str]
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
class LimitsInfo(TypedDict, total=False):
|
|
282
|
+
requestsPerMinute: Optional[int]
|
|
283
|
+
allowExternalSearch: Optional[bool]
|
|
284
|
+
canLiveSearch: Optional[bool]
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
class MercadoCnaeMes(TypedDict, total=False):
|
|
288
|
+
mes: Optional[str]
|
|
289
|
+
aberturas: Optional[int]
|
|
290
|
+
baixas: Optional[int]
|
|
291
|
+
saldo: Optional[int]
|
|
292
|
+
parcial: Optional[bool]
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
class MercadoCnaeMunicipio(TypedDict, total=False):
|
|
296
|
+
id: Optional[int]
|
|
297
|
+
nome: Optional[str]
|
|
298
|
+
uf: Optional[str]
|
|
299
|
+
ativas: Optional[int]
|
|
300
|
+
populacaoEstimada: Optional[int]
|
|
301
|
+
ativasPor10MilHabitantes: Optional[float]
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
class MercadoCnaeNacional(TypedDict, total=False):
|
|
305
|
+
total: Optional[int]
|
|
306
|
+
ativas: Optional[int]
|
|
307
|
+
ativasMei: Optional[int]
|
|
308
|
+
ativasSimples: Optional[int]
|
|
309
|
+
porte: Optional[List["MercadoCnaePorte"]]
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
class MercadoCnaePorte(TypedDict, total=False):
|
|
313
|
+
codigo: Optional[str]
|
|
314
|
+
descricao: Optional[str]
|
|
315
|
+
ativas: Optional[int]
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
class MercadoCnaeResponse(TypedDict, total=False):
|
|
319
|
+
cnae: Optional["CnpjItemResponseCode"]
|
|
320
|
+
disponivel: Optional[bool]
|
|
321
|
+
geradoEm: Optional[str]
|
|
322
|
+
nacional: Optional["MercadoCnaeNacional"]
|
|
323
|
+
ufs: Optional[List["MercadoCnaeUf"]]
|
|
324
|
+
uf: Optional["MercadoCnaeUf"]
|
|
325
|
+
maioresMunicipios: Optional[List["MercadoCnaeMunicipio"]]
|
|
326
|
+
tendencia: Optional[List["MercadoCnaeMes"]]
|
|
327
|
+
avisos: Optional[List[str]]
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
class MercadoCnaeUf(TypedDict, total=False):
|
|
331
|
+
uf: Optional[str]
|
|
332
|
+
ativas: Optional[int]
|
|
333
|
+
participacaoPercentual: Optional[float]
|
|
334
|
+
posicao: Optional[int]
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
class MercadoIndicadorPonto(TypedDict, total=False):
|
|
338
|
+
periodo: Optional[str]
|
|
339
|
+
ano: Optional[int]
|
|
340
|
+
mes: Optional[int]
|
|
341
|
+
valor: Optional[float]
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
class MercadoIndicadorResponse(TypedDict, total=False):
|
|
345
|
+
tipo: Optional[str]
|
|
346
|
+
descricao: Optional[str]
|
|
347
|
+
unidade: Optional[str]
|
|
348
|
+
fonte: Optional[str]
|
|
349
|
+
disponivel: Optional[bool]
|
|
350
|
+
serie: Optional[List["MercadoIndicadorPonto"]]
|
|
351
|
+
avisos: Optional[List[str]]
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
class MercadoMunicipioDados(TypedDict, total=False):
|
|
355
|
+
id: Optional[int]
|
|
356
|
+
nome: Optional[str]
|
|
357
|
+
uf: Optional[str]
|
|
358
|
+
codigoIbge: Optional[str]
|
|
359
|
+
regiao: Optional[str]
|
|
360
|
+
mesorregiao: Optional[str]
|
|
361
|
+
microrregiao: Optional[str]
|
|
362
|
+
populacaoEstimada: Optional[int]
|
|
363
|
+
areaKm2: Optional[float]
|
|
364
|
+
densidadeDemografica: Optional[float]
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
class MercadoMunicipioEconomia(TypedDict, total=False):
|
|
368
|
+
pibMilReais: Optional[float]
|
|
369
|
+
pibPerCapitaReais: Optional[float]
|
|
370
|
+
anoPib: Optional[int]
|
|
371
|
+
anoPopulacao: Optional[int]
|
|
372
|
+
atualizadoEm: Optional[str]
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
class MercadoMunicipioEmpresas(TypedDict, total=False):
|
|
376
|
+
estabelecimentosAtivos: Optional[int]
|
|
377
|
+
ativosPorMilHabitantes: Optional[float]
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
class MercadoMunicipioResponse(TypedDict, total=False):
|
|
381
|
+
municipio: Optional["MercadoMunicipioDados"]
|
|
382
|
+
economia: Optional["MercadoMunicipioEconomia"]
|
|
383
|
+
empresas: Optional["MercadoMunicipioEmpresas"]
|
|
384
|
+
avisos: Optional[List[str]]
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
class MunicipioDetalhadoResponse(TypedDict, total=False):
|
|
388
|
+
id: Optional[int]
|
|
389
|
+
descricao: Optional[str]
|
|
390
|
+
uf: Optional[str]
|
|
391
|
+
codigoIbge: Optional[str]
|
|
392
|
+
populacaoEstimada: Optional[int]
|
|
393
|
+
regiao: Optional[str]
|
|
394
|
+
mesorregiao: Optional["MunicipioHierarquiaResponse"]
|
|
395
|
+
microrregiao: Optional["MunicipioHierarquiaResponse"]
|
|
396
|
+
regiaoImediata: Optional["MunicipioHierarquiaResponse"]
|
|
397
|
+
regiaoIntermediaria: Optional["MunicipioHierarquiaResponse"]
|
|
398
|
+
ibgeAtualizadoEm: Optional[str]
|
|
399
|
+
totalEmpresas: Optional[int]
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
class MunicipioHierarquiaResponse(TypedDict, total=False):
|
|
403
|
+
codigo: Optional[str]
|
|
404
|
+
nome: Optional[str]
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
class MunicipioItemResponse(TypedDict, total=False):
|
|
408
|
+
id: Optional[int]
|
|
409
|
+
descricao: Optional[str]
|
|
410
|
+
uf: Optional[str]
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
class PlanCreditsInfo(TypedDict, total=False):
|
|
414
|
+
allocated: Optional[int]
|
|
415
|
+
remaining: Optional[int]
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
class SocioEmpresaItemResponse(TypedDict, total=False):
|
|
419
|
+
cnpj: Optional[str]
|
|
420
|
+
cnpjRaiz: Optional[str]
|
|
421
|
+
razaoSocial: Optional[str]
|
|
422
|
+
nomeFantasia: Optional[str]
|
|
423
|
+
situacaoCadastral: Optional[str]
|
|
424
|
+
dataAbertura: Optional[str]
|
|
425
|
+
porte: Optional[str]
|
|
426
|
+
capitalSocial: Optional[float]
|
|
427
|
+
uf: Optional[str]
|
|
428
|
+
municipio: Optional[str]
|
|
429
|
+
atividadePrincipal: Optional["CnpjItemResponseCode"]
|
|
430
|
+
qualificacao: Optional[str]
|
|
431
|
+
qualificacaoSocio: Optional[str]
|
|
432
|
+
dataEntradaSociedade: Optional[str]
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
class SocioEmpresasResponse(TypedDict, total=False):
|
|
436
|
+
socio: Optional["SocioInfoResponse"]
|
|
437
|
+
resumo: Optional["SocioResumoResponse"]
|
|
438
|
+
empresas: Optional["Page[SocioEmpresaItemResponse]"]
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
class SocioInfoResponse(TypedDict, total=False):
|
|
442
|
+
hashSocio: Optional[str]
|
|
443
|
+
nome: Optional[str]
|
|
444
|
+
documento: Optional[str]
|
|
445
|
+
tipo: Optional[str]
|
|
446
|
+
faixaEtaria: Optional[str]
|
|
447
|
+
vinculoVerificavel: Optional[bool]
|
|
448
|
+
avisos: Optional[List[str]]
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
class SocioResumoResponse(TypedDict, total=False):
|
|
452
|
+
totalEmpresas: Optional[int]
|
|
453
|
+
totalAtivas: Optional[int]
|
|
454
|
+
totalInativas: Optional[int]
|
|
455
|
+
capitalSocialConsolidado: Optional[float]
|
|
456
|
+
ufs: Optional[List[str]]
|
|
457
|
+
qualificacoes: Optional[List[str]]
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
class WorkspaceCreditsResponse(TypedDict, total=False):
|
|
461
|
+
workspaceId: Optional[int]
|
|
462
|
+
monthReference: Optional[str]
|
|
463
|
+
planCredits: Optional["PlanCreditsInfo"]
|
|
464
|
+
extraCredits: Optional["ExtraCreditsInfo"]
|
|
465
|
+
totalRemainingCredits: Optional[int]
|
|
466
|
+
limits: Optional["LimitsInfo"]
|
|
467
|
+
|
|
468
|
+
|
|
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"]
|
sharpfy_nextapi/py.typed
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# Marker file for PEP 561. This package uses inline types.
|
|
File without changes
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
|
|
3
|
+
if TYPE_CHECKING: # pragma: no cover
|
|
4
|
+
from sharpfy_nextapi.client import NextApiClient
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
class Resource:
|
|
8
|
+
def __init__(self, client: "NextApiClient"):
|
|
9
|
+
self._client = client
|
|
10
|
+
|
|
11
|
+
def _get(self, path: str):
|
|
12
|
+
return self._client._request("GET", path)
|
|
13
|
+
|
|
14
|
+
def _post(self, path: str, body):
|
|
15
|
+
return self._client._request("POST", path, body)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
from typing import Optional
|
|
2
|
+
|
|
3
|
+
from sharpfy_nextapi._validation import normalize_cep, query, require_positive, require_range
|
|
4
|
+
from sharpfy_nextapi.models import CepItemResponse, Page
|
|
5
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Ceps(Resource):
|
|
9
|
+
def consultar(self, cep: str) -> CepItemResponse:
|
|
10
|
+
"""Endereço e coordenadas de um CEP."""
|
|
11
|
+
return self._get(f"/v1/ceps/{normalize_cep(cep)}")
|
|
12
|
+
|
|
13
|
+
def buscar(self, *, uf: Optional[str] = None, id_municipio: Optional[int] = None,
|
|
14
|
+
nome_municipio: Optional[str] = None, logradouro: Optional[str] = None, q: Optional[str] = None,
|
|
15
|
+
page: Optional[int] = None, page_size: Optional[int] = None) -> "Page[CepItemResponse]":
|
|
16
|
+
"""Busca por UF, município, logradouro ou texto livre (``q``, que não combina com ``logradouro``)."""
|
|
17
|
+
return self._get("/v1/ceps" + query({
|
|
18
|
+
"uf": uf, "idMunicipio": id_municipio, "nomeMunicipio": nome_municipio, "logradouro": logradouro,
|
|
19
|
+
"q": q, "page": page, "pageSize": page_size}))
|
|
20
|
+
|
|
21
|
+
def buscar_proximos(self, *, latitude: float, longitude: float, raio_metro: float, page: Optional[int] = None,
|
|
22
|
+
page_size: Optional[int] = None) -> "Page[CepItemResponse]":
|
|
23
|
+
"""CEPs num raio (em metros) ao redor de uma coordenada."""
|
|
24
|
+
require_range(latitude, -90, 90, "latitude")
|
|
25
|
+
require_range(longitude, -180, 180, "longitude")
|
|
26
|
+
require_positive(raio_metro, "raio_metro")
|
|
27
|
+
return self._get("/v1/ceps/geo" + query({
|
|
28
|
+
"latitude": latitude, "longitude": longitude, "raioMetro": raio_metro, "page": page,
|
|
29
|
+
"pageSize": page_size}))
|
|
30
|
+
|
|
31
|
+
def buscar_proximos_do_cep(self, cep: str, *, raio_metro: float, page: Optional[int] = None,
|
|
32
|
+
page_size: Optional[int] = None) -> "Page[CepItemResponse]":
|
|
33
|
+
"""CEPs num raio (em metros) ao redor de outro CEP."""
|
|
34
|
+
require_positive(raio_metro, "raio_metro")
|
|
35
|
+
return self._get(f"/v1/ceps/geo/{normalize_cep(cep)}" + query({
|
|
36
|
+
"raioMetro": raio_metro, "page": page, "pageSize": page_size}))
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from typing import Iterable, List, Optional
|
|
2
|
+
|
|
3
|
+
from sharpfy_nextapi._validation import batch, normalize_cnpj, query
|
|
4
|
+
from sharpfy_nextapi.models import (CnpjConformidadeResponse, CnpjInscricaoEstadualResponse, CnpjItemResponse,
|
|
5
|
+
CnpjRelacionamentoResponse, CnpjSimplesResponse)
|
|
6
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Cnpj(Resource):
|
|
10
|
+
"""Consultas por CNPJ, com ou sem pontuação, numérico ou alfanumérico."""
|
|
11
|
+
|
|
12
|
+
def consultar(self, cnpj: str, *, tolerance_days: Optional[int] = None) -> CnpjItemResponse:
|
|
13
|
+
"""Dados cadastrais do estabelecimento (1 crédito).
|
|
14
|
+
|
|
15
|
+
:param tolerance_days: idade máxima aceita do dado em cache, em dias (0 a 45). 0 força a consulta em tempo real.
|
|
16
|
+
"""
|
|
17
|
+
return self._get(f"/v1/cnpj/{normalize_cnpj(cnpj)}" + query({"toleranceDays": tolerance_days}))
|
|
18
|
+
|
|
19
|
+
def consultar_ao_vivo(self, cnpj: str) -> CnpjItemResponse:
|
|
20
|
+
"""``consultar`` com ``tolerance_days=0``: consulta em tempo real ao provedor (exige plano que permita)."""
|
|
21
|
+
return self.consultar(cnpj, tolerance_days=0)
|
|
22
|
+
|
|
23
|
+
def obter_simples(self, cnpj: str, *, tolerance_days: Optional[int] = None) -> CnpjSimplesResponse:
|
|
24
|
+
"""Situação no Simples Nacional e no MEI."""
|
|
25
|
+
return self._get(f"/v1/cnpj/{normalize_cnpj(cnpj)}/simples" + query({"toleranceDays": tolerance_days}))
|
|
26
|
+
|
|
27
|
+
def obter_inscricoes_estaduais(self, cnpj: str) -> List[CnpjInscricaoEstadualResponse]:
|
|
28
|
+
"""Inscrições estaduais do estabelecimento, uma por UF."""
|
|
29
|
+
return self._get(f"/v1/cnpj/{normalize_cnpj(cnpj)}/ie")
|
|
30
|
+
|
|
31
|
+
def obter_conformidade(self, cnpj: str) -> CnpjConformidadeResponse:
|
|
32
|
+
"""Sanções (CEIS, CNEP, CEPIM) e dívida ativa da União. Planos pagos ou créditos avulsos."""
|
|
33
|
+
return self._get(f"/v1/cnpj/{normalize_cnpj(cnpj)}/conformidade")
|
|
34
|
+
|
|
35
|
+
def obter_relacionamentos(self, cnpj: str, *, page: Optional[int] = None, page_size: Optional[int] = None,
|
|
36
|
+
incluir_inativas: Optional[bool] = None) -> CnpjRelacionamentoResponse:
|
|
37
|
+
"""Sócios e empresas ligadas pelos mesmos sócios (grupo econômico), paginado."""
|
|
38
|
+
qs = query({"page": page, "pageSize": page_size, "incluirInativas": incluir_inativas})
|
|
39
|
+
return self._get(f"/v1/cnpj/{normalize_cnpj(cnpj)}/relacionamentos" + qs)
|
|
40
|
+
|
|
41
|
+
def consultar_lote(self, cnpjs: Iterable[str]) -> List[CnpjItemResponse]:
|
|
42
|
+
"""Até 100 CNPJs numa chamada; 1 crédito por CNPJ encontrado. Não é repetida automaticamente em falha."""
|
|
43
|
+
return self._post("/v1/cnpj/batch", {"cnpjs": batch(cnpjs)})
|
|
44
|
+
|
|
45
|
+
def obter_simples_lote(self, cnpjs: Iterable[str]) -> List[CnpjSimplesResponse]:
|
|
46
|
+
"""Simples Nacional de até 100 CNPJs numa chamada. Não é repetida automaticamente em falha."""
|
|
47
|
+
return self._post("/v1/cnpj/batch/simples", {"cnpjs": batch(cnpjs)})
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
from sharpfy_nextapi.models import WorkspaceCreditsResponse
|
|
2
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Creditos(Resource):
|
|
6
|
+
def consultar(self) -> WorkspaceCreditsResponse:
|
|
7
|
+
"""Saldo de créditos do plano e avulsos, e os limites da chave. Não consome crédito."""
|
|
8
|
+
return self._get("/v1/credits")
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
from datetime import date
|
|
2
|
+
from typing import Optional, Union
|
|
3
|
+
|
|
4
|
+
from sharpfy_nextapi._validation import query
|
|
5
|
+
from sharpfy_nextapi.models import CnpjSimplifiedResponse, Page
|
|
6
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Empresas(Resource):
|
|
10
|
+
def pesquisar(self, *, q: Optional[str] = None, uf: Optional[str] = None, codigo_municipio: Optional[str] = None,
|
|
11
|
+
cnpj_raiz: Optional[str] = None, cnpj: Optional[str] = None,
|
|
12
|
+
data_abertura_inicio: Union[date, str, None] = None, data_abertura_fim: Union[date, str, None] = None,
|
|
13
|
+
codigo_situacao_cadastral: Optional[str] = None, ceps: Optional[str] = None,
|
|
14
|
+
cnaes: Optional[str] = None, page: Optional[int] = None,
|
|
15
|
+
page_size: Optional[int] = None) -> "Page[CnpjSimplifiedResponse]":
|
|
16
|
+
"""Pesquisa de empresas por filtros. ``ceps`` e ``cnaes`` aceitam vários valores separados por vírgula."""
|
|
17
|
+
return self._get("/v1/empresas" + query({
|
|
18
|
+
"q": q, "uf": uf, "codigoMunicipio": codigo_municipio, "cnpjRaiz": cnpj_raiz, "cnpj": cnpj,
|
|
19
|
+
"dataAberturaInicio": data_abertura_inicio, "dataAberturaFim": data_abertura_fim,
|
|
20
|
+
"codigoSituacaoCadastral": codigo_situacao_cadastral, "ceps": ceps, "cnaes": cnaes, "page": page,
|
|
21
|
+
"pageSize": page_size}))
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
from typing import Optional
|
|
2
|
+
|
|
3
|
+
from sharpfy_nextapi._validation import positive_int, query
|
|
4
|
+
from sharpfy_nextapi.models import (CnaeItemResponse, EstadoItemResponse, MunicipioDetalhadoResponse,
|
|
5
|
+
MunicipioItemResponse, Page)
|
|
6
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Cnaes(Resource):
|
|
10
|
+
def listar(self, *, page: Optional[int] = None, page_size: Optional[int] = None) -> "Page[CnaeItemResponse]":
|
|
11
|
+
return self._get("/v1/cnaes" + query({"page": page, "pageSize": page_size}))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class Estados(Resource):
|
|
15
|
+
def listar(self, *, page: Optional[int] = None, page_size: Optional[int] = None) -> "Page[EstadoItemResponse]":
|
|
16
|
+
return self._get("/v1/estados" + query({"page": page, "pageSize": page_size}))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class Municipios(Resource):
|
|
20
|
+
def listar(self, *, uf: Optional[str] = None, page: Optional[int] = None,
|
|
21
|
+
page_size: Optional[int] = None) -> "Page[MunicipioItemResponse]":
|
|
22
|
+
return self._get("/v1/municipios" + query({"uf": uf, "page": page, "pageSize": page_size}))
|
|
23
|
+
|
|
24
|
+
def obter_por_id(self, id: int) -> MunicipioDetalhadoResponse:
|
|
25
|
+
"""Município pelo código da Receita (o ``id`` de ``listar``), com a hierarquia do IBGE."""
|
|
26
|
+
return self._get(f"/v1/municipios/{positive_int(id, 'id')}")
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import re
|
|
2
|
+
from typing import Optional
|
|
3
|
+
|
|
4
|
+
from sharpfy_nextapi._validation import path_segment, positive_int, query
|
|
5
|
+
from sharpfy_nextapi.models import MercadoCnaeResponse, MercadoIndicadorResponse, MercadoMunicipioResponse
|
|
6
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Mercado(Resource):
|
|
10
|
+
"""Dados de mercado agregados. Planos pagos ou créditos avulsos."""
|
|
11
|
+
|
|
12
|
+
def obter_cnae(self, cnae: str, *, uf: Optional[str] = None, meses: Optional[int] = None) -> MercadoCnaeResponse:
|
|
13
|
+
"""Empresas ativas, aberturas e baixas de um CNAE (com ou sem pontuação), no Brasil ou numa UF."""
|
|
14
|
+
codigo = path_segment(re.sub(r"[\s./-]", "", str(cnae or "")), "cnae")
|
|
15
|
+
return self._get(f"/v1/mercado/cnaes/{codigo}" + query({"uf": uf, "meses": meses}))
|
|
16
|
+
|
|
17
|
+
def obter_municipio(self, id: int) -> MercadoMunicipioResponse:
|
|
18
|
+
"""Empresas e economia (PIB, população) de um município, pelo código da Receita."""
|
|
19
|
+
return self._get(f"/v1/mercado/municipios/{positive_int(id, 'id')}")
|
|
20
|
+
|
|
21
|
+
def obter_indicador(self, tipo: str, *, inicio: Optional[str] = None,
|
|
22
|
+
fim: Optional[str] = None) -> MercadoIndicadorResponse:
|
|
23
|
+
"""Série de um indicador econômico (ex.: ``ipca``), de ``inicio`` a ``fim`` (``AAAAMM``)."""
|
|
24
|
+
return self._get(f"/v1/mercado/indicadores/{path_segment(tipo, 'tipo')}" + query({"inicio": inicio, "fim": fim}))
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
from typing import Optional
|
|
2
|
+
|
|
3
|
+
from sharpfy_nextapi._validation import normalize_hash_socio, query
|
|
4
|
+
from sharpfy_nextapi.models import SocioEmpresasResponse
|
|
5
|
+
from sharpfy_nextapi.resources.base import Resource
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Socios(Resource):
|
|
9
|
+
def listar_empresas(self, hash_socio: str, *, page: Optional[int] = None, page_size: Optional[int] = None,
|
|
10
|
+
incluir_inativas: Optional[bool] = None) -> SocioEmpresasResponse:
|
|
11
|
+
"""Empresas do sócio. O hash vem de ``obter_relacionamentos`` (``socios[].hashSocio``); com
|
|
12
|
+
``socio.vinculoVerificavel`` falso ele é provisório: não guarde."""
|
|
13
|
+
qs = query({"page": page, "pageSize": page_size, "incluirInativas": incluir_inativas})
|
|
14
|
+
return self._get(f"/v1/socios/{normalize_hash_socio(hash_socio)}/empresas" + qs)
|