A Equatorial Energia é uma holding que controla as distribuidoras de energia Equatorial Energia Alagoas, Equatorial Energia Maranhão, Equatorial Energia Pará, Equatorial Energia Piauí, CEEE Equatorial Energia e CEA Equatorial Energia.
Um modulo TypeScript que permite interagir facilmente com a API Equatorial Energia.
- Orientado a objecto
- Performático
Nesse módulo, está disponível para uso os seguintes estados:
- npm
npm install equatorial-energia
- yarn
yarn add equatorial-energia
import { Client } from "equatorial-energia";
const clien = new Client("username", "birhtday", {
state: "PI",
});
client
.loginWithBirhtday()
.then((structure) => {
client
.listInvoice(structure.getContractsId()[0], structure.getToken())
.then(console.log)
.catch(console.log);
})
.catch(console.log);
ou
const { Client } = require("equatorial-energia");
const client = new Client("username", "birhtday", {
state: "PI",
});
client
.loginWithBirhtday()
.then((structure) => {
client
.listInvoice(structure.getContractsId()[0], structure.getToken())
.then(console.log)
.catch(console.log);
})
.catch(console.log);
Uma vez instanciado o client, pode ser usado conjunto de ferramentas disponíveis
Observação Observe que cada funcionalidade abaixo se refere a class Client
-
Client.loginWithBirhtday(cpf?:
string
, birthday?:string
):Promise<StructureAccessToken>
- autentica usuário na plataforma com cpf e data de nascimentoclient.loginWithBirhtday("00000000000", "13/01/2022");
-
Client.loginWithDocument(cpf?:
string
, document?:string
):Promise<StructureAccessToken>
- autentica usuário na plataforma com cpf e primeiros dígitos do RGclient.loginWithDocument("00000000000", "000");
-
Client.loginWithCnpj(cnpj?:
string
, email?:string
):Promise<StructureAccessToken>
- autentica usuário na plataforma com cnpj e o email cadastradoclient.loginWithCnpj("00000000000000", "email@elizandrodantas.com");
-
Client.loginWithMontherName(cpf?:
string
, monther?:string
):Promise<StructureAccessToken>
- autentica usuário na plataforma com cpf e nome da mãeclient.loginWithMontherName("00000000000", "Monther Name");
-
Client.listInvoice(contract:
string
, token?:string
):Promise<InvoiceList>
- lista ultimas faturastoken
: caso não passado o parâmetro, ele ira buscar por token dentro da instância
client.listInvoice("000000000", "JWT");
-
Client.openInvoices(contract:
string
):Promise<InvoiceOpen>
- lista fatura não pagas- Login não obrigatório;
client.openInvoices("0000000000");
-
Client.consumpitonHistory(contract:
string
, token?:string
):Promise<InvoiceHistory>
- detalhes de consumo na sua fatura como:- consumo de kwh da fatura;
- tributos.
token
: caso não passado o parâmetro, ele ira buscar por token dentro da instância
client.consumpitonHistory("0000000000", "JWT");
-
Client.installationDetails(contract:
string
):Promise<InstallationDetails>
- detalhes da instalação e situação do contrato- Login não obrigatorio;
client.installationDetails("0000000000");
Email: dantaspm@icloud.com