teachstack v0.0.1

NodeJs SDK for teachstack APIs

Description

This module can be used to call teachstack APIs by just using a function. The functions are explained later in this document.

Requirements

• NPM
• Teachstack ClientID and AuthKey (https://docs.teachmint.com/api)

Installing

• node install teachstack
• Create a .env file and enter the following values:

  clientId = YOUR_CLIENT_ID
  authKey = YOUR_AUTH_KEY

Executing program

//If you are using ES6 module pattern (have "type": "module" in the package.json)
import * as ts from "teachstack";

//If you are not using ES6 module pattern
const ts = require("teachstack");

/*
Example Usage:
--------------

import * as ts from teachstack

ts.addRoom("ROOM_ID", "ROOM_NAME");
ts.addUser("ROOM_ID", "USER_ID", "USER_NAME", 1).then(function (result) {
console.log(result.data["data"]["url"]);
});
*/

Functions

• addRoom( room_id: String, name: String, is_video_on: Boolean = false, is_mic_on: Boolean = false, video_quality: Boolean = false, is_recording_on: Boolean = false, is_mute_blocked: Boolean = false, is_mic_blocked: Boolean = false, is_video_blocked: Boolean = false, is_chat_blocked: Boolean = false, is_front_camera: Boolean = false, is_portrait_vc: Boolean = false )
• getAllRoom()
• getRoom(room_id: String)
• deleteRoom(room_id: String)
• addUser( room_id: String, user_id: String, name: String, type: Number )
• getRecordings( room_id: String = undefined, starting_after: String = undefined, ending_before: String = undefined, limit: Number = undefined, status: Array = undefined, recording_id: Array = undefined, session_id: Array = undefined )
• deleteRecordings(UUIDs: String[])

Authors

Contributors names and contact info Parth Agrawal

License

This project is licensed under the MIT License - see the LICENSE.txt file for details