oliver-core v1.1.5

Oliver Core

Oliver client for NodeJs application integration.

Initialization

npm install oliver-core
// or
yarn add oliver-core

Create an account from Oliver Platform. (development, staging, production)

import { oliver } from '.';

// Choose environment 'development' | 'staging' | 'production'
// Retrieve your user keys from platform account settings.
oliver.configure('<ENV>', {
  apiKey: '<API_KEY>',
  apiSecret: '<API_SECRET>',
});

Usage

Create Room

import { createInvitation } from '.';

const response = await createRoom({
  /*See Parameters*/
});

if (response.type === 'success') {
  const room = response.value;
  console.log(room);
} else {
  throw Error(`Room creation failed with ${response.error}`);
}

Invite Admins, Moderators and Members

By creating admin/moderator invitation, collaboration e-mail is sent navigating user to the platform. By creating member invitation, participation e-mail is sent navigating user to join the room.

import { createInvitation } from '.';

const response = await createInvitation({
  /*See Parameters*/
});

if (response.type === 'success') {
  const invitation = response.value;
  console.log(invitation);
} else {
  throw Error(`Room creation failed with ${response.error}`);
}