@pairus/product-data 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -258,12 +258,167 @@ interface TaxPredictionResponse {
     dados_tributarios?: TaxPredictionData;
     resultados?: TaxPredictionItemResult[];
 }
+interface FiscalSanitizeItemInput {
+    ncm: string;
+    cest?: string;
+    descricao?: string;
+    gtin?: string;
+}
+interface FiscalSanitizeItemResult {
+    ncm: string;
+    ncm_valido: boolean;
+    descricao_ncm?: string;
+    cest_informado?: string;
+    cest_sugerido?: string;
+    sujeito_st: boolean;
+    aliquotas_sugeridas?: Record<string, any>;
+    avisos?: string[];
+}
+interface FiscalSanitizeResponse {
+    status: string;
+    provider: string;
+    timestamp?: string;
+    total_itens: number;
+    itens: Array<Record<string, any>>;
+}
 
 declare class FiscalResource extends BaseResource {
     /**
      * Executa a predição fiscal completa da Reforma Tributária (IBS/CBS/IS) e NF-e.
      */
     predict(params: TaxPredictionParams): Promise<TaxPredictionResponse>;
+    /**
+     * Audita e higieniza uma lista de produtos em lote perante as tabelas fiscais vigentes.
+     */
+    sanitize(itens: Array<Record<string, any>>): Promise<any>;
+}
+
+interface EnderecoNFSeInput {
+    logradouro: string;
+    numero: string;
+    complemento?: string;
+    bairro: string;
+    codigo_municipio_ibge: string;
+    uf: string;
+    cep: string;
+}
+interface PrestadorNFSeInput {
+    cnpj: string;
+    inscricao_municipal: string;
+    razao_social: string;
+    nome_fantasia?: string;
+    optante_simples_nacional?: boolean;
+    regime_especial_tributacao?: string;
+    endereco?: EnderecoNFSeInput;
+}
+interface TomadorNFSeInput {
+    cpf_cnpj: string;
+    razao_social: string;
+    inscricao_municipal?: string;
+    email?: string;
+    telefone?: string;
+    endereco?: EnderecoNFSeInput;
+}
+interface RetencoesFederaisInput {
+    pis_retido?: boolean;
+    aliquota_pis?: number;
+    valor_pis?: number;
+    cofins_retido?: boolean;
+    aliquota_cofins?: number;
+    valor_cofins?: number;
+    csll_retida?: boolean;
+    aliquota_csll?: number;
+    valor_csll?: number;
+    irrf_retido?: boolean;
+    aliquota_irrf?: number;
+    valor_irrf?: number;
+    inss_retido?: boolean;
+    aliquota_inss?: number;
+    valor_inss?: number;
+}
+interface ServicoNFSeInput {
+    item_lista_servico: string;
+    discriminacao: string;
+    municipio_prestacao_ibge: string;
+    valor_servicos: number;
+    codigo_cnae?: string;
+    codigo_tributacao_municipio?: string;
+    valor_deducoes?: number;
+    valor_desconto_incondicionado?: number;
+    valor_desconto_condicionado?: number;
+    iss_retido?: boolean;
+    aliquota_iss?: number;
+    exigibilidade_iss?: string;
+    retencoes_federais?: RetencoesFederaisInput;
+}
+interface NFSeEmissaoInput {
+    prestador: PrestadorNFSeInput | Record<string, any>;
+    tomador: TomadorNFSeInput | Record<string, any>;
+    servico: ServicoNFSeInput | Record<string, any>;
+    serie_dps?: string;
+    numero_dps?: number;
+    modo?: 'direto' | 'assistido' | 'simulacao';
+    politica_rejeicao?: 'autocura_silenciosa' | 'autocura_assistida' | 'nenhuma';
+    ambiente?: 'producao' | 'homologacao';
+    informacoes_complementares?: string;
+    webhook_url?: string;
+}
+interface NFSeEmissaoResponse {
+    sucesso: boolean;
+    status: 'autorizada' | 'rejeitada' | 'cancelada' | 'simulada';
+    numero_nfse?: string;
+    codigo_verificacao?: string;
+    chave_acesso_nacional?: string;
+    data_emissao?: string;
+    link_visualizacao?: string;
+    danfse_pdf_base64?: string;
+    xml_nfse?: string;
+    valor_servicos: number;
+    valor_iss: number;
+    valor_iss_retido: number;
+    total_retencoes_federais: number;
+    valor_liquido: number;
+    erros?: string[];
+    alertas?: string[];
+    trilha_auditoria?: Record<string, any>[];
+    creditos_cobrados: number;
+    tempo_processamento_ms: number;
+}
+interface CancelamentoNFSeInput {
+    numero_nfse: string;
+    cnpj_prestador: string;
+    inscricao_municipal: string;
+    codigo_municipio_ibge: string;
+    justificativa: string;
+    motivo_codigo?: string;
+    codigo_verificacao?: string;
+    chave_acesso_nacional?: string;
+}
+interface CancelamentoNFSeResponse {
+    sucesso: boolean;
+    numero_nfse: string;
+    data_cancelamento?: string;
+    mensagem: string;
+    erros?: string[];
+}
+
+declare class NFSeResource extends BaseResource {
+    /**
+     * Emite uma Nota Fiscal de Serviços Eletrônica (NFS-e) perante o SND ou prefeitura.
+     */
+    emitir(payload: NFSeEmissaoInput | Record<string, any>): Promise<NFSeEmissaoResponse>;
+    /**
+     * Simula o cálculo de NFS-e com retenções e apuração tributária (custo ZERO de créditos).
+     */
+    simular(payload: NFSeEmissaoInput | Record<string, any>): Promise<NFSeEmissaoResponse>;
+    /**
+     * Homologa o cancelamento oficial de uma NFS-e perante o SND ou prefeitura.
+     */
+    cancelar(payload: CancelamentoNFSeInput): Promise<CancelamentoNFSeResponse>;
+    /**
+     * Consulta os dados, status e DANFSE de uma NFS-e pelo número ou chave de 50 dígitos.
+     */
+    consultar(chaveOuNumero: string): Promise<Record<string, any>>;
 }
 
 interface ProductDetails {
@@ -287,13 +442,60 @@ interface ProductResponse {
     produto?: ProductDetails;
     raw_data?: Record<string, any>;
 }
+interface ProductSearchResultItem {
+    gtin: string;
+    xProd: string;
+    marca?: string;
+    categoria?: string;
+    score?: number;
+    ncm?: string;
+    cest?: string;
+    imagem_url?: string;
+}
+interface ProductSearchResponse {
+    status: string;
+    provider: string;
+    total_encontrados: number;
+    termo_buscado: string;
+    produtos: ProductSearchResultItem[];
+}
+interface ProductEnrichedDetails {
+    gtin: string;
+    xProd: string;
+    descricao_completa?: string;
+    ficha_tecnica?: Record<string, any>;
+    palavras_chave?: string[];
+    ncm?: string;
+    cest?: string;
+    marca?: string;
+    categoria?: string;
+    imagem_url?: string;
+    peso_bruto?: number;
+    peso_liquido?: number;
+    dados_tributarios_sugeridos?: Record<string, any>;
+}
 
 declare class ProductsResource extends BaseResource {
     /**
-     * Consulta um produto por código de barras GTIN/EAN.
+     * Consulta dados oficiais de um produto por código de barras GTIN/EAN (V1).
      * @param gtin Código numérico de 8 a 14 dígitos.
      */
     get(gtin: string): Promise<ProductDetails>;
+    /**
+     * Consulta dados enriquecidos por IA, com SEO e ficha técnica estruturada (V2).
+     * @param gtin Código numérico do produto.
+     */
+    getEnriched(gtin: string): Promise<ProductEnrichedDetails>;
+    /**
+     * Executa busca semântica por intenção/linguagem natural (V2).
+     * @param query Termo livre de busca (ex: 'refrigerante zero lata').
+     */
+    search(query: string): Promise<ProductSearchResponse>;
+    /**
+     * Reconhece código de barras por visão computacional a partir de foto JPEG (OCR V2).
+     * @param file Blob, Buffer ou FormData com a imagem JPEG.
+     */
+    scan(file: Blob | Buffer | FormData): Promise<ProductEnrichedDetails>;
 }
 
 interface WebhookEvent<T = Record<string, any>> {
@@ -324,6 +526,7 @@ declare class PairusProductData {
     readonly products: ProductsResource;
     readonly fiscal: FiscalResource;
     readonly emissao: EmissaoResource;
+    readonly nfse: NFSeResource;
     constructor(options?: PairusClientOptions);
 }
 
@@ -354,4 +557,4 @@ declare class NetworkError extends PairusError {
     constructor(message: string);
 }
 
-export { AuthenticationError, type CancelamentoInput, type CartaCorrecaoInput, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DetalheAutocura, type EmissaoDestinatarioInput, type EmissaoItemInput, type EmissaoNFeInput, type EmissaoNFeResponse, EmissaoResource, type EventoNFeResponse, FiscalResource, type FuelData, type IBSCBSData, type InutilizacaoInput, InvalidSignatureError, NetworkError, PairusAPIError, type PairusClientOptions, PairusError, PairusProductData, type ProductDetails, type ProductResponse, ProductsResource, RateLimitError, type SelectiveTaxData, type TaxPredictionData, type TaxPredictionItemInput, type TaxPredictionItemResult, type TaxPredictionParams, type TaxPredictionResponse, type WebhookEvent, Webhooks };
+export { AuthenticationError, type CancelamentoInput, type CancelamentoNFSeInput, type CancelamentoNFSeResponse, type CartaCorrecaoInput, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DetalheAutocura, type EmissaoDestinatarioInput, type EmissaoItemInput, type EmissaoNFeInput, type EmissaoNFeResponse, EmissaoResource, type EnderecoNFSeInput, type EventoNFeResponse, FiscalResource, type FiscalSanitizeItemInput, type FiscalSanitizeItemResult, type FiscalSanitizeResponse, type FuelData, type IBSCBSData, type InutilizacaoInput, InvalidSignatureError, type NFSeEmissaoInput, type NFSeEmissaoResponse, NFSeResource, NetworkError, PairusAPIError, type PairusClientOptions, PairusError, PairusProductData, type PrestadorNFSeInput, type ProductDetails, type ProductEnrichedDetails, type ProductResponse, type ProductSearchResponse, type ProductSearchResultItem, ProductsResource, RateLimitError, type RetencoesFederaisInput, type SelectiveTaxData, type ServicoNFSeInput, type TaxPredictionData, type TaxPredictionItemInput, type TaxPredictionItemResult, type TaxPredictionParams, type TaxPredictionResponse, type TomadorNFSeInput, type WebhookEvent, Webhooks };

package/dist/index.d.ts

@@ -258,12 +258,167 @@ interface TaxPredictionResponse {
     dados_tributarios?: TaxPredictionData;
     resultados?: TaxPredictionItemResult[];
 }
+interface FiscalSanitizeItemInput {
+    ncm: string;
+    cest?: string;
+    descricao?: string;
+    gtin?: string;
+}
+interface FiscalSanitizeItemResult {
+    ncm: string;
+    ncm_valido: boolean;
+    descricao_ncm?: string;
+    cest_informado?: string;
+    cest_sugerido?: string;
+    sujeito_st: boolean;
+    aliquotas_sugeridas?: Record<string, any>;
+    avisos?: string[];
+}
+interface FiscalSanitizeResponse {
+    status: string;
+    provider: string;
+    timestamp?: string;
+    total_itens: number;
+    itens: Array<Record<string, any>>;
+}
 
 declare class FiscalResource extends BaseResource {
     /**
      * Executa a predição fiscal completa da Reforma Tributária (IBS/CBS/IS) e NF-e.
      */
     predict(params: TaxPredictionParams): Promise<TaxPredictionResponse>;
+    /**
+     * Audita e higieniza uma lista de produtos em lote perante as tabelas fiscais vigentes.
+     */
+    sanitize(itens: Array<Record<string, any>>): Promise<any>;
+}
+
+interface EnderecoNFSeInput {
+    logradouro: string;
+    numero: string;
+    complemento?: string;
+    bairro: string;
+    codigo_municipio_ibge: string;
+    uf: string;
+    cep: string;
+}
+interface PrestadorNFSeInput {
+    cnpj: string;
+    inscricao_municipal: string;
+    razao_social: string;
+    nome_fantasia?: string;
+    optante_simples_nacional?: boolean;
+    regime_especial_tributacao?: string;
+    endereco?: EnderecoNFSeInput;
+}
+interface TomadorNFSeInput {
+    cpf_cnpj: string;
+    razao_social: string;
+    inscricao_municipal?: string;
+    email?: string;
+    telefone?: string;
+    endereco?: EnderecoNFSeInput;
+}
+interface RetencoesFederaisInput {
+    pis_retido?: boolean;
+    aliquota_pis?: number;
+    valor_pis?: number;
+    cofins_retido?: boolean;
+    aliquota_cofins?: number;
+    valor_cofins?: number;
+    csll_retida?: boolean;
+    aliquota_csll?: number;
+    valor_csll?: number;
+    irrf_retido?: boolean;
+    aliquota_irrf?: number;
+    valor_irrf?: number;
+    inss_retido?: boolean;
+    aliquota_inss?: number;
+    valor_inss?: number;
+}
+interface ServicoNFSeInput {
+    item_lista_servico: string;
+    discriminacao: string;
+    municipio_prestacao_ibge: string;
+    valor_servicos: number;
+    codigo_cnae?: string;
+    codigo_tributacao_municipio?: string;
+    valor_deducoes?: number;
+    valor_desconto_incondicionado?: number;
+    valor_desconto_condicionado?: number;
+    iss_retido?: boolean;
+    aliquota_iss?: number;
+    exigibilidade_iss?: string;
+    retencoes_federais?: RetencoesFederaisInput;
+}
+interface NFSeEmissaoInput {
+    prestador: PrestadorNFSeInput | Record<string, any>;
+    tomador: TomadorNFSeInput | Record<string, any>;
+    servico: ServicoNFSeInput | Record<string, any>;
+    serie_dps?: string;
+    numero_dps?: number;
+    modo?: 'direto' | 'assistido' | 'simulacao';
+    politica_rejeicao?: 'autocura_silenciosa' | 'autocura_assistida' | 'nenhuma';
+    ambiente?: 'producao' | 'homologacao';
+    informacoes_complementares?: string;
+    webhook_url?: string;
+}
+interface NFSeEmissaoResponse {
+    sucesso: boolean;
+    status: 'autorizada' | 'rejeitada' | 'cancelada' | 'simulada';
+    numero_nfse?: string;
+    codigo_verificacao?: string;
+    chave_acesso_nacional?: string;
+    data_emissao?: string;
+    link_visualizacao?: string;
+    danfse_pdf_base64?: string;
+    xml_nfse?: string;
+    valor_servicos: number;
+    valor_iss: number;
+    valor_iss_retido: number;
+    total_retencoes_federais: number;
+    valor_liquido: number;
+    erros?: string[];
+    alertas?: string[];
+    trilha_auditoria?: Record<string, any>[];
+    creditos_cobrados: number;
+    tempo_processamento_ms: number;
+}
+interface CancelamentoNFSeInput {
+    numero_nfse: string;
+    cnpj_prestador: string;
+    inscricao_municipal: string;
+    codigo_municipio_ibge: string;
+    justificativa: string;
+    motivo_codigo?: string;
+    codigo_verificacao?: string;
+    chave_acesso_nacional?: string;
+}
+interface CancelamentoNFSeResponse {
+    sucesso: boolean;
+    numero_nfse: string;
+    data_cancelamento?: string;
+    mensagem: string;
+    erros?: string[];
+}
+
+declare class NFSeResource extends BaseResource {
+    /**
+     * Emite uma Nota Fiscal de Serviços Eletrônica (NFS-e) perante o SND ou prefeitura.
+     */
+    emitir(payload: NFSeEmissaoInput | Record<string, any>): Promise<NFSeEmissaoResponse>;
+    /**
+     * Simula o cálculo de NFS-e com retenções e apuração tributária (custo ZERO de créditos).
+     */
+    simular(payload: NFSeEmissaoInput | Record<string, any>): Promise<NFSeEmissaoResponse>;
+    /**
+     * Homologa o cancelamento oficial de uma NFS-e perante o SND ou prefeitura.
+     */
+    cancelar(payload: CancelamentoNFSeInput): Promise<CancelamentoNFSeResponse>;
+    /**
+     * Consulta os dados, status e DANFSE de uma NFS-e pelo número ou chave de 50 dígitos.
+     */
+    consultar(chaveOuNumero: string): Promise<Record<string, any>>;
 }
 
 interface ProductDetails {
@@ -287,13 +442,60 @@ interface ProductResponse {
     produto?: ProductDetails;
     raw_data?: Record<string, any>;
 }
+interface ProductSearchResultItem {
+    gtin: string;
+    xProd: string;
+    marca?: string;
+    categoria?: string;
+    score?: number;
+    ncm?: string;
+    cest?: string;
+    imagem_url?: string;
+}
+interface ProductSearchResponse {
+    status: string;
+    provider: string;
+    total_encontrados: number;
+    termo_buscado: string;
+    produtos: ProductSearchResultItem[];
+}
+interface ProductEnrichedDetails {
+    gtin: string;
+    xProd: string;
+    descricao_completa?: string;
+    ficha_tecnica?: Record<string, any>;
+    palavras_chave?: string[];
+    ncm?: string;
+    cest?: string;
+    marca?: string;
+    categoria?: string;
+    imagem_url?: string;
+    peso_bruto?: number;
+    peso_liquido?: number;
+    dados_tributarios_sugeridos?: Record<string, any>;
+}
 
 declare class ProductsResource extends BaseResource {
     /**
-     * Consulta um produto por código de barras GTIN/EAN.
+     * Consulta dados oficiais de um produto por código de barras GTIN/EAN (V1).
      * @param gtin Código numérico de 8 a 14 dígitos.
      */
     get(gtin: string): Promise<ProductDetails>;
+    /**
+     * Consulta dados enriquecidos por IA, com SEO e ficha técnica estruturada (V2).
+     * @param gtin Código numérico do produto.
+     */
+    getEnriched(gtin: string): Promise<ProductEnrichedDetails>;
+    /**
+     * Executa busca semântica por intenção/linguagem natural (V2).
+     * @param query Termo livre de busca (ex: 'refrigerante zero lata').
+     */
+    search(query: string): Promise<ProductSearchResponse>;
+    /**
+     * Reconhece código de barras por visão computacional a partir de foto JPEG (OCR V2).
+     * @param file Blob, Buffer ou FormData com a imagem JPEG.
+     */
+    scan(file: Blob | Buffer | FormData): Promise<ProductEnrichedDetails>;
 }
 
 interface WebhookEvent<T = Record<string, any>> {
@@ -324,6 +526,7 @@ declare class PairusProductData {
     readonly products: ProductsResource;
     readonly fiscal: FiscalResource;
     readonly emissao: EmissaoResource;
+    readonly nfse: NFSeResource;
     constructor(options?: PairusClientOptions);
 }
 
@@ -354,4 +557,4 @@ declare class NetworkError extends PairusError {
     constructor(message: string);
 }
 
-export { AuthenticationError, type CancelamentoInput, type CartaCorrecaoInput, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DetalheAutocura, type EmissaoDestinatarioInput, type EmissaoItemInput, type EmissaoNFeInput, type EmissaoNFeResponse, EmissaoResource, type EventoNFeResponse, FiscalResource, type FuelData, type IBSCBSData, type InutilizacaoInput, InvalidSignatureError, NetworkError, PairusAPIError, type PairusClientOptions, PairusError, PairusProductData, type ProductDetails, type ProductResponse, ProductsResource, RateLimitError, type SelectiveTaxData, type TaxPredictionData, type TaxPredictionItemInput, type TaxPredictionItemResult, type TaxPredictionParams, type TaxPredictionResponse, type WebhookEvent, Webhooks };
+export { AuthenticationError, type CancelamentoInput, type CancelamentoNFSeInput, type CancelamentoNFSeResponse, type CartaCorrecaoInput, DEFAULT_BASE_URL, DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT_MS, type DetalheAutocura, type EmissaoDestinatarioInput, type EmissaoItemInput, type EmissaoNFeInput, type EmissaoNFeResponse, EmissaoResource, type EnderecoNFSeInput, type EventoNFeResponse, FiscalResource, type FiscalSanitizeItemInput, type FiscalSanitizeItemResult, type FiscalSanitizeResponse, type FuelData, type IBSCBSData, type InutilizacaoInput, InvalidSignatureError, type NFSeEmissaoInput, type NFSeEmissaoResponse, NFSeResource, NetworkError, PairusAPIError, type PairusClientOptions, PairusError, PairusProductData, type PrestadorNFSeInput, type ProductDetails, type ProductEnrichedDetails, type ProductResponse, type ProductSearchResponse, type ProductSearchResultItem, ProductsResource, RateLimitError, type RetencoesFederaisInput, type SelectiveTaxData, type ServicoNFSeInput, type TaxPredictionData, type TaxPredictionItemInput, type TaxPredictionItemResult, type TaxPredictionParams, type TaxPredictionResponse, type TomadorNFSeInput, type WebhookEvent, Webhooks };