paposms/lib/papoSMS.d.ts

Biblioteca para utilizar os serviços da PapoSMS

declare class PapoSMS {
    private user;
    private password;
    /**
     * Creates an instance of PapoSMS.
     * @param {string} user - No parâmetro “user” deve ser digitado o email de uma conta PAPO válida.
     * @param {string} password - No parâmetro “pass” deve ser digitado a senha correspondente ao email digitado em “user”
     * @memberof PapoSMS
     */
    constructor(user: string, password: string);
    /**
     *
     *
     * @param {string[]} numeros - Deve ser digitado os números de telefone celular para ser o destino da mensagem eg ['410000000','4200000000']
     * @param {string} mensagem - No parâmetro “message” deve ser digitado o texto o qual será enviado para o(s) número(s) do parâmetro “numbers”. Observação: O texto deve conter, no máximo, 140 caracteres
     * @param {Date} [data] - No parâmetro “date” deve ser digitada a data de agendamento, para o envio do SMS. Observações: O formato da data deve corresponder a “yyyy-mm-dd hh:ii”, onde “yyyy” é o ano, ”mm” é o mês, “dd” é o dia, “hh” é a hora e “ii” os minutos. Se esse parâmetro não for passado, a hora de agendamento será a do servidor.
     * @returns - Retorna uma promise que é rejeitada caso ocorra algum erro de conexão ou erro de resposta do servidor, a promise é aceita caso se tenha sucesso no envio do SMS
     * @memberof PapoSMS
     */
    send(numeros: string[], mensagem: string, data?: Date): Promise<unknown>;
}
export { PapoSMS };