Kigo-Wrap

Kigo wrap is a publicly published SDK wrapper for the Kigo Rentals API v0.8 (https://www.kigoapis.com/core/v0.8/swagger/)

Installation

Install the dependencies and devDependencies and start the server.

$ npm install @kma/kigo-wrap --save

Usage

Setting Configuration

/**
* @param {string} token 
* @returns {object}
* @throws {Error}
*/
const Kigo = require("@kma/kigo-wrap")
let config = Kigo.SetToken("super-secret-auth-key")

List All Properties

/**
* @param {object} configs
* @returns {object}
* @throws {Error}
*/
let list = Kigo.ListProperties(config)
list.then(result => {
    if(result.data.length > 0)
        //Do something
})

Retrieve Single Property

/**
* @param {int} id 
* @param {Array} options 
* @param {object} configs
* @returns {object}
* @throws {Error}
*/
let options = ["PrimaryImage", "Amenities, Rates", "Visibility", "Reviews"]
let property = Kigo.GetProperty(1234, options, config)
property.then(result => {
    if(result.data.length > 0)
        //Do something
})

Retreive Daily Rates for Single Property

/**
* @param {number} id 
* @param {Date} startDate 
* @param {Date} endDate 
* @param {Array} configs 
* @returns {object}
* @throws {Error}
*/
let rates = Kigo.GetPropertyRates(1234, new Date("2020-07-01 EST"), new Date("2020-07-04 EST"), config)
rates.then(result => {
    if(result.data.length > 0)
        //Do something
})

Retrieve Unavailability Dates

/**
* @param {number} id 
* @param {object} configs 
* @param {boolean} getBooked
* @returns {Array<string>} 
* @throws {Error}
*/
let unavail = Kigo.GetPropertyAvailability(1234, config, true)
unavil.then(result => {
    if(result.data.length > 0)
        //Do something
})

Create New Renter

/**
* @param {string} firstName 
* @param {string} lastName 
* @param {string} email 
* @param {string} phone 
* @param {object} configs 
* @returns {number}
* @throws {Error}
*/
let id = Kigo.CreateRenter("John", "Doe", "[email protected]", "1235551234", config)
id.then(result => {
    if(result > 0)
        //Do something
})

Generate a Quote Statement

/**
* @param {number} propertyId 
* @param {Date} checkInDate 
* @param {Date} checkOutDate 
* @param {number} numAdults 
* @param {number} numKids 
* @param {number} token
* @returns {object} 
* @throws {Error}
*/
let quote = Kigo.GetPropertyQuote(1234, new Date("2019-08-31 EST"), new Date("2019-09-04 EST"), 3, 0, "checkout-api-key")
quote.then(result => {
    if(result.statement.details.length > 0)
        //Do something
})

Generate a Booking

/**
 * @param {number} propertyId 
 * @param {Date} checkInDate 
 * @param {Date} checkOutDate 
 * @param {number} amount
 * @param {string} status 
 * @param {string} type 
 * @param {number} renterId 
 * @param {number} numAdults 
 * @param {number} numKids 
 * @param {number} bookingSourceID 
 * @param {object} configs 
 */
let id = await Kigo.CreateBooking(1234, new Date("2019-10-28"), new Date("2019-11-01"), 1425.25, "MarkedForDeletion", "OnlineBooking", 1234, 2, 3, 123, validConfig)
id.then(result => {
    //Do something
})

Development

Kigo-wrap is in the beginning stages of development with endpoints being added as needed.

License

ISC License

Copyright (c) 2019, Kerigan Marketing Associates

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.