# teachstack

> Teachstack SDK

Latest version **0.0.1** (published 2022-04-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install teachstack
pnpm add teachstack
yarn add teachstack
bun add teachstack
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-04-20 |
| First published | 2022-04-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Parth Agrawal |
| Maintainers | parthagrawal |
| Keywords | teachstack, teachmint |

## Links

- npm: https://www.npmjs.com/package/teachstack
- npm.io page: https://npm.io/package/teachstack

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.26.1
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.0

## Recent versions

- 0.0.1 (latest) — 2022-04-20

## README

# 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

```js
//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<String> = undefined,
  recording_id: Array<String> = undefined,
  session_id: Array<String> = undefined
  )
- deleteRecordings(UUIDs: String[])

## Authors

Contributors names and contact info
[Parth Agrawal](parth@teachmint.com)

## License

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

---
_Source: https://npm.io/package/teachstack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._