Ravti Node client

Warning! API does not support all functions yet even if client does

Warning! Please supply a API_ENDPOINT envvar while in alpha

Usage

When constructing a client with an API key, a simple request to fetch possible users is made, as a hack to confirm that the API key is valid. Please await the constructor.

const Ravti = require('ravti');

// Optional config object
// baseURL is default to staging api currently
const config = {
  baseURL: 'https://staging-api.ravti.com/api',
};


const ravtiClient = await new Ravti(API_KEY, config);

Supported models and functions

Currently, only read-only support is ready

Organizations

// Get all
await ravtiClient.organizations.get.all();

// Get at a certain id
await ravtiClient.organizations.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.organizations.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.organizations.get.where({name: 'Org Name'});

Users

// Get all
await ravtiClient.users.get.all();

// Get at a certain id
await ravtiClient.users.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.users.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.users.get.where({name: 'Org Name'});

Facilities

// Get all
await ravtiClient.facilities.get.all();

// Get at a certain id
await ravtiClient.facilities.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.facilities.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.facilities.get.where({name: 'Org Name'});

Suites

// Get all
await ravtiClient.suites.get.all();

// Get at a certain id
await ravtiClient.suites.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.suites.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.suites.get.where({name: 'Org Name'});

Units

// Get all
await ravtiClient.units.get.all();

// Get at a certain id
await ravtiClient.units.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.units.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.units.get.where({name: 'Org Name'});

Work Histories

// Get all
await ravtiClient.histories.get.all();

// Get at a certain id
await ravtiClient.histories.get.id(1337);

// Get all with only certain fields (not serialized)
await ravtiClient.histories.get.fields(['id', 'name']);

// Get where a certain query is true
await ravtiClient.histories.get.where({name: 'Org Name'});

// POST history
await ravtiClient.histories.create(data); // FormData object