@movelabs/pix-sicoob/dist/types.d.ts

Cliente PIX para integração com API do Sicoob - Sistema de Cobranças e Pagamentos Instantâneos

import { z } from "zod";
export interface Logger {
    debug(obj: any, msg?: string): void;
    info(obj: any, msg?: string): void;
    warn(obj: any, msg?: string): void;
    error(obj: any, msg?: string): void;
}
export interface SicoobAuthConfig {
    clientId: string;
    pfxBuffer: Buffer;
    pfxPassword: string;
    scope: string;
    baseUrl?: string;
    debug?: boolean;
    logger?: Logger;
}
export interface SicoobAuthResponse {
    access_token: string;
    token_type: string;
    expires_in: number;
    scope: string;
}
export declare const infoAdicionalSchema: z.ZodObject<{
    nome: z.ZodString;
    valor: z.ZodString;
}, "strip", z.ZodTypeAny, {
    nome: string;
    valor: string;
}, {
    nome: string;
    valor: string;
}>;
export declare const devedorSchema: z.ZodObject<{
    nome: z.ZodString;
    cpf: z.ZodOptional<z.ZodString>;
    cnpj: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    nome: string;
    cpf?: string | undefined;
    cnpj?: string | undefined;
}, {
    nome: string;
    cpf?: string | undefined;
    cnpj?: string | undefined;
}>;
export declare const valorSchema: z.ZodObject<{
    original: z.ZodString;
    modalidadeAlteracao: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
    original: string;
    modalidadeAlteracao?: number | undefined;
}, {
    original: string;
    modalidadeAlteracao?: number | undefined;
}>;
export declare const CalendarioSchema: z.ZodObject<{
    criacao: z.ZodOptional<z.ZodString>;
    expiracao: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    expiracao: number;
    criacao?: string | undefined;
}, {
    expiracao: number;
    criacao?: string | undefined;
}>;
export declare const cobPayloadSchema: z.ZodObject<{
    calendario: z.ZodObject<{
        criacao: z.ZodOptional<z.ZodString>;
        expiracao: z.ZodNumber;
    }, "strip", z.ZodTypeAny, {
        expiracao: number;
        criacao?: string | undefined;
    }, {
        expiracao: number;
        criacao?: string | undefined;
    }>;
    devedor: z.ZodOptional<z.ZodObject<{
        nome: z.ZodString;
        cpf: z.ZodOptional<z.ZodString>;
        cnpj: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }>>;
    valor: z.ZodObject<{
        original: z.ZodString;
        modalidadeAlteracao: z.ZodOptional<z.ZodNumber>;
    }, "strip", z.ZodTypeAny, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }>;
    chave: z.ZodString;
    txid: z.ZodOptional<z.ZodString>;
    solicitacaoPagador: z.ZodOptional<z.ZodString>;
    infoAdicionais: z.ZodOptional<z.ZodArray<z.ZodObject<{
        nome: z.ZodString;
        valor: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        valor: string;
    }, {
        nome: string;
        valor: string;
    }>, "many">>;
}, "strip", z.ZodTypeAny, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    chave: string;
    devedor?: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    } | undefined;
    txid?: string | undefined;
    solicitacaoPagador?: string | undefined;
    infoAdicionais?: {
        nome: string;
        valor: string;
    }[] | undefined;
}, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    chave: string;
    devedor?: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    } | undefined;
    txid?: string | undefined;
    solicitacaoPagador?: string | undefined;
    infoAdicionais?: {
        nome: string;
        valor: string;
    }[] | undefined;
}>;
export type CobPayload = z.infer<typeof cobPayloadSchema>;
export declare const cobResponseSchema: z.ZodObject<{
    calendario: z.ZodObject<{
        criacao: z.ZodOptional<z.ZodString>;
        expiracao: z.ZodNumber;
    }, "strip", z.ZodTypeAny, {
        expiracao: number;
        criacao?: string | undefined;
    }, {
        expiracao: number;
        criacao?: string | undefined;
    }>;
    devedor: z.ZodOptional<z.ZodObject<{
        nome: z.ZodString;
        cpf: z.ZodOptional<z.ZodString>;
        cnpj: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }>>;
    status: z.ZodString;
    txid: z.ZodString;
    revisao: z.ZodNumber;
    location: z.ZodString;
    valor: z.ZodObject<{
        original: z.ZodString;
        modalidadeAlteracao: z.ZodOptional<z.ZodNumber>;
    }, "strip", z.ZodTypeAny, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }>;
    chave: z.ZodString;
    infoAdicionais: z.ZodOptional<z.ZodArray<z.ZodObject<{
        nome: z.ZodString;
        valor: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        valor: string;
    }, {
        nome: string;
        valor: string;
    }>, "many">>;
    brcode: z.ZodString;
}, "strip", z.ZodTypeAny, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    status: string;
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    chave: string;
    txid: string;
    revisao: number;
    location: string;
    brcode: string;
    devedor?: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    } | undefined;
    infoAdicionais?: {
        nome: string;
        valor: string;
    }[] | undefined;
}, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    status: string;
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    chave: string;
    txid: string;
    revisao: number;
    location: string;
    brcode: string;
    devedor?: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    } | undefined;
    infoAdicionais?: {
        nome: string;
        valor: string;
    }[] | undefined;
}>;
export type CobResponse = z.infer<typeof cobResponseSchema>;
export declare const listPixQuerySchema: z.ZodObject<{
    inicio: z.ZodString;
    fim: z.ZodString;
    cpf: z.ZodOptional<z.ZodString>;
    cnpj: z.ZodOptional<z.ZodString>;
    locationPresente: z.ZodOptional<z.ZodBoolean>;
    status: z.ZodOptional<z.ZodString>;
    "paginacao.paginaAtual": z.ZodOptional<z.ZodNumber>;
    "paginacao.itensPorPagina": z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
    inicio: string;
    fim: string;
    status?: string | undefined;
    cpf?: string | undefined;
    cnpj?: string | undefined;
    locationPresente?: boolean | undefined;
    "paginacao.paginaAtual"?: number | undefined;
    "paginacao.itensPorPagina"?: number | undefined;
}, {
    inicio: string;
    fim: string;
    status?: string | undefined;
    cpf?: string | undefined;
    cnpj?: string | undefined;
    locationPresente?: boolean | undefined;
    "paginacao.paginaAtual"?: number | undefined;
    "paginacao.itensPorPagina"?: number | undefined;
}>;
export type ListPixQuery = z.infer<typeof listPixQuerySchema>;
export declare const pixSchema: z.ZodObject<{
    endToEndId: z.ZodString;
    txid: z.ZodString;
    valor: z.ZodString;
    horario: z.ZodString;
    nomePagador: z.ZodOptional<z.ZodString>;
    pagador: z.ZodOptional<z.ZodObject<{
        nome: z.ZodString;
        cpf: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        cpf: string;
    }, {
        nome: string;
        cpf: string;
    }>>;
    devolucoes: z.ZodArray<z.ZodAny, "many">;
}, "strip", z.ZodTypeAny, {
    valor: string;
    txid: string;
    endToEndId: string;
    horario: string;
    devolucoes: any[];
    nomePagador?: string | undefined;
    pagador?: {
        nome: string;
        cpf: string;
    } | undefined;
}, {
    valor: string;
    txid: string;
    endToEndId: string;
    horario: string;
    devolucoes: any[];
    nomePagador?: string | undefined;
    pagador?: {
        nome: string;
        cpf: string;
    } | undefined;
}>;
export declare const cobResponseWithPixSchema: z.ZodObject<{
    brcode: z.ZodString;
    txid: z.ZodString;
    calendario: z.ZodObject<{
        criacao: z.ZodOptional<z.ZodString>;
        expiracao: z.ZodNumber;
    }, "strip", z.ZodTypeAny, {
        expiracao: number;
        criacao?: string | undefined;
    }, {
        expiracao: number;
        criacao?: string | undefined;
    }>;
    status: z.ZodString;
    devedor: z.ZodObject<{
        nome: z.ZodString;
        cpf: z.ZodOptional<z.ZodString>;
        cnpj: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }, {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    }>;
    chave: z.ZodString;
    valor: z.ZodObject<{
        original: z.ZodString;
        modalidadeAlteracao: z.ZodOptional<z.ZodNumber>;
    }, "strip", z.ZodTypeAny, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }, {
        original: string;
        modalidadeAlteracao?: number | undefined;
    }>;
    permiteAlteracao: z.ZodBoolean;
    infoAdicionais: z.ZodArray<z.ZodObject<{
        nome: z.ZodString;
        valor: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        nome: string;
        valor: string;
    }, {
        nome: string;
        valor: string;
    }>, "many">;
    payloadURL: z.ZodString;
    pix: z.ZodArray<z.ZodObject<{
        endToEndId: z.ZodString;
        txid: z.ZodString;
        valor: z.ZodString;
        horario: z.ZodString;
        nomePagador: z.ZodOptional<z.ZodString>;
        pagador: z.ZodOptional<z.ZodObject<{
            nome: z.ZodString;
            cpf: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            nome: string;
            cpf: string;
        }, {
            nome: string;
            cpf: string;
        }>>;
        devolucoes: z.ZodArray<z.ZodAny, "many">;
    }, "strip", z.ZodTypeAny, {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }, {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }>, "many">;
}, "strip", z.ZodTypeAny, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    status: string;
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    devedor: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    };
    chave: string;
    txid: string;
    infoAdicionais: {
        nome: string;
        valor: string;
    }[];
    brcode: string;
    permiteAlteracao: boolean;
    payloadURL: string;
    pix: {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }[];
}, {
    valor: {
        original: string;
        modalidadeAlteracao?: number | undefined;
    };
    status: string;
    calendario: {
        expiracao: number;
        criacao?: string | undefined;
    };
    devedor: {
        nome: string;
        cpf?: string | undefined;
        cnpj?: string | undefined;
    };
    chave: string;
    txid: string;
    infoAdicionais: {
        nome: string;
        valor: string;
    }[];
    brcode: string;
    permiteAlteracao: boolean;
    payloadURL: string;
    pix: {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }[];
}>;
export type CobResponseWithPix = z.infer<typeof cobResponseWithPixSchema>;
export declare const listPixResponseSchema: z.ZodObject<{
    parametros: z.ZodObject<{
        inicio: z.ZodString;
        fim: z.ZodString;
        cpf: z.ZodOptional<z.ZodString>;
        cnpj: z.ZodOptional<z.ZodString>;
        locationPresente: z.ZodOptional<z.ZodBoolean>;
        status: z.ZodOptional<z.ZodString>;
        paginacao: z.ZodObject<{
            paginaAtual: z.ZodNumber;
            itensPorPagina: z.ZodNumber;
            quantidadeDePaginas: z.ZodNumber;
            quantidadeTotalDeItens: z.ZodNumber;
        }, "strip", z.ZodTypeAny, {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        }, {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        }>;
    }, "strip", z.ZodTypeAny, {
        inicio: string;
        fim: string;
        paginacao: {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        };
        status?: string | undefined;
        cpf?: string | undefined;
        cnpj?: string | undefined;
        locationPresente?: boolean | undefined;
    }, {
        inicio: string;
        fim: string;
        paginacao: {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        };
        status?: string | undefined;
        cpf?: string | undefined;
        cnpj?: string | undefined;
        locationPresente?: boolean | undefined;
    }>;
    cobs: z.ZodArray<z.ZodObject<{
        brcode: z.ZodString;
        txid: z.ZodString;
        calendario: z.ZodObject<{
            criacao: z.ZodOptional<z.ZodString>;
            expiracao: z.ZodNumber;
        }, "strip", z.ZodTypeAny, {
            expiracao: number;
            criacao?: string | undefined;
        }, {
            expiracao: number;
            criacao?: string | undefined;
        }>;
        status: z.ZodString;
        devedor: z.ZodObject<{
            nome: z.ZodString;
            cpf: z.ZodOptional<z.ZodString>;
            cnpj: z.ZodOptional<z.ZodString>;
        }, "strip", z.ZodTypeAny, {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        }, {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        }>;
        chave: z.ZodString;
        valor: z.ZodObject<{
            original: z.ZodString;
            modalidadeAlteracao: z.ZodOptional<z.ZodNumber>;
        }, "strip", z.ZodTypeAny, {
            original: string;
            modalidadeAlteracao?: number | undefined;
        }, {
            original: string;
            modalidadeAlteracao?: number | undefined;
        }>;
        permiteAlteracao: z.ZodBoolean;
        infoAdicionais: z.ZodArray<z.ZodObject<{
            nome: z.ZodString;
            valor: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            nome: string;
            valor: string;
        }, {
            nome: string;
            valor: string;
        }>, "many">;
        payloadURL: z.ZodString;
        pix: z.ZodArray<z.ZodObject<{
            endToEndId: z.ZodString;
            txid: z.ZodString;
            valor: z.ZodString;
            horario: z.ZodString;
            nomePagador: z.ZodOptional<z.ZodString>;
            pagador: z.ZodOptional<z.ZodObject<{
                nome: z.ZodString;
                cpf: z.ZodString;
            }, "strip", z.ZodTypeAny, {
                nome: string;
                cpf: string;
            }, {
                nome: string;
                cpf: string;
            }>>;
            devolucoes: z.ZodArray<z.ZodAny, "many">;
        }, "strip", z.ZodTypeAny, {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }, {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }>, "many">;
    }, "strip", z.ZodTypeAny, {
        valor: {
            original: string;
            modalidadeAlteracao?: number | undefined;
        };
        status: string;
        calendario: {
            expiracao: number;
            criacao?: string | undefined;
        };
        devedor: {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        };
        chave: string;
        txid: string;
        infoAdicionais: {
            nome: string;
            valor: string;
        }[];
        brcode: string;
        permiteAlteracao: boolean;
        payloadURL: string;
        pix: {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }[];
    }, {
        valor: {
            original: string;
            modalidadeAlteracao?: number | undefined;
        };
        status: string;
        calendario: {
            expiracao: number;
            criacao?: string | undefined;
        };
        devedor: {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        };
        chave: string;
        txid: string;
        infoAdicionais: {
            nome: string;
            valor: string;
        }[];
        brcode: string;
        permiteAlteracao: boolean;
        payloadURL: string;
        pix: {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }[];
    }>, "many">;
}, "strip", z.ZodTypeAny, {
    parametros: {
        inicio: string;
        fim: string;
        paginacao: {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        };
        status?: string | undefined;
        cpf?: string | undefined;
        cnpj?: string | undefined;
        locationPresente?: boolean | undefined;
    };
    cobs: {
        valor: {
            original: string;
            modalidadeAlteracao?: number | undefined;
        };
        status: string;
        calendario: {
            expiracao: number;
            criacao?: string | undefined;
        };
        devedor: {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        };
        chave: string;
        txid: string;
        infoAdicionais: {
            nome: string;
            valor: string;
        }[];
        brcode: string;
        permiteAlteracao: boolean;
        payloadURL: string;
        pix: {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }[];
    }[];
}, {
    parametros: {
        inicio: string;
        fim: string;
        paginacao: {
            paginaAtual: number;
            itensPorPagina: number;
            quantidadeDePaginas: number;
            quantidadeTotalDeItens: number;
        };
        status?: string | undefined;
        cpf?: string | undefined;
        cnpj?: string | undefined;
        locationPresente?: boolean | undefined;
    };
    cobs: {
        valor: {
            original: string;
            modalidadeAlteracao?: number | undefined;
        };
        status: string;
        calendario: {
            expiracao: number;
            criacao?: string | undefined;
        };
        devedor: {
            nome: string;
            cpf?: string | undefined;
            cnpj?: string | undefined;
        };
        chave: string;
        txid: string;
        infoAdicionais: {
            nome: string;
            valor: string;
        }[];
        brcode: string;
        permiteAlteracao: boolean;
        payloadURL: string;
        pix: {
            valor: string;
            txid: string;
            endToEndId: string;
            horario: string;
            devolucoes: any[];
            nomePagador?: string | undefined;
            pagador?: {
                nome: string;
                cpf: string;
            } | undefined;
        }[];
    }[];
}>;
export type ListPixResponse = z.infer<typeof listPixResponseSchema>;
export declare const webhookPixPayloadSchema: z.ZodObject<{
    pix: z.ZodArray<z.ZodObject<{
        endToEndId: z.ZodString;
        txid: z.ZodString;
        valor: z.ZodString;
        horario: z.ZodString;
        nomePagador: z.ZodOptional<z.ZodString>;
        pagador: z.ZodOptional<z.ZodObject<{
            nome: z.ZodString;
            cpf: z.ZodString;
        }, "strip", z.ZodTypeAny, {
            nome: string;
            cpf: string;
        }, {
            nome: string;
            cpf: string;
        }>>;
        devolucoes: z.ZodArray<z.ZodAny, "many">;
    }, "strip", z.ZodTypeAny, {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }, {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }>, "many">;
}, "strip", z.ZodTypeAny, {
    pix: {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }[];
}, {
    pix: {
        valor: string;
        txid: string;
        endToEndId: string;
        horario: string;
        devolucoes: any[];
        nomePagador?: string | undefined;
        pagador?: {
            nome: string;
            cpf: string;
        } | undefined;
    }[];
}>;
export type WebhookPixPayload = z.infer<typeof webhookPixPayloadSchema>;
export type PixRecebido = z.infer<typeof pixSchema>;
//# sourceMappingURL=types.d.ts.map