iptuapi 2.0.3 → 2.1.1

package/dist/index.d.mts

@@ -23,11 +23,16 @@
  * });
  * ```
  */
-type Cidade = 'sp' | 'bh' | 'recife';
+type Cidade = 'sp' | 'bh' | 'recife' | 'poa' | 'fortaleza' | 'curitiba' | 'rj' | 'brasilia';
 declare const CidadeEnum: {
     readonly SAO_PAULO: Cidade;
     readonly BELO_HORIZONTE: Cidade;
     readonly RECIFE: Cidade;
+    readonly PORTO_ALEGRE: Cidade;
+    readonly FORTALEZA: Cidade;
+    readonly CURITIBA: Cidade;
+    readonly RIO_DE_JANEIRO: Cidade;
+    readonly BRASILIA: Cidade;
 };
 interface RateLimitInfo {
     limit: number;
@@ -333,6 +338,104 @@ declare class IPTUClient {
         valor_corrigido: number;
         fator: number;
     }>;
+    /**
+     * Lista todas as cidades com calendario de IPTU disponivel.
+     *
+     * @returns Lista de cidades com codigo, nome, desconto e parcelas
+     */
+    iptuToolsCidades(): Promise<{
+        cidades: Array<{
+            codigo: string;
+            nome: string;
+            ano: number;
+            desconto_vista: string;
+            parcelas_max: number;
+            site_oficial: string;
+        }>;
+        total: number;
+    }>;
+    /**
+     * Retorna o calendario completo de IPTU para a cidade especificada.
+     *
+     * @param cidade - Codigo da cidade (sp, bh, rj, recife, curitiba, poa, fortaleza)
+     * @returns Calendario com vencimentos, descontos, alertas e novidades
+     */
+    iptuToolsCalendario(cidade?: Cidade): Promise<{
+        cidade: string;
+        ano: number;
+        desconto_vista_percentual: number;
+        desconto_vista_texto: string;
+        parcelas_max: number;
+        valor_minimo_parcela: number;
+        isencao_valor_venal?: number;
+        isencao_texto?: string;
+        site_oficial: string;
+        novidades?: string[];
+        alertas?: string[];
+        formas_pagamento?: string[];
+        vencimentos_cota_unica: string[];
+        vencimentos_parcelado: string[];
+        proximo_vencimento?: string;
+        dias_para_proximo_vencimento?: number;
+    }>;
+    /**
+     * Simula as opcoes de pagamento do IPTU (a vista vs parcelado).
+     *
+     * @param valorIptu - Valor total do IPTU
+     * @param cidade - Codigo da cidade
+     * @param valorVenal - Valor venal do imovel (para verificar isencao)
+     * @returns Comparativo entre pagamento a vista e parcelado com recomendacao
+     */
+    iptuToolsSimulador(valorIptu: number, cidade?: Cidade, valorVenal?: number): Promise<{
+        valor_original: number;
+        valor_vista: number;
+        desconto_vista: number;
+        desconto_percentual: number;
+        parcelas: number;
+        valor_parcela: number;
+        valor_total_parcelado: number;
+        economia_vista: number;
+        economia_percentual: number;
+        recomendacao: string;
+        elegivel_isencao: boolean;
+        isencao_mensagem?: string;
+        cidade: string;
+        ano: number;
+        proximo_vencimento?: string;
+    }>;
+    /**
+     * Verifica se um imovel e elegivel para isencao de IPTU.
+     *
+     * @param valorVenal - Valor venal do imovel
+     * @param cidade - Codigo da cidade
+     * @returns Elegibilidade para isencao total ou parcial
+     */
+    iptuToolsIsencao(valorVenal: number, cidade?: Cidade): Promise<{
+        cidade: string;
+        valor_venal: number;
+        limite_isencao: number;
+        elegivel_isencao_total: boolean;
+        elegivel_desconto_parcial: boolean;
+        desconto_estimado_percentual?: number;
+        mensagem: string;
+        requisitos_adicionais: string[];
+    }>;
+    /**
+     * Retorna informacoes sobre o proximo vencimento do IPTU.
+     *
+     * @param cidade - Codigo da cidade
+     * @param parcela - Numero da parcela (1-12)
+     * @returns Data de vencimento, dias restantes e status
+     */
+    iptuToolsProximoVencimento(cidade?: Cidade, parcela?: number): Promise<{
+        cidade: string;
+        data_vencimento: string;
+        dias_restantes: number;
+        status: "em_dia" | "proximo" | "vence_hoje" | "vencido";
+        mensagem: string;
+        multa_estimada?: number;
+        juros_estimados?: number;
+    }>;
 }
 
 export { AuthenticationError, type BatchValuationResult, type Cidade, CidadeEnum, type ComparavelItem, type ConsultaEnderecoParams, type ConsultaEnderecoResult, type ConsultaSQLResult, ForbiddenError, type HistoricoItem, IPTUAPIError, IPTUClient, type IPTUClientOptions, type Logger, NetworkError, NotFoundError, RateLimitError, type RateLimitInfo, type RetryConfig, ServerError, TimeoutError, ValidationError, type ValuationParams, type ValuationResult, type ZoneamentoResult, IPTUClient as default };

package/dist/index.d.ts

@@ -23,11 +23,16 @@
  * });
  * ```
  */
-type Cidade = 'sp' | 'bh' | 'recife';
+type Cidade = 'sp' | 'bh' | 'recife' | 'poa' | 'fortaleza' | 'curitiba' | 'rj' | 'brasilia';
 declare const CidadeEnum: {
     readonly SAO_PAULO: Cidade;
     readonly BELO_HORIZONTE: Cidade;
     readonly RECIFE: Cidade;
+    readonly PORTO_ALEGRE: Cidade;
+    readonly FORTALEZA: Cidade;
+    readonly CURITIBA: Cidade;
+    readonly RIO_DE_JANEIRO: Cidade;
+    readonly BRASILIA: Cidade;
 };
 interface RateLimitInfo {
     limit: number;
@@ -333,6 +338,104 @@ declare class IPTUClient {
         valor_corrigido: number;
         fator: number;
     }>;
+    /**
+     * Lista todas as cidades com calendario de IPTU disponivel.
+     *
+     * @returns Lista de cidades com codigo, nome, desconto e parcelas
+     */
+    iptuToolsCidades(): Promise<{
+        cidades: Array<{
+            codigo: string;
+            nome: string;
+            ano: number;
+            desconto_vista: string;
+            parcelas_max: number;
+            site_oficial: string;
+        }>;
+        total: number;
+    }>;
+    /**
+     * Retorna o calendario completo de IPTU para a cidade especificada.
+     *
+     * @param cidade - Codigo da cidade (sp, bh, rj, recife, curitiba, poa, fortaleza)
+     * @returns Calendario com vencimentos, descontos, alertas e novidades
+     */
+    iptuToolsCalendario(cidade?: Cidade): Promise<{
+        cidade: string;
+        ano: number;
+        desconto_vista_percentual: number;
+        desconto_vista_texto: string;
+        parcelas_max: number;
+        valor_minimo_parcela: number;
+        isencao_valor_venal?: number;
+        isencao_texto?: string;
+        site_oficial: string;
+        novidades?: string[];
+        alertas?: string[];
+        formas_pagamento?: string[];
+        vencimentos_cota_unica: string[];
+        vencimentos_parcelado: string[];
+        proximo_vencimento?: string;
+        dias_para_proximo_vencimento?: number;
+    }>;
+    /**
+     * Simula as opcoes de pagamento do IPTU (a vista vs parcelado).
+     *
+     * @param valorIptu - Valor total do IPTU
+     * @param cidade - Codigo da cidade
+     * @param valorVenal - Valor venal do imovel (para verificar isencao)
+     * @returns Comparativo entre pagamento a vista e parcelado com recomendacao
+     */
+    iptuToolsSimulador(valorIptu: number, cidade?: Cidade, valorVenal?: number): Promise<{
+        valor_original: number;
+        valor_vista: number;
+        desconto_vista: number;
+        desconto_percentual: number;
+        parcelas: number;
+        valor_parcela: number;
+        valor_total_parcelado: number;
+        economia_vista: number;
+        economia_percentual: number;
+        recomendacao: string;
+        elegivel_isencao: boolean;
+        isencao_mensagem?: string;
+        cidade: string;
+        ano: number;
+        proximo_vencimento?: string;
+    }>;
+    /**
+     * Verifica se um imovel e elegivel para isencao de IPTU.
+     *
+     * @param valorVenal - Valor venal do imovel
+     * @param cidade - Codigo da cidade
+     * @returns Elegibilidade para isencao total ou parcial
+     */
+    iptuToolsIsencao(valorVenal: number, cidade?: Cidade): Promise<{
+        cidade: string;
+        valor_venal: number;
+        limite_isencao: number;
+        elegivel_isencao_total: boolean;
+        elegivel_desconto_parcial: boolean;
+        desconto_estimado_percentual?: number;
+        mensagem: string;
+        requisitos_adicionais: string[];
+    }>;
+    /**
+     * Retorna informacoes sobre o proximo vencimento do IPTU.
+     *
+     * @param cidade - Codigo da cidade
+     * @param parcela - Numero da parcela (1-12)
+     * @returns Data de vencimento, dias restantes e status
+     */
+    iptuToolsProximoVencimento(cidade?: Cidade, parcela?: number): Promise<{
+        cidade: string;
+        data_vencimento: string;
+        dias_restantes: number;
+        status: "em_dia" | "proximo" | "vence_hoje" | "vencido";
+        mensagem: string;
+        multa_estimada?: number;
+        juros_estimados?: number;
+    }>;
 }
 
 export { AuthenticationError, type BatchValuationResult, type Cidade, CidadeEnum, type ComparavelItem, type ConsultaEnderecoParams, type ConsultaEnderecoResult, type ConsultaSQLResult, ForbiddenError, type HistoricoItem, IPTUAPIError, IPTUClient, type IPTUClientOptions, type Logger, NetworkError, NotFoundError, RateLimitError, type RateLimitInfo, type RetryConfig, ServerError, TimeoutError, ValidationError, type ValuationParams, type ValuationResult, type ZoneamentoResult, IPTUClient as default };

package/dist/index.js

@@ -37,7 +37,12 @@ module.exports = __toCommonJS(index_exports);
 var CidadeEnum = {
   SAO_PAULO: "sp",
   BELO_HORIZONTE: "bh",
-  RECIFE: "recife"
+  RECIFE: "recife",
+  PORTO_ALEGRE: "poa",
+  FORTALEZA: "fortaleza",
+  CURITIBA: "curitiba",
+  RIO_DE_JANEIRO: "rj",
+  BRASILIA: "brasilia"
 };
 var IPTUAPIError = class _IPTUAPIError extends Error {
   statusCode;
@@ -166,7 +171,7 @@ var IPTUClient = class {
     this.logger = options.logger;
     this.logRequests = options.logRequests || false;
     this.logResponses = options.logResponses || false;
-    this.userAgent = options.userAgent || "iptuapi-js/2.0.0";
+    this.userAgent = options.userAgent || "iptuapi-js/2.1.0";
   }
   // ===========================================================================
   // Properties
@@ -537,6 +542,70 @@ var IPTUClient = class {
       }
     );
   }
+  // ===========================================================================
+  // IPTU Tools Endpoints (Ferramentas IPTU 2026)
+  // ===========================================================================
+  /**
+   * Lista todas as cidades com calendario de IPTU disponivel.
+   *
+   * @returns Lista de cidades com codigo, nome, desconto e parcelas
+   */
+  async iptuToolsCidades() {
+    return this.request("GET", "/iptu-tools/cidades");
+  }
+  /**
+   * Retorna o calendario completo de IPTU para a cidade especificada.
+   *
+   * @param cidade - Codigo da cidade (sp, bh, rj, recife, curitiba, poa, fortaleza)
+   * @returns Calendario com vencimentos, descontos, alertas e novidades
+   */
+  async iptuToolsCalendario(cidade = "sp") {
+    return this.request("GET", "/iptu-tools/calendario", { cidade });
+  }
+  /**
+   * Simula as opcoes de pagamento do IPTU (a vista vs parcelado).
+   *
+   * @param valorIptu - Valor total do IPTU
+   * @param cidade - Codigo da cidade
+   * @param valorVenal - Valor venal do imovel (para verificar isencao)
+   * @returns Comparativo entre pagamento a vista e parcelado com recomendacao
+   */
+  async iptuToolsSimulador(valorIptu, cidade = "sp", valorVenal) {
+    const body = {
+      valor_iptu: valorIptu,
+      cidade
+    };
+    if (valorVenal !== void 0) {
+      body.valor_venal = valorVenal;
+    }
+    return this.request("POST", "/iptu-tools/simulador", void 0, body);
+  }
+  /**
+   * Verifica se um imovel e elegivel para isencao de IPTU.
+   *
+   * @param valorVenal - Valor venal do imovel
+   * @param cidade - Codigo da cidade
+   * @returns Elegibilidade para isencao total ou parcial
+   */
+  async iptuToolsIsencao(valorVenal, cidade = "sp") {
+    return this.request("GET", "/iptu-tools/isencao", {
+      valor_venal: valorVenal,
+      cidade
+    });
+  }
+  /**
+   * Retorna informacoes sobre o proximo vencimento do IPTU.
+   *
+   * @param cidade - Codigo da cidade
+   * @param parcela - Numero da parcela (1-12)
+   * @returns Data de vencimento, dias restantes e status
+   */
+  async iptuToolsProximoVencimento(cidade = "sp", parcela = 1) {
+    return this.request("GET", "/iptu-tools/proximo-vencimento", {
+      cidade,
+      parcela
+    });
+  }
 };
 var index_default = IPTUClient;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -2,7 +2,12 @@
 var CidadeEnum = {
   SAO_PAULO: "sp",
   BELO_HORIZONTE: "bh",
-  RECIFE: "recife"
+  RECIFE: "recife",
+  PORTO_ALEGRE: "poa",
+  FORTALEZA: "fortaleza",
+  CURITIBA: "curitiba",
+  RIO_DE_JANEIRO: "rj",
+  BRASILIA: "brasilia"
 };
 var IPTUAPIError = class _IPTUAPIError extends Error {
   statusCode;
@@ -131,7 +136,7 @@ var IPTUClient = class {
     this.logger = options.logger;
     this.logRequests = options.logRequests || false;
     this.logResponses = options.logResponses || false;
-    this.userAgent = options.userAgent || "iptuapi-js/2.0.0";
+    this.userAgent = options.userAgent || "iptuapi-js/2.1.0";
   }
   // ===========================================================================
   // Properties
@@ -502,6 +507,70 @@ var IPTUClient = class {
       }
     );
   }
+  // ===========================================================================
+  // IPTU Tools Endpoints (Ferramentas IPTU 2026)
+  // ===========================================================================
+  /**
+   * Lista todas as cidades com calendario de IPTU disponivel.
+   *
+   * @returns Lista de cidades com codigo, nome, desconto e parcelas
+   */
+  async iptuToolsCidades() {
+    return this.request("GET", "/iptu-tools/cidades");
+  }
+  /**
+   * Retorna o calendario completo de IPTU para a cidade especificada.
+   *
+   * @param cidade - Codigo da cidade (sp, bh, rj, recife, curitiba, poa, fortaleza)
+   * @returns Calendario com vencimentos, descontos, alertas e novidades
+   */
+  async iptuToolsCalendario(cidade = "sp") {
+    return this.request("GET", "/iptu-tools/calendario", { cidade });
+  }
+  /**
+   * Simula as opcoes de pagamento do IPTU (a vista vs parcelado).
+   *
+   * @param valorIptu - Valor total do IPTU
+   * @param cidade - Codigo da cidade
+   * @param valorVenal - Valor venal do imovel (para verificar isencao)
+   * @returns Comparativo entre pagamento a vista e parcelado com recomendacao
+   */
+  async iptuToolsSimulador(valorIptu, cidade = "sp", valorVenal) {
+    const body = {
+      valor_iptu: valorIptu,
+      cidade
+    };
+    if (valorVenal !== void 0) {
+      body.valor_venal = valorVenal;
+    }
+    return this.request("POST", "/iptu-tools/simulador", void 0, body);
+  }
+  /**
+   * Verifica se um imovel e elegivel para isencao de IPTU.
+   *
+   * @param valorVenal - Valor venal do imovel
+   * @param cidade - Codigo da cidade
+   * @returns Elegibilidade para isencao total ou parcial
+   */
+  async iptuToolsIsencao(valorVenal, cidade = "sp") {
+    return this.request("GET", "/iptu-tools/isencao", {
+      valor_venal: valorVenal,
+      cidade
+    });
+  }
+  /**
+   * Retorna informacoes sobre o proximo vencimento do IPTU.
+   *
+   * @param cidade - Codigo da cidade
+   * @param parcela - Numero da parcela (1-12)
+   * @returns Data de vencimento, dias restantes e status
+   */
+  async iptuToolsProximoVencimento(cidade = "sp", parcela = 1) {
+    return this.request("GET", "/iptu-tools/proximo-vencimento", {
+      cidade,
+      parcela
+    });
+  }
 };
 var index_default = IPTUClient;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iptuapi",
-  "version": "2.0.3",
+  "version": "2.1.1",
   "description": "SDK oficial para a IPTU API - Dados de IPTU de São Paulo, Belo Horizonte e Recife",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -49,11 +49,11 @@
   },
   "devDependencies": {
     "@types/node": "^20.10.0",
-    "@vitest/coverage-v8": "^1.0.0",
+    "@vitest/coverage-v8": "^4.0.16",
     "msw": "^2.0.0",
     "tsup": "^8.0.0",
     "typescript": "^5.3.0",
-    "vitest": "^1.0.0"
+    "vitest": "^4.0.16"
   },
   "engines": {
     "node": ">=18"