@easyedu/js-lsm-api

v1.32.0

Published

2 months ago

OpenAPI client for @easyedu/js-lsm-api

0High
0Medium
0Low

easyedu

@easyedu/[email protected]

A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.

Usage

First, install the SDK from npm.

npm install @easyedu/js-lsm-api --save

Next, try it out.

import {
  Configuration,
  ContentApi,
} from '@easyedu/js-lsm-api';
import type { CommitScormSessionRequest } from '@easyedu/js-lsm-api';

async function example() {
  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
  const api = new ContentApi();

  const body = {
    // string | The external_id of the SCORM session
    scormSessionId: scormSessionId_example,
  } satisfies CommitScormSessionRequest;

  try {
    const data = await api.commitScormSession(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- ContentApi | commitScormSession | POST /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data ContentApi | getContent | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content ContentApi | getContentList | GET /courses/{courseId}/modules/{moduleId}/contents | get content list ContentApi | getContentSession | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session ContentApi | getContentSessionDetail | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId} | Get content session details (instructor only) ContentApi | getContentVersion | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Get details of a specific content version ContentApi | getContentVersionList | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions | Get all versions of a content ContentApi | getScormApiLogs | GET /scorm/sessions/{sessionId}/api-logs | Get SCORM API call logs (instructor only) ContentApi | getScormPackage | GET /scorm/packages/{packageId} | Get details of a SCORM package ContentApi | getScormSessionData | GET /scorm/sessions/{scormSessionId}/session-data | Get SCORM session data (instructor only) ContentApi | getScormValue | GET /scorm/sessions/{scormSessionId}/get-value | Get a SCORM CMI data element value ContentApi | initializeScormSession | POST /scorm/sessions/{scormSessionId}/initialize | Initialize a SCORM session ContentApi | listContentSessions | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions | List content sessions (instructor only) ContentApi | postContentProcess | POST /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process ContentApi | postContentQuiz | POST /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content ContentApi | postContentSession | POST /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session ContentApi | postContentUpload | POST /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload ContentApi | putContent | PUT /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id ContentApi | putContentVersion | PUT /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Update a content version ContentApi | setScormValue | POST /scorm/sessions/{scormSessionId}/set-value | Set a SCORM CMI data element value ContentApi | terminateScormSession | POST /scorm/sessions/{scormSessionId}/terminate | Terminate a SCORM session ContentApi | verifyScormManifest | POST /scorm/tools/verify-manifest | Parse and verify a SCORM manifest CourseApi | getCourse | GET /courses/{courseId} | get course CourseApi | getCourseEnrollment | GET /courses/{courseId}/enrollments/{enrollmentId} | Get a specific course enrollment CourseApi | getCourseEnrollments | GET /courses/{courseId}/enrollments | Get course enrollments CourseApi | getCourseExport | GET /courses/{courseId}/exports/{exportId} | Get details of a specific SCORM export CourseApi | getCourseExports | GET /courses/{courseId}/exports | List all SCORM exports for a course CourseApi | getCourseList | GET /courses | get course list CourseApi | getCourseReportingBasic | GET /courses/{courseId}/reporting/basic | Get basic course reporting data CourseApi | postCourse | POST /courses | Post a new course CourseApi | postCourseEnrollment | POST /courses/{courseId}/enrollments | Create a new course enrollment CourseApi | postCourseExport | POST /courses/{courseId}/exports | Create a new SCORM export for a course CourseApi | putCourse | PUT /courses/{courseId} | Update a course by id CourseApi | putCourseEnrollment | PUT /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment ModuleApi | getModule | GET /courses/{courseId}/modules/{moduleId} | get a course module ModuleApi | getModuleList | GET /courses/{courseId}/modules | get module list ModuleApi | postModule | POST /courses/{courseId}/modules | Post a new module ModuleApi | putModule | PUT /courses/{courseId}/modules/{moduleId} | Update a module by id OtherApi | getHealth | GET /healthcheck | Health check endpoint PortalApi | getPortalById | GET /portals/{portalId} | Get a portal by id (can use 'current' to get the current users selected portal) PortalApi | getPortalList | GET /portals | Get all portals a user has access to PortalApi | getPortalUsers | GET /portals/{portalId}/users | Get all users for a portal with optional role filtering PortalApi | inviteUserToPortal | POST /portals/{portalId}/invite | Invite a new user to a portal PortalApi | postPortal | POST /portals | Create a new portal as a child of the current selected portal PortalApi | putPortalBranding | PUT /portals/{portalId} | Update portal branding (name, background color, text color) PortalApi | updateSelectedPortal | PUT /portals/{portalId}/selected | Update the users current selected portal QuestionApi | deleteQuestion | DELETE /questions/{questionId} | Delete a question by ID QuestionApi | getQuestion | GET /questions/{questionId} | Get a question by ID QuestionApi | getQuestionList | GET /questions | Get list of questions with filtering and pagination QuestionApi | postQuestion | POST /questions | Create a new question QuestionApi | putQuestion | PUT /questions/{questionId} | Update a question by ID QuizApi | addQuizCriteriaQuestionSelection | POST /quizzes/{quizId}/criteria-question-selection | Add question selection criteria QuizApi | addQuizManualQuestionSelection | POST /quizzes/{quizId}/manual-question-selection | Add questions to quiz manually QuizApi | addQuizQuestions | POST /quizzes/{quizId}/questions | Add questions to quiz (manual selection) QuizApi | createQuiz | POST /quizzes | Create a new quiz configuration QuizApi | deleteQuiz | DELETE /quizzes/{quizId} | Delete quiz configuration QuizApi | deleteQuizCriteriaQuestionSelection | DELETE /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Delete question selection criteria QuizApi | deleteQuizManualQuestionSelection | DELETE /quizzes/{quizId}/manual-question-selection/{questionId} | Remove manually selected question from quiz QuizApi | getQuiz | GET /quizzes/{quizId} | Get quiz configuration by ID QuizApi | getQuizAttempt | GET /quiz-attempts/{attemptId} | Get current quiz attempt status and questions QuizApi | getQuizAttemptAnalytics | GET /quiz-attempts/{attemptId}/analytics | Get detailed analytics for quiz attempt (admin) QuizApi | getQuizAttemptResults | GET /quiz-attempts/{attemptId}/results | Get quiz attempt results QuizApi | getQuizAttempts | GET /quizzes/{quizId}/attempts | List attempts for this quiz (admin) QuizApi | getQuizCriteriaQuestionSelection | GET /quizzes/{quizId}/criteria-question-selection/{criteriaId} | Get single question selection criteria QuizApi | getQuizCriteriaQuestionSelectionList | GET /quizzes/{quizId}/criteria-question-selection | Get quiz question selection criteria list QuizApi | getQuizList | GET /quizzes | List quiz configurations QuizApi | getQuizManualQuestionSelection | GET /quizzes/{quizId}/manual-question-selection/{questionId} | Get single manually selected question QuizApi | getQuizManualQuestionSelectionList | GET /quizzes/{quizId}/manual-question-selection | Get manually selected questions for quiz QuizApi | getQuizQuestions | GET /quizzes/{quizId}/questions | Get quiz questions (paginated) QuizApi | getUserQuizAttempts | GET /users/{userId}/quiz-attempts | Get user's quiz attempts across all quizzes QuizApi | removeQuizQuestion | DELETE /quizzes/{quizId}/questions/{questionId} | Remove question from quiz QuizApi | saveQuizAnswer | PUT /quiz-attempts/{attemptId}/answers/{questionId} | Save answer for a specific question QuizApi | startQuizAttempt | POST /quizzes/{quizId}/attempts | Start a new quiz attempt QuizApi | submitQuizAttempt | POST /quiz-attempts/{attemptId}/submit | Submit quiz attempt for final scoring QuizApi | updateQuiz | PUT /quizzes/{quizId} | Update quiz configuration QuizApi | updateQuizQuestions | PUT /quizzes/{quizId}/questions | Update quiz question selection ReportingApi | getContentGradeDetail | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades/{studentId} | Get detailed grade information for a specific student and content (can use 'current' for studentId) ReportingApi | getContentGrades | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/grades | Get grades for all students enrolled in course for specific content ReportingApi | getContentInstructorBasicReporting | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/reporting/instructor/basic | Get basic instructor reporting for content ReportingApi | getCourseInstructorReportingBasic | GET /courses/{courseId}/reporting/instructor/basic | Get basic course reporting data for instructors ReportingApi | getCourseStudentReporting | GET /courses/{courseId}/reporting/students/{studentId} | Get student-specific reporting for a course (can use 'current' for studentId) ReportingApi | getModuleInstructorBasicReporting | GET /courses/{courseId}/modules/{moduleId}/reporting/instructor/basic | Get basic instructor reporting for a module ReportingApi | getModuleStudentReporting | GET /courses/{courseId}/modules/{moduleId}/reporting/students/{studentId} | Get student-specific reporting for a module (can use 'current' for studentId) ReportingApi | getPortalBasicReporting | GET /portals/{portalId}/reporting/basic | Get basic reporting for a portal (can use 'current' for portalId) ReportingApi | getPortalStudentReporting | GET /portals/{portalId}/reporting/students/{studentId} | Get student reporting for a portal (can use 'current' for portalId and studentId) UserApi | getAuthCheck | GET /auth/check | Check if a user is logged in UserApi | getUser | GET /users/{userId} | Get a user by id UserApi | postLogin | POST /auth/login | Post a new login UserApi | postLogout | POST /auth/logout | Logout a user UserApi | putUser | PUT /users/{userId} | Update a user by id UserApi | resetPassword | POST /auth/reset-password | Reset a users password UserApi | sendResetPassword | POST /auth/send-reset-password | Send a reset password email

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.32.0
Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme