stem-graden-api

stemgarden_api

StemgardenApi - JavaScript client for stemgarden_api stemgarden api This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.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 stemgarden_api --save

git

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

    npm install YOUR_USERNAME/stemgarden_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 StemgardenApi = require('stemgarden_api');

var api = new StemgardenApi.AgeRangeApi()

var body = new StemgardenApi.AgeRange(); // {AgeRange} add new workshop


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addNewAgeRange(body, callback);

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/stemgarden/stemgarden/1.0

Class	Method	HTTP request	Description
StemgardenApi.AgeRangeApi	addNewAgeRange	POST /ageRange	add a new age range
StemgardenApi.AgeRangeApi	deleteAgeRangeById	DELETE /ageRange/{ageRangeId}	Deletes a age range
StemgardenApi.AgeRangeApi	getAgeRangeById	GET /ageRange/{ageRangeId}	get age range by id
StemgardenApi.AgeRangeApi	getAgeRangeList	GET /ageRange	get age range
StemgardenApi.AgeRangeApi	updateAgeRange	PUT /ageRange	Update an existing age range
StemgardenApi.AgeRangeApi	updateAgeRangeWithForm	POST /ageRange/{ageRangeId}	Updates a age range in the store with form data
StemgardenApi.ArtifactApi	addNewArtifact	POST /artifact	add a new artifact
StemgardenApi.ArtifactApi	deleteArtifactById	DELETE /artifact/{artifactId}	Deletes a artifact
StemgardenApi.ArtifactApi	getArtifactById	GET /artifact/{artifactId}	get artifact by id
StemgardenApi.ArtifactApi	getTopArtifactList	GET /artifact/topN	get top N artifacts
StemgardenApi.ArtifactApi	updateArtifact	PUT /artifact	Update an existing artifact
StemgardenApi.ArtifactApi	updateArtifactWithForm	POST /artifact/{artifactId}	Updates a artifact in the store with form data
StemgardenApi.LessonApi	addNewLesson	POST /lesson	add a new lesson
StemgardenApi.LessonApi	deleteLessonById	DELETE /lesson/{lessonId}	Deletes a lesson
StemgardenApi.LessonApi	getLessonById	GET /lesson/{lessonId}	get lesson by id
StemgardenApi.LessonApi	getLessonListByAgeRange	GET /lesson/findByAgeRange	get lesson list by age range
StemgardenApi.LessonApi	getLessonListByCategory	GET /lesson/findByCategory	get lesson list by category
StemgardenApi.LessonApi	getLessonListByType	GET /lesson/findByType	get lesson list by type
StemgardenApi.LessonApi	updateLesson	PUT /lesson	Update an existing lesson
StemgardenApi.LessonApi	updateLessonWithForm	POST /lesson/{lessonId}	Updates a lesson in the store with form data
StemgardenApi.LessonCategoryApi	getLessonCategoryList	GET /lessonCategory	get lesson category
StemgardenApi.UserApi	addNewUser	POST /user	add a new user
StemgardenApi.UserApi	authenticateUser	POST /user/authenticate	authenticate a user
StemgardenApi.UserApi	deleteUserById	DELETE /user/{userId}	Deletes a user
StemgardenApi.UserApi	getUserById	GET /user/{userId}	get user
StemgardenApi.UserApi	updateUser	PUT /user	Update an existing user
StemgardenApi.UserApi	updateUserWithForm	POST /user/{userId}	Updates a user in the store with form data
StemgardenApi.WorkshopApi	addNewWorkshop	POST /workshop	add a new workshop
StemgardenApi.WorkshopApi	deleteWorkshopById	DELETE /workshop/{workshopId}	Deletes a workshop
StemgardenApi.WorkshopApi	getRecentWorkshopList	GET /workshop/findRecent	get recent workshops
StemgardenApi.WorkshopApi	getWorkshopById	GET /workshop/{workshopId}	get workshop by id
StemgardenApi.WorkshopApi	getWorkshopByTimeRange	GET /workshop/findByTime	get workshop by time range
StemgardenApi.WorkshopApi	updateWorkshop	PUT /workshop	Update an existing workshop
StemgardenApi.WorkshopApi	updateWorkshopWithForm	POST /workshop/{workshopId}	Updates a workshop in the store with form data

Documentation for Models

• StemgardenApi.AgeRange
• StemgardenApi.ArtifactItem
• StemgardenApi.LessonCategory
• StemgardenApi.LessonItem
• StemgardenApi.LessonType
• StemgardenApi.PageRange
• StemgardenApi.User
• StemgardenApi.Workshop

Documentation for Authorization

UserSecurity

• Type: API key
• API key parameter name: X-Access-Token
• Location: HTTP header