@lexnode/legal-data-sdk 1.28.0 → 1.29.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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/schema.d.ts +6 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexnode/legal-data-sdk",
3
- "version": "1.28.0",
3
+ "version": "1.29.0",
4
4
  "description": "Cliente TypeScript do LexNode, o motor de dados jur\u00eddicos do Brasil: transporte tipado, erros classificados, verifica\u00e7\u00e3o de webhook e os tipos gerados do contrato OpenAPI.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://www.lexnode.com.br/docs",
package/schema.d.ts CHANGED
@@ -641,7 +641,7 @@ export interface paths {
641
641
  };
642
642
  /**
643
643
  * Consultar a cobertura do corpus indexado
644
- * @description Cobertura agregada do corpus de jurisprudência indexado localmente: documentos indexáveis por fonte × tribunal × mês (a mesma agregação congelada no snapshot de cobertura de cada busca textual), combinada com o estado das fatias de colheita do diário oficial — grupo com fatia pendente reporta `PARTIAL` (o conjunto indexado ainda pode crescer), grupo totalmente colhido/indexado reporta `INDEXED`, e `NONE` significa nada indexado nem colheita solicitada. Inclui totais por fonte com as datas da publicação indexada mais antiga e mais recente, e a cobertura por matéria em `areas` — cada área do direito com estado, contagens e tribunais indexados, inclusive as matérias fora do acervo (`covered: false`), para que resultado vazio nunca se confunda com matéria não coberta. As fontes são reportadas separadamente — um corpus estruturado espelhado do tribunal e menções no diário oficial são ativos diferentes. Leitura local, zero créditos.
644
+ * @description Cobertura agregada do corpus de jurisprudência indexado localmente: documentos indexáveis por fonte × tribunal × mês (a mesma agregação que cada busca textual congela no snapshot de cobertura — lá marcado `UNAVAILABLE`, sem grupos, quando ela não coube no prazo da busca), combinada com o estado das fatias de colheita do diário oficial — grupo com fatia pendente reporta `PARTIAL` (o conjunto indexado ainda pode crescer), grupo totalmente colhido/indexado reporta `INDEXED`, e `NONE` significa nada indexado nem colheita solicitada. Inclui totais por fonte com as datas da publicação indexada mais antiga e mais recente, e a cobertura por matéria em `areas` — cada área do direito com estado, contagens e tribunais indexados, inclusive as matérias fora do acervo (`covered: false`), para que resultado vazio nunca se confunda com matéria não coberta. As fontes são reportadas separadamente — um corpus estruturado espelhado do tribunal e menções no diário oficial são ativos diferentes. Leitura local, zero créditos.
645
645
  *
646
646
  * **Escopo exigido na chave de API:** `PUBLICATIONS_READ`
647
647
  */
@@ -11136,10 +11136,10 @@ export interface operations {
11136
11136
  }[];
11137
11137
  coverage: {
11138
11138
  /**
11139
- * @description NONE = nada indexado nem colheita registrada; PARTIAL = há fatia de colheita pendente (o indexado pode crescer); INDEXED = há documento pesquisável indexado e nenhuma colheita pendente.
11139
+ * @description NONE = nada indexado nem colheita registrada; PARTIAL = há fatia de colheita pendente (o indexado pode crescer); INDEXED = há documento pesquisável indexado e nenhuma colheita pendente. UNAVAILABLE = a cobertura do recorte não coube no prazo da busca: `byTribunalMonth` vem vazio, o ranking vem inteiro e a busca custa o preço de sempre. O valor congelado não muda depois; a cobertura do mesmo recorte sai em GET /v1/publications/corpus/coverage, a 0 crédito, com os tribunais da busca num só `tribunalCodes`, separados por vírgula (`tribunalCodes=STJ,TJSP`), e a janela dela em `from` e `to`.
11140
11140
  * @enum {string}
11141
11141
  */
11142
- overallState: "NONE" | "PARTIAL" | "INDEXED";
11142
+ overallState: "NONE" | "PARTIAL" | "INDEXED" | "UNAVAILABLE";
11143
11143
  byTribunalMonth: {
11144
11144
  source?: string;
11145
11145
  tribunalSigla: string;
@@ -11396,10 +11396,10 @@ export interface operations {
11396
11396
  corpusWatermark: string | null;
11397
11397
  coverage: {
11398
11398
  /**
11399
- * @description NONE = nada indexado nem colheita registrada; PARTIAL = há fatia de colheita pendente (o indexado pode crescer); INDEXED = há documento pesquisável indexado e nenhuma colheita pendente.
11399
+ * @description NONE = nada indexado nem colheita registrada; PARTIAL = há fatia de colheita pendente (o indexado pode crescer); INDEXED = há documento pesquisável indexado e nenhuma colheita pendente. UNAVAILABLE = a cobertura do recorte não coube no prazo da busca: `byTribunalMonth` vem vazio, o ranking vem inteiro e a busca custa o preço de sempre. O valor congelado não muda depois; a cobertura do mesmo recorte sai em GET /v1/publications/corpus/coverage, a 0 crédito, com os tribunais da busca num só `tribunalCodes`, separados por vírgula (`tribunalCodes=STJ,TJSP`), e a janela dela em `from` e `to`.
11400
11400
  * @enum {string}
11401
11401
  */
11402
- overallState: "NONE" | "PARTIAL" | "INDEXED";
11402
+ overallState: "NONE" | "PARTIAL" | "INDEXED" | "UNAVAILABLE";
11403
11403
  byTribunalMonth: {
11404
11404
  source?: string;
11405
11405
  tribunalSigla: string;
@@ -11723,6 +11723,7 @@ export interface operations {
11723
11723
  getPublicationCorpusCoverage: {
11724
11724
  parameters: {
11725
11725
  query?: {
11726
+ /** @description Tribunais do recorte num só valor, separados por vírgula (`tribunalCodes=STJ,TJSP`), pela sigla ou pelo apelido da fonte. Sem ele, a cobertura é a de todos os tribunais do acervo. */
11726
11727
  tribunalCodes?: string;
11727
11728
  from?: string;
11728
11729
  to?: string;