# educhat_api

> ERROR_UNKNOWN

Latest version **1.0.0** (published 2017-03-30) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-03-30 |
| First published | 2017-03-30 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | ldaltro |

## Links

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

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 1.7.1

## Recent versions

- 1.0.0 (latest) — 2017-03-30

## README

# educhat_api

EduchatApi - JavaScript client for educhat_api
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install educhat_api --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/educhat_api
then install it via:

```shell
    npm install YOUR_USERNAME/educhat_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var EduchatApi = require('educhat_api');

var api = new EduchatApi.ApiApi()

var opts = { 
  'data': new EduchatApi.Data() // {Data} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiLoginCreate(opts, callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://api.edu.chat*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EduchatApi.ApiApi* | [**apiLoginCreate**](docs/ApiApi.md#apiLoginCreate) | **POST** /v1/api/login/ | 
*EduchatApi.ApiApi* | [**apiLogoutCreate**](docs/ApiApi.md#apiLogoutCreate) | **POST** /v1/api/logout/ | No documentation beyond REST Standards;
*EduchatApi.BotApi* | [**botAddQuestionAnswerPairCreate**](docs/BotApi.md#botAddQuestionAnswerPairCreate) | **POST** /v1/bot/add_question_answer_pair/ | 
*EduchatApi.BotApi* | [**botCreateChatBotCreate**](docs/BotApi.md#botCreateChatBotCreate) | **POST** /v1/bot/create_chat_bot/ | 
*EduchatApi.BotApi* | [**botCrowdsourceAdminsOnlyCreate**](docs/BotApi.md#botCrowdsourceAdminsOnlyCreate) | **POST** /v1/bot/crowdsource_admins_only/ | 
*EduchatApi.BotApi* | [**botJoinChatGroupCreate**](docs/BotApi.md#botJoinChatGroupCreate) | **POST** /v1/bot/join_chat_group/ | 
*EduchatApi.BotApi* | [**botMakeAdminCreate**](docs/BotApi.md#botMakeAdminCreate) | **POST** /v1/bot/make_admin/ | 
*EduchatApi.BotApi* | [**botSendAnswerCreate**](docs/BotApi.md#botSendAnswerCreate) | **POST** /v1/bot/send_answer/ | 
*EduchatApi.BotApi* | [**botValidateCreate**](docs/BotApi.md#botValidateCreate) | **POST** /v1/bot/validate/ | 
*EduchatApi.BotApi* | [**botViewAnswersList**](docs/BotApi.md#botViewAnswersList) | **GET** /v1/bot/view_answers/ | 
*EduchatApi.BotApi* | [**botViewQuestionsAnswersList**](docs/BotApi.md#botViewQuestionsAnswersList) | **GET** /v1/bot/view_questions_answers/ | 
*EduchatApi.ChatApi* | [**chatCreate**](docs/ChatApi.md#chatCreate) | **POST** /v1/chat/ | Paginated;
*EduchatApi.ChatApi* | [**chatDelete**](docs/ChatApi.md#chatDelete) | **DELETE** /v1/chat/{id}/ | No documentation beyond REST Standards;
*EduchatApi.ChatApi* | [**chatList**](docs/ChatApi.md#chatList) | **GET** /v1/chat/ | Paginated;
*EduchatApi.ChatApi* | [**chatPartialUpdate**](docs/ChatApi.md#chatPartialUpdate) | **PATCH** /v1/chat/{id}/ | No documentation beyond REST Standards;
*EduchatApi.ChatApi* | [**chatResourcesList**](docs/ChatApi.md#chatResourcesList) | **GET** /v1/chat/{chat}/resources/ | Paginated;
*EduchatApi.Chat_userApi* | [**chatUserCreate**](docs/Chat_userApi.md#chatUserCreate) | **POST** /v1/chat_user/ | Paginated;
*EduchatApi.Chat_userApi* | [**chatUserDelete**](docs/Chat_userApi.md#chatUserDelete) | **DELETE** /v1/chat_user/{chat}/{user}/ | No documentation beyond REST Standards;
*EduchatApi.Chat_userApi* | [**chatUserList**](docs/Chat_userApi.md#chatUserList) | **GET** /v1/chat_user/ | Paginated;
*EduchatApi.Chat_userApi* | [**chatUserPartialUpdate**](docs/Chat_userApi.md#chatUserPartialUpdate) | **PATCH** /v1/chat_user/{chat}/{user}/ | No documentation beyond REST Standards;
*EduchatApi.FileApi* | [**fileCreate**](docs/FileApi.md#fileCreate) | **POST** /v1/file/ | No documentation beyond REST Standards;
*EduchatApi.FileApi* | [**filePartialUpdate**](docs/FileApi.md#filePartialUpdate) | **PATCH** /v1/file/{id}/ | No documentation beyond REST Standards;
*EduchatApi.InstitutionApi* | [**institutionDepartmentList**](docs/InstitutionApi.md#institutionDepartmentList) | **GET** /v1/institution/department/ | Paginated;
*EduchatApi.InstitutionApi* | [**institutionSchoolList**](docs/InstitutionApi.md#institutionSchoolList) | **GET** /v1/institution/school/ | Paginated;
*EduchatApi.InstitutionApi* | [**institutionUniversityList**](docs/InstitutionApi.md#institutionUniversityList) | **GET** /v1/institution/university/ | Paginated;
*EduchatApi.MessageApi* | [**messageCreate**](docs/MessageApi.md#messageCreate) | **POST** /v1/message/ | Paginated;
*EduchatApi.MessageApi* | [**messageList**](docs/MessageApi.md#messageList) | **GET** /v1/message/ | Paginated;
*EduchatApi.MessageApi* | [**messagePartialUpdate**](docs/MessageApi.md#messagePartialUpdate) | **PATCH** /v1/message/{id}/ | No documentation beyond REST Standards;
*EduchatApi.MessageApi* | [**messageUpvoteCreate**](docs/MessageApi.md#messageUpvoteCreate) | **POST** /v1/message/upvote/ | Paginated;
*EduchatApi.MessageApi* | [**messageUpvoteList**](docs/MessageApi.md#messageUpvoteList) | **GET** /v1/message/upvote/ | Paginated;
*EduchatApi.PasswordApi* | [**passwordRequestCreate**](docs/PasswordApi.md#passwordRequestCreate) | **POST** /v1/password/request/ | No documentation beyond REST Standards;
*EduchatApi.PasswordApi* | [**passwordResetCreate**](docs/PasswordApi.md#passwordResetCreate) | **POST** /v1/password/reset/ | No documentation beyond REST Standards;
*EduchatApi.TagApi* | [**tagChatCreate**](docs/TagApi.md#tagChatCreate) | **POST** /v1/tag/chat/ | No documentation beyond REST Standards;
*EduchatApi.TagApi* | [**tagList**](docs/TagApi.md#tagList) | **GET** /v1/tag/ | No documentation beyond REST Standards;
*EduchatApi.TagApi* | [**tagUserCreate**](docs/TagApi.md#tagUserCreate) | **POST** /v1/tag/user/ | No documentation beyond REST Standards;
*EduchatApi.UserApi* | [**userList**](docs/UserApi.md#userList) | **GET** /v1/user/ | Paginated;
*EduchatApi.UserApi* | [**userMeList**](docs/UserApi.md#userMeList) | **GET** /v1/user/me/ | No documentation beyond REST Standards;
*EduchatApi.UserApi* | [**userPartialUpdate**](docs/UserApi.md#userPartialUpdate) | **PATCH** /v1/user/{id}/ | No documentation beyond REST Standards;
*EduchatApi.UserApi* | [**userSignupCreate**](docs/UserApi.md#userSignupCreate) | **POST** /v1/user/signup/ | No documentation beyond REST Standards;
*EduchatApi.UserApi* | [**userVerifyList**](docs/UserApi.md#userVerifyList) | **GET** /v1/user/verify/ | No documentation beyond REST Standards;


## Documentation for Models

 - [EduchatApi.ChatUser](docs/ChatUser.md)
 - [EduchatApi.Data](docs/Data.md)
 - [EduchatApi.Data1](docs/Data1.md)
 - [EduchatApi.Data10](docs/Data10.md)
 - [EduchatApi.Data11](docs/Data11.md)
 - [EduchatApi.Data12](docs/Data12.md)
 - [EduchatApi.Data13](docs/Data13.md)
 - [EduchatApi.Data14](docs/Data14.md)
 - [EduchatApi.Data15](docs/Data15.md)
 - [EduchatApi.Data2](docs/Data2.md)
 - [EduchatApi.Data3](docs/Data3.md)
 - [EduchatApi.Data4](docs/Data4.md)
 - [EduchatApi.Data5](docs/Data5.md)
 - [EduchatApi.Data6](docs/Data6.md)
 - [EduchatApi.Data7](docs/Data7.md)
 - [EduchatApi.Data8](docs/Data8.md)
 - [EduchatApi.Data9](docs/Data9.md)
 - [EduchatApi.InlineResponse201](docs/InlineResponse201.md)
 - [EduchatApi.InlineResponse2011](docs/InlineResponse2011.md)
 - [EduchatApi.InlineResponse2012](docs/InlineResponse2012.md)
 - [EduchatApi.User](docs/User.md)


## Documentation for Authorization

 All endpoints do not require authorization.

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