@lexnode/legal-data-sdk 1.0.0 → 1.18.0
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.
- package/README.md +331 -11
- package/dist/client.d.ts +95 -0
- package/dist/client.js +430 -0
- package/dist/errors.d.ts +94 -0
- package/dist/errors.js +215 -0
- package/dist/freshness.d.ts +48 -0
- package/dist/freshness.js +105 -0
- package/dist/index.d.ts +26 -0
- package/dist/index.js +17 -0
- package/dist/paginate.d.ts +21 -0
- package/dist/paginate.js +106 -0
- package/dist/search.d.ts +64 -0
- package/dist/search.js +75 -0
- package/dist/types.d.ts +179 -0
- package/dist/types.js +1 -0
- package/dist/watch.d.ts +93 -0
- package/dist/watch.js +95 -0
- package/dist/webhooks.d.ts +321 -0
- package/dist/webhooks.js +223 -0
- package/package.json +28 -4
- package/schema.d.ts +520 -17
package/schema.d.ts
CHANGED
|
@@ -93,7 +93,7 @@ export interface paths {
|
|
|
93
93
|
};
|
|
94
94
|
/**
|
|
95
95
|
* Listar os tribunais suportados
|
|
96
|
-
* @description Retorna os tribunais suportados e as fontes
|
|
96
|
+
* @description Retorna os tribunais suportados e, para cada um, as fontes que o servem em `sources`: o eixo de processo, o diário e, onde existe, o acervo de jurisprudência. A entrada do ramo `ADMINISTRATIVE` tem só o acervo — consulta de processo, busca e colheita no diário, vigília e calendário forense a recusam com `TRIBUNAL_NOT_SUPPORTED`. É daqui que sai a grafia aceita nas demais rotas, pela sigla (`code`) ou pelo apelido da fonte (`alias`); a chave que liga uma publicação ao catálogo é `code`.
|
|
97
97
|
*
|
|
98
98
|
* **Escopo exigido na chave de API:** `TRIBUNALS_READ`
|
|
99
99
|
*/
|
|
@@ -269,7 +269,7 @@ export interface paths {
|
|
|
269
269
|
};
|
|
270
270
|
/**
|
|
271
271
|
* Listar monitores
|
|
272
|
-
* @description Paginação keyset: passe em `cursor` o `meta.nextCursor` da resposta anterior. `officeScoped=true` restringe aos monitores atribuídos ao `X-Office-Id` da chamada.
|
|
272
|
+
* @description Paginação keyset: passe em `cursor` o `meta.nextCursor` da resposta anterior. `officeScoped=true` restringe aos monitores atribuídos ao `X-Office-Id` da chamada. Os campos de alvo (`tribunalAlias`, `processNumber`, `oabNumber`, `oabState`, `term`, `partyName`) filtram pelo que o monitor vigia, nas mesmas grafias que a criação aceita — quem mantém um sensor por alvo pergunta pelo alvo em vez de paginar a conta inteira.
|
|
273
273
|
*
|
|
274
274
|
* **Escopo exigido na chave de API:** `MONITORS_READ`
|
|
275
275
|
*/
|
|
@@ -277,7 +277,7 @@ export interface paths {
|
|
|
277
277
|
put?: never;
|
|
278
278
|
/**
|
|
279
279
|
* Criar um monitor
|
|
280
|
-
* @description Cria um monitor PROCESS, OAB ou TERM. O motor varre as fontes na própria agenda: monitor OAB emite `PUBLICATION_CREATED` a cada publicação nova do advogado; monitor TERM vigia a edição diária do diário por um termo livre (mínimo 5 caracteres — piso da fonte —, casamento por palavra inteira, varredura nacional) e emite `PUBLICATION_CREATED` — com o campo `term` no payload — para cada menção compartilhável nova; monitor PROCESS emite `MONITOR_SYNC_SUCCEEDED` (com o campo `changed`) a cada varredura e `MONITOR_SYNC_FAILED` quando a varredura falha. Para ser notificado de movimentação nova de um processo, use POST /v1/subscriptions. **Vigília de aparição:** um monitor PROCESS cujo alvo a fonte ainda não indexou é aceito e fica esperando — `targetSeenAt: null` na resposta marca a espera, a varredura em espera emite `MONITOR_SYNC_SUCCEEDED` com `awaitingAppearance: true`, e a primeira aparição chega com `firstAppearance: true`. Informe `distributedAt` (AAAA-MM-DD, nunca no futuro; imutável depois de criado — corrigir a data é recriar o monitor) para a espera ter critério de parada: enquanto a data-limite do índice da fonte não alcança a data, o alvo nem é consultado; quando a ultrapassa com folga de 3 dias e nada apareceu, o monitor entra em ERROR — cadastro provavelmente errado — sem deixar de tentar.
|
|
280
|
+
* @description Cria um monitor PROCESS, OAB ou TERM. O motor varre as fontes na própria agenda: monitor OAB emite `PUBLICATION_CREATED` a cada publicação nova do advogado; monitor TERM vigia a edição diária do diário por um termo livre (mínimo 5 caracteres — piso da fonte —, casamento por palavra inteira, varredura nacional) e emite `PUBLICATION_CREATED` — com o campo `term` no payload — para cada menção compartilhável nova; monitor PROCESS emite `MONITOR_SYNC_SUCCEEDED` (com o campo `changed`) a cada varredura e `MONITOR_SYNC_FAILED` quando a varredura falha. Para ser notificado de movimentação nova de um processo, use POST /v1/subscriptions. **Vigília de aparição:** um monitor PROCESS cujo alvo a fonte ainda não indexou é aceito e fica esperando — `targetSeenAt: null` na resposta marca a espera, a varredura em espera emite `MONITOR_SYNC_SUCCEEDED` com `awaitingAppearance: true`, e a primeira aparição chega com `firstAppearance: true`. Informe `distributedAt` (AAAA-MM-DD, nunca no futuro; imutável depois de criado — corrigir a data é recriar o monitor) para a espera ter critério de parada: enquanto a data-limite do índice da fonte não alcança a data, o alvo nem é consultado; quando a ultrapassa com folga de 3 dias e nada apareceu, o monitor entra em ERROR — cadastro provavelmente errado — sem deixar de tentar. **Alvo já vigiado:** o monitor é único por alvo dentro da conta e do projeto, e o segundo pedido responde 409 `MONITOR_ALREADY_EXISTS` com `error.details.monitorId` — o id do que já está lá, para quem compõe sensor e assinatura seguir sem procurar na lista.
|
|
281
281
|
*
|
|
282
282
|
* **Escopo exigido na chave de API:** `MONITORS_WRITE`
|
|
283
283
|
*/
|
|
@@ -397,7 +397,7 @@ export interface paths {
|
|
|
397
397
|
};
|
|
398
398
|
/**
|
|
399
399
|
* Consultar um job de busca
|
|
400
|
-
* @description Retorna o status do job; em SUCCEEDED, `result` carrega o mesmo formato da busca síncrona de processos. Jobs são visíveis apenas para a conta/office que os submeteu (404 caso contrário). A submissão acontece via POST /v1/processes/search, que responde 202 + jobId quando o modo assíncrono está ativo.
|
|
400
|
+
* @description Retorna o status do job; em SUCCEEDED, `result` carrega o mesmo formato da busca síncrona de processos — inclusive `sourceIndex.updatedThrough`, a data até onde o índice do tribunal está atualizado, que qualifica um `total: 0` como *ainda não chegou* em vez de *não existe*. O campo acompanha o resultado que consultou a fonte; um job servido do acervo não o traz. Jobs são visíveis apenas para a conta/office que os submeteu (404 caso contrário). A submissão acontece via POST /v1/processes/search, que responde 202 + jobId quando o modo assíncrono está ativo.
|
|
401
401
|
*
|
|
402
402
|
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
403
403
|
*/
|
|
@@ -569,7 +569,7 @@ export interface paths {
|
|
|
569
569
|
};
|
|
570
570
|
/**
|
|
571
571
|
* Consultar a cobertura do corpus indexado
|
|
572
|
-
* @description Cobertura agregada do corpus de jurisprudência indexado localmente: documentos indexáveis por fonte × tribunal × mês (a mesma agregação congelada no snapshot de cobertura de cada busca textual), combinada com o estado das fatias de colheita do diário oficial — grupo com fatia pendente reporta `PARTIAL` (o conjunto indexado ainda pode crescer), grupo totalmente colhido/indexado reporta `INDEXED`, e `NONE` significa nada indexado nem colheita solicitada. Inclui totais por fonte com as datas da publicação indexada mais antiga e mais recente. As fontes são reportadas separadamente — um corpus estruturado espelhado do tribunal e menções no diário oficial são ativos diferentes. Leitura local, zero créditos.
|
|
572
|
+
* @description Cobertura agregada do corpus de jurisprudência indexado localmente: documentos indexáveis por fonte × tribunal × mês (a mesma agregação congelada no snapshot de cobertura de cada busca textual), combinada com o estado das fatias de colheita do diário oficial — grupo com fatia pendente reporta `PARTIAL` (o conjunto indexado ainda pode crescer), grupo totalmente colhido/indexado reporta `INDEXED`, e `NONE` significa nada indexado nem colheita solicitada. Inclui totais por fonte com as datas da publicação indexada mais antiga e mais recente, e a cobertura por matéria em `areas` — cada área do direito com estado, contagens e tribunais indexados, inclusive as matérias fora do acervo (`covered: false`), para que resultado vazio nunca se confunda com matéria não coberta. As fontes são reportadas separadamente — um corpus estruturado espelhado do tribunal e menções no diário oficial são ativos diferentes. Leitura local, zero créditos.
|
|
573
573
|
*
|
|
574
574
|
* **Escopo exigido na chave de API:** `PUBLICATIONS_READ`
|
|
575
575
|
*/
|
|
@@ -726,6 +726,28 @@ export interface paths {
|
|
|
726
726
|
patch?: never;
|
|
727
727
|
trace?: never;
|
|
728
728
|
};
|
|
729
|
+
"/v1/legal-norms/resolve": {
|
|
730
|
+
parameters: {
|
|
731
|
+
query?: never;
|
|
732
|
+
header?: never;
|
|
733
|
+
path?: never;
|
|
734
|
+
cookie?: never;
|
|
735
|
+
};
|
|
736
|
+
get?: never;
|
|
737
|
+
put?: never;
|
|
738
|
+
/**
|
|
739
|
+
* Resolver uma norma federal no registro oficial
|
|
740
|
+
* @description Entende a citação como ela é escrita (ou aceita tipo, número e ano já separados), pergunta o ato ao registro oficial de normas federais e devolve o que ele declara. Custa crédito só quando há consulta: citação não entendida (`UNRECOGNIZED`) e tipo de ato fora do registro (`OUT_OF_REACH`) são decididos antes da rede e saem a zero. `NOT_FOUND` significa que o ato não consta do registro — não é prova de que ele não exista. A chave de teste recusa esta porta: não há acervo a reler.
|
|
741
|
+
*
|
|
742
|
+
* **Escopo exigido na chave de API:** `PUBLICATIONS_READ`
|
|
743
|
+
*/
|
|
744
|
+
post: operations["resolveLegalNorm"];
|
|
745
|
+
delete?: never;
|
|
746
|
+
options?: never;
|
|
747
|
+
head?: never;
|
|
748
|
+
patch?: never;
|
|
749
|
+
trace?: never;
|
|
750
|
+
};
|
|
729
751
|
"/v1/usage": {
|
|
730
752
|
parameters: {
|
|
731
753
|
query?: never;
|
|
@@ -925,7 +947,7 @@ export interface paths {
|
|
|
925
947
|
put?: never;
|
|
926
948
|
/**
|
|
927
949
|
* Reenviar um evento (replay)
|
|
928
|
-
* @description Reenfileira as entregas de um evento para tentativa imediata: cria as entregas que faltam (endpoint cadastrado depois do evento) e zera as FAILED/CANCELED/DELIVERED. O eventId vem de GET /v1/webhooks/deliveries. Evento de outra conta responde 404.
|
|
950
|
+
* @description Reenfileira as entregas de um evento para tentativa imediata: cria as entregas que faltam (endpoint cadastrado depois do evento) e zera as FAILED/CANCELED/DELIVERED — só nos endpoints que recebem entrega; o pausado pelo titular e o com push suspenso são pulados. O eventId vem de GET /v1/webhooks/deliveries. Evento de outra conta responde 404.
|
|
929
951
|
*
|
|
930
952
|
* **Escopo exigido na chave de API:** `WEBHOOKS_WRITE`
|
|
931
953
|
*/
|
|
@@ -947,7 +969,7 @@ export interface paths {
|
|
|
947
969
|
put?: never;
|
|
948
970
|
/**
|
|
949
971
|
* Reenviar uma janela de eventos ao endpoint
|
|
950
|
-
* @description O "reenvie tudo de sábado para cá": reenfileira, para UM endpoint, os eventos assinados que ocorreram na janela `from`..`to` — cria as entregas que faltam e devolve à fila as FAILED/CANCELED (com `includeDelivered: true`, também as já entregues). O teto por chamada é dito na resposta: quando `skipped > 0`, repita a chamada com `from = nextFrom` para continuar. Endpoint desativado responde 409; endpoint de outra conta responde 404.
|
|
972
|
+
* @description O "reenvie tudo de sábado para cá": reenfileira, para UM endpoint, os eventos assinados que ocorreram na janela `from`..`to` — cria as entregas que faltam e devolve à fila as FAILED/CANCELED (com `includeDelivered: true`, também as já entregues). O teto por chamada é dito na resposta: quando `skipped > 0`, repita a chamada com `from = nextFrom` para continuar. Endpoint desativado ou com o push suspenso responde 409; endpoint de outra conta responde 404.
|
|
951
973
|
*
|
|
952
974
|
* **Escopo exigido na chave de API:** `WEBHOOKS_WRITE`
|
|
953
975
|
*/
|
|
@@ -968,8 +990,8 @@ export interface paths {
|
|
|
968
990
|
get?: never;
|
|
969
991
|
put?: never;
|
|
970
992
|
/**
|
|
971
|
-
* Retomar as entregas de um endpoint espaçado
|
|
972
|
-
* @description Devolve a fila do endpoint ao ritmo normal, zerando a fieira de recusas e
|
|
993
|
+
* Retomar as entregas de um endpoint espaçado ou suspenso
|
|
994
|
+
* @description Devolve a fila do endpoint ao ritmo normal, zerando a fieira de recusas, o espaçamento e a suspensão do push. O espaçamento se desfaz sozinho na primeira resposta 2xx — esta rota existe para quem acabou de consertar o receptor e não quer esperar a próxima sonda, que no teto sai a cada 6 horas. A suspensão (depois de 7 dias de recusa contínua) só se desfaz aqui ou pelo portal. A resposta traz `replayFrom` sempre que havia uma série de recusas — o início dela, de onde reenviar (`POST …/replay`) para repor o que falhou na série e, se o push esteve suspenso, o que nasceu sem entrega — e `suspendedSince` quando o push estava suspenso. Não ressuscita entrega já esgotada: para isso é o replay. Endpoint pausado pelo titular responde 409; endpoint de outra conta responde 404.
|
|
973
995
|
*
|
|
974
996
|
* **Escopo exigido na chave de API:** `WEBHOOKS_WRITE`
|
|
975
997
|
*/
|
|
@@ -1168,7 +1190,7 @@ export interface operations {
|
|
|
1168
1190
|
listTribunals: {
|
|
1169
1191
|
parameters: {
|
|
1170
1192
|
query?: {
|
|
1171
|
-
branch?: "SUPERIOR" | "FEDERAL" | "STATE" | "LABOR" | "ELECTORAL" | "MILITARY";
|
|
1193
|
+
branch?: "SUPERIOR" | "FEDERAL" | "STATE" | "LABOR" | "ELECTORAL" | "MILITARY" | "ADMINISTRATIVE";
|
|
1172
1194
|
};
|
|
1173
1195
|
header?: {
|
|
1174
1196
|
/** @description Identificador da requisição escolhido pelo cliente, ecoado em meta.requestId e no corpo de erro. Tem DOIS papéis: (1) rastreio, em toda rota — é por ele que o suporte encontra a chamada; (2) idempotência por conta em POST /v1/publications/text-searches e POST /v1/search-jobs, onde reenviar o mesmo valor reapresenta o resultado já produzido, sem nova cobrança. Fora dessas duas rotas o valor não deduplica nada: para repetir uma chamada de propósito, mande um valor novo. Aceita [A-Za-z0-9_.:-], até 200 caracteres; valor fora disso é ignorado e o motor cunha o próprio. */
|
|
@@ -1193,8 +1215,12 @@ export interface operations {
|
|
|
1193
1215
|
code: string;
|
|
1194
1216
|
name: string;
|
|
1195
1217
|
/** @enum {string} */
|
|
1196
|
-
branch: "SUPERIOR" | "FEDERAL" | "STATE" | "LABOR" | "ELECTORAL" | "MILITARY";
|
|
1197
|
-
sources: ("CNJ_DATAJUD" | "DJEN_PUBLIC")[];
|
|
1218
|
+
branch: "SUPERIOR" | "FEDERAL" | "STATE" | "LABOR" | "ELECTORAL" | "MILITARY" | "ADMINISTRATIVE";
|
|
1219
|
+
sources: ("CNJ_DATAJUD" | "DJEN_PUBLIC" | "STJ_OPEN_DATA" | "CARF_OPEN_DATA" | "TJDFT_OPEN_DATA")[];
|
|
1220
|
+
cnjNumbering: {
|
|
1221
|
+
segment: number;
|
|
1222
|
+
code: number;
|
|
1223
|
+
} | null;
|
|
1198
1224
|
}[];
|
|
1199
1225
|
meta: {
|
|
1200
1226
|
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
@@ -1424,13 +1450,26 @@ export interface operations {
|
|
|
1424
1450
|
entries: {
|
|
1425
1451
|
date: string;
|
|
1426
1452
|
/** @enum {string} */
|
|
1427
|
-
kind: "HOLIDAY";
|
|
1453
|
+
kind: "HOLIDAY" | "RECESS";
|
|
1428
1454
|
/** @enum {string} */
|
|
1429
1455
|
scope: "NATIONAL" | "STATE" | "MUNICIPAL";
|
|
1430
1456
|
label: string;
|
|
1431
1457
|
uf: string | null;
|
|
1432
1458
|
municipalityIbgeCode?: number;
|
|
1433
1459
|
}[];
|
|
1460
|
+
coverage: {
|
|
1461
|
+
/** @enum {string} */
|
|
1462
|
+
layer: "NATIONAL_MOVABLE" | "NATIONAL_FIXED" | "JUDICIAL_RECESS" | "STATE" | "MUNICIPAL" | "SUSPENSION";
|
|
1463
|
+
label: string;
|
|
1464
|
+
/** @enum {string} */
|
|
1465
|
+
status: "CONSULTED" | "APPLIED_BY_CALLER" | "NOT_REQUESTED" | "UNAVAILABLE_FOR_COURT" | "COURT_NOT_RECOGNIZED" | "NOT_CATALOGUED" | "NOT_SERVED";
|
|
1466
|
+
detail: string;
|
|
1467
|
+
}[];
|
|
1468
|
+
jurisdiction: {
|
|
1469
|
+
/** @enum {string} */
|
|
1470
|
+
reach: "NATIONAL" | "SINGLE_STATE" | "MULTI_STATE";
|
|
1471
|
+
states: string[];
|
|
1472
|
+
} | null;
|
|
1434
1473
|
};
|
|
1435
1474
|
meta: {
|
|
1436
1475
|
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
@@ -1678,6 +1717,13 @@ export interface operations {
|
|
|
1678
1717
|
};
|
|
1679
1718
|
degree?: string | null;
|
|
1680
1719
|
sigiloLevel?: number | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
1722
|
+
* @enum {string}
|
|
1723
|
+
*/
|
|
1724
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
1725
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
1726
|
+
shareable?: boolean;
|
|
1681
1727
|
class: {
|
|
1682
1728
|
code?: number | null;
|
|
1683
1729
|
name?: string | null;
|
|
@@ -1722,7 +1768,10 @@ export interface operations {
|
|
|
1722
1768
|
* @description Última atualização presente no índice da fonte. Um processo distribuído depois desta data ainda não é encontrável — a ausência dele não significa que não exista. Null quando a fonte não respondeu à sondagem.
|
|
1723
1769
|
*/
|
|
1724
1770
|
updatedThrough: string | null;
|
|
1725
|
-
/**
|
|
1771
|
+
/**
|
|
1772
|
+
* Format: date-time
|
|
1773
|
+
* @description Quando esta busca montou a resposta com a data-limite acima.
|
|
1774
|
+
*/
|
|
1726
1775
|
checkedAt: string;
|
|
1727
1776
|
} | null;
|
|
1728
1777
|
};
|
|
@@ -1754,8 +1803,6 @@ export interface operations {
|
|
|
1754
1803
|
creditsReserved?: number;
|
|
1755
1804
|
/** Format: date-time */
|
|
1756
1805
|
createdAt?: string;
|
|
1757
|
-
} & {
|
|
1758
|
-
[key: string]: unknown;
|
|
1759
1806
|
};
|
|
1760
1807
|
meta: {
|
|
1761
1808
|
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
@@ -1986,6 +2033,13 @@ export interface operations {
|
|
|
1986
2033
|
};
|
|
1987
2034
|
degree?: string | null;
|
|
1988
2035
|
sigiloLevel?: number | null;
|
|
2036
|
+
/**
|
|
2037
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
2038
|
+
* @enum {string}
|
|
2039
|
+
*/
|
|
2040
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
2041
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
2042
|
+
shareable?: boolean;
|
|
1989
2043
|
class: {
|
|
1990
2044
|
code?: number | null;
|
|
1991
2045
|
name?: string | null;
|
|
@@ -2282,6 +2336,13 @@ export interface operations {
|
|
|
2282
2336
|
};
|
|
2283
2337
|
degree?: string | null;
|
|
2284
2338
|
sigiloLevel?: number | null;
|
|
2339
|
+
/**
|
|
2340
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
2341
|
+
* @enum {string}
|
|
2342
|
+
*/
|
|
2343
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
2344
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
2345
|
+
shareable?: boolean;
|
|
2285
2346
|
class: {
|
|
2286
2347
|
code?: number | null;
|
|
2287
2348
|
name?: string | null;
|
|
@@ -2583,6 +2644,13 @@ export interface operations {
|
|
|
2583
2644
|
};
|
|
2584
2645
|
degree?: string | null;
|
|
2585
2646
|
sigiloLevel?: number | null;
|
|
2647
|
+
/**
|
|
2648
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
2649
|
+
* @enum {string}
|
|
2650
|
+
*/
|
|
2651
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
2652
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
2653
|
+
shareable?: boolean;
|
|
2586
2654
|
class: {
|
|
2587
2655
|
code?: number | null;
|
|
2588
2656
|
name?: string | null;
|
|
@@ -2887,6 +2955,8 @@ export interface operations {
|
|
|
2887
2955
|
formattedProcessNumber: string;
|
|
2888
2956
|
/** Format: date-time */
|
|
2889
2957
|
movementDate?: string | null;
|
|
2958
|
+
code: number | null;
|
|
2959
|
+
label?: string | null;
|
|
2890
2960
|
payload: unknown;
|
|
2891
2961
|
}[];
|
|
2892
2962
|
};
|
|
@@ -3162,6 +3232,13 @@ export interface operations {
|
|
|
3162
3232
|
};
|
|
3163
3233
|
degree?: string | null;
|
|
3164
3234
|
sigiloLevel?: number | null;
|
|
3235
|
+
/**
|
|
3236
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
3237
|
+
* @enum {string}
|
|
3238
|
+
*/
|
|
3239
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
3240
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
3241
|
+
shareable?: boolean;
|
|
3165
3242
|
class: {
|
|
3166
3243
|
code?: number | null;
|
|
3167
3244
|
name?: string | null;
|
|
@@ -3415,6 +3492,12 @@ export interface operations {
|
|
|
3415
3492
|
status?: "ACTIVE" | "PAUSED" | "DISABLED" | "ERROR";
|
|
3416
3493
|
type?: "PROCESS" | "OAB" | "TERM" | "PARTY";
|
|
3417
3494
|
officeScoped?: "true" | "false";
|
|
3495
|
+
tribunalAlias?: string;
|
|
3496
|
+
processNumber?: string;
|
|
3497
|
+
oabNumber?: string;
|
|
3498
|
+
oabState?: string;
|
|
3499
|
+
term?: string;
|
|
3500
|
+
partyName?: string;
|
|
3418
3501
|
};
|
|
3419
3502
|
header?: {
|
|
3420
3503
|
/** @description Identificador da requisição escolhido pelo cliente, ecoado em meta.requestId e no corpo de erro. Tem DOIS papéis: (1) rastreio, em toda rota — é por ele que o suporte encontra a chamada; (2) idempotência por conta em POST /v1/publications/text-searches e POST /v1/search-jobs, onde reenviar o mesmo valor reapresenta o resultado já produzido, sem nova cobrança. Fora dessas duas rotas o valor não deduplica nada: para repetir uma chamada de propósito, mande um valor novo. Aceita [A-Za-z0-9_.:-], até 200 caracteres; valor fora disso é ignorado e o motor cunha o próprio. */
|
|
@@ -3442,6 +3525,7 @@ export interface operations {
|
|
|
3442
3525
|
status: "ACTIVE" | "PAUSED" | "DISABLED" | "ERROR";
|
|
3443
3526
|
label?: string | null;
|
|
3444
3527
|
tribunalAlias?: string | null;
|
|
3528
|
+
tribunalSigla?: string | null;
|
|
3445
3529
|
processNumber?: string | null;
|
|
3446
3530
|
oabNumber?: string | null;
|
|
3447
3531
|
oabState?: string | null;
|
|
@@ -3456,8 +3540,14 @@ export interface operations {
|
|
|
3456
3540
|
/** Format: date-time */
|
|
3457
3541
|
targetSeenAt?: string | null;
|
|
3458
3542
|
/** Format: date-time */
|
|
3543
|
+
retiredAt?: string | null;
|
|
3544
|
+
/** Format: date-time */
|
|
3459
3545
|
targetExpectedFrom?: string | null;
|
|
3460
3546
|
/** Format: date-time */
|
|
3547
|
+
sourceUpdatedAt?: string | null;
|
|
3548
|
+
/** Format: date-time */
|
|
3549
|
+
latestMovementAt?: string | null;
|
|
3550
|
+
/** Format: date-time */
|
|
3461
3551
|
createdAt: string;
|
|
3462
3552
|
/** Format: date-time */
|
|
3463
3553
|
updatedAt: string;
|
|
@@ -3701,6 +3791,7 @@ export interface operations {
|
|
|
3701
3791
|
status: "ACTIVE" | "PAUSED" | "DISABLED" | "ERROR";
|
|
3702
3792
|
label?: string | null;
|
|
3703
3793
|
tribunalAlias?: string | null;
|
|
3794
|
+
tribunalSigla?: string | null;
|
|
3704
3795
|
processNumber?: string | null;
|
|
3705
3796
|
oabNumber?: string | null;
|
|
3706
3797
|
oabState?: string | null;
|
|
@@ -3715,8 +3806,14 @@ export interface operations {
|
|
|
3715
3806
|
/** Format: date-time */
|
|
3716
3807
|
targetSeenAt?: string | null;
|
|
3717
3808
|
/** Format: date-time */
|
|
3809
|
+
retiredAt?: string | null;
|
|
3810
|
+
/** Format: date-time */
|
|
3718
3811
|
targetExpectedFrom?: string | null;
|
|
3719
3812
|
/** Format: date-time */
|
|
3813
|
+
sourceUpdatedAt?: string | null;
|
|
3814
|
+
/** Format: date-time */
|
|
3815
|
+
latestMovementAt?: string | null;
|
|
3816
|
+
/** Format: date-time */
|
|
3720
3817
|
createdAt: string;
|
|
3721
3818
|
/** Format: date-time */
|
|
3722
3819
|
updatedAt: string;
|
|
@@ -4185,6 +4282,7 @@ export interface operations {
|
|
|
4185
4282
|
status: "ACTIVE" | "PAUSED" | "DISABLED" | "ERROR";
|
|
4186
4283
|
label?: string | null;
|
|
4187
4284
|
tribunalAlias?: string | null;
|
|
4285
|
+
tribunalSigla?: string | null;
|
|
4188
4286
|
processNumber?: string | null;
|
|
4189
4287
|
oabNumber?: string | null;
|
|
4190
4288
|
oabState?: string | null;
|
|
@@ -4199,8 +4297,14 @@ export interface operations {
|
|
|
4199
4297
|
/** Format: date-time */
|
|
4200
4298
|
targetSeenAt?: string | null;
|
|
4201
4299
|
/** Format: date-time */
|
|
4300
|
+
retiredAt?: string | null;
|
|
4301
|
+
/** Format: date-time */
|
|
4202
4302
|
targetExpectedFrom?: string | null;
|
|
4203
4303
|
/** Format: date-time */
|
|
4304
|
+
sourceUpdatedAt?: string | null;
|
|
4305
|
+
/** Format: date-time */
|
|
4306
|
+
latestMovementAt?: string | null;
|
|
4307
|
+
/** Format: date-time */
|
|
4204
4308
|
createdAt: string;
|
|
4205
4309
|
/** Format: date-time */
|
|
4206
4310
|
updatedAt: string;
|
|
@@ -4719,6 +4823,7 @@ export interface operations {
|
|
|
4719
4823
|
status: "ACTIVE" | "PAUSED" | "DISABLED" | "ERROR";
|
|
4720
4824
|
label?: string | null;
|
|
4721
4825
|
tribunalAlias?: string | null;
|
|
4826
|
+
tribunalSigla?: string | null;
|
|
4722
4827
|
processNumber?: string | null;
|
|
4723
4828
|
oabNumber?: string | null;
|
|
4724
4829
|
oabState?: string | null;
|
|
@@ -4733,8 +4838,14 @@ export interface operations {
|
|
|
4733
4838
|
/** Format: date-time */
|
|
4734
4839
|
targetSeenAt?: string | null;
|
|
4735
4840
|
/** Format: date-time */
|
|
4841
|
+
retiredAt?: string | null;
|
|
4842
|
+
/** Format: date-time */
|
|
4736
4843
|
targetExpectedFrom?: string | null;
|
|
4737
4844
|
/** Format: date-time */
|
|
4845
|
+
sourceUpdatedAt?: string | null;
|
|
4846
|
+
/** Format: date-time */
|
|
4847
|
+
latestMovementAt?: string | null;
|
|
4848
|
+
/** Format: date-time */
|
|
4738
4849
|
createdAt: string;
|
|
4739
4850
|
/** Format: date-time */
|
|
4740
4851
|
updatedAt: string;
|
|
@@ -5507,6 +5618,13 @@ export interface operations {
|
|
|
5507
5618
|
};
|
|
5508
5619
|
degree?: string | null;
|
|
5509
5620
|
sigiloLevel?: number | null;
|
|
5621
|
+
/**
|
|
5622
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5623
|
+
* @enum {string}
|
|
5624
|
+
*/
|
|
5625
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5626
|
+
/** @description Se a linha pode ser amortizada entre consumidores. Falso acompanha o segredo e também a linha que o motor reteve por outro motivo. */
|
|
5627
|
+
shareable?: boolean;
|
|
5510
5628
|
class: {
|
|
5511
5629
|
code?: number | null;
|
|
5512
5630
|
name?: string | null;
|
|
@@ -5545,6 +5663,19 @@ export interface operations {
|
|
|
5545
5663
|
}[];
|
|
5546
5664
|
redactedCount?: number | null;
|
|
5547
5665
|
nextCursor?: (string | number)[] | null;
|
|
5666
|
+
sourceIndex?: {
|
|
5667
|
+
tribunalAlias: string;
|
|
5668
|
+
/**
|
|
5669
|
+
* Format: date-time
|
|
5670
|
+
* @description Última atualização presente no índice da fonte. Um processo distribuído depois desta data ainda não é encontrável — a ausência dele não significa que não exista. Null quando a fonte não respondeu à sondagem.
|
|
5671
|
+
*/
|
|
5672
|
+
updatedThrough: string | null;
|
|
5673
|
+
/**
|
|
5674
|
+
* Format: date-time
|
|
5675
|
+
* @description Quando esta busca montou a resposta com a data-limite acima.
|
|
5676
|
+
*/
|
|
5677
|
+
checkedAt: string;
|
|
5678
|
+
} | null;
|
|
5548
5679
|
} | null;
|
|
5549
5680
|
error?: {
|
|
5550
5681
|
class?: string | null;
|
|
@@ -7017,6 +7148,19 @@ export interface operations {
|
|
|
7017
7148
|
excerpt: string;
|
|
7018
7149
|
} | null;
|
|
7019
7150
|
metadata: unknown;
|
|
7151
|
+
/** @description Quem a publicação nomeia, com o polo declarado na origem. Vem do eixo do diário; o acervo estruturado de jurisprudência não nomeia partes e devolve lista vazia. Publicação sob segredo sai sem partes. */
|
|
7152
|
+
parties?: {
|
|
7153
|
+
name: string;
|
|
7154
|
+
polo: string | null;
|
|
7155
|
+
}[];
|
|
7156
|
+
/** @description Advogados nomeados na publicação, com número e UF da inscrição quando a fonte os traz. Nome e inscrição são independentes — a fonte às vezes entrega só um dos dois. Publicação sob segredo sai sem advogados. */
|
|
7157
|
+
lawyers?: {
|
|
7158
|
+
name: string | null;
|
|
7159
|
+
oabNumber: string | null;
|
|
7160
|
+
oabState: string | null;
|
|
7161
|
+
}[];
|
|
7162
|
+
/** @description Órgão julgador da publicação, como a fonte o escreve. Presente nos dois eixos; `null` quando a fonte não o declara. */
|
|
7163
|
+
courtBody?: string | null;
|
|
7020
7164
|
shareable?: boolean;
|
|
7021
7165
|
rawPayload?: unknown;
|
|
7022
7166
|
}[];
|
|
@@ -7571,6 +7715,19 @@ export interface operations {
|
|
|
7571
7715
|
excerpt: string;
|
|
7572
7716
|
} | null;
|
|
7573
7717
|
metadata: unknown;
|
|
7718
|
+
/** @description Quem a publicação nomeia, com o polo declarado na origem. Vem do eixo do diário; o acervo estruturado de jurisprudência não nomeia partes e devolve lista vazia. Publicação sob segredo sai sem partes. */
|
|
7719
|
+
parties?: {
|
|
7720
|
+
name: string;
|
|
7721
|
+
polo: string | null;
|
|
7722
|
+
}[];
|
|
7723
|
+
/** @description Advogados nomeados na publicação, com número e UF da inscrição quando a fonte os traz. Nome e inscrição são independentes — a fonte às vezes entrega só um dos dois. Publicação sob segredo sai sem advogados. */
|
|
7724
|
+
lawyers?: {
|
|
7725
|
+
name: string | null;
|
|
7726
|
+
oabNumber: string | null;
|
|
7727
|
+
oabState: string | null;
|
|
7728
|
+
}[];
|
|
7729
|
+
/** @description Órgão julgador da publicação, como a fonte o escreve. Presente nos dois eixos; `null` quando a fonte não o declara. */
|
|
7730
|
+
courtBody?: string | null;
|
|
7574
7731
|
shareable?: boolean;
|
|
7575
7732
|
} & {
|
|
7576
7733
|
[key: string]: unknown;
|
|
@@ -7915,6 +8072,19 @@ export interface operations {
|
|
|
7915
8072
|
excerpt: string;
|
|
7916
8073
|
} | null;
|
|
7917
8074
|
metadata: unknown;
|
|
8075
|
+
/** @description Quem a publicação nomeia, com o polo declarado na origem. Vem do eixo do diário; o acervo estruturado de jurisprudência não nomeia partes e devolve lista vazia. Publicação sob segredo sai sem partes. */
|
|
8076
|
+
parties?: {
|
|
8077
|
+
name: string;
|
|
8078
|
+
polo: string | null;
|
|
8079
|
+
}[];
|
|
8080
|
+
/** @description Advogados nomeados na publicação, com número e UF da inscrição quando a fonte os traz. Nome e inscrição são independentes — a fonte às vezes entrega só um dos dois. Publicação sob segredo sai sem advogados. */
|
|
8081
|
+
lawyers?: {
|
|
8082
|
+
name: string | null;
|
|
8083
|
+
oabNumber: string | null;
|
|
8084
|
+
oabState: string | null;
|
|
8085
|
+
}[];
|
|
8086
|
+
/** @description Órgão julgador da publicação, como a fonte o escreve. Presente nos dois eixos; `null` quando a fonte não o declara. */
|
|
8087
|
+
courtBody?: string | null;
|
|
7918
8088
|
shareable?: boolean;
|
|
7919
8089
|
} & {
|
|
7920
8090
|
[key: string]: unknown;
|
|
@@ -8199,6 +8369,24 @@ export interface operations {
|
|
|
8199
8369
|
/** Format: date-time */
|
|
8200
8370
|
newestPublicationDate: string | null;
|
|
8201
8371
|
}[];
|
|
8372
|
+
/** @description Cobertura por matéria, na ordem do catálogo, incluindo as não cobertas — para que resultado vazio seja distinguível de matéria fora do acervo. */
|
|
8373
|
+
areas: {
|
|
8374
|
+
/** @enum {string} */
|
|
8375
|
+
area: "STATE_JUSTICE" | "FEDERAL_JUSTICE" | "SUPERIOR_INFRACONSTITUTIONAL" | "LABOR" | "ELECTORAL" | "MILITARY" | "TAX_ADMINISTRATIVE" | "CONSTITUTIONAL" | "SOCIAL_SECURITY_ADMINISTRATIVE" | "JUDICIARY_NORMATIVE" | "EXTERNAL_CONTROL";
|
|
8376
|
+
label: string;
|
|
8377
|
+
description: string;
|
|
8378
|
+
/** @description Se alguma fonte integrada alimenta a matéria. false = fora do acervo — declarado, para que resultado vazio nunca se confunda com matéria não coberta. */
|
|
8379
|
+
covered: boolean;
|
|
8380
|
+
/**
|
|
8381
|
+
* @description NONE = nada indexado nem colheita registrada; PARTIAL = há fatia de colheita pendente (o indexado pode crescer); INDEXED = há documento pesquisável indexado e nenhuma colheita pendente.
|
|
8382
|
+
* @enum {string}
|
|
8383
|
+
*/
|
|
8384
|
+
state: "NONE" | "PARTIAL" | "INDEXED";
|
|
8385
|
+
documentCount: number;
|
|
8386
|
+
indexableCount: number;
|
|
8387
|
+
/** @description Tribunais com documento indexado na matéria, do maior volume para o menor. */
|
|
8388
|
+
tribunalSiglas: string[];
|
|
8389
|
+
}[];
|
|
8202
8390
|
};
|
|
8203
8391
|
meta: {
|
|
8204
8392
|
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
@@ -9686,12 +9874,25 @@ export interface operations {
|
|
|
9686
9874
|
excerpt: string;
|
|
9687
9875
|
} | null;
|
|
9688
9876
|
metadata: unknown;
|
|
9877
|
+
/** @description Quem a publicação nomeia, com o polo declarado na origem. Vem do eixo do diário; o acervo estruturado de jurisprudência não nomeia partes e devolve lista vazia. Publicação sob segredo sai sem partes. */
|
|
9878
|
+
parties?: {
|
|
9879
|
+
name: string;
|
|
9880
|
+
polo: string | null;
|
|
9881
|
+
}[];
|
|
9882
|
+
/** @description Advogados nomeados na publicação, com número e UF da inscrição quando a fonte os traz. Nome e inscrição são independentes — a fonte às vezes entrega só um dos dois. Publicação sob segredo sai sem advogados. */
|
|
9883
|
+
lawyers?: {
|
|
9884
|
+
name: string | null;
|
|
9885
|
+
oabNumber: string | null;
|
|
9886
|
+
oabState: string | null;
|
|
9887
|
+
}[];
|
|
9888
|
+
/** @description Órgão julgador da publicação, como a fonte o escreve. Presente nos dois eixos; `null` quando a fonte não o declara. */
|
|
9889
|
+
courtBody?: string | null;
|
|
9689
9890
|
shareable?: boolean;
|
|
9690
9891
|
} & {
|
|
9691
9892
|
[key: string]: unknown;
|
|
9692
9893
|
};
|
|
9693
9894
|
caseLaw: {
|
|
9694
|
-
/** @description Ementa isolada do teor, já redigida. */
|
|
9895
|
+
/** @description Ementa isolada do teor, já redigida. Em fonte estruturada que não publica ementa para o julgado, o dispositivo faz as vezes de resumo. */
|
|
9695
9896
|
ementa: string;
|
|
9696
9897
|
/** @description Tese jurídica, quando destacável. */
|
|
9697
9898
|
tese: string | null;
|
|
@@ -10472,6 +10673,294 @@ export interface operations {
|
|
|
10472
10673
|
};
|
|
10473
10674
|
};
|
|
10474
10675
|
};
|
|
10676
|
+
resolveLegalNorm: {
|
|
10677
|
+
parameters: {
|
|
10678
|
+
query?: never;
|
|
10679
|
+
header?: {
|
|
10680
|
+
/** @description Identificador da requisição escolhido pelo cliente, ecoado em meta.requestId e no corpo de erro. Tem DOIS papéis: (1) rastreio, em toda rota — é por ele que o suporte encontra a chamada; (2) idempotência por conta em POST /v1/publications/text-searches e POST /v1/search-jobs, onde reenviar o mesmo valor reapresenta o resultado já produzido, sem nova cobrança. Fora dessas duas rotas o valor não deduplica nada: para repetir uma chamada de propósito, mande um valor novo. Aceita [A-Za-z0-9_.:-], até 200 caracteres; valor fora disso é ignorado e o motor cunha o próprio. */
|
|
10681
|
+
"x-request-id"?: string;
|
|
10682
|
+
/** @description Atribui a chamada a um sub-tenant seu (por exemplo, um escritório) na medição de uso e no roteamento de eventos. Opcional. */
|
|
10683
|
+
"x-office-id"?: string;
|
|
10684
|
+
};
|
|
10685
|
+
path?: never;
|
|
10686
|
+
cookie?: never;
|
|
10687
|
+
};
|
|
10688
|
+
requestBody: {
|
|
10689
|
+
content: {
|
|
10690
|
+
"application/json": {
|
|
10691
|
+
/** @description A citação como ela aparece no texto: "Lei 8.078/1990, art. 6º, VIII", "CDC art. 6", "art. 5º, LXXVIII, da CF", "Decreto-Lei 5.452/43", "LC 123/2006", "MP 1.172/2023". */
|
|
10692
|
+
citation?: string;
|
|
10693
|
+
/**
|
|
10694
|
+
* @description Alternativa à citação livre: o tipo do ato. CF dispensa número e ano.
|
|
10695
|
+
* @enum {string}
|
|
10696
|
+
*/
|
|
10697
|
+
type?: "LEI" | "LCP" | "DEL" | "DEC" | "MPV" | "EMC" | "CF";
|
|
10698
|
+
number?: string;
|
|
10699
|
+
year?: number;
|
|
10700
|
+
};
|
|
10701
|
+
};
|
|
10702
|
+
};
|
|
10703
|
+
responses: {
|
|
10704
|
+
/** @description Resposta padrão */
|
|
10705
|
+
200: {
|
|
10706
|
+
headers: {
|
|
10707
|
+
[name: string]: unknown;
|
|
10708
|
+
};
|
|
10709
|
+
content: {
|
|
10710
|
+
"application/json": {
|
|
10711
|
+
data: {
|
|
10712
|
+
/**
|
|
10713
|
+
* @description FOUND: o ato consta do registro. NOT_FOUND: não consta — o que não é prova de que não exista. OUT_OF_REACH: o tipo de ato citado está fora do registro, que cobre lei, lei complementar, decreto-lei, decreto, medida provisória, emenda constitucional e a Constituição da República. UNRECOGNIZED: a citação não foi entendida; reenvie com tipo, número e ano.
|
|
10714
|
+
* @enum {string}
|
|
10715
|
+
*/
|
|
10716
|
+
status: "FOUND" | "NOT_FOUND" | "OUT_OF_REACH" | "UNRECOGNIZED";
|
|
10717
|
+
reason: string | null;
|
|
10718
|
+
parsed: {
|
|
10719
|
+
/** @enum {string} */
|
|
10720
|
+
type: "LEI" | "LCP" | "DEL" | "DEC" | "MPV" | "EMC" | "CF";
|
|
10721
|
+
number: string | null;
|
|
10722
|
+
year: number;
|
|
10723
|
+
/** @description O ano veio com dois dígitos e foi completado pela janela do presente; `checked` diz qual ano foi de fato perguntado. */
|
|
10724
|
+
yearAssumed: boolean;
|
|
10725
|
+
alias: string | null;
|
|
10726
|
+
article: string | null;
|
|
10727
|
+
paragraph: string | null;
|
|
10728
|
+
item: string | null;
|
|
10729
|
+
} | null;
|
|
10730
|
+
/** @description O ato que foi de fato perguntado ao registro. */
|
|
10731
|
+
checked: {
|
|
10732
|
+
/** @enum {string} */
|
|
10733
|
+
type: "LEI" | "LCP" | "DEL" | "DEC" | "MPV" | "EMC" | "CF";
|
|
10734
|
+
number: string | null;
|
|
10735
|
+
year: number;
|
|
10736
|
+
} | null;
|
|
10737
|
+
norm: {
|
|
10738
|
+
name: string;
|
|
10739
|
+
number: string | null;
|
|
10740
|
+
aliases: string[];
|
|
10741
|
+
ementa: string | null;
|
|
10742
|
+
signedAt: string | null;
|
|
10743
|
+
/** @description Página oficial da norma no registro. */
|
|
10744
|
+
url: string | null;
|
|
10745
|
+
/**
|
|
10746
|
+
* @description O que o registro DECLARA sobre a norma. Não há `IN_FORCE`: ausência de declaração de revogação não é afirmação de vigência.
|
|
10747
|
+
* @enum {string}
|
|
10748
|
+
*/
|
|
10749
|
+
standing: "REVOKED" | "CONVERTED" | "REJECTED" | "UNKNOWN";
|
|
10750
|
+
/** @description A norma posterior que revogou, converteu ou rejeitou esta. */
|
|
10751
|
+
standingBy: string | null;
|
|
10752
|
+
standingNote: string;
|
|
10753
|
+
/** @description Alterações PERMANENTES que o registro associa à norma. Reedição de medida provisória não é contada. */
|
|
10754
|
+
amendments: number;
|
|
10755
|
+
lastAmendedAt: string | null;
|
|
10756
|
+
/** @description Quantos documentos o registro guarda sob este número e ano. Acima de 1 são reedições, e a resposta descreve a última. */
|
|
10757
|
+
editions: number;
|
|
10758
|
+
} | null;
|
|
10759
|
+
article: {
|
|
10760
|
+
cited: string;
|
|
10761
|
+
/** @description O que o registro prende a este dispositivo — alteração, acréscimo, regulamentação, revogação. O `comment` de cada item diz qual. */
|
|
10762
|
+
references: {
|
|
10763
|
+
norm: string;
|
|
10764
|
+
comment: string;
|
|
10765
|
+
}[];
|
|
10766
|
+
note: string;
|
|
10767
|
+
} | null;
|
|
10768
|
+
checkedAt: string | null;
|
|
10769
|
+
disclaimer: string;
|
|
10770
|
+
};
|
|
10771
|
+
meta: {
|
|
10772
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10773
|
+
requestId: string;
|
|
10774
|
+
credits?: number;
|
|
10775
|
+
cacheHit?: boolean;
|
|
10776
|
+
} & {
|
|
10777
|
+
[key: string]: unknown;
|
|
10778
|
+
};
|
|
10779
|
+
};
|
|
10780
|
+
};
|
|
10781
|
+
};
|
|
10782
|
+
/** @description Resposta padrão */
|
|
10783
|
+
400: {
|
|
10784
|
+
headers: {
|
|
10785
|
+
[name: string]: unknown;
|
|
10786
|
+
};
|
|
10787
|
+
content: {
|
|
10788
|
+
"application/json": {
|
|
10789
|
+
error: {
|
|
10790
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10791
|
+
code: string;
|
|
10792
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10793
|
+
message: string;
|
|
10794
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10795
|
+
requestId: string;
|
|
10796
|
+
/**
|
|
10797
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10798
|
+
* @enum {string}
|
|
10799
|
+
*/
|
|
10800
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10801
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10802
|
+
retryable: boolean;
|
|
10803
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10804
|
+
upstreamStatus?: number;
|
|
10805
|
+
details: {
|
|
10806
|
+
[key: string]: unknown;
|
|
10807
|
+
};
|
|
10808
|
+
};
|
|
10809
|
+
};
|
|
10810
|
+
};
|
|
10811
|
+
};
|
|
10812
|
+
/** @description Resposta padrão */
|
|
10813
|
+
401: {
|
|
10814
|
+
headers: {
|
|
10815
|
+
[name: string]: unknown;
|
|
10816
|
+
};
|
|
10817
|
+
content: {
|
|
10818
|
+
"application/json": {
|
|
10819
|
+
error: {
|
|
10820
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10821
|
+
code: string;
|
|
10822
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10823
|
+
message: string;
|
|
10824
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10825
|
+
requestId: string;
|
|
10826
|
+
/**
|
|
10827
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10828
|
+
* @enum {string}
|
|
10829
|
+
*/
|
|
10830
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10831
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10832
|
+
retryable: boolean;
|
|
10833
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10834
|
+
upstreamStatus?: number;
|
|
10835
|
+
details: {
|
|
10836
|
+
[key: string]: unknown;
|
|
10837
|
+
};
|
|
10838
|
+
};
|
|
10839
|
+
};
|
|
10840
|
+
};
|
|
10841
|
+
};
|
|
10842
|
+
/** @description Resposta padrão */
|
|
10843
|
+
402: {
|
|
10844
|
+
headers: {
|
|
10845
|
+
[name: string]: unknown;
|
|
10846
|
+
};
|
|
10847
|
+
content: {
|
|
10848
|
+
"application/json": {
|
|
10849
|
+
error: {
|
|
10850
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10851
|
+
code: string;
|
|
10852
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10853
|
+
message: string;
|
|
10854
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10855
|
+
requestId: string;
|
|
10856
|
+
/**
|
|
10857
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10858
|
+
* @enum {string}
|
|
10859
|
+
*/
|
|
10860
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10861
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10862
|
+
retryable: boolean;
|
|
10863
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10864
|
+
upstreamStatus?: number;
|
|
10865
|
+
details: {
|
|
10866
|
+
[key: string]: unknown;
|
|
10867
|
+
};
|
|
10868
|
+
};
|
|
10869
|
+
};
|
|
10870
|
+
};
|
|
10871
|
+
};
|
|
10872
|
+
/** @description Resposta padrão */
|
|
10873
|
+
403: {
|
|
10874
|
+
headers: {
|
|
10875
|
+
[name: string]: unknown;
|
|
10876
|
+
};
|
|
10877
|
+
content: {
|
|
10878
|
+
"application/json": {
|
|
10879
|
+
error: {
|
|
10880
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10881
|
+
code: string;
|
|
10882
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10883
|
+
message: string;
|
|
10884
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10885
|
+
requestId: string;
|
|
10886
|
+
/**
|
|
10887
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10888
|
+
* @enum {string}
|
|
10889
|
+
*/
|
|
10890
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10891
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10892
|
+
retryable: boolean;
|
|
10893
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10894
|
+
upstreamStatus?: number;
|
|
10895
|
+
details: {
|
|
10896
|
+
[key: string]: unknown;
|
|
10897
|
+
};
|
|
10898
|
+
};
|
|
10899
|
+
};
|
|
10900
|
+
};
|
|
10901
|
+
};
|
|
10902
|
+
/** @description Resposta padrão */
|
|
10903
|
+
429: {
|
|
10904
|
+
headers: {
|
|
10905
|
+
[name: string]: unknown;
|
|
10906
|
+
};
|
|
10907
|
+
content: {
|
|
10908
|
+
"application/json": {
|
|
10909
|
+
error: {
|
|
10910
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10911
|
+
code: string;
|
|
10912
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10913
|
+
message: string;
|
|
10914
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10915
|
+
requestId: string;
|
|
10916
|
+
/**
|
|
10917
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10918
|
+
* @enum {string}
|
|
10919
|
+
*/
|
|
10920
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10921
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10922
|
+
retryable: boolean;
|
|
10923
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10924
|
+
upstreamStatus?: number;
|
|
10925
|
+
details: {
|
|
10926
|
+
[key: string]: unknown;
|
|
10927
|
+
};
|
|
10928
|
+
};
|
|
10929
|
+
};
|
|
10930
|
+
};
|
|
10931
|
+
};
|
|
10932
|
+
/** @description Resposta padrão */
|
|
10933
|
+
500: {
|
|
10934
|
+
headers: {
|
|
10935
|
+
[name: string]: unknown;
|
|
10936
|
+
};
|
|
10937
|
+
content: {
|
|
10938
|
+
"application/json": {
|
|
10939
|
+
error: {
|
|
10940
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
10941
|
+
code: string;
|
|
10942
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
10943
|
+
message: string;
|
|
10944
|
+
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|
|
10945
|
+
requestId: string;
|
|
10946
|
+
/**
|
|
10947
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
10948
|
+
* @enum {string}
|
|
10949
|
+
*/
|
|
10950
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
10951
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
10952
|
+
retryable: boolean;
|
|
10953
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
10954
|
+
upstreamStatus?: number;
|
|
10955
|
+
details: {
|
|
10956
|
+
[key: string]: unknown;
|
|
10957
|
+
};
|
|
10958
|
+
};
|
|
10959
|
+
};
|
|
10960
|
+
};
|
|
10961
|
+
};
|
|
10962
|
+
};
|
|
10963
|
+
};
|
|
10475
10964
|
getUsage: {
|
|
10476
10965
|
parameters: {
|
|
10477
10966
|
query?: never;
|
|
@@ -10754,6 +11243,10 @@ export interface operations {
|
|
|
10754
11243
|
consecutiveFailures: number;
|
|
10755
11244
|
/** Format: date-time */
|
|
10756
11245
|
retryPausedUntil: string | null;
|
|
11246
|
+
/** Format: date-time */
|
|
11247
|
+
suspendedAt: string | null;
|
|
11248
|
+
/** Format: date-time */
|
|
11249
|
+
oldestPendingAt: string | null;
|
|
10757
11250
|
} & {
|
|
10758
11251
|
[key: string]: unknown;
|
|
10759
11252
|
})[];
|
|
@@ -11717,6 +12210,8 @@ export interface operations {
|
|
|
11717
12210
|
description: string | null;
|
|
11718
12211
|
eventTypes: string[];
|
|
11719
12212
|
isActive: boolean;
|
|
12213
|
+
/** Format: date-time */
|
|
12214
|
+
suspendedAt: string | null;
|
|
11720
12215
|
project: {
|
|
11721
12216
|
id: string;
|
|
11722
12217
|
name: string;
|
|
@@ -11955,6 +12450,8 @@ export interface operations {
|
|
|
11955
12450
|
description: string | null;
|
|
11956
12451
|
eventTypes: string[];
|
|
11957
12452
|
isActive: boolean;
|
|
12453
|
+
/** Format: date-time */
|
|
12454
|
+
suspendedAt: string | null;
|
|
11958
12455
|
project: {
|
|
11959
12456
|
id: string;
|
|
11960
12457
|
name: string;
|
|
@@ -12416,6 +12913,8 @@ export interface operations {
|
|
|
12416
12913
|
description: string | null;
|
|
12417
12914
|
eventTypes: string[];
|
|
12418
12915
|
isActive: boolean;
|
|
12916
|
+
/** Format: date-time */
|
|
12917
|
+
suspendedAt: string | null;
|
|
12419
12918
|
project: {
|
|
12420
12919
|
id: string;
|
|
12421
12920
|
name: string;
|
|
@@ -13322,6 +13821,10 @@ export interface operations {
|
|
|
13322
13821
|
url: string;
|
|
13323
13822
|
clearedFailures: number;
|
|
13324
13823
|
pendingDeliveries: number;
|
|
13824
|
+
/** Format: date-time */
|
|
13825
|
+
suspendedSince: string | null;
|
|
13826
|
+
/** Format: date-time */
|
|
13827
|
+
replayFrom: string | null;
|
|
13325
13828
|
};
|
|
13326
13829
|
meta: {
|
|
13327
13830
|
/** @description Identificador da requisição, para suporte e rastreamento. É o X-Request-Id enviado pelo cliente quando há um; senão, um req_<uuid> cunhado pelo motor. */
|