whmcs-api/index.js

Javascript based client for WHMCS API.

/**
 * @author Om Bhende
 * @module whmcs-api
*/

const fetch = require("node-fetch")
const prepare = require("querystring")


class WHMCS {
    /**
     * Initializer.
     * @param {object} object 
     * @param {string} object.accesskey WHMCS API Accesskey
     * @param {string} object.responsetype WHMCS API Response Type (Default: JSON)

    * @param {string} object.username WHMCS API Username
    * @param {string} object.password WHMCS API Password
    * OR
    * @param {string} object.identifier WHMCS API Username
    * @param {string} object.secret WHMCS API Password
    */
    constructor(object) {
        this.eval = {}  
        for (let key in object) {
            this.eval[key] = object[key]
        }
    return this;
    }

    
    /**
     * Calling API
     * @param {string} Action
     * @param {object} API_Parameters
     */

    call = (api, params) => {
        this.eval.action = api
        return new Promise((resolve, reject) => {
            if (typeof(params) === "object") {
                // Check the array.
                for (let key in params) {
                    if (params[key] === false) {
                        reject(`Missing Object Parameters. Key: ${key}`)
                    } else {
                        this.eval[key] = params[key]
                    }
                }
            }
            fetch(`${this.eval.endpoint}?${prepare.stringify(this.eval)}`).then(res => {
                res.json().then(data => {
                    if (data.result === "success") {
                        resolve(data)
                    } else {
                        reject(new Error(data.message))
                    }
                })
            })
        })
    }
}

module.exports = WHMCS