1.0.1 • Published 7 years ago

stem-graden-api v1.0.1

Weekly downloads
1
License
ISC
Repository
-
Last release
7 years ago

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

ClassMethodHTTP requestDescription
StemgardenApi.AgeRangeApiaddNewAgeRangePOST /ageRangeadd a new age range
StemgardenApi.AgeRangeApideleteAgeRangeByIdDELETE /ageRange/{ageRangeId}Deletes a age range
StemgardenApi.AgeRangeApigetAgeRangeByIdGET /ageRange/{ageRangeId}get age range by id
StemgardenApi.AgeRangeApigetAgeRangeListGET /ageRangeget age range
StemgardenApi.AgeRangeApiupdateAgeRangePUT /ageRangeUpdate an existing age range
StemgardenApi.AgeRangeApiupdateAgeRangeWithFormPOST /ageRange/{ageRangeId}Updates a age range in the store with form data
StemgardenApi.ArtifactApiaddNewArtifactPOST /artifactadd a new artifact
StemgardenApi.ArtifactApideleteArtifactByIdDELETE /artifact/{artifactId}Deletes a artifact
StemgardenApi.ArtifactApigetArtifactByIdGET /artifact/{artifactId}get artifact by id
StemgardenApi.ArtifactApigetTopArtifactListGET /artifact/topNget top N artifacts
StemgardenApi.ArtifactApiupdateArtifactPUT /artifactUpdate an existing artifact
StemgardenApi.ArtifactApiupdateArtifactWithFormPOST /artifact/{artifactId}Updates a artifact in the store with form data
StemgardenApi.LessonApiaddNewLessonPOST /lessonadd a new lesson
StemgardenApi.LessonApideleteLessonByIdDELETE /lesson/{lessonId}Deletes a lesson
StemgardenApi.LessonApigetLessonByIdGET /lesson/{lessonId}get lesson by id
StemgardenApi.LessonApigetLessonListByAgeRangeGET /lesson/findByAgeRangeget lesson list by age range
StemgardenApi.LessonApigetLessonListByCategoryGET /lesson/findByCategoryget lesson list by category
StemgardenApi.LessonApigetLessonListByTypeGET /lesson/findByTypeget lesson list by type
StemgardenApi.LessonApiupdateLessonPUT /lessonUpdate an existing lesson
StemgardenApi.LessonApiupdateLessonWithFormPOST /lesson/{lessonId}Updates a lesson in the store with form data
StemgardenApi.LessonCategoryApigetLessonCategoryListGET /lessonCategoryget lesson category
StemgardenApi.UserApiaddNewUserPOST /useradd a new user
StemgardenApi.UserApiauthenticateUserPOST /user/authenticateauthenticate a user
StemgardenApi.UserApideleteUserByIdDELETE /user/{userId}Deletes a user
StemgardenApi.UserApigetUserByIdGET /user/{userId}get user
StemgardenApi.UserApiupdateUserPUT /userUpdate an existing user
StemgardenApi.UserApiupdateUserWithFormPOST /user/{userId}Updates a user in the store with form data
StemgardenApi.WorkshopApiaddNewWorkshopPOST /workshopadd a new workshop
StemgardenApi.WorkshopApideleteWorkshopByIdDELETE /workshop/{workshopId}Deletes a workshop
StemgardenApi.WorkshopApigetRecentWorkshopListGET /workshop/findRecentget recent workshops
StemgardenApi.WorkshopApigetWorkshopByIdGET /workshop/{workshopId}get workshop by id
StemgardenApi.WorkshopApigetWorkshopByTimeRangeGET /workshop/findByTimeget workshop by time range
StemgardenApi.WorkshopApiupdateWorkshopPUT /workshopUpdate an existing workshop
StemgardenApi.WorkshopApiupdateWorkshopWithFormPOST /workshop/{workshopId}Updates a workshop in the store with form data

Documentation for Models

Documentation for Authorization

UserSecurity

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