Educhat_api NPM

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 project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

    npm install YOUR_USERNAME/educhat_api --save

For browser

The library also works in the browser environment via npm and browserify. 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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

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

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@infinitebrahmanuniverse/nolb-edu @everything-registry/sub-chunk-1555

1.0.0

8 years ago