@lexnode/legal-data-sdk 1.27.0 → 1.28.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 +86 -0
- package/dist/client.d.ts +16 -2
- package/dist/client.js +38 -9
- package/dist/errors.d.ts +1 -1
- package/dist/errors.js +2 -0
- package/dist/index.d.ts +3 -1
- package/dist/index.js +1 -0
- package/dist/lookup.d.ts +79 -0
- package/dist/lookup.js +158 -0
- package/dist/webhooks.d.ts +44 -2
- package/dist/webhooks.js +1 -0
- package/package.json +1 -1
- package/schema.d.ts +3047 -9
package/schema.d.ts
CHANGED
|
@@ -260,6 +260,78 @@ export interface paths {
|
|
|
260
260
|
patch?: never;
|
|
261
261
|
trace?: never;
|
|
262
262
|
};
|
|
263
|
+
"/v1/processes/lookups": {
|
|
264
|
+
parameters: {
|
|
265
|
+
query?: never;
|
|
266
|
+
header?: never;
|
|
267
|
+
path?: never;
|
|
268
|
+
cookie?: never;
|
|
269
|
+
};
|
|
270
|
+
/**
|
|
271
|
+
* Listar as consultas de processo em segundo plano
|
|
272
|
+
* @description Lista as consultas da conta, no recorte do escritório, da mais nova para a mais antiga, com paginação keyset. Só o que cada uma é: o processo fica atrás da leitura da consulta. Sem cobrança.
|
|
273
|
+
*
|
|
274
|
+
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
275
|
+
*/
|
|
276
|
+
get: operations["listProcessLookups"];
|
|
277
|
+
put?: never;
|
|
278
|
+
/**
|
|
279
|
+
* Ler um processo e seguir em segundo plano se a fonte não entregar
|
|
280
|
+
* @description Faz a leitura de `GET /v1/processes/{processNumber}` (visão `PROCESS`) ou de `GET /v1/processes/{processNumber}/snapshot` (visão `SNAPSHOT`) dentro de `waitSeconds`. Quando ela cabe na espera, a resposta é **200** com uma consulta `SUCCEEDED`, sem consulta aberta (`lookupId` nulo), que traz o processo em `process` ou `snapshot`: o mesmo corpo, o mesmo `meta` e o mesmo preço da leitura direta — inclusive a cópia de até 24 h que socorre a fonte que falhou. Quando a fonte processual falha — não responde dentro da espera, fica indisponível, responde com parte do índice sem o processo ou pede para esperar por volume —, a resposta é **202** com a consulta aberta: o motor segue tentando sozinho, até 60 s por tentativa, por até 6 h (`giveUpAt`). O header `Location` aponta a consulta, que se lê sem cobrança em `GET /v1/processes/lookups/{lookupId}`, e `Retry-After` diz quando lê-la de novo. O 202 não cobra: o preço da leitura fica retido em `creditsReserved` e só é cobrado se o processo vier — 3 pela ficha, 8 pelo retrato; 1 pela ficha que outra leitura trouxe ao acervo nesse meio-tempo. O fim sai no evento `PROCESS_LOOKUP_COMPLETED`, que aponta a consulta e nunca traz o processo; o movimento novo segue no próprio evento dele. Chamar de novo a mesma leitura (conta, escritório, processo e visão) devolve a mesma consulta (`deduped: true`), sem nova retenção nem conferência de saldo; quando a próxima tentativa agendada está a mais de 2 min e a última ficou pelo menos isso para trás, a chamada tenta a fonte na hora, dentro da espera dela, e responde 200 se o processo vier. Com `staleOnFailure: true`, a falha da fonte com uma cópia guardada mais velha que o frescor do plano responde 202 com a cópia em `stale`, por 1 crédito, e a consulta cobra só o resto do preço se a versão atual vier: socorro e atualização somam o preço da leitura viva. Toda outra recusa é exatamente a da leitura direta: a resposta da fonte sem o processo (404), o segredo de justiça (403), o saldo (402) — e também a falha da fonte quando a conta já tem consultas abertas demais (5 por chave, 20 por conta) ou quando o saldo não comporta a retenção. Uma leitura direta sua do mesmo processo que dá certo fecha a consulta aberta sem cobrar, e o retrato fecha também a da ficha. A chave de teste nunca abre consulta: responde como a leitura direta.
|
|
281
|
+
*
|
|
282
|
+
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
283
|
+
*/
|
|
284
|
+
post: operations["createProcessLookup"];
|
|
285
|
+
delete?: never;
|
|
286
|
+
options?: never;
|
|
287
|
+
head?: never;
|
|
288
|
+
patch?: never;
|
|
289
|
+
trace?: never;
|
|
290
|
+
};
|
|
291
|
+
"/v1/processes/lookups/{lookupId}": {
|
|
292
|
+
parameters: {
|
|
293
|
+
query?: never;
|
|
294
|
+
header?: never;
|
|
295
|
+
path?: never;
|
|
296
|
+
cookie?: never;
|
|
297
|
+
};
|
|
298
|
+
/**
|
|
299
|
+
* Ler uma consulta de processo em segundo plano
|
|
300
|
+
* @description Lê a consulta, sem cobrança. Aberta, diz a próxima tentativa (`nextAttemptAt`), até quando ela tenta (`giveUpAt`) e a última ida à fonte (`lastAttempt`). Entregue, traz o processo por 24 h depois da entrega (`resultExpiresAt`), relido do acervo e passado de novo pelo controle de confidencialidade de quem lê: o processo que passou a segredo de justiça depois da entrega responde 403, como a leitura direta. Depois disso, `resultExpired` e nenhum processo: uma leitura nova o traz. No retrato, `sourcePayload` é nulo. `meta.sourceFetchedAt` diz quando a cópia servida foi buscada na fonte. Terminada sem o processo, `error` diz o código e `creditsRefunded` a retenção devolvida. Consulta de outra conta ou de outro escritório responde 404 `PROCESS_LOOKUP_NOT_FOUND`.
|
|
301
|
+
*
|
|
302
|
+
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
303
|
+
*/
|
|
304
|
+
get: operations["getProcessLookup"];
|
|
305
|
+
put?: never;
|
|
306
|
+
post?: never;
|
|
307
|
+
delete?: never;
|
|
308
|
+
options?: never;
|
|
309
|
+
head?: never;
|
|
310
|
+
patch?: never;
|
|
311
|
+
trace?: never;
|
|
312
|
+
};
|
|
313
|
+
"/v1/processes/lookups/{lookupId}/cancel": {
|
|
314
|
+
parameters: {
|
|
315
|
+
query?: never;
|
|
316
|
+
header?: never;
|
|
317
|
+
path?: never;
|
|
318
|
+
cookie?: never;
|
|
319
|
+
};
|
|
320
|
+
get?: never;
|
|
321
|
+
put?: never;
|
|
322
|
+
/**
|
|
323
|
+
* Cancelar uma consulta de processo em segundo plano
|
|
324
|
+
* @description Cancela uma consulta aberta da própria conta e escritório e devolve a retenção na mesma chamada; `refunded` diz se a devolução aconteceu AQUI, porque uma entrega em corrida pode já tê-la consumido. O que a mesma compra já cobrou pela cópia em `stale` fica cobrado: a cópia foi entregue. O cancelamento não gera `PROCESS_LOOKUP_COMPLETED`. Consulta terminada responde 409 `JOB_TERMINAL`; de outra conta, 404 `PROCESS_LOOKUP_NOT_FOUND`.
|
|
325
|
+
*
|
|
326
|
+
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
327
|
+
*/
|
|
328
|
+
post: operations["cancelProcessLookup"];
|
|
329
|
+
delete?: never;
|
|
330
|
+
options?: never;
|
|
331
|
+
head?: never;
|
|
332
|
+
patch?: never;
|
|
333
|
+
trace?: never;
|
|
334
|
+
};
|
|
263
335
|
"/v1/monitors": {
|
|
264
336
|
parameters: {
|
|
265
337
|
query?: never;
|
|
@@ -375,7 +447,7 @@ export interface paths {
|
|
|
375
447
|
};
|
|
376
448
|
/**
|
|
377
449
|
* Listar os jobs de busca do chamador
|
|
378
|
-
* @description Lista com escopo de conta/office dos jobs de busca assíncronos (mais recentes primeiro, paginação keyset). Apenas metadados — os resultados ficam atrás do endpoint de consulta do job.
|
|
450
|
+
* @description Lista com escopo de conta/office dos jobs de busca assíncronos (mais recentes primeiro, paginação keyset). Apenas metadados — os resultados ficam atrás do endpoint de consulta do job. Só a busca assíncrona de processos: a consulta de processo em segundo plano tem rota própria, `/v1/processes/lookups`.
|
|
379
451
|
*
|
|
380
452
|
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
381
453
|
*/
|
|
@@ -397,7 +469,7 @@ export interface paths {
|
|
|
397
469
|
};
|
|
398
470
|
/**
|
|
399
471
|
* 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 — 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. O processo que o controle de confidencialidade retém de quem consulta sai de `items`, conta em `redactedCount` e uma vez só em `total`, quantos documentos dele a busca tenha achado. 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.
|
|
472
|
+
* @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. O processo que o controle de confidencialidade retém de quem consulta sai de `items`, conta em `redactedCount` e uma vez só em `total`, quantos documentos dele a busca tenha achado. 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. O id de uma consulta de processo em segundo plano responde 404 aqui: ela se lê em `GET /v1/processes/lookups/{lookupId}`.
|
|
401
473
|
*
|
|
402
474
|
* **Escopo exigido na chave de API:** `PROCESSES_READ`
|
|
403
475
|
*/
|
|
@@ -421,7 +493,7 @@ export interface paths {
|
|
|
421
493
|
put?: never;
|
|
422
494
|
/**
|
|
423
495
|
* Cancelar um job de busca ainda não concluído
|
|
424
|
-
* @description Cancela um job QUEUED/LEASED da própria conta/office e devolve a retenção de créditos na mesma chamada — job que não rodou não custa nada. `refunded` diz se a devolução aconteceu AQUI: um worker em corrida pode já ter consumido ou devolvido a retenção. Job em estado terminal responde 409; job de outra conta, 404.
|
|
496
|
+
* @description Cancela um job QUEUED/LEASED da própria conta/office e devolve a retenção de créditos na mesma chamada — job que não rodou não custa nada. `refunded` diz se a devolução aconteceu AQUI: um worker em corrida pode já ter consumido ou devolvido a retenção. Job em estado terminal responde 409; job de outra conta, 404. A consulta de processo em segundo plano se cancela em `POST /v1/processes/lookups/{lookupId}/cancel`; o id dela aqui responde 404.
|
|
425
497
|
*
|
|
426
498
|
* **Escopo exigido na chave de API:** `PROCESSES_SEARCH`
|
|
427
499
|
*/
|
|
@@ -3824,6 +3896,2972 @@ export interface operations {
|
|
|
3824
3896
|
};
|
|
3825
3897
|
};
|
|
3826
3898
|
};
|
|
3899
|
+
listProcessLookups: {
|
|
3900
|
+
parameters: {
|
|
3901
|
+
query?: {
|
|
3902
|
+
status?: "QUEUED" | "LEASED" | "SUCCEEDED" | "FAILED" | "CANCELED";
|
|
3903
|
+
cursor?: string;
|
|
3904
|
+
limit?: number;
|
|
3905
|
+
};
|
|
3906
|
+
header?: {
|
|
3907
|
+
/** @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. */
|
|
3908
|
+
"x-request-id"?: string;
|
|
3909
|
+
/** @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. */
|
|
3910
|
+
"x-office-id"?: string;
|
|
3911
|
+
};
|
|
3912
|
+
path?: never;
|
|
3913
|
+
cookie?: never;
|
|
3914
|
+
};
|
|
3915
|
+
requestBody?: never;
|
|
3916
|
+
responses: {
|
|
3917
|
+
/** @description Resposta padrão */
|
|
3918
|
+
200: {
|
|
3919
|
+
headers: {
|
|
3920
|
+
[name: string]: unknown;
|
|
3921
|
+
};
|
|
3922
|
+
content: {
|
|
3923
|
+
"application/json": {
|
|
3924
|
+
data: {
|
|
3925
|
+
items: {
|
|
3926
|
+
lookupId: string;
|
|
3927
|
+
/** @enum {string} */
|
|
3928
|
+
status: "QUEUED" | "LEASED" | "SUCCEEDED" | "FAILED" | "CANCELED";
|
|
3929
|
+
/**
|
|
3930
|
+
* @description O que ler: `PROCESS`, a ficha do processo (a mesma de `GET /v1/processes/{processNumber}`), ou `SNAPSHOT`, o retrato com os movimentos (o de `GET /v1/processes/{processNumber}/snapshot`).
|
|
3931
|
+
* @enum {string}
|
|
3932
|
+
*/
|
|
3933
|
+
view: "PROCESS" | "SNAPSHOT";
|
|
3934
|
+
tribunalAlias: string;
|
|
3935
|
+
/** @description O número do processo, só os 20 dígitos. */
|
|
3936
|
+
processNumber: string;
|
|
3937
|
+
/** @description Onde a consulta é lida, sem nova cobrança. */
|
|
3938
|
+
pollUrl: string;
|
|
3939
|
+
/** @description A chamada reencontrou a consulta já aberta para a mesma conta, escritório, processo e visão, em vez de abrir outra. */
|
|
3940
|
+
deduped: boolean;
|
|
3941
|
+
/** @description Créditos retidos pela consulta: o máximo que a entrega cobra, só se o processo vier — a ficha que outra leitura trouxe ao acervo cobra menos. Enquanto isso, a retenção conta no saldo e no teto diário da chave que abriu a consulta. */
|
|
3942
|
+
creditsReserved: number;
|
|
3943
|
+
/** @description O que a mesma compra já cobrou fora da consulta: a cópia guardada entregue em `stale`. A entrega cobra o preço da leitura menos isto. */
|
|
3944
|
+
alreadyCharged: number;
|
|
3945
|
+
/** @description Idas à fonte até aqui, a leitura que abriu a consulta incluída. */
|
|
3946
|
+
attempts: number;
|
|
3947
|
+
/**
|
|
3948
|
+
* Format: date-time
|
|
3949
|
+
* @description Quando a próxima tentativa sai; nulo na consulta terminada e enquanto uma tentativa está em curso. A hora que já passou é a da tentativa esperando a vez na fila. Ler a consulta antes da hora futura devolve o mesmo estado.
|
|
3950
|
+
*/
|
|
3951
|
+
nextAttemptAt: string | null;
|
|
3952
|
+
/**
|
|
3953
|
+
* Format: date-time
|
|
3954
|
+
* @description Até quando a consulta tenta; depois, termina sem o processo e devolve a retenção.
|
|
3955
|
+
*/
|
|
3956
|
+
giveUpAt: string;
|
|
3957
|
+
/** @description A última ida à fonte que não entregou: quando, e por quê — `UPSTREAM_TIMEOUT` (não respondeu dentro da espera), `UPSTREAM_UNAVAILABLE` (indisponível, ou respondeu com parte do índice sem o processo) ou `UPSTREAM_RATE_LIMITED` (pediu para esperar por volume). */
|
|
3958
|
+
lastAttempt: {
|
|
3959
|
+
/** Format: date-time */
|
|
3960
|
+
at: string;
|
|
3961
|
+
/** @enum {string} */
|
|
3962
|
+
code: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
3963
|
+
retryable: boolean;
|
|
3964
|
+
} | null;
|
|
3965
|
+
/**
|
|
3966
|
+
* @description Quem entregou: `SOURCE`, uma tentativa na fonte; `LAKE`, o acervo, que outra leitura atualizou depois de a consulta abrir; `DIRECT_READ`, uma leitura sua do mesmo processo, que entregou e cobrou antes — a consulta fecha sem cobrar. Nulo enquanto não houve entrega.
|
|
3967
|
+
* @enum {string|null}
|
|
3968
|
+
*/
|
|
3969
|
+
satisfiedBy: "SOURCE" | "LAKE" | "DIRECT_READ" | null;
|
|
3970
|
+
creditsCharged: number | null;
|
|
3971
|
+
creditsRefunded: number | null;
|
|
3972
|
+
/** @description Por que a consulta terminou sem o processo: o código da taxonomia de erros, como a leitura síncrona o daria. */
|
|
3973
|
+
error: {
|
|
3974
|
+
/** @enum {string} */
|
|
3975
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
3976
|
+
code: string;
|
|
3977
|
+
/** @description O texto público fixo do código, o mesmo em toda consulta. */
|
|
3978
|
+
message: string;
|
|
3979
|
+
retryable: boolean;
|
|
3980
|
+
upstreamStatus?: number;
|
|
3981
|
+
} | null;
|
|
3982
|
+
/** Format: date-time */
|
|
3983
|
+
createdAt: string;
|
|
3984
|
+
/** Format: date-time */
|
|
3985
|
+
finishedAt: string | null;
|
|
3986
|
+
/**
|
|
3987
|
+
* Format: date-time
|
|
3988
|
+
* @description Até quando o processo entregue é lido nesta consulta sem nova cobrança: 24 h depois da entrega.
|
|
3989
|
+
*/
|
|
3990
|
+
resultExpiresAt: string | null;
|
|
3991
|
+
/** @description O processo entregue já não é lido aqui: o prazo passou, ou o acervo já não sustenta a cópia. Uma leitura nova o traz. */
|
|
3992
|
+
resultExpired: boolean;
|
|
3993
|
+
}[];
|
|
3994
|
+
nextCursor: string | null;
|
|
3995
|
+
};
|
|
3996
|
+
meta: {
|
|
3997
|
+
/** @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. */
|
|
3998
|
+
requestId: string;
|
|
3999
|
+
credits?: number;
|
|
4000
|
+
cacheHit?: boolean;
|
|
4001
|
+
} & {
|
|
4002
|
+
[key: string]: unknown;
|
|
4003
|
+
};
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
};
|
|
4007
|
+
/** @description Resposta padrão */
|
|
4008
|
+
400: {
|
|
4009
|
+
headers: {
|
|
4010
|
+
[name: string]: unknown;
|
|
4011
|
+
};
|
|
4012
|
+
content: {
|
|
4013
|
+
"application/json": {
|
|
4014
|
+
error: {
|
|
4015
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4016
|
+
code: string;
|
|
4017
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4018
|
+
message: string;
|
|
4019
|
+
/** @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. */
|
|
4020
|
+
requestId: string;
|
|
4021
|
+
/**
|
|
4022
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4023
|
+
* @enum {string}
|
|
4024
|
+
*/
|
|
4025
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4026
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4027
|
+
retryable: boolean;
|
|
4028
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4029
|
+
upstreamStatus?: number;
|
|
4030
|
+
details: {
|
|
4031
|
+
[key: string]: unknown;
|
|
4032
|
+
};
|
|
4033
|
+
};
|
|
4034
|
+
};
|
|
4035
|
+
};
|
|
4036
|
+
};
|
|
4037
|
+
/** @description Resposta padrão */
|
|
4038
|
+
401: {
|
|
4039
|
+
headers: {
|
|
4040
|
+
[name: string]: unknown;
|
|
4041
|
+
};
|
|
4042
|
+
content: {
|
|
4043
|
+
"application/json": {
|
|
4044
|
+
error: {
|
|
4045
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4046
|
+
code: string;
|
|
4047
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4048
|
+
message: string;
|
|
4049
|
+
/** @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. */
|
|
4050
|
+
requestId: string;
|
|
4051
|
+
/**
|
|
4052
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4053
|
+
* @enum {string}
|
|
4054
|
+
*/
|
|
4055
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4056
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4057
|
+
retryable: boolean;
|
|
4058
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4059
|
+
upstreamStatus?: number;
|
|
4060
|
+
details: {
|
|
4061
|
+
[key: string]: unknown;
|
|
4062
|
+
};
|
|
4063
|
+
};
|
|
4064
|
+
};
|
|
4065
|
+
};
|
|
4066
|
+
};
|
|
4067
|
+
/** @description Resposta padrão */
|
|
4068
|
+
402: {
|
|
4069
|
+
headers: {
|
|
4070
|
+
[name: string]: unknown;
|
|
4071
|
+
};
|
|
4072
|
+
content: {
|
|
4073
|
+
"application/json": {
|
|
4074
|
+
error: {
|
|
4075
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4076
|
+
code: string;
|
|
4077
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4078
|
+
message: string;
|
|
4079
|
+
/** @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. */
|
|
4080
|
+
requestId: string;
|
|
4081
|
+
/**
|
|
4082
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4083
|
+
* @enum {string}
|
|
4084
|
+
*/
|
|
4085
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4086
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4087
|
+
retryable: boolean;
|
|
4088
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4089
|
+
upstreamStatus?: number;
|
|
4090
|
+
details: {
|
|
4091
|
+
[key: string]: unknown;
|
|
4092
|
+
};
|
|
4093
|
+
};
|
|
4094
|
+
};
|
|
4095
|
+
};
|
|
4096
|
+
};
|
|
4097
|
+
/** @description Resposta padrão */
|
|
4098
|
+
403: {
|
|
4099
|
+
headers: {
|
|
4100
|
+
[name: string]: unknown;
|
|
4101
|
+
};
|
|
4102
|
+
content: {
|
|
4103
|
+
"application/json": {
|
|
4104
|
+
error: {
|
|
4105
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4106
|
+
code: string;
|
|
4107
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4108
|
+
message: string;
|
|
4109
|
+
/** @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. */
|
|
4110
|
+
requestId: string;
|
|
4111
|
+
/**
|
|
4112
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4113
|
+
* @enum {string}
|
|
4114
|
+
*/
|
|
4115
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4116
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4117
|
+
retryable: boolean;
|
|
4118
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4119
|
+
upstreamStatus?: number;
|
|
4120
|
+
details: {
|
|
4121
|
+
[key: string]: unknown;
|
|
4122
|
+
};
|
|
4123
|
+
};
|
|
4124
|
+
};
|
|
4125
|
+
};
|
|
4126
|
+
};
|
|
4127
|
+
/** @description Resposta padrão */
|
|
4128
|
+
429: {
|
|
4129
|
+
headers: {
|
|
4130
|
+
[name: string]: unknown;
|
|
4131
|
+
};
|
|
4132
|
+
content: {
|
|
4133
|
+
"application/json": {
|
|
4134
|
+
error: {
|
|
4135
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4136
|
+
code: string;
|
|
4137
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4138
|
+
message: string;
|
|
4139
|
+
/** @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. */
|
|
4140
|
+
requestId: string;
|
|
4141
|
+
/**
|
|
4142
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4143
|
+
* @enum {string}
|
|
4144
|
+
*/
|
|
4145
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4146
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4147
|
+
retryable: boolean;
|
|
4148
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4149
|
+
upstreamStatus?: number;
|
|
4150
|
+
details: {
|
|
4151
|
+
[key: string]: unknown;
|
|
4152
|
+
};
|
|
4153
|
+
};
|
|
4154
|
+
};
|
|
4155
|
+
};
|
|
4156
|
+
};
|
|
4157
|
+
/** @description Resposta padrão */
|
|
4158
|
+
500: {
|
|
4159
|
+
headers: {
|
|
4160
|
+
[name: string]: unknown;
|
|
4161
|
+
};
|
|
4162
|
+
content: {
|
|
4163
|
+
"application/json": {
|
|
4164
|
+
error: {
|
|
4165
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
4166
|
+
code: string;
|
|
4167
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
4168
|
+
message: string;
|
|
4169
|
+
/** @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. */
|
|
4170
|
+
requestId: string;
|
|
4171
|
+
/**
|
|
4172
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
4173
|
+
* @enum {string}
|
|
4174
|
+
*/
|
|
4175
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4176
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
4177
|
+
retryable: boolean;
|
|
4178
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
4179
|
+
upstreamStatus?: number;
|
|
4180
|
+
details: {
|
|
4181
|
+
[key: string]: unknown;
|
|
4182
|
+
};
|
|
4183
|
+
};
|
|
4184
|
+
};
|
|
4185
|
+
};
|
|
4186
|
+
};
|
|
4187
|
+
};
|
|
4188
|
+
};
|
|
4189
|
+
createProcessLookup: {
|
|
4190
|
+
parameters: {
|
|
4191
|
+
query?: never;
|
|
4192
|
+
header?: {
|
|
4193
|
+
/** @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. */
|
|
4194
|
+
"x-request-id"?: string;
|
|
4195
|
+
/** @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. */
|
|
4196
|
+
"x-office-id"?: string;
|
|
4197
|
+
};
|
|
4198
|
+
path?: never;
|
|
4199
|
+
cookie?: never;
|
|
4200
|
+
};
|
|
4201
|
+
requestBody: {
|
|
4202
|
+
content: {
|
|
4203
|
+
"application/json": {
|
|
4204
|
+
tribunalAlias: string;
|
|
4205
|
+
processNumber: string;
|
|
4206
|
+
/**
|
|
4207
|
+
* @description O que ler: `PROCESS`, a ficha do processo (a mesma de `GET /v1/processes/{processNumber}`), ou `SNAPSHOT`, o retrato com os movimentos (o de `GET /v1/processes/{processNumber}/snapshot`).
|
|
4208
|
+
* @enum {string}
|
|
4209
|
+
*/
|
|
4210
|
+
view: "PROCESS" | "SNAPSHOT";
|
|
4211
|
+
/**
|
|
4212
|
+
* @description Quanto esperar pela fonte processual nesta chamada, em segundos: de 10 a 180, padrão 20. A mesma espera de `waitSeconds` nas duas leituras de processo; o que não cabe nela segue em segundo plano.
|
|
4213
|
+
* @default 20
|
|
4214
|
+
*/
|
|
4215
|
+
waitSeconds?: number;
|
|
4216
|
+
/**
|
|
4217
|
+
* @description Com `true`, quando a fonte falha e o acervo guarda uma cópia do processo mais velha que o frescor do seu plano, a resposta 202 traz essa cópia em `stale`, por 1 crédito, e a consulta segue buscando a versão atual pelo resto do preço. Sem ele, a falha da fonte socorrida pela cópia de até 24 h responde 200, como nas duas leituras.
|
|
4218
|
+
* @default false
|
|
4219
|
+
*/
|
|
4220
|
+
staleOnFailure?: boolean;
|
|
4221
|
+
};
|
|
4222
|
+
};
|
|
4223
|
+
};
|
|
4224
|
+
responses: {
|
|
4225
|
+
/** @description Resposta padrão */
|
|
4226
|
+
200: {
|
|
4227
|
+
headers: {
|
|
4228
|
+
[name: string]: unknown;
|
|
4229
|
+
};
|
|
4230
|
+
content: {
|
|
4231
|
+
"application/json": {
|
|
4232
|
+
data: {
|
|
4233
|
+
/** @description O id da consulta; nulo quando a leitura coube na espera e nenhuma consulta foi aberta. */
|
|
4234
|
+
lookupId: string | null;
|
|
4235
|
+
/** @enum {string} */
|
|
4236
|
+
status: "QUEUED" | "LEASED" | "SUCCEEDED" | "FAILED" | "CANCELED";
|
|
4237
|
+
/**
|
|
4238
|
+
* @description O que ler: `PROCESS`, a ficha do processo (a mesma de `GET /v1/processes/{processNumber}`), ou `SNAPSHOT`, o retrato com os movimentos (o de `GET /v1/processes/{processNumber}/snapshot`).
|
|
4239
|
+
* @enum {string}
|
|
4240
|
+
*/
|
|
4241
|
+
view: "PROCESS" | "SNAPSHOT";
|
|
4242
|
+
tribunalAlias: string;
|
|
4243
|
+
/** @description O número do processo, só os 20 dígitos. */
|
|
4244
|
+
processNumber: string;
|
|
4245
|
+
/** @description Onde a consulta é lida, sem nova cobrança; nulo sem consulta aberta. */
|
|
4246
|
+
pollUrl: string | null;
|
|
4247
|
+
/** @description A chamada reencontrou a consulta já aberta para a mesma conta, escritório, processo e visão, em vez de abrir outra. */
|
|
4248
|
+
deduped: boolean;
|
|
4249
|
+
/** @description Créditos retidos pela consulta: o máximo que a entrega cobra, só se o processo vier — a ficha que outra leitura trouxe ao acervo cobra menos. Enquanto isso, a retenção conta no saldo e no teto diário da chave que abriu a consulta. */
|
|
4250
|
+
creditsReserved: number;
|
|
4251
|
+
/** @description O que a mesma compra já cobrou fora da consulta: a cópia guardada entregue em `stale`. A entrega cobra o preço da leitura menos isto. */
|
|
4252
|
+
alreadyCharged: number;
|
|
4253
|
+
/** @description Idas à fonte até aqui, a leitura que abriu a consulta incluída. */
|
|
4254
|
+
attempts: number;
|
|
4255
|
+
/**
|
|
4256
|
+
* Format: date-time
|
|
4257
|
+
* @description Quando a próxima tentativa sai; nulo na consulta terminada e enquanto uma tentativa está em curso. A hora que já passou é a da tentativa esperando a vez na fila. Ler a consulta antes da hora futura devolve o mesmo estado.
|
|
4258
|
+
*/
|
|
4259
|
+
nextAttemptAt: string | null;
|
|
4260
|
+
/**
|
|
4261
|
+
* Format: date-time
|
|
4262
|
+
* @description Até quando a consulta tenta; depois, termina sem o processo e devolve a retenção. Nulo sem consulta aberta.
|
|
4263
|
+
*/
|
|
4264
|
+
giveUpAt: string | null;
|
|
4265
|
+
/** @description A última ida à fonte que não entregou: quando, e por quê — `UPSTREAM_TIMEOUT` (não respondeu dentro da espera), `UPSTREAM_UNAVAILABLE` (indisponível, ou respondeu com parte do índice sem o processo) ou `UPSTREAM_RATE_LIMITED` (pediu para esperar por volume). */
|
|
4266
|
+
lastAttempt: {
|
|
4267
|
+
/** Format: date-time */
|
|
4268
|
+
at: string;
|
|
4269
|
+
/** @enum {string} */
|
|
4270
|
+
code: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
4271
|
+
retryable: boolean;
|
|
4272
|
+
} | null;
|
|
4273
|
+
/**
|
|
4274
|
+
* @description Quem entregou: `SOURCE`, uma tentativa na fonte; `LAKE`, o acervo, que outra leitura atualizou depois de a consulta abrir; `DIRECT_READ`, uma leitura sua do mesmo processo, que entregou e cobrou antes — a consulta fecha sem cobrar. Nulo enquanto não houve entrega.
|
|
4275
|
+
* @enum {string|null}
|
|
4276
|
+
*/
|
|
4277
|
+
satisfiedBy: "SOURCE" | "LAKE" | "DIRECT_READ" | null;
|
|
4278
|
+
creditsCharged: number | null;
|
|
4279
|
+
creditsRefunded: number | null;
|
|
4280
|
+
/** @description Por que a consulta terminou sem o processo: o código da taxonomia de erros, como a leitura síncrona o daria. */
|
|
4281
|
+
error: {
|
|
4282
|
+
/** @enum {string} */
|
|
4283
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4284
|
+
code: string;
|
|
4285
|
+
/** @description O texto público fixo do código, o mesmo em toda consulta. */
|
|
4286
|
+
message: string;
|
|
4287
|
+
retryable: boolean;
|
|
4288
|
+
upstreamStatus?: number;
|
|
4289
|
+
} | null;
|
|
4290
|
+
/** Format: date-time */
|
|
4291
|
+
createdAt: string;
|
|
4292
|
+
/** Format: date-time */
|
|
4293
|
+
finishedAt: string | null;
|
|
4294
|
+
/**
|
|
4295
|
+
* Format: date-time
|
|
4296
|
+
* @description Até quando o processo entregue é lido nesta consulta sem nova cobrança: 24 h depois da entrega.
|
|
4297
|
+
*/
|
|
4298
|
+
resultExpiresAt: string | null;
|
|
4299
|
+
/** @description O processo entregue já não é lido aqui: o prazo passou, ou o acervo já não sustenta a cópia. Uma leitura nova o traz. */
|
|
4300
|
+
resultExpired: boolean;
|
|
4301
|
+
/** @description A vigília que a conta já mantém sobre o processo: quando olhou pela última vez e quando olha de novo. Só para a chave que lê monitores (`MONITORS_READ`); nulo sem vigília. */
|
|
4302
|
+
monitor: {
|
|
4303
|
+
monitorId: string;
|
|
4304
|
+
/** Format: date-time */
|
|
4305
|
+
lastCheckedAt: string | null;
|
|
4306
|
+
/** Format: date-time */
|
|
4307
|
+
nextCheckAt: string | null;
|
|
4308
|
+
} | null;
|
|
4309
|
+
/** @description A ficha entregue, na visão `PROCESS`, enquanto o resultado vale, com as instâncias do número em `instances`, como na leitura direta. Lida da consulta, ela passa de novo pelo controle de confidencialidade. */
|
|
4310
|
+
process?: {
|
|
4311
|
+
sourceId?: string | null;
|
|
4312
|
+
number: string;
|
|
4313
|
+
formattedNumber: string;
|
|
4314
|
+
tribunal: {
|
|
4315
|
+
alias: string;
|
|
4316
|
+
code: string;
|
|
4317
|
+
};
|
|
4318
|
+
degree?: string | null;
|
|
4319
|
+
sigiloLevel?: number | null;
|
|
4320
|
+
/**
|
|
4321
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4322
|
+
* @enum {string}
|
|
4323
|
+
*/
|
|
4324
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4325
|
+
/** @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. */
|
|
4326
|
+
shareable?: boolean;
|
|
4327
|
+
class: {
|
|
4328
|
+
code?: number | null;
|
|
4329
|
+
name?: string | null;
|
|
4330
|
+
} | null;
|
|
4331
|
+
courtBody: {
|
|
4332
|
+
code?: number | null;
|
|
4333
|
+
name?: string | null;
|
|
4334
|
+
municipalityIbgeCode?: number | null;
|
|
4335
|
+
} | null;
|
|
4336
|
+
system?: {
|
|
4337
|
+
code?: number | null;
|
|
4338
|
+
name?: string | null;
|
|
4339
|
+
} | null;
|
|
4340
|
+
format?: {
|
|
4341
|
+
code?: number | null;
|
|
4342
|
+
name?: string | null;
|
|
4343
|
+
} | null;
|
|
4344
|
+
/** Format: date-time */
|
|
4345
|
+
filedAt?: string | null;
|
|
4346
|
+
/** Format: date-time */
|
|
4347
|
+
updatedAt?: string | null;
|
|
4348
|
+
/** Format: date-time */
|
|
4349
|
+
indexedAt?: string | null;
|
|
4350
|
+
subjects: {
|
|
4351
|
+
code?: number | null;
|
|
4352
|
+
name: string;
|
|
4353
|
+
}[];
|
|
4354
|
+
djen?: {
|
|
4355
|
+
publicationCount: number;
|
|
4356
|
+
/** Format: date-time */
|
|
4357
|
+
latestPublicationAt?: string | null;
|
|
4358
|
+
latestPublicationType?: string | null;
|
|
4359
|
+
latestPublicationExcerpt?: string | null;
|
|
4360
|
+
latestPublicationUrl?: string | null;
|
|
4361
|
+
} | null;
|
|
4362
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
4363
|
+
instances?: {
|
|
4364
|
+
sourceId?: string | null;
|
|
4365
|
+
number: string;
|
|
4366
|
+
formattedNumber: string;
|
|
4367
|
+
tribunal: {
|
|
4368
|
+
alias: string;
|
|
4369
|
+
code: string;
|
|
4370
|
+
};
|
|
4371
|
+
degree?: string | null;
|
|
4372
|
+
sigiloLevel?: number | null;
|
|
4373
|
+
/**
|
|
4374
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4375
|
+
* @enum {string}
|
|
4376
|
+
*/
|
|
4377
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4378
|
+
/** @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. */
|
|
4379
|
+
shareable?: boolean;
|
|
4380
|
+
class: {
|
|
4381
|
+
code?: number | null;
|
|
4382
|
+
name?: string | null;
|
|
4383
|
+
} | null;
|
|
4384
|
+
courtBody: {
|
|
4385
|
+
code?: number | null;
|
|
4386
|
+
name?: string | null;
|
|
4387
|
+
municipalityIbgeCode?: number | null;
|
|
4388
|
+
} | null;
|
|
4389
|
+
system?: {
|
|
4390
|
+
code?: number | null;
|
|
4391
|
+
name?: string | null;
|
|
4392
|
+
} | null;
|
|
4393
|
+
format?: {
|
|
4394
|
+
code?: number | null;
|
|
4395
|
+
name?: string | null;
|
|
4396
|
+
} | null;
|
|
4397
|
+
/** Format: date-time */
|
|
4398
|
+
filedAt?: string | null;
|
|
4399
|
+
/** Format: date-time */
|
|
4400
|
+
updatedAt?: string | null;
|
|
4401
|
+
/** Format: date-time */
|
|
4402
|
+
indexedAt?: string | null;
|
|
4403
|
+
subjects: {
|
|
4404
|
+
code?: number | null;
|
|
4405
|
+
name: string;
|
|
4406
|
+
}[];
|
|
4407
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
4408
|
+
primary: boolean;
|
|
4409
|
+
/**
|
|
4410
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
4411
|
+
* @enum {string}
|
|
4412
|
+
*/
|
|
4413
|
+
origin: "SOURCE" | "LAKE";
|
|
4414
|
+
/**
|
|
4415
|
+
* Format: date-time
|
|
4416
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
4417
|
+
*/
|
|
4418
|
+
fetchedAt: string;
|
|
4419
|
+
/**
|
|
4420
|
+
* Format: date-time
|
|
4421
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
4422
|
+
*/
|
|
4423
|
+
absentSince: string | null;
|
|
4424
|
+
}[];
|
|
4425
|
+
};
|
|
4426
|
+
/** @description O retrato entregue, na visão `SNAPSHOT`, enquanto o resultado vale: a instância principal no topo e cada instância do número em `instances`, como na leitura direta. Lido da consulta, ele é composto do que o acervo guarda da última captura de cada instância, e `sourcePayload` é nulo: o documento bruto da fonte não é guardado. */
|
|
4427
|
+
snapshot?: {
|
|
4428
|
+
process: {
|
|
4429
|
+
sourceId?: string | null;
|
|
4430
|
+
number: string;
|
|
4431
|
+
formattedNumber: string;
|
|
4432
|
+
tribunal: {
|
|
4433
|
+
alias: string;
|
|
4434
|
+
code: string;
|
|
4435
|
+
};
|
|
4436
|
+
degree?: string | null;
|
|
4437
|
+
sigiloLevel?: number | null;
|
|
4438
|
+
/**
|
|
4439
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4440
|
+
* @enum {string}
|
|
4441
|
+
*/
|
|
4442
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4443
|
+
/** @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. */
|
|
4444
|
+
shareable?: boolean;
|
|
4445
|
+
class: {
|
|
4446
|
+
code?: number | null;
|
|
4447
|
+
name?: string | null;
|
|
4448
|
+
} | null;
|
|
4449
|
+
courtBody: {
|
|
4450
|
+
code?: number | null;
|
|
4451
|
+
name?: string | null;
|
|
4452
|
+
municipalityIbgeCode?: number | null;
|
|
4453
|
+
} | null;
|
|
4454
|
+
system?: {
|
|
4455
|
+
code?: number | null;
|
|
4456
|
+
name?: string | null;
|
|
4457
|
+
} | null;
|
|
4458
|
+
format?: {
|
|
4459
|
+
code?: number | null;
|
|
4460
|
+
name?: string | null;
|
|
4461
|
+
} | null;
|
|
4462
|
+
/** Format: date-time */
|
|
4463
|
+
filedAt?: string | null;
|
|
4464
|
+
/** Format: date-time */
|
|
4465
|
+
updatedAt?: string | null;
|
|
4466
|
+
/** Format: date-time */
|
|
4467
|
+
indexedAt?: string | null;
|
|
4468
|
+
subjects: {
|
|
4469
|
+
code?: number | null;
|
|
4470
|
+
name: string;
|
|
4471
|
+
}[];
|
|
4472
|
+
djen?: {
|
|
4473
|
+
publicationCount: number;
|
|
4474
|
+
/** Format: date-time */
|
|
4475
|
+
latestPublicationAt?: string | null;
|
|
4476
|
+
latestPublicationType?: string | null;
|
|
4477
|
+
latestPublicationExcerpt?: string | null;
|
|
4478
|
+
latestPublicationUrl?: string | null;
|
|
4479
|
+
} | null;
|
|
4480
|
+
};
|
|
4481
|
+
sourcePayload: unknown;
|
|
4482
|
+
movements: {
|
|
4483
|
+
externalMovementKey: string;
|
|
4484
|
+
codigo?: number | null;
|
|
4485
|
+
nome: string;
|
|
4486
|
+
/** Format: date-time */
|
|
4487
|
+
dataHora?: string | null;
|
|
4488
|
+
complementos: unknown;
|
|
4489
|
+
rawPayload: unknown;
|
|
4490
|
+
}[];
|
|
4491
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
4492
|
+
instances: {
|
|
4493
|
+
sourceId?: string | null;
|
|
4494
|
+
number: string;
|
|
4495
|
+
formattedNumber: string;
|
|
4496
|
+
tribunal: {
|
|
4497
|
+
alias: string;
|
|
4498
|
+
code: string;
|
|
4499
|
+
};
|
|
4500
|
+
degree?: string | null;
|
|
4501
|
+
sigiloLevel?: number | null;
|
|
4502
|
+
/**
|
|
4503
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4504
|
+
* @enum {string}
|
|
4505
|
+
*/
|
|
4506
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4507
|
+
/** @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. */
|
|
4508
|
+
shareable?: boolean;
|
|
4509
|
+
class: {
|
|
4510
|
+
code?: number | null;
|
|
4511
|
+
name?: string | null;
|
|
4512
|
+
} | null;
|
|
4513
|
+
courtBody: {
|
|
4514
|
+
code?: number | null;
|
|
4515
|
+
name?: string | null;
|
|
4516
|
+
municipalityIbgeCode?: number | null;
|
|
4517
|
+
} | null;
|
|
4518
|
+
system?: {
|
|
4519
|
+
code?: number | null;
|
|
4520
|
+
name?: string | null;
|
|
4521
|
+
} | null;
|
|
4522
|
+
format?: {
|
|
4523
|
+
code?: number | null;
|
|
4524
|
+
name?: string | null;
|
|
4525
|
+
} | null;
|
|
4526
|
+
/** Format: date-time */
|
|
4527
|
+
filedAt?: string | null;
|
|
4528
|
+
/** Format: date-time */
|
|
4529
|
+
updatedAt?: string | null;
|
|
4530
|
+
/** Format: date-time */
|
|
4531
|
+
indexedAt?: string | null;
|
|
4532
|
+
subjects: {
|
|
4533
|
+
code?: number | null;
|
|
4534
|
+
name: string;
|
|
4535
|
+
}[];
|
|
4536
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
4537
|
+
primary: boolean;
|
|
4538
|
+
/**
|
|
4539
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
4540
|
+
* @enum {string}
|
|
4541
|
+
*/
|
|
4542
|
+
origin: "SOURCE" | "LAKE";
|
|
4543
|
+
/**
|
|
4544
|
+
* Format: date-time
|
|
4545
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
4546
|
+
*/
|
|
4547
|
+
fetchedAt: string;
|
|
4548
|
+
/**
|
|
4549
|
+
* Format: date-time
|
|
4550
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
4551
|
+
*/
|
|
4552
|
+
absentSince: string | null;
|
|
4553
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
4554
|
+
movementsCaptured: boolean;
|
|
4555
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
4556
|
+
movementCount: number | null;
|
|
4557
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
4558
|
+
movements: {
|
|
4559
|
+
externalMovementKey: string;
|
|
4560
|
+
codigo?: number | null;
|
|
4561
|
+
nome: string;
|
|
4562
|
+
/** Format: date-time */
|
|
4563
|
+
dataHora?: string | null;
|
|
4564
|
+
complementos: unknown;
|
|
4565
|
+
}[] | null;
|
|
4566
|
+
}[];
|
|
4567
|
+
};
|
|
4568
|
+
/** @description Presente só no 202 de uma chamada com `staleOnFailure: true`: a cópia que o acervo guarda, com a data, na visão pedida. Movimentos posteriores a essa data podem existir e não estão nela; é a versão atual que a consulta segue buscando. */
|
|
4569
|
+
stale?: {
|
|
4570
|
+
process?: {
|
|
4571
|
+
sourceId?: string | null;
|
|
4572
|
+
number: string;
|
|
4573
|
+
formattedNumber: string;
|
|
4574
|
+
tribunal: {
|
|
4575
|
+
alias: string;
|
|
4576
|
+
code: string;
|
|
4577
|
+
};
|
|
4578
|
+
degree?: string | null;
|
|
4579
|
+
sigiloLevel?: number | null;
|
|
4580
|
+
/**
|
|
4581
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4582
|
+
* @enum {string}
|
|
4583
|
+
*/
|
|
4584
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4585
|
+
/** @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. */
|
|
4586
|
+
shareable?: boolean;
|
|
4587
|
+
class: {
|
|
4588
|
+
code?: number | null;
|
|
4589
|
+
name?: string | null;
|
|
4590
|
+
} | null;
|
|
4591
|
+
courtBody: {
|
|
4592
|
+
code?: number | null;
|
|
4593
|
+
name?: string | null;
|
|
4594
|
+
municipalityIbgeCode?: number | null;
|
|
4595
|
+
} | null;
|
|
4596
|
+
system?: {
|
|
4597
|
+
code?: number | null;
|
|
4598
|
+
name?: string | null;
|
|
4599
|
+
} | null;
|
|
4600
|
+
format?: {
|
|
4601
|
+
code?: number | null;
|
|
4602
|
+
name?: string | null;
|
|
4603
|
+
} | null;
|
|
4604
|
+
/** Format: date-time */
|
|
4605
|
+
filedAt?: string | null;
|
|
4606
|
+
/** Format: date-time */
|
|
4607
|
+
updatedAt?: string | null;
|
|
4608
|
+
/** Format: date-time */
|
|
4609
|
+
indexedAt?: string | null;
|
|
4610
|
+
subjects: {
|
|
4611
|
+
code?: number | null;
|
|
4612
|
+
name: string;
|
|
4613
|
+
}[];
|
|
4614
|
+
djen?: {
|
|
4615
|
+
publicationCount: number;
|
|
4616
|
+
/** Format: date-time */
|
|
4617
|
+
latestPublicationAt?: string | null;
|
|
4618
|
+
latestPublicationType?: string | null;
|
|
4619
|
+
latestPublicationExcerpt?: string | null;
|
|
4620
|
+
latestPublicationUrl?: string | null;
|
|
4621
|
+
} | null;
|
|
4622
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
4623
|
+
instances?: {
|
|
4624
|
+
sourceId?: string | null;
|
|
4625
|
+
number: string;
|
|
4626
|
+
formattedNumber: string;
|
|
4627
|
+
tribunal: {
|
|
4628
|
+
alias: string;
|
|
4629
|
+
code: string;
|
|
4630
|
+
};
|
|
4631
|
+
degree?: string | null;
|
|
4632
|
+
sigiloLevel?: number | null;
|
|
4633
|
+
/**
|
|
4634
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4635
|
+
* @enum {string}
|
|
4636
|
+
*/
|
|
4637
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4638
|
+
/** @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. */
|
|
4639
|
+
shareable?: boolean;
|
|
4640
|
+
class: {
|
|
4641
|
+
code?: number | null;
|
|
4642
|
+
name?: string | null;
|
|
4643
|
+
} | null;
|
|
4644
|
+
courtBody: {
|
|
4645
|
+
code?: number | null;
|
|
4646
|
+
name?: string | null;
|
|
4647
|
+
municipalityIbgeCode?: number | null;
|
|
4648
|
+
} | null;
|
|
4649
|
+
system?: {
|
|
4650
|
+
code?: number | null;
|
|
4651
|
+
name?: string | null;
|
|
4652
|
+
} | null;
|
|
4653
|
+
format?: {
|
|
4654
|
+
code?: number | null;
|
|
4655
|
+
name?: string | null;
|
|
4656
|
+
} | null;
|
|
4657
|
+
/** Format: date-time */
|
|
4658
|
+
filedAt?: string | null;
|
|
4659
|
+
/** Format: date-time */
|
|
4660
|
+
updatedAt?: string | null;
|
|
4661
|
+
/** Format: date-time */
|
|
4662
|
+
indexedAt?: string | null;
|
|
4663
|
+
subjects: {
|
|
4664
|
+
code?: number | null;
|
|
4665
|
+
name: string;
|
|
4666
|
+
}[];
|
|
4667
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
4668
|
+
primary: boolean;
|
|
4669
|
+
/**
|
|
4670
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
4671
|
+
* @enum {string}
|
|
4672
|
+
*/
|
|
4673
|
+
origin: "SOURCE" | "LAKE";
|
|
4674
|
+
/**
|
|
4675
|
+
* Format: date-time
|
|
4676
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
4677
|
+
*/
|
|
4678
|
+
fetchedAt: string;
|
|
4679
|
+
/**
|
|
4680
|
+
* Format: date-time
|
|
4681
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
4682
|
+
*/
|
|
4683
|
+
absentSince: string | null;
|
|
4684
|
+
}[];
|
|
4685
|
+
};
|
|
4686
|
+
snapshot?: {
|
|
4687
|
+
process: {
|
|
4688
|
+
sourceId?: string | null;
|
|
4689
|
+
number: string;
|
|
4690
|
+
formattedNumber: string;
|
|
4691
|
+
tribunal: {
|
|
4692
|
+
alias: string;
|
|
4693
|
+
code: string;
|
|
4694
|
+
};
|
|
4695
|
+
degree?: string | null;
|
|
4696
|
+
sigiloLevel?: number | null;
|
|
4697
|
+
/**
|
|
4698
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4699
|
+
* @enum {string}
|
|
4700
|
+
*/
|
|
4701
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4702
|
+
/** @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. */
|
|
4703
|
+
shareable?: boolean;
|
|
4704
|
+
class: {
|
|
4705
|
+
code?: number | null;
|
|
4706
|
+
name?: string | null;
|
|
4707
|
+
} | null;
|
|
4708
|
+
courtBody: {
|
|
4709
|
+
code?: number | null;
|
|
4710
|
+
name?: string | null;
|
|
4711
|
+
municipalityIbgeCode?: number | null;
|
|
4712
|
+
} | null;
|
|
4713
|
+
system?: {
|
|
4714
|
+
code?: number | null;
|
|
4715
|
+
name?: string | null;
|
|
4716
|
+
} | null;
|
|
4717
|
+
format?: {
|
|
4718
|
+
code?: number | null;
|
|
4719
|
+
name?: string | null;
|
|
4720
|
+
} | null;
|
|
4721
|
+
/** Format: date-time */
|
|
4722
|
+
filedAt?: string | null;
|
|
4723
|
+
/** Format: date-time */
|
|
4724
|
+
updatedAt?: string | null;
|
|
4725
|
+
/** Format: date-time */
|
|
4726
|
+
indexedAt?: string | null;
|
|
4727
|
+
subjects: {
|
|
4728
|
+
code?: number | null;
|
|
4729
|
+
name: string;
|
|
4730
|
+
}[];
|
|
4731
|
+
djen?: {
|
|
4732
|
+
publicationCount: number;
|
|
4733
|
+
/** Format: date-time */
|
|
4734
|
+
latestPublicationAt?: string | null;
|
|
4735
|
+
latestPublicationType?: string | null;
|
|
4736
|
+
latestPublicationExcerpt?: string | null;
|
|
4737
|
+
latestPublicationUrl?: string | null;
|
|
4738
|
+
} | null;
|
|
4739
|
+
};
|
|
4740
|
+
sourcePayload: unknown;
|
|
4741
|
+
movements: {
|
|
4742
|
+
externalMovementKey: string;
|
|
4743
|
+
codigo?: number | null;
|
|
4744
|
+
nome: string;
|
|
4745
|
+
/** Format: date-time */
|
|
4746
|
+
dataHora?: string | null;
|
|
4747
|
+
complementos: unknown;
|
|
4748
|
+
rawPayload: unknown;
|
|
4749
|
+
}[];
|
|
4750
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
4751
|
+
instances: {
|
|
4752
|
+
sourceId?: string | null;
|
|
4753
|
+
number: string;
|
|
4754
|
+
formattedNumber: string;
|
|
4755
|
+
tribunal: {
|
|
4756
|
+
alias: string;
|
|
4757
|
+
code: string;
|
|
4758
|
+
};
|
|
4759
|
+
degree?: string | null;
|
|
4760
|
+
sigiloLevel?: number | null;
|
|
4761
|
+
/**
|
|
4762
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4763
|
+
* @enum {string}
|
|
4764
|
+
*/
|
|
4765
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4766
|
+
/** @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. */
|
|
4767
|
+
shareable?: boolean;
|
|
4768
|
+
class: {
|
|
4769
|
+
code?: number | null;
|
|
4770
|
+
name?: string | null;
|
|
4771
|
+
} | null;
|
|
4772
|
+
courtBody: {
|
|
4773
|
+
code?: number | null;
|
|
4774
|
+
name?: string | null;
|
|
4775
|
+
municipalityIbgeCode?: number | null;
|
|
4776
|
+
} | null;
|
|
4777
|
+
system?: {
|
|
4778
|
+
code?: number | null;
|
|
4779
|
+
name?: string | null;
|
|
4780
|
+
} | null;
|
|
4781
|
+
format?: {
|
|
4782
|
+
code?: number | null;
|
|
4783
|
+
name?: string | null;
|
|
4784
|
+
} | null;
|
|
4785
|
+
/** Format: date-time */
|
|
4786
|
+
filedAt?: string | null;
|
|
4787
|
+
/** Format: date-time */
|
|
4788
|
+
updatedAt?: string | null;
|
|
4789
|
+
/** Format: date-time */
|
|
4790
|
+
indexedAt?: string | null;
|
|
4791
|
+
subjects: {
|
|
4792
|
+
code?: number | null;
|
|
4793
|
+
name: string;
|
|
4794
|
+
}[];
|
|
4795
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
4796
|
+
primary: boolean;
|
|
4797
|
+
/**
|
|
4798
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
4799
|
+
* @enum {string}
|
|
4800
|
+
*/
|
|
4801
|
+
origin: "SOURCE" | "LAKE";
|
|
4802
|
+
/**
|
|
4803
|
+
* Format: date-time
|
|
4804
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
4805
|
+
*/
|
|
4806
|
+
fetchedAt: string;
|
|
4807
|
+
/**
|
|
4808
|
+
* Format: date-time
|
|
4809
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
4810
|
+
*/
|
|
4811
|
+
absentSince: string | null;
|
|
4812
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
4813
|
+
movementsCaptured: boolean;
|
|
4814
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
4815
|
+
movementCount: number | null;
|
|
4816
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
4817
|
+
movements: {
|
|
4818
|
+
externalMovementKey: string;
|
|
4819
|
+
codigo?: number | null;
|
|
4820
|
+
nome: string;
|
|
4821
|
+
/** Format: date-time */
|
|
4822
|
+
dataHora?: string | null;
|
|
4823
|
+
complementos: unknown;
|
|
4824
|
+
}[] | null;
|
|
4825
|
+
}[];
|
|
4826
|
+
};
|
|
4827
|
+
/**
|
|
4828
|
+
* Format: date-time
|
|
4829
|
+
* @description Quando a cópia foi buscada na fonte.
|
|
4830
|
+
*/
|
|
4831
|
+
sourceFetchedAt: string;
|
|
4832
|
+
/**
|
|
4833
|
+
* @description Por que a fonte não entregou nesta chamada.
|
|
4834
|
+
* @enum {string}
|
|
4835
|
+
*/
|
|
4836
|
+
cause: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
4837
|
+
};
|
|
4838
|
+
};
|
|
4839
|
+
meta: {
|
|
4840
|
+
/** @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. */
|
|
4841
|
+
requestId: string;
|
|
4842
|
+
credits?: number;
|
|
4843
|
+
cacheHit?: boolean;
|
|
4844
|
+
/**
|
|
4845
|
+
* Format: date-time
|
|
4846
|
+
* @description Quando os dados servidos foram buscados na fonte: agora, se ela respondeu; antes, se vieram do acervo. No retrato socorrido pelo acervo, é a data da captura dos movimentos servidos. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor.
|
|
4847
|
+
*/
|
|
4848
|
+
sourceFetchedAt?: string;
|
|
4849
|
+
/** @description Presente só quando a fonte processual falhou e o motor serviu a cópia que o acervo guarda do processo. A data da cópia está em `meta.sourceFetchedAt`; movimentos posteriores a ela podem existir e não estão na resposta. */
|
|
4850
|
+
lakeRescue?: {
|
|
4851
|
+
/**
|
|
4852
|
+
* @description Por que a fonte não entregou: `UPSTREAM_TIMEOUT` (não respondeu dentro da espera), `UPSTREAM_UNAVAILABLE` (indisponível, ou respondeu com parte do índice sem poder servir o processo) ou `UPSTREAM_RATE_LIMITED` (pediu para esperar por volume).
|
|
4853
|
+
* @enum {string}
|
|
4854
|
+
*/
|
|
4855
|
+
cause: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
4856
|
+
/** @description A espera que a fonte pediu: não consulte a fonte de novo antes dela. */
|
|
4857
|
+
retryAfterSeconds?: number;
|
|
4858
|
+
};
|
|
4859
|
+
/** @description Presente só quando a fonte respondeu com parte do índice e o processo estava na parte que respondeu: o documento que o acervo já guardava e não veio sai em `instances` do acervo (`origin: LAKE`), e outra instância que o acervo não conhece, se existir, pode não ter vindo. */
|
|
4860
|
+
partialIndex?: {
|
|
4861
|
+
/** @description Partes do índice da fonte que não responderam. */
|
|
4862
|
+
shardsFailed: number;
|
|
4863
|
+
/** @description Total de partes do índice; nulo quando a fonte não as contou. */
|
|
4864
|
+
shardsTotal: number | null;
|
|
4865
|
+
/** @description A fonte estourou o próprio prazo interno e devolveu só o que deu tempo de olhar. */
|
|
4866
|
+
timedOut: boolean;
|
|
4867
|
+
};
|
|
4868
|
+
/** @description Presente só quando a resposta da fonte trouxe outros documentos do número além da instância principal, que é o topo de `data` (com o grau em `degree`) — em geral de instâncias diferentes, mas dois podem ter o mesmo `grau`. O motor guarda cada documento na sua instância e serve todos em `data.instances`; esta lista é o resumo dos outros que vieram na mesma resposta. Não inclui documento que o motor classificaria como segredo de justiça, e não aparece quando o processo servido é restrito. */
|
|
4869
|
+
otherInstances?: {
|
|
4870
|
+
/** @description O grau deste documento na fonte: G1, G2, JE, TR… */
|
|
4871
|
+
grau: string | null;
|
|
4872
|
+
/**
|
|
4873
|
+
* Format: date-time
|
|
4874
|
+
* @description Quando a fonte atualizou este documento pela última vez.
|
|
4875
|
+
*/
|
|
4876
|
+
updatedAt: string | null;
|
|
4877
|
+
/** @description O órgão julgador deste documento, quando a fonte o traz. */
|
|
4878
|
+
courtBody?: string;
|
|
4879
|
+
}[];
|
|
4880
|
+
} & {
|
|
4881
|
+
[key: string]: unknown;
|
|
4882
|
+
};
|
|
4883
|
+
};
|
|
4884
|
+
};
|
|
4885
|
+
};
|
|
4886
|
+
/** @description Resposta padrão */
|
|
4887
|
+
202: {
|
|
4888
|
+
headers: {
|
|
4889
|
+
[name: string]: unknown;
|
|
4890
|
+
};
|
|
4891
|
+
content: {
|
|
4892
|
+
"application/json": {
|
|
4893
|
+
data: {
|
|
4894
|
+
/** @description O id da consulta; nulo quando a leitura coube na espera e nenhuma consulta foi aberta. */
|
|
4895
|
+
lookupId: string | null;
|
|
4896
|
+
/** @enum {string} */
|
|
4897
|
+
status: "QUEUED" | "LEASED" | "SUCCEEDED" | "FAILED" | "CANCELED";
|
|
4898
|
+
/**
|
|
4899
|
+
* @description O que ler: `PROCESS`, a ficha do processo (a mesma de `GET /v1/processes/{processNumber}`), ou `SNAPSHOT`, o retrato com os movimentos (o de `GET /v1/processes/{processNumber}/snapshot`).
|
|
4900
|
+
* @enum {string}
|
|
4901
|
+
*/
|
|
4902
|
+
view: "PROCESS" | "SNAPSHOT";
|
|
4903
|
+
tribunalAlias: string;
|
|
4904
|
+
/** @description O número do processo, só os 20 dígitos. */
|
|
4905
|
+
processNumber: string;
|
|
4906
|
+
/** @description Onde a consulta é lida, sem nova cobrança; nulo sem consulta aberta. */
|
|
4907
|
+
pollUrl: string | null;
|
|
4908
|
+
/** @description A chamada reencontrou a consulta já aberta para a mesma conta, escritório, processo e visão, em vez de abrir outra. */
|
|
4909
|
+
deduped: boolean;
|
|
4910
|
+
/** @description Créditos retidos pela consulta: o máximo que a entrega cobra, só se o processo vier — a ficha que outra leitura trouxe ao acervo cobra menos. Enquanto isso, a retenção conta no saldo e no teto diário da chave que abriu a consulta. */
|
|
4911
|
+
creditsReserved: number;
|
|
4912
|
+
/** @description O que a mesma compra já cobrou fora da consulta: a cópia guardada entregue em `stale`. A entrega cobra o preço da leitura menos isto. */
|
|
4913
|
+
alreadyCharged: number;
|
|
4914
|
+
/** @description Idas à fonte até aqui, a leitura que abriu a consulta incluída. */
|
|
4915
|
+
attempts: number;
|
|
4916
|
+
/**
|
|
4917
|
+
* Format: date-time
|
|
4918
|
+
* @description Quando a próxima tentativa sai; nulo na consulta terminada e enquanto uma tentativa está em curso. A hora que já passou é a da tentativa esperando a vez na fila. Ler a consulta antes da hora futura devolve o mesmo estado.
|
|
4919
|
+
*/
|
|
4920
|
+
nextAttemptAt: string | null;
|
|
4921
|
+
/**
|
|
4922
|
+
* Format: date-time
|
|
4923
|
+
* @description Até quando a consulta tenta; depois, termina sem o processo e devolve a retenção. Nulo sem consulta aberta.
|
|
4924
|
+
*/
|
|
4925
|
+
giveUpAt: string | null;
|
|
4926
|
+
/** @description A última ida à fonte que não entregou: quando, e por quê — `UPSTREAM_TIMEOUT` (não respondeu dentro da espera), `UPSTREAM_UNAVAILABLE` (indisponível, ou respondeu com parte do índice sem o processo) ou `UPSTREAM_RATE_LIMITED` (pediu para esperar por volume). */
|
|
4927
|
+
lastAttempt: {
|
|
4928
|
+
/** Format: date-time */
|
|
4929
|
+
at: string;
|
|
4930
|
+
/** @enum {string} */
|
|
4931
|
+
code: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
4932
|
+
retryable: boolean;
|
|
4933
|
+
} | null;
|
|
4934
|
+
/**
|
|
4935
|
+
* @description Quem entregou: `SOURCE`, uma tentativa na fonte; `LAKE`, o acervo, que outra leitura atualizou depois de a consulta abrir; `DIRECT_READ`, uma leitura sua do mesmo processo, que entregou e cobrou antes — a consulta fecha sem cobrar. Nulo enquanto não houve entrega.
|
|
4936
|
+
* @enum {string|null}
|
|
4937
|
+
*/
|
|
4938
|
+
satisfiedBy: "SOURCE" | "LAKE" | "DIRECT_READ" | null;
|
|
4939
|
+
creditsCharged: number | null;
|
|
4940
|
+
creditsRefunded: number | null;
|
|
4941
|
+
/** @description Por que a consulta terminou sem o processo: o código da taxonomia de erros, como a leitura síncrona o daria. */
|
|
4942
|
+
error: {
|
|
4943
|
+
/** @enum {string} */
|
|
4944
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
4945
|
+
code: string;
|
|
4946
|
+
/** @description O texto público fixo do código, o mesmo em toda consulta. */
|
|
4947
|
+
message: string;
|
|
4948
|
+
retryable: boolean;
|
|
4949
|
+
upstreamStatus?: number;
|
|
4950
|
+
} | null;
|
|
4951
|
+
/** Format: date-time */
|
|
4952
|
+
createdAt: string;
|
|
4953
|
+
/** Format: date-time */
|
|
4954
|
+
finishedAt: string | null;
|
|
4955
|
+
/**
|
|
4956
|
+
* Format: date-time
|
|
4957
|
+
* @description Até quando o processo entregue é lido nesta consulta sem nova cobrança: 24 h depois da entrega.
|
|
4958
|
+
*/
|
|
4959
|
+
resultExpiresAt: string | null;
|
|
4960
|
+
/** @description O processo entregue já não é lido aqui: o prazo passou, ou o acervo já não sustenta a cópia. Uma leitura nova o traz. */
|
|
4961
|
+
resultExpired: boolean;
|
|
4962
|
+
/** @description A vigília que a conta já mantém sobre o processo: quando olhou pela última vez e quando olha de novo. Só para a chave que lê monitores (`MONITORS_READ`); nulo sem vigília. */
|
|
4963
|
+
monitor: {
|
|
4964
|
+
monitorId: string;
|
|
4965
|
+
/** Format: date-time */
|
|
4966
|
+
lastCheckedAt: string | null;
|
|
4967
|
+
/** Format: date-time */
|
|
4968
|
+
nextCheckAt: string | null;
|
|
4969
|
+
} | null;
|
|
4970
|
+
/** @description A ficha entregue, na visão `PROCESS`, enquanto o resultado vale, com as instâncias do número em `instances`, como na leitura direta. Lida da consulta, ela passa de novo pelo controle de confidencialidade. */
|
|
4971
|
+
process?: {
|
|
4972
|
+
sourceId?: string | null;
|
|
4973
|
+
number: string;
|
|
4974
|
+
formattedNumber: string;
|
|
4975
|
+
tribunal: {
|
|
4976
|
+
alias: string;
|
|
4977
|
+
code: string;
|
|
4978
|
+
};
|
|
4979
|
+
degree?: string | null;
|
|
4980
|
+
sigiloLevel?: number | null;
|
|
4981
|
+
/**
|
|
4982
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
4983
|
+
* @enum {string}
|
|
4984
|
+
*/
|
|
4985
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
4986
|
+
/** @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. */
|
|
4987
|
+
shareable?: boolean;
|
|
4988
|
+
class: {
|
|
4989
|
+
code?: number | null;
|
|
4990
|
+
name?: string | null;
|
|
4991
|
+
} | null;
|
|
4992
|
+
courtBody: {
|
|
4993
|
+
code?: number | null;
|
|
4994
|
+
name?: string | null;
|
|
4995
|
+
municipalityIbgeCode?: number | null;
|
|
4996
|
+
} | null;
|
|
4997
|
+
system?: {
|
|
4998
|
+
code?: number | null;
|
|
4999
|
+
name?: string | null;
|
|
5000
|
+
} | null;
|
|
5001
|
+
format?: {
|
|
5002
|
+
code?: number | null;
|
|
5003
|
+
name?: string | null;
|
|
5004
|
+
} | null;
|
|
5005
|
+
/** Format: date-time */
|
|
5006
|
+
filedAt?: string | null;
|
|
5007
|
+
/** Format: date-time */
|
|
5008
|
+
updatedAt?: string | null;
|
|
5009
|
+
/** Format: date-time */
|
|
5010
|
+
indexedAt?: string | null;
|
|
5011
|
+
subjects: {
|
|
5012
|
+
code?: number | null;
|
|
5013
|
+
name: string;
|
|
5014
|
+
}[];
|
|
5015
|
+
djen?: {
|
|
5016
|
+
publicationCount: number;
|
|
5017
|
+
/** Format: date-time */
|
|
5018
|
+
latestPublicationAt?: string | null;
|
|
5019
|
+
latestPublicationType?: string | null;
|
|
5020
|
+
latestPublicationExcerpt?: string | null;
|
|
5021
|
+
latestPublicationUrl?: string | null;
|
|
5022
|
+
} | null;
|
|
5023
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
5024
|
+
instances?: {
|
|
5025
|
+
sourceId?: string | null;
|
|
5026
|
+
number: string;
|
|
5027
|
+
formattedNumber: string;
|
|
5028
|
+
tribunal: {
|
|
5029
|
+
alias: string;
|
|
5030
|
+
code: string;
|
|
5031
|
+
};
|
|
5032
|
+
degree?: string | null;
|
|
5033
|
+
sigiloLevel?: number | null;
|
|
5034
|
+
/**
|
|
5035
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5036
|
+
* @enum {string}
|
|
5037
|
+
*/
|
|
5038
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5039
|
+
/** @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. */
|
|
5040
|
+
shareable?: boolean;
|
|
5041
|
+
class: {
|
|
5042
|
+
code?: number | null;
|
|
5043
|
+
name?: string | null;
|
|
5044
|
+
} | null;
|
|
5045
|
+
courtBody: {
|
|
5046
|
+
code?: number | null;
|
|
5047
|
+
name?: string | null;
|
|
5048
|
+
municipalityIbgeCode?: number | null;
|
|
5049
|
+
} | null;
|
|
5050
|
+
system?: {
|
|
5051
|
+
code?: number | null;
|
|
5052
|
+
name?: string | null;
|
|
5053
|
+
} | null;
|
|
5054
|
+
format?: {
|
|
5055
|
+
code?: number | null;
|
|
5056
|
+
name?: string | null;
|
|
5057
|
+
} | null;
|
|
5058
|
+
/** Format: date-time */
|
|
5059
|
+
filedAt?: string | null;
|
|
5060
|
+
/** Format: date-time */
|
|
5061
|
+
updatedAt?: string | null;
|
|
5062
|
+
/** Format: date-time */
|
|
5063
|
+
indexedAt?: string | null;
|
|
5064
|
+
subjects: {
|
|
5065
|
+
code?: number | null;
|
|
5066
|
+
name: string;
|
|
5067
|
+
}[];
|
|
5068
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
5069
|
+
primary: boolean;
|
|
5070
|
+
/**
|
|
5071
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
5072
|
+
* @enum {string}
|
|
5073
|
+
*/
|
|
5074
|
+
origin: "SOURCE" | "LAKE";
|
|
5075
|
+
/**
|
|
5076
|
+
* Format: date-time
|
|
5077
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
5078
|
+
*/
|
|
5079
|
+
fetchedAt: string;
|
|
5080
|
+
/**
|
|
5081
|
+
* Format: date-time
|
|
5082
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
5083
|
+
*/
|
|
5084
|
+
absentSince: string | null;
|
|
5085
|
+
}[];
|
|
5086
|
+
};
|
|
5087
|
+
/** @description O retrato entregue, na visão `SNAPSHOT`, enquanto o resultado vale: a instância principal no topo e cada instância do número em `instances`, como na leitura direta. Lido da consulta, ele é composto do que o acervo guarda da última captura de cada instância, e `sourcePayload` é nulo: o documento bruto da fonte não é guardado. */
|
|
5088
|
+
snapshot?: {
|
|
5089
|
+
process: {
|
|
5090
|
+
sourceId?: string | null;
|
|
5091
|
+
number: string;
|
|
5092
|
+
formattedNumber: string;
|
|
5093
|
+
tribunal: {
|
|
5094
|
+
alias: string;
|
|
5095
|
+
code: string;
|
|
5096
|
+
};
|
|
5097
|
+
degree?: string | null;
|
|
5098
|
+
sigiloLevel?: number | null;
|
|
5099
|
+
/**
|
|
5100
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5101
|
+
* @enum {string}
|
|
5102
|
+
*/
|
|
5103
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5104
|
+
/** @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. */
|
|
5105
|
+
shareable?: boolean;
|
|
5106
|
+
class: {
|
|
5107
|
+
code?: number | null;
|
|
5108
|
+
name?: string | null;
|
|
5109
|
+
} | null;
|
|
5110
|
+
courtBody: {
|
|
5111
|
+
code?: number | null;
|
|
5112
|
+
name?: string | null;
|
|
5113
|
+
municipalityIbgeCode?: number | null;
|
|
5114
|
+
} | null;
|
|
5115
|
+
system?: {
|
|
5116
|
+
code?: number | null;
|
|
5117
|
+
name?: string | null;
|
|
5118
|
+
} | null;
|
|
5119
|
+
format?: {
|
|
5120
|
+
code?: number | null;
|
|
5121
|
+
name?: string | null;
|
|
5122
|
+
} | null;
|
|
5123
|
+
/** Format: date-time */
|
|
5124
|
+
filedAt?: string | null;
|
|
5125
|
+
/** Format: date-time */
|
|
5126
|
+
updatedAt?: string | null;
|
|
5127
|
+
/** Format: date-time */
|
|
5128
|
+
indexedAt?: string | null;
|
|
5129
|
+
subjects: {
|
|
5130
|
+
code?: number | null;
|
|
5131
|
+
name: string;
|
|
5132
|
+
}[];
|
|
5133
|
+
djen?: {
|
|
5134
|
+
publicationCount: number;
|
|
5135
|
+
/** Format: date-time */
|
|
5136
|
+
latestPublicationAt?: string | null;
|
|
5137
|
+
latestPublicationType?: string | null;
|
|
5138
|
+
latestPublicationExcerpt?: string | null;
|
|
5139
|
+
latestPublicationUrl?: string | null;
|
|
5140
|
+
} | null;
|
|
5141
|
+
};
|
|
5142
|
+
sourcePayload: unknown;
|
|
5143
|
+
movements: {
|
|
5144
|
+
externalMovementKey: string;
|
|
5145
|
+
codigo?: number | null;
|
|
5146
|
+
nome: string;
|
|
5147
|
+
/** Format: date-time */
|
|
5148
|
+
dataHora?: string | null;
|
|
5149
|
+
complementos: unknown;
|
|
5150
|
+
rawPayload: unknown;
|
|
5151
|
+
}[];
|
|
5152
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
5153
|
+
instances: {
|
|
5154
|
+
sourceId?: string | null;
|
|
5155
|
+
number: string;
|
|
5156
|
+
formattedNumber: string;
|
|
5157
|
+
tribunal: {
|
|
5158
|
+
alias: string;
|
|
5159
|
+
code: string;
|
|
5160
|
+
};
|
|
5161
|
+
degree?: string | null;
|
|
5162
|
+
sigiloLevel?: number | null;
|
|
5163
|
+
/**
|
|
5164
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5165
|
+
* @enum {string}
|
|
5166
|
+
*/
|
|
5167
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5168
|
+
/** @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. */
|
|
5169
|
+
shareable?: boolean;
|
|
5170
|
+
class: {
|
|
5171
|
+
code?: number | null;
|
|
5172
|
+
name?: string | null;
|
|
5173
|
+
} | null;
|
|
5174
|
+
courtBody: {
|
|
5175
|
+
code?: number | null;
|
|
5176
|
+
name?: string | null;
|
|
5177
|
+
municipalityIbgeCode?: number | null;
|
|
5178
|
+
} | null;
|
|
5179
|
+
system?: {
|
|
5180
|
+
code?: number | null;
|
|
5181
|
+
name?: string | null;
|
|
5182
|
+
} | null;
|
|
5183
|
+
format?: {
|
|
5184
|
+
code?: number | null;
|
|
5185
|
+
name?: string | null;
|
|
5186
|
+
} | null;
|
|
5187
|
+
/** Format: date-time */
|
|
5188
|
+
filedAt?: string | null;
|
|
5189
|
+
/** Format: date-time */
|
|
5190
|
+
updatedAt?: string | null;
|
|
5191
|
+
/** Format: date-time */
|
|
5192
|
+
indexedAt?: string | null;
|
|
5193
|
+
subjects: {
|
|
5194
|
+
code?: number | null;
|
|
5195
|
+
name: string;
|
|
5196
|
+
}[];
|
|
5197
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
5198
|
+
primary: boolean;
|
|
5199
|
+
/**
|
|
5200
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
5201
|
+
* @enum {string}
|
|
5202
|
+
*/
|
|
5203
|
+
origin: "SOURCE" | "LAKE";
|
|
5204
|
+
/**
|
|
5205
|
+
* Format: date-time
|
|
5206
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
5207
|
+
*/
|
|
5208
|
+
fetchedAt: string;
|
|
5209
|
+
/**
|
|
5210
|
+
* Format: date-time
|
|
5211
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
5212
|
+
*/
|
|
5213
|
+
absentSince: string | null;
|
|
5214
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
5215
|
+
movementsCaptured: boolean;
|
|
5216
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
5217
|
+
movementCount: number | null;
|
|
5218
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
5219
|
+
movements: {
|
|
5220
|
+
externalMovementKey: string;
|
|
5221
|
+
codigo?: number | null;
|
|
5222
|
+
nome: string;
|
|
5223
|
+
/** Format: date-time */
|
|
5224
|
+
dataHora?: string | null;
|
|
5225
|
+
complementos: unknown;
|
|
5226
|
+
}[] | null;
|
|
5227
|
+
}[];
|
|
5228
|
+
};
|
|
5229
|
+
/** @description Presente só no 202 de uma chamada com `staleOnFailure: true`: a cópia que o acervo guarda, com a data, na visão pedida. Movimentos posteriores a essa data podem existir e não estão nela; é a versão atual que a consulta segue buscando. */
|
|
5230
|
+
stale?: {
|
|
5231
|
+
process?: {
|
|
5232
|
+
sourceId?: string | null;
|
|
5233
|
+
number: string;
|
|
5234
|
+
formattedNumber: string;
|
|
5235
|
+
tribunal: {
|
|
5236
|
+
alias: string;
|
|
5237
|
+
code: string;
|
|
5238
|
+
};
|
|
5239
|
+
degree?: string | null;
|
|
5240
|
+
sigiloLevel?: number | null;
|
|
5241
|
+
/**
|
|
5242
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5243
|
+
* @enum {string}
|
|
5244
|
+
*/
|
|
5245
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5246
|
+
/** @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. */
|
|
5247
|
+
shareable?: boolean;
|
|
5248
|
+
class: {
|
|
5249
|
+
code?: number | null;
|
|
5250
|
+
name?: string | null;
|
|
5251
|
+
} | null;
|
|
5252
|
+
courtBody: {
|
|
5253
|
+
code?: number | null;
|
|
5254
|
+
name?: string | null;
|
|
5255
|
+
municipalityIbgeCode?: number | null;
|
|
5256
|
+
} | null;
|
|
5257
|
+
system?: {
|
|
5258
|
+
code?: number | null;
|
|
5259
|
+
name?: string | null;
|
|
5260
|
+
} | null;
|
|
5261
|
+
format?: {
|
|
5262
|
+
code?: number | null;
|
|
5263
|
+
name?: string | null;
|
|
5264
|
+
} | null;
|
|
5265
|
+
/** Format: date-time */
|
|
5266
|
+
filedAt?: string | null;
|
|
5267
|
+
/** Format: date-time */
|
|
5268
|
+
updatedAt?: string | null;
|
|
5269
|
+
/** Format: date-time */
|
|
5270
|
+
indexedAt?: string | null;
|
|
5271
|
+
subjects: {
|
|
5272
|
+
code?: number | null;
|
|
5273
|
+
name: string;
|
|
5274
|
+
}[];
|
|
5275
|
+
djen?: {
|
|
5276
|
+
publicationCount: number;
|
|
5277
|
+
/** Format: date-time */
|
|
5278
|
+
latestPublicationAt?: string | null;
|
|
5279
|
+
latestPublicationType?: string | null;
|
|
5280
|
+
latestPublicationExcerpt?: string | null;
|
|
5281
|
+
latestPublicationUrl?: string | null;
|
|
5282
|
+
} | null;
|
|
5283
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
5284
|
+
instances?: {
|
|
5285
|
+
sourceId?: string | null;
|
|
5286
|
+
number: string;
|
|
5287
|
+
formattedNumber: string;
|
|
5288
|
+
tribunal: {
|
|
5289
|
+
alias: string;
|
|
5290
|
+
code: string;
|
|
5291
|
+
};
|
|
5292
|
+
degree?: string | null;
|
|
5293
|
+
sigiloLevel?: number | null;
|
|
5294
|
+
/**
|
|
5295
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5296
|
+
* @enum {string}
|
|
5297
|
+
*/
|
|
5298
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5299
|
+
/** @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. */
|
|
5300
|
+
shareable?: boolean;
|
|
5301
|
+
class: {
|
|
5302
|
+
code?: number | null;
|
|
5303
|
+
name?: string | null;
|
|
5304
|
+
} | null;
|
|
5305
|
+
courtBody: {
|
|
5306
|
+
code?: number | null;
|
|
5307
|
+
name?: string | null;
|
|
5308
|
+
municipalityIbgeCode?: number | null;
|
|
5309
|
+
} | null;
|
|
5310
|
+
system?: {
|
|
5311
|
+
code?: number | null;
|
|
5312
|
+
name?: string | null;
|
|
5313
|
+
} | null;
|
|
5314
|
+
format?: {
|
|
5315
|
+
code?: number | null;
|
|
5316
|
+
name?: string | null;
|
|
5317
|
+
} | null;
|
|
5318
|
+
/** Format: date-time */
|
|
5319
|
+
filedAt?: string | null;
|
|
5320
|
+
/** Format: date-time */
|
|
5321
|
+
updatedAt?: string | null;
|
|
5322
|
+
/** Format: date-time */
|
|
5323
|
+
indexedAt?: string | null;
|
|
5324
|
+
subjects: {
|
|
5325
|
+
code?: number | null;
|
|
5326
|
+
name: string;
|
|
5327
|
+
}[];
|
|
5328
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
5329
|
+
primary: boolean;
|
|
5330
|
+
/**
|
|
5331
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
5332
|
+
* @enum {string}
|
|
5333
|
+
*/
|
|
5334
|
+
origin: "SOURCE" | "LAKE";
|
|
5335
|
+
/**
|
|
5336
|
+
* Format: date-time
|
|
5337
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
5338
|
+
*/
|
|
5339
|
+
fetchedAt: string;
|
|
5340
|
+
/**
|
|
5341
|
+
* Format: date-time
|
|
5342
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
5343
|
+
*/
|
|
5344
|
+
absentSince: string | null;
|
|
5345
|
+
}[];
|
|
5346
|
+
};
|
|
5347
|
+
snapshot?: {
|
|
5348
|
+
process: {
|
|
5349
|
+
sourceId?: string | null;
|
|
5350
|
+
number: string;
|
|
5351
|
+
formattedNumber: string;
|
|
5352
|
+
tribunal: {
|
|
5353
|
+
alias: string;
|
|
5354
|
+
code: string;
|
|
5355
|
+
};
|
|
5356
|
+
degree?: string | null;
|
|
5357
|
+
sigiloLevel?: number | null;
|
|
5358
|
+
/**
|
|
5359
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5360
|
+
* @enum {string}
|
|
5361
|
+
*/
|
|
5362
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5363
|
+
/** @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. */
|
|
5364
|
+
shareable?: boolean;
|
|
5365
|
+
class: {
|
|
5366
|
+
code?: number | null;
|
|
5367
|
+
name?: string | null;
|
|
5368
|
+
} | null;
|
|
5369
|
+
courtBody: {
|
|
5370
|
+
code?: number | null;
|
|
5371
|
+
name?: string | null;
|
|
5372
|
+
municipalityIbgeCode?: number | null;
|
|
5373
|
+
} | null;
|
|
5374
|
+
system?: {
|
|
5375
|
+
code?: number | null;
|
|
5376
|
+
name?: string | null;
|
|
5377
|
+
} | null;
|
|
5378
|
+
format?: {
|
|
5379
|
+
code?: number | null;
|
|
5380
|
+
name?: string | null;
|
|
5381
|
+
} | null;
|
|
5382
|
+
/** Format: date-time */
|
|
5383
|
+
filedAt?: string | null;
|
|
5384
|
+
/** Format: date-time */
|
|
5385
|
+
updatedAt?: string | null;
|
|
5386
|
+
/** Format: date-time */
|
|
5387
|
+
indexedAt?: string | null;
|
|
5388
|
+
subjects: {
|
|
5389
|
+
code?: number | null;
|
|
5390
|
+
name: string;
|
|
5391
|
+
}[];
|
|
5392
|
+
djen?: {
|
|
5393
|
+
publicationCount: number;
|
|
5394
|
+
/** Format: date-time */
|
|
5395
|
+
latestPublicationAt?: string | null;
|
|
5396
|
+
latestPublicationType?: string | null;
|
|
5397
|
+
latestPublicationExcerpt?: string | null;
|
|
5398
|
+
latestPublicationUrl?: string | null;
|
|
5399
|
+
} | null;
|
|
5400
|
+
};
|
|
5401
|
+
sourcePayload: unknown;
|
|
5402
|
+
movements: {
|
|
5403
|
+
externalMovementKey: string;
|
|
5404
|
+
codigo?: number | null;
|
|
5405
|
+
nome: string;
|
|
5406
|
+
/** Format: date-time */
|
|
5407
|
+
dataHora?: string | null;
|
|
5408
|
+
complementos: unknown;
|
|
5409
|
+
rawPayload: unknown;
|
|
5410
|
+
}[];
|
|
5411
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
5412
|
+
instances: {
|
|
5413
|
+
sourceId?: string | null;
|
|
5414
|
+
number: string;
|
|
5415
|
+
formattedNumber: string;
|
|
5416
|
+
tribunal: {
|
|
5417
|
+
alias: string;
|
|
5418
|
+
code: string;
|
|
5419
|
+
};
|
|
5420
|
+
degree?: string | null;
|
|
5421
|
+
sigiloLevel?: number | null;
|
|
5422
|
+
/**
|
|
5423
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5424
|
+
* @enum {string}
|
|
5425
|
+
*/
|
|
5426
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5427
|
+
/** @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. */
|
|
5428
|
+
shareable?: boolean;
|
|
5429
|
+
class: {
|
|
5430
|
+
code?: number | null;
|
|
5431
|
+
name?: string | null;
|
|
5432
|
+
} | null;
|
|
5433
|
+
courtBody: {
|
|
5434
|
+
code?: number | null;
|
|
5435
|
+
name?: string | null;
|
|
5436
|
+
municipalityIbgeCode?: number | null;
|
|
5437
|
+
} | null;
|
|
5438
|
+
system?: {
|
|
5439
|
+
code?: number | null;
|
|
5440
|
+
name?: string | null;
|
|
5441
|
+
} | null;
|
|
5442
|
+
format?: {
|
|
5443
|
+
code?: number | null;
|
|
5444
|
+
name?: string | null;
|
|
5445
|
+
} | null;
|
|
5446
|
+
/** Format: date-time */
|
|
5447
|
+
filedAt?: string | null;
|
|
5448
|
+
/** Format: date-time */
|
|
5449
|
+
updatedAt?: string | null;
|
|
5450
|
+
/** Format: date-time */
|
|
5451
|
+
indexedAt?: string | null;
|
|
5452
|
+
subjects: {
|
|
5453
|
+
code?: number | null;
|
|
5454
|
+
name: string;
|
|
5455
|
+
}[];
|
|
5456
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
5457
|
+
primary: boolean;
|
|
5458
|
+
/**
|
|
5459
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
5460
|
+
* @enum {string}
|
|
5461
|
+
*/
|
|
5462
|
+
origin: "SOURCE" | "LAKE";
|
|
5463
|
+
/**
|
|
5464
|
+
* Format: date-time
|
|
5465
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
5466
|
+
*/
|
|
5467
|
+
fetchedAt: string;
|
|
5468
|
+
/**
|
|
5469
|
+
* Format: date-time
|
|
5470
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
5471
|
+
*/
|
|
5472
|
+
absentSince: string | null;
|
|
5473
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
5474
|
+
movementsCaptured: boolean;
|
|
5475
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
5476
|
+
movementCount: number | null;
|
|
5477
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
5478
|
+
movements: {
|
|
5479
|
+
externalMovementKey: string;
|
|
5480
|
+
codigo?: number | null;
|
|
5481
|
+
nome: string;
|
|
5482
|
+
/** Format: date-time */
|
|
5483
|
+
dataHora?: string | null;
|
|
5484
|
+
complementos: unknown;
|
|
5485
|
+
}[] | null;
|
|
5486
|
+
}[];
|
|
5487
|
+
};
|
|
5488
|
+
/**
|
|
5489
|
+
* Format: date-time
|
|
5490
|
+
* @description Quando a cópia foi buscada na fonte.
|
|
5491
|
+
*/
|
|
5492
|
+
sourceFetchedAt: string;
|
|
5493
|
+
/**
|
|
5494
|
+
* @description Por que a fonte não entregou nesta chamada.
|
|
5495
|
+
* @enum {string}
|
|
5496
|
+
*/
|
|
5497
|
+
cause: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
5498
|
+
};
|
|
5499
|
+
};
|
|
5500
|
+
meta: {
|
|
5501
|
+
/** @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. */
|
|
5502
|
+
requestId: string;
|
|
5503
|
+
credits?: number;
|
|
5504
|
+
cacheHit?: boolean;
|
|
5505
|
+
/** @description O rastro da chamada, o mesmo do evento que a consulta emite. */
|
|
5506
|
+
traceId?: string;
|
|
5507
|
+
} & {
|
|
5508
|
+
[key: string]: unknown;
|
|
5509
|
+
};
|
|
5510
|
+
};
|
|
5511
|
+
};
|
|
5512
|
+
};
|
|
5513
|
+
/** @description Resposta padrão */
|
|
5514
|
+
400: {
|
|
5515
|
+
headers: {
|
|
5516
|
+
[name: string]: unknown;
|
|
5517
|
+
};
|
|
5518
|
+
content: {
|
|
5519
|
+
"application/json": {
|
|
5520
|
+
error: {
|
|
5521
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5522
|
+
code: string;
|
|
5523
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5524
|
+
message: string;
|
|
5525
|
+
/** @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. */
|
|
5526
|
+
requestId: string;
|
|
5527
|
+
/**
|
|
5528
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5529
|
+
* @enum {string}
|
|
5530
|
+
*/
|
|
5531
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5532
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5533
|
+
retryable: boolean;
|
|
5534
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5535
|
+
upstreamStatus?: number;
|
|
5536
|
+
details: {
|
|
5537
|
+
[key: string]: unknown;
|
|
5538
|
+
};
|
|
5539
|
+
};
|
|
5540
|
+
};
|
|
5541
|
+
};
|
|
5542
|
+
};
|
|
5543
|
+
/** @description Resposta padrão */
|
|
5544
|
+
401: {
|
|
5545
|
+
headers: {
|
|
5546
|
+
[name: string]: unknown;
|
|
5547
|
+
};
|
|
5548
|
+
content: {
|
|
5549
|
+
"application/json": {
|
|
5550
|
+
error: {
|
|
5551
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5552
|
+
code: string;
|
|
5553
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5554
|
+
message: string;
|
|
5555
|
+
/** @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. */
|
|
5556
|
+
requestId: string;
|
|
5557
|
+
/**
|
|
5558
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5559
|
+
* @enum {string}
|
|
5560
|
+
*/
|
|
5561
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5562
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5563
|
+
retryable: boolean;
|
|
5564
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5565
|
+
upstreamStatus?: number;
|
|
5566
|
+
details: {
|
|
5567
|
+
[key: string]: unknown;
|
|
5568
|
+
};
|
|
5569
|
+
};
|
|
5570
|
+
};
|
|
5571
|
+
};
|
|
5572
|
+
};
|
|
5573
|
+
/** @description Resposta padrão */
|
|
5574
|
+
402: {
|
|
5575
|
+
headers: {
|
|
5576
|
+
[name: string]: unknown;
|
|
5577
|
+
};
|
|
5578
|
+
content: {
|
|
5579
|
+
"application/json": {
|
|
5580
|
+
error: {
|
|
5581
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5582
|
+
code: string;
|
|
5583
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5584
|
+
message: string;
|
|
5585
|
+
/** @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. */
|
|
5586
|
+
requestId: string;
|
|
5587
|
+
/**
|
|
5588
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5589
|
+
* @enum {string}
|
|
5590
|
+
*/
|
|
5591
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5592
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5593
|
+
retryable: boolean;
|
|
5594
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5595
|
+
upstreamStatus?: number;
|
|
5596
|
+
details: {
|
|
5597
|
+
[key: string]: unknown;
|
|
5598
|
+
};
|
|
5599
|
+
};
|
|
5600
|
+
};
|
|
5601
|
+
};
|
|
5602
|
+
};
|
|
5603
|
+
/** @description Resposta padrão */
|
|
5604
|
+
403: {
|
|
5605
|
+
headers: {
|
|
5606
|
+
[name: string]: unknown;
|
|
5607
|
+
};
|
|
5608
|
+
content: {
|
|
5609
|
+
"application/json": {
|
|
5610
|
+
error: {
|
|
5611
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5612
|
+
code: string;
|
|
5613
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5614
|
+
message: string;
|
|
5615
|
+
/** @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. */
|
|
5616
|
+
requestId: string;
|
|
5617
|
+
/**
|
|
5618
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5619
|
+
* @enum {string}
|
|
5620
|
+
*/
|
|
5621
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5622
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5623
|
+
retryable: boolean;
|
|
5624
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5625
|
+
upstreamStatus?: number;
|
|
5626
|
+
details: {
|
|
5627
|
+
[key: string]: unknown;
|
|
5628
|
+
};
|
|
5629
|
+
};
|
|
5630
|
+
};
|
|
5631
|
+
};
|
|
5632
|
+
};
|
|
5633
|
+
/** @description Resposta padrão */
|
|
5634
|
+
404: {
|
|
5635
|
+
headers: {
|
|
5636
|
+
[name: string]: unknown;
|
|
5637
|
+
};
|
|
5638
|
+
content: {
|
|
5639
|
+
"application/json": {
|
|
5640
|
+
error: {
|
|
5641
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5642
|
+
code: string;
|
|
5643
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5644
|
+
message: string;
|
|
5645
|
+
/** @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. */
|
|
5646
|
+
requestId: string;
|
|
5647
|
+
/**
|
|
5648
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5649
|
+
* @enum {string}
|
|
5650
|
+
*/
|
|
5651
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5652
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5653
|
+
retryable: boolean;
|
|
5654
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5655
|
+
upstreamStatus?: number;
|
|
5656
|
+
details: {
|
|
5657
|
+
[key: string]: unknown;
|
|
5658
|
+
};
|
|
5659
|
+
};
|
|
5660
|
+
};
|
|
5661
|
+
};
|
|
5662
|
+
};
|
|
5663
|
+
/** @description Resposta padrão */
|
|
5664
|
+
429: {
|
|
5665
|
+
headers: {
|
|
5666
|
+
[name: string]: unknown;
|
|
5667
|
+
};
|
|
5668
|
+
content: {
|
|
5669
|
+
"application/json": {
|
|
5670
|
+
error: {
|
|
5671
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5672
|
+
code: string;
|
|
5673
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5674
|
+
message: string;
|
|
5675
|
+
/** @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. */
|
|
5676
|
+
requestId: string;
|
|
5677
|
+
/**
|
|
5678
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5679
|
+
* @enum {string}
|
|
5680
|
+
*/
|
|
5681
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5682
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5683
|
+
retryable: boolean;
|
|
5684
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5685
|
+
upstreamStatus?: number;
|
|
5686
|
+
details: {
|
|
5687
|
+
[key: string]: unknown;
|
|
5688
|
+
};
|
|
5689
|
+
};
|
|
5690
|
+
};
|
|
5691
|
+
};
|
|
5692
|
+
};
|
|
5693
|
+
/** @description Resposta padrão */
|
|
5694
|
+
500: {
|
|
5695
|
+
headers: {
|
|
5696
|
+
[name: string]: unknown;
|
|
5697
|
+
};
|
|
5698
|
+
content: {
|
|
5699
|
+
"application/json": {
|
|
5700
|
+
error: {
|
|
5701
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
5702
|
+
code: string;
|
|
5703
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
5704
|
+
message: string;
|
|
5705
|
+
/** @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. */
|
|
5706
|
+
requestId: string;
|
|
5707
|
+
/**
|
|
5708
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
5709
|
+
* @enum {string}
|
|
5710
|
+
*/
|
|
5711
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5712
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
5713
|
+
retryable: boolean;
|
|
5714
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
5715
|
+
upstreamStatus?: number;
|
|
5716
|
+
details: {
|
|
5717
|
+
[key: string]: unknown;
|
|
5718
|
+
};
|
|
5719
|
+
};
|
|
5720
|
+
};
|
|
5721
|
+
};
|
|
5722
|
+
};
|
|
5723
|
+
};
|
|
5724
|
+
};
|
|
5725
|
+
getProcessLookup: {
|
|
5726
|
+
parameters: {
|
|
5727
|
+
query?: never;
|
|
5728
|
+
header?: {
|
|
5729
|
+
/** @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. */
|
|
5730
|
+
"x-request-id"?: string;
|
|
5731
|
+
/** @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. */
|
|
5732
|
+
"x-office-id"?: string;
|
|
5733
|
+
};
|
|
5734
|
+
path: {
|
|
5735
|
+
lookupId: string;
|
|
5736
|
+
};
|
|
5737
|
+
cookie?: never;
|
|
5738
|
+
};
|
|
5739
|
+
requestBody?: never;
|
|
5740
|
+
responses: {
|
|
5741
|
+
/** @description Resposta padrão */
|
|
5742
|
+
200: {
|
|
5743
|
+
headers: {
|
|
5744
|
+
[name: string]: unknown;
|
|
5745
|
+
};
|
|
5746
|
+
content: {
|
|
5747
|
+
"application/json": {
|
|
5748
|
+
data: {
|
|
5749
|
+
/** @description O id da consulta; nulo quando a leitura coube na espera e nenhuma consulta foi aberta. */
|
|
5750
|
+
lookupId: string | null;
|
|
5751
|
+
/** @enum {string} */
|
|
5752
|
+
status: "QUEUED" | "LEASED" | "SUCCEEDED" | "FAILED" | "CANCELED";
|
|
5753
|
+
/**
|
|
5754
|
+
* @description O que ler: `PROCESS`, a ficha do processo (a mesma de `GET /v1/processes/{processNumber}`), ou `SNAPSHOT`, o retrato com os movimentos (o de `GET /v1/processes/{processNumber}/snapshot`).
|
|
5755
|
+
* @enum {string}
|
|
5756
|
+
*/
|
|
5757
|
+
view: "PROCESS" | "SNAPSHOT";
|
|
5758
|
+
tribunalAlias: string;
|
|
5759
|
+
/** @description O número do processo, só os 20 dígitos. */
|
|
5760
|
+
processNumber: string;
|
|
5761
|
+
/** @description Onde a consulta é lida, sem nova cobrança; nulo sem consulta aberta. */
|
|
5762
|
+
pollUrl: string | null;
|
|
5763
|
+
/** @description A chamada reencontrou a consulta já aberta para a mesma conta, escritório, processo e visão, em vez de abrir outra. */
|
|
5764
|
+
deduped: boolean;
|
|
5765
|
+
/** @description Créditos retidos pela consulta: o máximo que a entrega cobra, só se o processo vier — a ficha que outra leitura trouxe ao acervo cobra menos. Enquanto isso, a retenção conta no saldo e no teto diário da chave que abriu a consulta. */
|
|
5766
|
+
creditsReserved: number;
|
|
5767
|
+
/** @description O que a mesma compra já cobrou fora da consulta: a cópia guardada entregue em `stale`. A entrega cobra o preço da leitura menos isto. */
|
|
5768
|
+
alreadyCharged: number;
|
|
5769
|
+
/** @description Idas à fonte até aqui, a leitura que abriu a consulta incluída. */
|
|
5770
|
+
attempts: number;
|
|
5771
|
+
/**
|
|
5772
|
+
* Format: date-time
|
|
5773
|
+
* @description Quando a próxima tentativa sai; nulo na consulta terminada e enquanto uma tentativa está em curso. A hora que já passou é a da tentativa esperando a vez na fila. Ler a consulta antes da hora futura devolve o mesmo estado.
|
|
5774
|
+
*/
|
|
5775
|
+
nextAttemptAt: string | null;
|
|
5776
|
+
/**
|
|
5777
|
+
* Format: date-time
|
|
5778
|
+
* @description Até quando a consulta tenta; depois, termina sem o processo e devolve a retenção. Nulo sem consulta aberta.
|
|
5779
|
+
*/
|
|
5780
|
+
giveUpAt: string | null;
|
|
5781
|
+
/** @description A última ida à fonte que não entregou: quando, e por quê — `UPSTREAM_TIMEOUT` (não respondeu dentro da espera), `UPSTREAM_UNAVAILABLE` (indisponível, ou respondeu com parte do índice sem o processo) ou `UPSTREAM_RATE_LIMITED` (pediu para esperar por volume). */
|
|
5782
|
+
lastAttempt: {
|
|
5783
|
+
/** Format: date-time */
|
|
5784
|
+
at: string;
|
|
5785
|
+
/** @enum {string} */
|
|
5786
|
+
code: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
5787
|
+
retryable: boolean;
|
|
5788
|
+
} | null;
|
|
5789
|
+
/**
|
|
5790
|
+
* @description Quem entregou: `SOURCE`, uma tentativa na fonte; `LAKE`, o acervo, que outra leitura atualizou depois de a consulta abrir; `DIRECT_READ`, uma leitura sua do mesmo processo, que entregou e cobrou antes — a consulta fecha sem cobrar. Nulo enquanto não houve entrega.
|
|
5791
|
+
* @enum {string|null}
|
|
5792
|
+
*/
|
|
5793
|
+
satisfiedBy: "SOURCE" | "LAKE" | "DIRECT_READ" | null;
|
|
5794
|
+
creditsCharged: number | null;
|
|
5795
|
+
creditsRefunded: number | null;
|
|
5796
|
+
/** @description Por que a consulta terminou sem o processo: o código da taxonomia de erros, como a leitura síncrona o daria. */
|
|
5797
|
+
error: {
|
|
5798
|
+
/** @enum {string} */
|
|
5799
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
5800
|
+
code: string;
|
|
5801
|
+
/** @description O texto público fixo do código, o mesmo em toda consulta. */
|
|
5802
|
+
message: string;
|
|
5803
|
+
retryable: boolean;
|
|
5804
|
+
upstreamStatus?: number;
|
|
5805
|
+
} | null;
|
|
5806
|
+
/** Format: date-time */
|
|
5807
|
+
createdAt: string;
|
|
5808
|
+
/** Format: date-time */
|
|
5809
|
+
finishedAt: string | null;
|
|
5810
|
+
/**
|
|
5811
|
+
* Format: date-time
|
|
5812
|
+
* @description Até quando o processo entregue é lido nesta consulta sem nova cobrança: 24 h depois da entrega.
|
|
5813
|
+
*/
|
|
5814
|
+
resultExpiresAt: string | null;
|
|
5815
|
+
/** @description O processo entregue já não é lido aqui: o prazo passou, ou o acervo já não sustenta a cópia. Uma leitura nova o traz. */
|
|
5816
|
+
resultExpired: boolean;
|
|
5817
|
+
/** @description A vigília que a conta já mantém sobre o processo: quando olhou pela última vez e quando olha de novo. Só para a chave que lê monitores (`MONITORS_READ`); nulo sem vigília. */
|
|
5818
|
+
monitor: {
|
|
5819
|
+
monitorId: string;
|
|
5820
|
+
/** Format: date-time */
|
|
5821
|
+
lastCheckedAt: string | null;
|
|
5822
|
+
/** Format: date-time */
|
|
5823
|
+
nextCheckAt: string | null;
|
|
5824
|
+
} | null;
|
|
5825
|
+
/** @description A ficha entregue, na visão `PROCESS`, enquanto o resultado vale, com as instâncias do número em `instances`, como na leitura direta. Lida da consulta, ela passa de novo pelo controle de confidencialidade. */
|
|
5826
|
+
process?: {
|
|
5827
|
+
sourceId?: string | null;
|
|
5828
|
+
number: string;
|
|
5829
|
+
formattedNumber: string;
|
|
5830
|
+
tribunal: {
|
|
5831
|
+
alias: string;
|
|
5832
|
+
code: string;
|
|
5833
|
+
};
|
|
5834
|
+
degree?: string | null;
|
|
5835
|
+
sigiloLevel?: number | null;
|
|
5836
|
+
/**
|
|
5837
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5838
|
+
* @enum {string}
|
|
5839
|
+
*/
|
|
5840
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5841
|
+
/** @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. */
|
|
5842
|
+
shareable?: boolean;
|
|
5843
|
+
class: {
|
|
5844
|
+
code?: number | null;
|
|
5845
|
+
name?: string | null;
|
|
5846
|
+
} | null;
|
|
5847
|
+
courtBody: {
|
|
5848
|
+
code?: number | null;
|
|
5849
|
+
name?: string | null;
|
|
5850
|
+
municipalityIbgeCode?: number | null;
|
|
5851
|
+
} | null;
|
|
5852
|
+
system?: {
|
|
5853
|
+
code?: number | null;
|
|
5854
|
+
name?: string | null;
|
|
5855
|
+
} | null;
|
|
5856
|
+
format?: {
|
|
5857
|
+
code?: number | null;
|
|
5858
|
+
name?: string | null;
|
|
5859
|
+
} | null;
|
|
5860
|
+
/** Format: date-time */
|
|
5861
|
+
filedAt?: string | null;
|
|
5862
|
+
/** Format: date-time */
|
|
5863
|
+
updatedAt?: string | null;
|
|
5864
|
+
/** Format: date-time */
|
|
5865
|
+
indexedAt?: string | null;
|
|
5866
|
+
subjects: {
|
|
5867
|
+
code?: number | null;
|
|
5868
|
+
name: string;
|
|
5869
|
+
}[];
|
|
5870
|
+
djen?: {
|
|
5871
|
+
publicationCount: number;
|
|
5872
|
+
/** Format: date-time */
|
|
5873
|
+
latestPublicationAt?: string | null;
|
|
5874
|
+
latestPublicationType?: string | null;
|
|
5875
|
+
latestPublicationExcerpt?: string | null;
|
|
5876
|
+
latestPublicationUrl?: string | null;
|
|
5877
|
+
} | null;
|
|
5878
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
5879
|
+
instances?: {
|
|
5880
|
+
sourceId?: string | null;
|
|
5881
|
+
number: string;
|
|
5882
|
+
formattedNumber: string;
|
|
5883
|
+
tribunal: {
|
|
5884
|
+
alias: string;
|
|
5885
|
+
code: string;
|
|
5886
|
+
};
|
|
5887
|
+
degree?: string | null;
|
|
5888
|
+
sigiloLevel?: number | null;
|
|
5889
|
+
/**
|
|
5890
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5891
|
+
* @enum {string}
|
|
5892
|
+
*/
|
|
5893
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5894
|
+
/** @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. */
|
|
5895
|
+
shareable?: boolean;
|
|
5896
|
+
class: {
|
|
5897
|
+
code?: number | null;
|
|
5898
|
+
name?: string | null;
|
|
5899
|
+
} | null;
|
|
5900
|
+
courtBody: {
|
|
5901
|
+
code?: number | null;
|
|
5902
|
+
name?: string | null;
|
|
5903
|
+
municipalityIbgeCode?: number | null;
|
|
5904
|
+
} | null;
|
|
5905
|
+
system?: {
|
|
5906
|
+
code?: number | null;
|
|
5907
|
+
name?: string | null;
|
|
5908
|
+
} | null;
|
|
5909
|
+
format?: {
|
|
5910
|
+
code?: number | null;
|
|
5911
|
+
name?: string | null;
|
|
5912
|
+
} | null;
|
|
5913
|
+
/** Format: date-time */
|
|
5914
|
+
filedAt?: string | null;
|
|
5915
|
+
/** Format: date-time */
|
|
5916
|
+
updatedAt?: string | null;
|
|
5917
|
+
/** Format: date-time */
|
|
5918
|
+
indexedAt?: string | null;
|
|
5919
|
+
subjects: {
|
|
5920
|
+
code?: number | null;
|
|
5921
|
+
name: string;
|
|
5922
|
+
}[];
|
|
5923
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
5924
|
+
primary: boolean;
|
|
5925
|
+
/**
|
|
5926
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
5927
|
+
* @enum {string}
|
|
5928
|
+
*/
|
|
5929
|
+
origin: "SOURCE" | "LAKE";
|
|
5930
|
+
/**
|
|
5931
|
+
* Format: date-time
|
|
5932
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
5933
|
+
*/
|
|
5934
|
+
fetchedAt: string;
|
|
5935
|
+
/**
|
|
5936
|
+
* Format: date-time
|
|
5937
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
5938
|
+
*/
|
|
5939
|
+
absentSince: string | null;
|
|
5940
|
+
}[];
|
|
5941
|
+
};
|
|
5942
|
+
/** @description O retrato entregue, na visão `SNAPSHOT`, enquanto o resultado vale: a instância principal no topo e cada instância do número em `instances`, como na leitura direta. Lido da consulta, ele é composto do que o acervo guarda da última captura de cada instância, e `sourcePayload` é nulo: o documento bruto da fonte não é guardado. */
|
|
5943
|
+
snapshot?: {
|
|
5944
|
+
process: {
|
|
5945
|
+
sourceId?: string | null;
|
|
5946
|
+
number: string;
|
|
5947
|
+
formattedNumber: string;
|
|
5948
|
+
tribunal: {
|
|
5949
|
+
alias: string;
|
|
5950
|
+
code: string;
|
|
5951
|
+
};
|
|
5952
|
+
degree?: string | null;
|
|
5953
|
+
sigiloLevel?: number | null;
|
|
5954
|
+
/**
|
|
5955
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
5956
|
+
* @enum {string}
|
|
5957
|
+
*/
|
|
5958
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
5959
|
+
/** @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. */
|
|
5960
|
+
shareable?: boolean;
|
|
5961
|
+
class: {
|
|
5962
|
+
code?: number | null;
|
|
5963
|
+
name?: string | null;
|
|
5964
|
+
} | null;
|
|
5965
|
+
courtBody: {
|
|
5966
|
+
code?: number | null;
|
|
5967
|
+
name?: string | null;
|
|
5968
|
+
municipalityIbgeCode?: number | null;
|
|
5969
|
+
} | null;
|
|
5970
|
+
system?: {
|
|
5971
|
+
code?: number | null;
|
|
5972
|
+
name?: string | null;
|
|
5973
|
+
} | null;
|
|
5974
|
+
format?: {
|
|
5975
|
+
code?: number | null;
|
|
5976
|
+
name?: string | null;
|
|
5977
|
+
} | null;
|
|
5978
|
+
/** Format: date-time */
|
|
5979
|
+
filedAt?: string | null;
|
|
5980
|
+
/** Format: date-time */
|
|
5981
|
+
updatedAt?: string | null;
|
|
5982
|
+
/** Format: date-time */
|
|
5983
|
+
indexedAt?: string | null;
|
|
5984
|
+
subjects: {
|
|
5985
|
+
code?: number | null;
|
|
5986
|
+
name: string;
|
|
5987
|
+
}[];
|
|
5988
|
+
djen?: {
|
|
5989
|
+
publicationCount: number;
|
|
5990
|
+
/** Format: date-time */
|
|
5991
|
+
latestPublicationAt?: string | null;
|
|
5992
|
+
latestPublicationType?: string | null;
|
|
5993
|
+
latestPublicationExcerpt?: string | null;
|
|
5994
|
+
latestPublicationUrl?: string | null;
|
|
5995
|
+
} | null;
|
|
5996
|
+
};
|
|
5997
|
+
sourcePayload: unknown;
|
|
5998
|
+
movements: {
|
|
5999
|
+
externalMovementKey: string;
|
|
6000
|
+
codigo?: number | null;
|
|
6001
|
+
nome: string;
|
|
6002
|
+
/** Format: date-time */
|
|
6003
|
+
dataHora?: string | null;
|
|
6004
|
+
complementos: unknown;
|
|
6005
|
+
rawPayload: unknown;
|
|
6006
|
+
}[];
|
|
6007
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
6008
|
+
instances: {
|
|
6009
|
+
sourceId?: string | null;
|
|
6010
|
+
number: string;
|
|
6011
|
+
formattedNumber: string;
|
|
6012
|
+
tribunal: {
|
|
6013
|
+
alias: string;
|
|
6014
|
+
code: string;
|
|
6015
|
+
};
|
|
6016
|
+
degree?: string | null;
|
|
6017
|
+
sigiloLevel?: number | null;
|
|
6018
|
+
/**
|
|
6019
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
6020
|
+
* @enum {string}
|
|
6021
|
+
*/
|
|
6022
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
6023
|
+
/** @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. */
|
|
6024
|
+
shareable?: boolean;
|
|
6025
|
+
class: {
|
|
6026
|
+
code?: number | null;
|
|
6027
|
+
name?: string | null;
|
|
6028
|
+
} | null;
|
|
6029
|
+
courtBody: {
|
|
6030
|
+
code?: number | null;
|
|
6031
|
+
name?: string | null;
|
|
6032
|
+
municipalityIbgeCode?: number | null;
|
|
6033
|
+
} | null;
|
|
6034
|
+
system?: {
|
|
6035
|
+
code?: number | null;
|
|
6036
|
+
name?: string | null;
|
|
6037
|
+
} | null;
|
|
6038
|
+
format?: {
|
|
6039
|
+
code?: number | null;
|
|
6040
|
+
name?: string | null;
|
|
6041
|
+
} | null;
|
|
6042
|
+
/** Format: date-time */
|
|
6043
|
+
filedAt?: string | null;
|
|
6044
|
+
/** Format: date-time */
|
|
6045
|
+
updatedAt?: string | null;
|
|
6046
|
+
/** Format: date-time */
|
|
6047
|
+
indexedAt?: string | null;
|
|
6048
|
+
subjects: {
|
|
6049
|
+
code?: number | null;
|
|
6050
|
+
name: string;
|
|
6051
|
+
}[];
|
|
6052
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
6053
|
+
primary: boolean;
|
|
6054
|
+
/**
|
|
6055
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
6056
|
+
* @enum {string}
|
|
6057
|
+
*/
|
|
6058
|
+
origin: "SOURCE" | "LAKE";
|
|
6059
|
+
/**
|
|
6060
|
+
* Format: date-time
|
|
6061
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
6062
|
+
*/
|
|
6063
|
+
fetchedAt: string;
|
|
6064
|
+
/**
|
|
6065
|
+
* Format: date-time
|
|
6066
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
6067
|
+
*/
|
|
6068
|
+
absentSince: string | null;
|
|
6069
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
6070
|
+
movementsCaptured: boolean;
|
|
6071
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
6072
|
+
movementCount: number | null;
|
|
6073
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
6074
|
+
movements: {
|
|
6075
|
+
externalMovementKey: string;
|
|
6076
|
+
codigo?: number | null;
|
|
6077
|
+
nome: string;
|
|
6078
|
+
/** Format: date-time */
|
|
6079
|
+
dataHora?: string | null;
|
|
6080
|
+
complementos: unknown;
|
|
6081
|
+
}[] | null;
|
|
6082
|
+
}[];
|
|
6083
|
+
};
|
|
6084
|
+
/** @description Presente só no 202 de uma chamada com `staleOnFailure: true`: a cópia que o acervo guarda, com a data, na visão pedida. Movimentos posteriores a essa data podem existir e não estão nela; é a versão atual que a consulta segue buscando. */
|
|
6085
|
+
stale?: {
|
|
6086
|
+
process?: {
|
|
6087
|
+
sourceId?: string | null;
|
|
6088
|
+
number: string;
|
|
6089
|
+
formattedNumber: string;
|
|
6090
|
+
tribunal: {
|
|
6091
|
+
alias: string;
|
|
6092
|
+
code: string;
|
|
6093
|
+
};
|
|
6094
|
+
degree?: string | null;
|
|
6095
|
+
sigiloLevel?: number | null;
|
|
6096
|
+
/**
|
|
6097
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
6098
|
+
* @enum {string}
|
|
6099
|
+
*/
|
|
6100
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
6101
|
+
/** @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. */
|
|
6102
|
+
shareable?: boolean;
|
|
6103
|
+
class: {
|
|
6104
|
+
code?: number | null;
|
|
6105
|
+
name?: string | null;
|
|
6106
|
+
} | null;
|
|
6107
|
+
courtBody: {
|
|
6108
|
+
code?: number | null;
|
|
6109
|
+
name?: string | null;
|
|
6110
|
+
municipalityIbgeCode?: number | null;
|
|
6111
|
+
} | null;
|
|
6112
|
+
system?: {
|
|
6113
|
+
code?: number | null;
|
|
6114
|
+
name?: string | null;
|
|
6115
|
+
} | null;
|
|
6116
|
+
format?: {
|
|
6117
|
+
code?: number | null;
|
|
6118
|
+
name?: string | null;
|
|
6119
|
+
} | null;
|
|
6120
|
+
/** Format: date-time */
|
|
6121
|
+
filedAt?: string | null;
|
|
6122
|
+
/** Format: date-time */
|
|
6123
|
+
updatedAt?: string | null;
|
|
6124
|
+
/** Format: date-time */
|
|
6125
|
+
indexedAt?: string | null;
|
|
6126
|
+
subjects: {
|
|
6127
|
+
code?: number | null;
|
|
6128
|
+
name: string;
|
|
6129
|
+
}[];
|
|
6130
|
+
djen?: {
|
|
6131
|
+
publicationCount: number;
|
|
6132
|
+
/** Format: date-time */
|
|
6133
|
+
latestPublicationAt?: string | null;
|
|
6134
|
+
latestPublicationType?: string | null;
|
|
6135
|
+
latestPublicationExcerpt?: string | null;
|
|
6136
|
+
latestPublicationUrl?: string | null;
|
|
6137
|
+
} | null;
|
|
6138
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor. */
|
|
6139
|
+
instances?: {
|
|
6140
|
+
sourceId?: string | null;
|
|
6141
|
+
number: string;
|
|
6142
|
+
formattedNumber: string;
|
|
6143
|
+
tribunal: {
|
|
6144
|
+
alias: string;
|
|
6145
|
+
code: string;
|
|
6146
|
+
};
|
|
6147
|
+
degree?: string | null;
|
|
6148
|
+
sigiloLevel?: number | null;
|
|
6149
|
+
/**
|
|
6150
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
6151
|
+
* @enum {string}
|
|
6152
|
+
*/
|
|
6153
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
6154
|
+
/** @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. */
|
|
6155
|
+
shareable?: boolean;
|
|
6156
|
+
class: {
|
|
6157
|
+
code?: number | null;
|
|
6158
|
+
name?: string | null;
|
|
6159
|
+
} | null;
|
|
6160
|
+
courtBody: {
|
|
6161
|
+
code?: number | null;
|
|
6162
|
+
name?: string | null;
|
|
6163
|
+
municipalityIbgeCode?: number | null;
|
|
6164
|
+
} | null;
|
|
6165
|
+
system?: {
|
|
6166
|
+
code?: number | null;
|
|
6167
|
+
name?: string | null;
|
|
6168
|
+
} | null;
|
|
6169
|
+
format?: {
|
|
6170
|
+
code?: number | null;
|
|
6171
|
+
name?: string | null;
|
|
6172
|
+
} | null;
|
|
6173
|
+
/** Format: date-time */
|
|
6174
|
+
filedAt?: string | null;
|
|
6175
|
+
/** Format: date-time */
|
|
6176
|
+
updatedAt?: string | null;
|
|
6177
|
+
/** Format: date-time */
|
|
6178
|
+
indexedAt?: string | null;
|
|
6179
|
+
subjects: {
|
|
6180
|
+
code?: number | null;
|
|
6181
|
+
name: string;
|
|
6182
|
+
}[];
|
|
6183
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
6184
|
+
primary: boolean;
|
|
6185
|
+
/**
|
|
6186
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
6187
|
+
* @enum {string}
|
|
6188
|
+
*/
|
|
6189
|
+
origin: "SOURCE" | "LAKE";
|
|
6190
|
+
/**
|
|
6191
|
+
* Format: date-time
|
|
6192
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
6193
|
+
*/
|
|
6194
|
+
fetchedAt: string;
|
|
6195
|
+
/**
|
|
6196
|
+
* Format: date-time
|
|
6197
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
6198
|
+
*/
|
|
6199
|
+
absentSince: string | null;
|
|
6200
|
+
}[];
|
|
6201
|
+
};
|
|
6202
|
+
snapshot?: {
|
|
6203
|
+
process: {
|
|
6204
|
+
sourceId?: string | null;
|
|
6205
|
+
number: string;
|
|
6206
|
+
formattedNumber: string;
|
|
6207
|
+
tribunal: {
|
|
6208
|
+
alias: string;
|
|
6209
|
+
code: string;
|
|
6210
|
+
};
|
|
6211
|
+
degree?: string | null;
|
|
6212
|
+
sigiloLevel?: number | null;
|
|
6213
|
+
/**
|
|
6214
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
6215
|
+
* @enum {string}
|
|
6216
|
+
*/
|
|
6217
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
6218
|
+
/** @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. */
|
|
6219
|
+
shareable?: boolean;
|
|
6220
|
+
class: {
|
|
6221
|
+
code?: number | null;
|
|
6222
|
+
name?: string | null;
|
|
6223
|
+
} | null;
|
|
6224
|
+
courtBody: {
|
|
6225
|
+
code?: number | null;
|
|
6226
|
+
name?: string | null;
|
|
6227
|
+
municipalityIbgeCode?: number | null;
|
|
6228
|
+
} | null;
|
|
6229
|
+
system?: {
|
|
6230
|
+
code?: number | null;
|
|
6231
|
+
name?: string | null;
|
|
6232
|
+
} | null;
|
|
6233
|
+
format?: {
|
|
6234
|
+
code?: number | null;
|
|
6235
|
+
name?: string | null;
|
|
6236
|
+
} | null;
|
|
6237
|
+
/** Format: date-time */
|
|
6238
|
+
filedAt?: string | null;
|
|
6239
|
+
/** Format: date-time */
|
|
6240
|
+
updatedAt?: string | null;
|
|
6241
|
+
/** Format: date-time */
|
|
6242
|
+
indexedAt?: string | null;
|
|
6243
|
+
subjects: {
|
|
6244
|
+
code?: number | null;
|
|
6245
|
+
name: string;
|
|
6246
|
+
}[];
|
|
6247
|
+
djen?: {
|
|
6248
|
+
publicationCount: number;
|
|
6249
|
+
/** Format: date-time */
|
|
6250
|
+
latestPublicationAt?: string | null;
|
|
6251
|
+
latestPublicationType?: string | null;
|
|
6252
|
+
latestPublicationExcerpt?: string | null;
|
|
6253
|
+
latestPublicationUrl?: string | null;
|
|
6254
|
+
} | null;
|
|
6255
|
+
};
|
|
6256
|
+
sourcePayload: unknown;
|
|
6257
|
+
movements: {
|
|
6258
|
+
externalMovementKey: string;
|
|
6259
|
+
codigo?: number | null;
|
|
6260
|
+
nome: string;
|
|
6261
|
+
/** Format: date-time */
|
|
6262
|
+
dataHora?: string | null;
|
|
6263
|
+
complementos: unknown;
|
|
6264
|
+
rawPayload: unknown;
|
|
6265
|
+
}[];
|
|
6266
|
+
/** @description Todos os documentos que o motor guarda deste número — em geral um por instância (1º grau, 2º grau, turma recursal…), às vezes dois do mesmo grau —, a principal primeiro, depois os que a fonte ainda traz e por fim os que ela deixou de trazer. O topo da resposta é a principal. Cada um leva a classificação do número inteiro: basta um documento em segredo de justiça para todos saírem marcados. `process` e `movements` são os da principal, e cada instância traz os movimentos dela. */
|
|
6267
|
+
instances: {
|
|
6268
|
+
sourceId?: string | null;
|
|
6269
|
+
number: string;
|
|
6270
|
+
formattedNumber: string;
|
|
6271
|
+
tribunal: {
|
|
6272
|
+
alias: string;
|
|
6273
|
+
code: string;
|
|
6274
|
+
};
|
|
6275
|
+
degree?: string | null;
|
|
6276
|
+
sigiloLevel?: number | null;
|
|
6277
|
+
/**
|
|
6278
|
+
* @description Classificação do motor: PUBLIC ou SEGREDO_DE_JUSTICA. Linha em segredo nunca deve ser exibida a público.
|
|
6279
|
+
* @enum {string}
|
|
6280
|
+
*/
|
|
6281
|
+
confidentiality?: "PUBLIC" | "SEGREDO_DE_JUSTICA";
|
|
6282
|
+
/** @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. */
|
|
6283
|
+
shareable?: boolean;
|
|
6284
|
+
class: {
|
|
6285
|
+
code?: number | null;
|
|
6286
|
+
name?: string | null;
|
|
6287
|
+
} | null;
|
|
6288
|
+
courtBody: {
|
|
6289
|
+
code?: number | null;
|
|
6290
|
+
name?: string | null;
|
|
6291
|
+
municipalityIbgeCode?: number | null;
|
|
6292
|
+
} | null;
|
|
6293
|
+
system?: {
|
|
6294
|
+
code?: number | null;
|
|
6295
|
+
name?: string | null;
|
|
6296
|
+
} | null;
|
|
6297
|
+
format?: {
|
|
6298
|
+
code?: number | null;
|
|
6299
|
+
name?: string | null;
|
|
6300
|
+
} | null;
|
|
6301
|
+
/** Format: date-time */
|
|
6302
|
+
filedAt?: string | null;
|
|
6303
|
+
/** Format: date-time */
|
|
6304
|
+
updatedAt?: string | null;
|
|
6305
|
+
/** Format: date-time */
|
|
6306
|
+
indexedAt?: string | null;
|
|
6307
|
+
subjects: {
|
|
6308
|
+
code?: number | null;
|
|
6309
|
+
name: string;
|
|
6310
|
+
}[];
|
|
6311
|
+
/** @description A instância principal do número, a que o topo da resposta serve. É a mesma de uma leitura para a outra e só muda quando uma resposta completa da fonte pelo número deixa de trazê-la. */
|
|
6312
|
+
primary: boolean;
|
|
6313
|
+
/**
|
|
6314
|
+
* @description `SOURCE`: veio da fonte nesta resposta. `LAKE`: servida do que o acervo guarda — a fonte não a trouxe nesta resposta, ou a resposta inteira saiu do acervo.
|
|
6315
|
+
* @enum {string}
|
|
6316
|
+
*/
|
|
6317
|
+
origin: "SOURCE" | "LAKE";
|
|
6318
|
+
/**
|
|
6319
|
+
* Format: date-time
|
|
6320
|
+
* @description Quando os dados desta instância foram buscados na fonte. No retrato, com os movimentos servidos do acervo, é a data da captura deles.
|
|
6321
|
+
*/
|
|
6322
|
+
fetchedAt: string;
|
|
6323
|
+
/**
|
|
6324
|
+
* Format: date-time
|
|
6325
|
+
* @description Desde quando a resposta completa da fonte pelo número vem sem este documento; nulo enquanto ela o traz.
|
|
6326
|
+
*/
|
|
6327
|
+
absentSince: string | null;
|
|
6328
|
+
/** @description Se o motor guarda os movimentos desta instância. Falso quando eles nunca foram capturados — o documento só veio numa ficha ou numa busca — ou quando o acervo já não guarda algum deles, e aí `movements` e `movementCount` são nulos. */
|
|
6329
|
+
movementsCaptured: boolean;
|
|
6330
|
+
/** @description Quantos movimentos a última captura desta instância trouxe; nulo quando eles nunca foram capturados. */
|
|
6331
|
+
movementCount: number | null;
|
|
6332
|
+
/** @description Os movimentos da última captura desta instância, do mais recente ao mais antigo, sem o payload bruto da fonte; nulo quando eles nunca foram capturados. */
|
|
6333
|
+
movements: {
|
|
6334
|
+
externalMovementKey: string;
|
|
6335
|
+
codigo?: number | null;
|
|
6336
|
+
nome: string;
|
|
6337
|
+
/** Format: date-time */
|
|
6338
|
+
dataHora?: string | null;
|
|
6339
|
+
complementos: unknown;
|
|
6340
|
+
}[] | null;
|
|
6341
|
+
}[];
|
|
6342
|
+
};
|
|
6343
|
+
/**
|
|
6344
|
+
* Format: date-time
|
|
6345
|
+
* @description Quando a cópia foi buscada na fonte.
|
|
6346
|
+
*/
|
|
6347
|
+
sourceFetchedAt: string;
|
|
6348
|
+
/**
|
|
6349
|
+
* @description Por que a fonte não entregou nesta chamada.
|
|
6350
|
+
* @enum {string}
|
|
6351
|
+
*/
|
|
6352
|
+
cause: "UPSTREAM_TIMEOUT" | "UPSTREAM_UNAVAILABLE" | "UPSTREAM_RATE_LIMITED";
|
|
6353
|
+
};
|
|
6354
|
+
};
|
|
6355
|
+
meta: {
|
|
6356
|
+
/** @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. */
|
|
6357
|
+
requestId: string;
|
|
6358
|
+
credits?: number;
|
|
6359
|
+
cacheHit?: boolean;
|
|
6360
|
+
/**
|
|
6361
|
+
* Format: date-time
|
|
6362
|
+
* @description Quando os dados servidos foram buscados na fonte: agora, se ela respondeu; antes, se vieram do acervo. No retrato socorrido pelo acervo, é a data da captura dos movimentos servidos. Ausente na ficha que o controle de confidencialidade entrega retida, sem o teor.
|
|
6363
|
+
*/
|
|
6364
|
+
sourceFetchedAt?: string;
|
|
6365
|
+
} & {
|
|
6366
|
+
[key: string]: unknown;
|
|
6367
|
+
};
|
|
6368
|
+
};
|
|
6369
|
+
};
|
|
6370
|
+
};
|
|
6371
|
+
/** @description Resposta padrão */
|
|
6372
|
+
400: {
|
|
6373
|
+
headers: {
|
|
6374
|
+
[name: string]: unknown;
|
|
6375
|
+
};
|
|
6376
|
+
content: {
|
|
6377
|
+
"application/json": {
|
|
6378
|
+
error: {
|
|
6379
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6380
|
+
code: string;
|
|
6381
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6382
|
+
message: string;
|
|
6383
|
+
/** @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. */
|
|
6384
|
+
requestId: string;
|
|
6385
|
+
/**
|
|
6386
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6387
|
+
* @enum {string}
|
|
6388
|
+
*/
|
|
6389
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6390
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6391
|
+
retryable: boolean;
|
|
6392
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6393
|
+
upstreamStatus?: number;
|
|
6394
|
+
details: {
|
|
6395
|
+
[key: string]: unknown;
|
|
6396
|
+
};
|
|
6397
|
+
};
|
|
6398
|
+
};
|
|
6399
|
+
};
|
|
6400
|
+
};
|
|
6401
|
+
/** @description Resposta padrão */
|
|
6402
|
+
401: {
|
|
6403
|
+
headers: {
|
|
6404
|
+
[name: string]: unknown;
|
|
6405
|
+
};
|
|
6406
|
+
content: {
|
|
6407
|
+
"application/json": {
|
|
6408
|
+
error: {
|
|
6409
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6410
|
+
code: string;
|
|
6411
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6412
|
+
message: string;
|
|
6413
|
+
/** @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. */
|
|
6414
|
+
requestId: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6417
|
+
* @enum {string}
|
|
6418
|
+
*/
|
|
6419
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6420
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6421
|
+
retryable: boolean;
|
|
6422
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6423
|
+
upstreamStatus?: number;
|
|
6424
|
+
details: {
|
|
6425
|
+
[key: string]: unknown;
|
|
6426
|
+
};
|
|
6427
|
+
};
|
|
6428
|
+
};
|
|
6429
|
+
};
|
|
6430
|
+
};
|
|
6431
|
+
/** @description Resposta padrão */
|
|
6432
|
+
402: {
|
|
6433
|
+
headers: {
|
|
6434
|
+
[name: string]: unknown;
|
|
6435
|
+
};
|
|
6436
|
+
content: {
|
|
6437
|
+
"application/json": {
|
|
6438
|
+
error: {
|
|
6439
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6440
|
+
code: string;
|
|
6441
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6442
|
+
message: string;
|
|
6443
|
+
/** @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. */
|
|
6444
|
+
requestId: string;
|
|
6445
|
+
/**
|
|
6446
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6447
|
+
* @enum {string}
|
|
6448
|
+
*/
|
|
6449
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6450
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6451
|
+
retryable: boolean;
|
|
6452
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6453
|
+
upstreamStatus?: number;
|
|
6454
|
+
details: {
|
|
6455
|
+
[key: string]: unknown;
|
|
6456
|
+
};
|
|
6457
|
+
};
|
|
6458
|
+
};
|
|
6459
|
+
};
|
|
6460
|
+
};
|
|
6461
|
+
/** @description Resposta padrão */
|
|
6462
|
+
403: {
|
|
6463
|
+
headers: {
|
|
6464
|
+
[name: string]: unknown;
|
|
6465
|
+
};
|
|
6466
|
+
content: {
|
|
6467
|
+
"application/json": {
|
|
6468
|
+
error: {
|
|
6469
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6470
|
+
code: string;
|
|
6471
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6472
|
+
message: string;
|
|
6473
|
+
/** @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. */
|
|
6474
|
+
requestId: string;
|
|
6475
|
+
/**
|
|
6476
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6477
|
+
* @enum {string}
|
|
6478
|
+
*/
|
|
6479
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6480
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6481
|
+
retryable: boolean;
|
|
6482
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6483
|
+
upstreamStatus?: number;
|
|
6484
|
+
details: {
|
|
6485
|
+
[key: string]: unknown;
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
};
|
|
6489
|
+
};
|
|
6490
|
+
};
|
|
6491
|
+
/** @description Resposta padrão */
|
|
6492
|
+
404: {
|
|
6493
|
+
headers: {
|
|
6494
|
+
[name: string]: unknown;
|
|
6495
|
+
};
|
|
6496
|
+
content: {
|
|
6497
|
+
"application/json": {
|
|
6498
|
+
error: {
|
|
6499
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6500
|
+
code: string;
|
|
6501
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6502
|
+
message: string;
|
|
6503
|
+
/** @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. */
|
|
6504
|
+
requestId: string;
|
|
6505
|
+
/**
|
|
6506
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6507
|
+
* @enum {string}
|
|
6508
|
+
*/
|
|
6509
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6510
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6511
|
+
retryable: boolean;
|
|
6512
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6513
|
+
upstreamStatus?: number;
|
|
6514
|
+
details: {
|
|
6515
|
+
[key: string]: unknown;
|
|
6516
|
+
};
|
|
6517
|
+
};
|
|
6518
|
+
};
|
|
6519
|
+
};
|
|
6520
|
+
};
|
|
6521
|
+
/** @description Resposta padrão */
|
|
6522
|
+
429: {
|
|
6523
|
+
headers: {
|
|
6524
|
+
[name: string]: unknown;
|
|
6525
|
+
};
|
|
6526
|
+
content: {
|
|
6527
|
+
"application/json": {
|
|
6528
|
+
error: {
|
|
6529
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6530
|
+
code: string;
|
|
6531
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6532
|
+
message: string;
|
|
6533
|
+
/** @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. */
|
|
6534
|
+
requestId: string;
|
|
6535
|
+
/**
|
|
6536
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6537
|
+
* @enum {string}
|
|
6538
|
+
*/
|
|
6539
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6540
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6541
|
+
retryable: boolean;
|
|
6542
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6543
|
+
upstreamStatus?: number;
|
|
6544
|
+
details: {
|
|
6545
|
+
[key: string]: unknown;
|
|
6546
|
+
};
|
|
6547
|
+
};
|
|
6548
|
+
};
|
|
6549
|
+
};
|
|
6550
|
+
};
|
|
6551
|
+
/** @description Resposta padrão */
|
|
6552
|
+
500: {
|
|
6553
|
+
headers: {
|
|
6554
|
+
[name: string]: unknown;
|
|
6555
|
+
};
|
|
6556
|
+
content: {
|
|
6557
|
+
"application/json": {
|
|
6558
|
+
error: {
|
|
6559
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6560
|
+
code: string;
|
|
6561
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6562
|
+
message: string;
|
|
6563
|
+
/** @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. */
|
|
6564
|
+
requestId: string;
|
|
6565
|
+
/**
|
|
6566
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6567
|
+
* @enum {string}
|
|
6568
|
+
*/
|
|
6569
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6570
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6571
|
+
retryable: boolean;
|
|
6572
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6573
|
+
upstreamStatus?: number;
|
|
6574
|
+
details: {
|
|
6575
|
+
[key: string]: unknown;
|
|
6576
|
+
};
|
|
6577
|
+
};
|
|
6578
|
+
};
|
|
6579
|
+
};
|
|
6580
|
+
};
|
|
6581
|
+
};
|
|
6582
|
+
};
|
|
6583
|
+
cancelProcessLookup: {
|
|
6584
|
+
parameters: {
|
|
6585
|
+
query?: never;
|
|
6586
|
+
header?: {
|
|
6587
|
+
/** @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. */
|
|
6588
|
+
"x-request-id"?: string;
|
|
6589
|
+
/** @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. */
|
|
6590
|
+
"x-office-id"?: string;
|
|
6591
|
+
};
|
|
6592
|
+
path: {
|
|
6593
|
+
lookupId: string;
|
|
6594
|
+
};
|
|
6595
|
+
cookie?: never;
|
|
6596
|
+
};
|
|
6597
|
+
requestBody?: never;
|
|
6598
|
+
responses: {
|
|
6599
|
+
/** @description Resposta padrão */
|
|
6600
|
+
200: {
|
|
6601
|
+
headers: {
|
|
6602
|
+
[name: string]: unknown;
|
|
6603
|
+
};
|
|
6604
|
+
content: {
|
|
6605
|
+
"application/json": {
|
|
6606
|
+
data: {
|
|
6607
|
+
lookupId: string;
|
|
6608
|
+
/** @enum {boolean} */
|
|
6609
|
+
canceled: true;
|
|
6610
|
+
refunded: boolean;
|
|
6611
|
+
};
|
|
6612
|
+
meta: {
|
|
6613
|
+
/** @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. */
|
|
6614
|
+
requestId: string;
|
|
6615
|
+
credits?: number;
|
|
6616
|
+
cacheHit?: boolean;
|
|
6617
|
+
} & {
|
|
6618
|
+
[key: string]: unknown;
|
|
6619
|
+
};
|
|
6620
|
+
};
|
|
6621
|
+
};
|
|
6622
|
+
};
|
|
6623
|
+
/** @description Resposta padrão */
|
|
6624
|
+
400: {
|
|
6625
|
+
headers: {
|
|
6626
|
+
[name: string]: unknown;
|
|
6627
|
+
};
|
|
6628
|
+
content: {
|
|
6629
|
+
"application/json": {
|
|
6630
|
+
error: {
|
|
6631
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6632
|
+
code: string;
|
|
6633
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6634
|
+
message: string;
|
|
6635
|
+
/** @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. */
|
|
6636
|
+
requestId: string;
|
|
6637
|
+
/**
|
|
6638
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6639
|
+
* @enum {string}
|
|
6640
|
+
*/
|
|
6641
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6642
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6643
|
+
retryable: boolean;
|
|
6644
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6645
|
+
upstreamStatus?: number;
|
|
6646
|
+
details: {
|
|
6647
|
+
[key: string]: unknown;
|
|
6648
|
+
};
|
|
6649
|
+
};
|
|
6650
|
+
};
|
|
6651
|
+
};
|
|
6652
|
+
};
|
|
6653
|
+
/** @description Resposta padrão */
|
|
6654
|
+
401: {
|
|
6655
|
+
headers: {
|
|
6656
|
+
[name: string]: unknown;
|
|
6657
|
+
};
|
|
6658
|
+
content: {
|
|
6659
|
+
"application/json": {
|
|
6660
|
+
error: {
|
|
6661
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6662
|
+
code: string;
|
|
6663
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6664
|
+
message: string;
|
|
6665
|
+
/** @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. */
|
|
6666
|
+
requestId: string;
|
|
6667
|
+
/**
|
|
6668
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6669
|
+
* @enum {string}
|
|
6670
|
+
*/
|
|
6671
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6672
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6673
|
+
retryable: boolean;
|
|
6674
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6675
|
+
upstreamStatus?: number;
|
|
6676
|
+
details: {
|
|
6677
|
+
[key: string]: unknown;
|
|
6678
|
+
};
|
|
6679
|
+
};
|
|
6680
|
+
};
|
|
6681
|
+
};
|
|
6682
|
+
};
|
|
6683
|
+
/** @description Resposta padrão */
|
|
6684
|
+
402: {
|
|
6685
|
+
headers: {
|
|
6686
|
+
[name: string]: unknown;
|
|
6687
|
+
};
|
|
6688
|
+
content: {
|
|
6689
|
+
"application/json": {
|
|
6690
|
+
error: {
|
|
6691
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6692
|
+
code: string;
|
|
6693
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6694
|
+
message: string;
|
|
6695
|
+
/** @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. */
|
|
6696
|
+
requestId: string;
|
|
6697
|
+
/**
|
|
6698
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6699
|
+
* @enum {string}
|
|
6700
|
+
*/
|
|
6701
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6702
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6703
|
+
retryable: boolean;
|
|
6704
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6705
|
+
upstreamStatus?: number;
|
|
6706
|
+
details: {
|
|
6707
|
+
[key: string]: unknown;
|
|
6708
|
+
};
|
|
6709
|
+
};
|
|
6710
|
+
};
|
|
6711
|
+
};
|
|
6712
|
+
};
|
|
6713
|
+
/** @description Resposta padrão */
|
|
6714
|
+
403: {
|
|
6715
|
+
headers: {
|
|
6716
|
+
[name: string]: unknown;
|
|
6717
|
+
};
|
|
6718
|
+
content: {
|
|
6719
|
+
"application/json": {
|
|
6720
|
+
error: {
|
|
6721
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6722
|
+
code: string;
|
|
6723
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6724
|
+
message: string;
|
|
6725
|
+
/** @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. */
|
|
6726
|
+
requestId: string;
|
|
6727
|
+
/**
|
|
6728
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6729
|
+
* @enum {string}
|
|
6730
|
+
*/
|
|
6731
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6732
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6733
|
+
retryable: boolean;
|
|
6734
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6735
|
+
upstreamStatus?: number;
|
|
6736
|
+
details: {
|
|
6737
|
+
[key: string]: unknown;
|
|
6738
|
+
};
|
|
6739
|
+
};
|
|
6740
|
+
};
|
|
6741
|
+
};
|
|
6742
|
+
};
|
|
6743
|
+
/** @description Resposta padrão */
|
|
6744
|
+
404: {
|
|
6745
|
+
headers: {
|
|
6746
|
+
[name: string]: unknown;
|
|
6747
|
+
};
|
|
6748
|
+
content: {
|
|
6749
|
+
"application/json": {
|
|
6750
|
+
error: {
|
|
6751
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6752
|
+
code: string;
|
|
6753
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6754
|
+
message: string;
|
|
6755
|
+
/** @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. */
|
|
6756
|
+
requestId: string;
|
|
6757
|
+
/**
|
|
6758
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6759
|
+
* @enum {string}
|
|
6760
|
+
*/
|
|
6761
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6762
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6763
|
+
retryable: boolean;
|
|
6764
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6765
|
+
upstreamStatus?: number;
|
|
6766
|
+
details: {
|
|
6767
|
+
[key: string]: unknown;
|
|
6768
|
+
};
|
|
6769
|
+
};
|
|
6770
|
+
};
|
|
6771
|
+
};
|
|
6772
|
+
};
|
|
6773
|
+
/** @description Resposta padrão */
|
|
6774
|
+
409: {
|
|
6775
|
+
headers: {
|
|
6776
|
+
[name: string]: unknown;
|
|
6777
|
+
};
|
|
6778
|
+
content: {
|
|
6779
|
+
"application/json": {
|
|
6780
|
+
error: {
|
|
6781
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6782
|
+
code: string;
|
|
6783
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6784
|
+
message: string;
|
|
6785
|
+
/** @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. */
|
|
6786
|
+
requestId: string;
|
|
6787
|
+
/**
|
|
6788
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6789
|
+
* @enum {string}
|
|
6790
|
+
*/
|
|
6791
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6792
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6793
|
+
retryable: boolean;
|
|
6794
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6795
|
+
upstreamStatus?: number;
|
|
6796
|
+
details: {
|
|
6797
|
+
[key: string]: unknown;
|
|
6798
|
+
};
|
|
6799
|
+
};
|
|
6800
|
+
};
|
|
6801
|
+
};
|
|
6802
|
+
};
|
|
6803
|
+
/** @description Resposta padrão */
|
|
6804
|
+
429: {
|
|
6805
|
+
headers: {
|
|
6806
|
+
[name: string]: unknown;
|
|
6807
|
+
};
|
|
6808
|
+
content: {
|
|
6809
|
+
"application/json": {
|
|
6810
|
+
error: {
|
|
6811
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6812
|
+
code: string;
|
|
6813
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6814
|
+
message: string;
|
|
6815
|
+
/** @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. */
|
|
6816
|
+
requestId: string;
|
|
6817
|
+
/**
|
|
6818
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6819
|
+
* @enum {string}
|
|
6820
|
+
*/
|
|
6821
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6822
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6823
|
+
retryable: boolean;
|
|
6824
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6825
|
+
upstreamStatus?: number;
|
|
6826
|
+
details: {
|
|
6827
|
+
[key: string]: unknown;
|
|
6828
|
+
};
|
|
6829
|
+
};
|
|
6830
|
+
};
|
|
6831
|
+
};
|
|
6832
|
+
};
|
|
6833
|
+
/** @description Resposta padrão */
|
|
6834
|
+
500: {
|
|
6835
|
+
headers: {
|
|
6836
|
+
[name: string]: unknown;
|
|
6837
|
+
};
|
|
6838
|
+
content: {
|
|
6839
|
+
"application/json": {
|
|
6840
|
+
error: {
|
|
6841
|
+
/** @description Código estável da taxonomia (VALIDATION_ERROR, QUOTA_EXCEEDED, UPSTREAM_TIMEOUT…). É por ele que se programa, não pela mensagem. */
|
|
6842
|
+
code: string;
|
|
6843
|
+
/** @description Descrição legível, sujeita a mudança. */
|
|
6844
|
+
message: string;
|
|
6845
|
+
/** @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. */
|
|
6846
|
+
requestId: string;
|
|
6847
|
+
/**
|
|
6848
|
+
* @description Classificação da falha. TERMINAL não melhora com nova tentativa; RETRYABLE sim.
|
|
6849
|
+
* @enum {string}
|
|
6850
|
+
*/
|
|
6851
|
+
class: "RETRYABLE" | "TERMINAL";
|
|
6852
|
+
/** @description Atalho booleano de `class`, para quem só precisa decidir se repete. */
|
|
6853
|
+
retryable: boolean;
|
|
6854
|
+
/** @description Status HTTP real devolvido pela fonte externa, quando a falha veio dela. Preservado sem tradução. */
|
|
6855
|
+
upstreamStatus?: number;
|
|
6856
|
+
details: {
|
|
6857
|
+
[key: string]: unknown;
|
|
6858
|
+
};
|
|
6859
|
+
};
|
|
6860
|
+
};
|
|
6861
|
+
};
|
|
6862
|
+
};
|
|
6863
|
+
};
|
|
6864
|
+
};
|
|
3827
6865
|
listMonitors: {
|
|
3828
6866
|
parameters: {
|
|
3829
6867
|
query?: {
|
|
@@ -12093,7 +15131,7 @@ export interface operations {
|
|
|
12093
15131
|
windowDays: number;
|
|
12094
15132
|
items: ({
|
|
12095
15133
|
/** @enum {string} */
|
|
12096
|
-
type: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
15134
|
+
type: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
12097
15135
|
/** @enum {string} */
|
|
12098
15136
|
class: "DATA" | "OPERATIONAL";
|
|
12099
15137
|
count: number;
|
|
@@ -12104,7 +15142,7 @@ export interface operations {
|
|
|
12104
15142
|
})[];
|
|
12105
15143
|
dismissed: ({
|
|
12106
15144
|
/** @enum {string} */
|
|
12107
|
-
type: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
15145
|
+
type: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
12108
15146
|
/** Format: date-time */
|
|
12109
15147
|
dismissedAt: string;
|
|
12110
15148
|
} & {
|
|
@@ -12309,7 +15347,7 @@ export interface operations {
|
|
|
12309
15347
|
query?: {
|
|
12310
15348
|
cursor?: string;
|
|
12311
15349
|
limit?: number;
|
|
12312
|
-
type?: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
15350
|
+
type?: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
12313
15351
|
monitorId?: string;
|
|
12314
15352
|
since?: unknown;
|
|
12315
15353
|
until?: unknown;
|
|
@@ -13062,7 +16100,7 @@ export interface operations {
|
|
|
13062
16100
|
/** Format: uri */
|
|
13063
16101
|
url: string;
|
|
13064
16102
|
description?: string;
|
|
13065
|
-
eventTypes: ("PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE")[];
|
|
16103
|
+
eventTypes: ("PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE")[];
|
|
13066
16104
|
/** @default true */
|
|
13067
16105
|
isActive?: boolean;
|
|
13068
16106
|
};
|
|
@@ -13537,7 +16575,7 @@ export interface operations {
|
|
|
13537
16575
|
/** Format: uri */
|
|
13538
16576
|
url?: string;
|
|
13539
16577
|
description?: string;
|
|
13540
|
-
eventTypes?: ("PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE")[];
|
|
16578
|
+
eventTypes?: ("PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE")[];
|
|
13541
16579
|
isActive?: boolean;
|
|
13542
16580
|
};
|
|
13543
16581
|
};
|
|
@@ -14230,7 +17268,7 @@ export interface operations {
|
|
|
14230
17268
|
from: unknown;
|
|
14231
17269
|
to?: unknown;
|
|
14232
17270
|
/** @enum {string} */
|
|
14233
|
-
type?: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
17271
|
+
type?: "PROCESS_MOVEMENT_CREATED" | "PROCESS_INSTANCE_DISCOVERED" | "PUBLICATION_CREATED" | "MONITOR_SYNC_SUCCEEDED" | "MONITOR_SYNC_FAILED" | "SEARCH_JOB_COMPLETED" | "PUBLICATION_TEXT_ALERT_MATCHED" | "PUBLICATION_HARVEST_COMPLETED" | "PROCESS_LOOKUP_COMPLETED" | "QUOTA_LOW" | "PERIOD_ENDING" | "SUBSCRIPTION_PAST_DUE";
|
|
14234
17272
|
/** @default false */
|
|
14235
17273
|
includeDelivered?: boolean;
|
|
14236
17274
|
};
|