zcrmsdk/routes/controllers/api_response.js

Node JS SDK for Zoho CRM

/**
 * This class is the common API response object.
 */
class APIResponse{

    statusCode;

    object;
    
    headers;

    /**
     * Creates an APIResponse class instance with the specified parameters.
     * @param {Map} headers The map containing the API Response headers
     * @param {Integer} statusCode The integer containing the API response HTTP status code. 
     * @param {Object} object The object containing the API response class instance.
     */
    constructor(headers, statusCode, object) {

        this.headers = headers;

        this.statusCode = statusCode;

        this.object = object;
    }

    /**
     * The method to get the API response HTTP status code.
     * @returns {Integer} The integer containing the API response HTTP status code.
     */
    get statusCode(){

        return this.statusCode;
    }

    /**
     * The method to get the API response class instance.
     * @returns {Object} The object containing the API response class instance.
     */
    get object(){

        return this.object;
    }

    /**
     * The method to get the API Response headers
     * @returns {Map} The map containing the API Response headers
     */
    get headers(){

        return this.headers;
    }
}

module.exports = {
    MasterModel : APIResponse, 
    APIResponse : APIResponse
}