node_whiz_api v1.2.3

node_whiz_api

Setup

Install in your project using npm

npm install node_whiz_api

Require in your file as

const whiz_api = require('node_whiz_api')({
    api_url:  'https://api.example.com',
    client_id:  1,
    client_secret: 'client_secret_hash'
});

Identity Methods

Validate Document Number (DNI)

let dni = '71747124';
let person = await whiz_api.identity.validate(dni);
console.log(person);

Person Methods

Create Person

let person = await whiz_api.person.createPerson({
	"name": "Luis",
	"last_name": "Torres",
	"birthdate": "1994-04-04",
	"document_type": "DNI",
	"document_number": "71747125",
	"phone": "983241622"
});
console.log(person);

Show Person

let person_uuid = 'uuid_example';
let person = await whiz_api.person.showPerson(person_uuid);
console.log(person);

List Person

let people = await whiz_api.person.listPerson({
    query: {
        page: 2
    }
});
console.log(people);

User Methods

List Users

let users = await whiz_api.user.list();
console.log(users);

Get User

let user = await whiz_api.user.get('user_uuid');
console.log(user);

Get User by Email

let user = await whiz_api.user.getByEmail('user_email', 'user_role');
console.log(user);

Login User

let login = await whiz_api.user.login({email: 'user_email', password: 'user_password', role: 'user_role'});
console.log(login);

Create User

let created_user = await whiz_api.user.create({
    name: "user_name",
    last_name: "user_lastname",
    birthdate: "user_birthdate",
    phone: "user_phone",
    document_type: "user_document_type",
    document_number: "user_document_number",
    email: "user_email",
    role: "user_role",
    password: "user_password"
});
console.log(created_user);

Patch User

let user = await whiz_api.user.patch({
    person: {
        uuid: "person_uuid",
        name: "user_name",
        last_name: "user_lastname",
        birthdate: "user_birthdate",
        phone: "user_phone",
        document_type: "user_document_type",
        document_number: "user_document_number"
    },
    user: {
        uuid: "user_uuid",
        password: "user_password"
    }
});
console.log(user);

Mail Methods

Send Mail

let mail = await whiz_api.mail.send({
    cc: [],
    from: {email: 'sender@example.com', name: 'Sender'}, 
    to: {email: 'receiver@example.com', name: 'Reciever'}, 
    content: '<h1>Hi!</h1>',
    subject: 'Greetings'
});
console.log(mail);

Create Mail List

let mail_list = await whiz_api.mail.list.create({
    name: 'mail_list_name',
    description: 'mail_list_description',
    category: 'mail_list_category',
    status: 1
});
console.log(mail_list);

Patch Mail List

let mail_list = await whiz_api.mail.list.patch({
    list_uuid: 'mail_list_uuid',
    name: 'mail_list_name',
    description: 'mail_list_description',
    category: 'mail_list_category',
    status: 1
});
console.log(mail_list);

Delete Mail List

await whiz_api.mail.list.delete('email_list_uuid');

Show Mail List

let mail_list = await whiz_api.mail.list.show('email_list_uuid');
console.log(mail_list);

Mail List Add People

await whiz_api.mail.list.addPeople({
    list_uuid: 'email_list_uuid',
    people: [{email: '', name: ''}]
});

Mail List Send mail

await whiz_api.mail.list.send({
    list_uuid: 'email_list_uuid',
    from: {email: 'sender@example.com', name: 'Sender'},
    content: '<h1>Hi!</h1>',
    subject: 'Greetings'
});

Image Methods

Upload Image

await whiz_api.image.upload(image_buffer, {
    table_name: '',
    table_key: '',
    filename: ''
});

Role Methods

List Role

let roles = await whiz_api.role.list();
console.log(roles);

Create Role

let role = await whiz_api.role.create({
    title: 'admin',
    abilities: ["ability_uuid"]
});
console.log(role);

Patch Role

let role = await whiz_api.role.patch({
    uuid: 'role_uuid',
    title: 'admin',
    abilities: ["ability_uuid"]
});
console.log(role);

Ability Methods

Create Ability

let ability = await whiz_api.ability.create({
    title: 'manage_commercial'
});
console.log(ability);

Patch Ability

let ability = await whiz_api.ability.patch({
    uuid: 'ability_uuid',
    title: 'admin'
});
console.log(ability);

Get Ability

let ability = await whiz_api.ability.get({
    uuid: 'ability_uuid'
});
console.log(ability);

List Ability

let abilities = await whiz_api.ability.list();
console.log(abilities);