@tucupy-tecnologia/cielo-ecommerce-sdk-unofficial/dist/services/queryService.d.ts

SDK Não Oficial para interagir com a API Cielo E-commerce usando Bun/Node.js

import { HttpClient } from '../core/httpClient';
import { type QueryByMerchantOrderIdResponse, type QueryByPaymentIdResponse } from '../models/queryTypes';
/**
 * Serviço para realizar consultas de transações na API Cielo E-commerce.
 */
export declare class QueryService {
    private readonly httpClient;
    private readonly salesBasePath;
    /**
     * Cria uma instância do serviço de consulta.
     * @param httpClient Uma instância do HttpClient JÁ CONFIGURADA com a URL base da API de Consulta.
     */
    constructor(httpClient: HttpClient);
    /**
     * Consulta os detalhes de uma transação específica usando seu PaymentId.
     * Corresponde à operação 'consulta-paymentid-api' (GET /1/sales/{PaymentId}).
     *
     * @param paymentId O ID do pagamento retornado na criação da transação.
     * @returns Uma Promise que resolve com os detalhes da transação consultada.
     * @throws {CieloApiError | CieloNetworkError} Em caso de falha.
     */
    queryByPaymentId(paymentId: string): Promise<QueryByPaymentIdResponse>;
    /**
     * Consulta um resumo das transações associadas a um MerchantOrderId.
     * Corresponde à operação 'consulta-merchantorderid-api' (GET /1/sales?merchantOrderId=...).
     *
     * @param merchantOrderId O ID do pedido usado na criação da(s) transação(ões).
     * @returns Uma Promise que resolve com uma lista de pagamentos associados ao pedido.
     * @throws {CieloApiError | CieloNetworkError} Em caso de falha.
     */
    queryByMerchantOrderId(merchantOrderId: string): Promise<QueryByMerchantOrderIdResponse>;
}