@easyedu/js-lsm-api

v1.83.0

Published

3 days 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,
  CertificateApi,
} from '@easyedu/js-lsm-api';
import type { DeleteCertificateConfigRequest } from '@easyedu/js-lsm-api';

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

  const body = {
    // string
    configId: configId_example,
  } satisfies DeleteCertificateConfigRequest;

  try {
    const data = await api.deleteCertificateConfig(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 | ----- | ------ | ------------ | ------------- CertificateApi | deleteCertificateConfig | DELETE /certificate-configs/{configId} | Delete a certificate config CertificateApi | getCertificate | GET /certificates/{certificateId} | Get a single certificate CertificateApi | getCertificateConfig | GET /certificate-configs/{configId} | Get a certificate config CertificateApi | getCertificateConfigs | GET /certificate-configs | List certificate configs in the current portal CertificateApi | getCertificatePdf | GET /certificates/{certificateId}/pdf | Download certificate as PDF CertificateApi | getCertificates | GET /certificates | List certificates in the current portal CertificateApi | getCurrentUserCertificates | GET /certificates/current | List the authenticated user's own certificates CertificateApi | getEffectiveCertificateConfig | GET /courses/{courseId}/certificate-config/effective | Resolve effective certificate config for a course CertificateApi | postCertificateConfig | POST /certificate-configs | Create a certificate config CertificateApi | postCourseCertificate | POST /courses/{courseId}/certificates | Manually issue a certificate for a course CertificateApi | postRevokeCertificate | POST /certificates/{certificateId}/revoke | Revoke a certificate CertificateApi | putCertificateConfig | PUT /certificate-configs/{configId} | Update a certificate config CertificateApi | verifyCertificate | GET /public/certificates/{certificateId}/verify | Public certificate verification (no auth) ChatApi | deleteConversation | DELETE /chat/conversations/{conversationId} | Delete a conversation ChatApi | getConversationMessages | GET /chat/conversations/{conversationId}/messages | Get all messages in a conversation ChatApi | getConversations | GET /chat/conversations | List conversations for the current user ChatApi | postConversation | POST /chat/conversations | Create a new conversation ChatApi | postMessage | POST /chat/conversations/{conversationId}/messages | Send a message to a conversation ContentApi | commitScormSession | POST /scorm/sessions/{scormSessionId}/commit | Commit SCORM session data ContentApi | deleteContent | DELETE /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id ContentApi | deleteContentVersion | DELETE /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Delete an inactive content version ContentApi | getContent | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content ContentApi | getContentAttempts | GET /courses/{courseId}/modules/{moduleId}/contents/{contentId}/attempts | Get content attempts 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 | postContentDuplicate | POST /courses/{courseId}/modules/{moduleId}/contents/{contentId}/duplicate | Duplicate a content item 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 | postContentSessionRetake | POST /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session/retake | Create a new retake 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 | putContentReorder | PUT /courses/{courseId}/modules/{moduleId}/contents/reorder | Reorder content in a module ContentApi | putContentUploadFile | PUT /courses/{courseId}/modules/{moduleId}/contents/uploads/{uploadId}/file | Upload content file through the API 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 | deleteCourse | DELETE /courses/{courseId} | Delete a course by id CourseApi | deleteCourseEnrollment | DELETE /courses/{courseId}/enrollments/{enrollmentId} | Remove a course enrollment CourseApi | deleteCourseExport | DELETE /courses/{courseId}/exports/{exportId} | Delete a course export CourseApi | deleteCourseImage | DELETE /courses/{courseId}/image | Remove the course image CourseApi | downloadCourseExport | GET /courses/{courseId}/exports/{exportId}/download | Download a completed course export 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 | postCourseDuplicate | POST /courses/{courseId}/duplicate | Duplicate a 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 | postCourseImageUpload | POST /courses/{courseId}/image | Upload a course image CourseApi | postCourseResume | POST /courses/{courseId}/resume | Resume the current learner's progress in a course CourseApi | putCourse | PUT /courses/{courseId} | Update a course by id CourseApi | putCourseEnrollment | PUT /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment CourseCatalogApi | addCourseToCatalog | POST /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog CourseCatalogApi | deleteCourseCatalog | DELETE /catalogs/{catalogId} | Delete a catalog CourseCatalogApi | getCatalogCourses | GET /catalogs/{catalogId}/courses | List the courses in a catalog CourseCatalogApi | getCourseCatalog | GET /catalogs/{catalogId} | Get a catalog CourseCatalogApi | getCourseCatalogs | GET /catalogs | List catalogs in the current portal CourseCatalogApi | postCourseCatalog | POST /catalogs | Create a course catalog CourseCatalogApi | putCourseCatalog | PUT /catalogs/{catalogId} | Update a catalog CourseCatalogApi | removeCourseFromCatalog | DELETE /catalogs/{catalogId}/courses/{courseId} | Remove a course from a catalog CourseShareApi | deleteCourseShare | DELETE /course-shares/{shareId} | Revoke a share CourseShareApi | getCourseSharesOfferedByMe | GET /course-shares/offered-by-me | List shares the current portal has offered out CourseShareApi | getCourseSharesOfferedToMe | GET /course-shares/offered-to-me | List shares offered to the current portal CourseShareApi | postOfferCatalog | POST /catalogs/{catalogId}/shares | Offer every course in a catalog to a descendant portal CourseShareApi | postOfferCourse | POST /courses/{courseId}/shares | Offer a single course to a descendant portal CourseShareApi | postUnrevokeShare | POST /course-shares/{shareId}/unrevoke | Restore a previously revoked share CourseShareApi | putAcceptClone | PUT /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal) CourseShareApi | putAcceptMirror | PUT /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source) CourseShareApi | putDeclineShare | PUT /course-shares/{shareId}/decline | Decline an offer DispatchApi | getDispatchRollup | GET /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data DispatchApi | postDispatchLaunch | POST /dispatch/launch | Launch a dispatch package ModuleApi | deleteModule | DELETE /courses/{courseId}/modules/{moduleId} | Delete a module by id 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 | postModuleDuplicate | POST /courses/{courseId}/modules/{moduleId}/duplicate | Duplicate a module ModuleApi | putModule | PUT /courses/{courseId}/modules/{moduleId} | Update a module by id ModuleApi | putModuleReorder | PUT /courses/{courseId}/modules/reorder | Reorder modules in a course OtherApi | getHealth | GET /healthcheck | Health check endpoint PlayerApi | getDispatchScormPlayer | GET /scorm/dispatch/session/{sessionId}/player | Dispatch SCORM player HTML page PlayerApi | getFileAsset | GET /file/{contentId}/asset | File asset PlayerApi | getFilePlayer | GET /file/session/{sessionId}/player | File player HTML page PlayerApi | getImagePlayer | GET /image/session/{sessionId}/player | Image player HTML page PlayerApi | getPdfAsset | GET /pdf/{contentId}/asset | PDF asset PlayerApi | getPdfPlayer | GET /pdf/session/{sessionId}/player | PDF player HTML page PlayerApi | getQuizPlayer | GET /quiz/session/{sessionId}/player | Quiz player HTML page PlayerApi | getScormAsset | GET /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset PlayerApi | getScormPlayer | GET /scorm/session/{sessionId}/player | SCORM player HTML page PlayerApi | getVideoAsset | GET /video/{contentId}/asset | Video asset PlayerApi | getVideoPlayer | GET /video/session/{sessionId}/player | Video player HTML page PortalApi | deletePortalFavicon | DELETE /portals/{portalId}/branding/favicon | Remove the portal favicon PortalApi | deletePortalLogo | DELETE /portals/{portalId}/branding/logo | Remove the portal logo PortalApi | getPortalById | GET /portals/{portalId} | Get a portal by id (can use 'current' to get the current users selected portal) PortalApi | getPortalFaviconAsset | GET /portals/{portalId}/branding/favicon | Stream the configured portal favicon PortalApi | getPortalList | GET /portals | Get all portals a user has access to PortalApi | getPortalLogoAsset | GET /portals/{portalId}/branding/logo | Stream the configured portal logo PortalApi | getPortalUserFieldConfig | GET /portals/{portalId}/user-field-config | Get portal user field configuration PortalApi | getPortalUserFieldValues | GET /portals/{portalId}/users/{userId}/user-field-values | Get a user's portal field values and completion status PortalApi | getPortalUsers | GET /portals/{portalId}/users | Get all users for a portal with optional role filtering PortalApi | getPublicPortalBranding | GET /public/portal/branding | Public portal branding resolved from the request host PortalApi | getPublicPortalFaviconAsset | GET /public/portal/branding/favicon | Public portal favicon resolved from the request host PortalApi | getPublicPortalLogoAsset | GET /public/portal/branding/logo | Public portal logo resolved from the request host 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 | postPortalFaviconUpload | POST /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding PortalApi | postPortalLogoUpload | POST /portals/{portalId}/branding/logo | Upload a logo image for portal branding PortalApi | putPortalBranding | PUT /portals/{portalId} | Update portal branding (name, background color, text color) PortalApi | putPortalUserFieldConfig | PUT /portals/{portalId}/user-field-config | Replace portal user field configuration PortalApi | putPortalUserFieldValues | PUT /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user's portal field values PortalApi | removePortalUser | DELETE /portals/{portalId}/users/{userId} | Remove a user from a portal PortalApi | updateSelectedPortal | PUT /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. PortalSublicenseApi | putPortalSublicense | PUT /portals/{portalId}/sublicense | Manage seat limit and license window for a descendant 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 | gradeQuizAnswer | PUT /quiz-attempts/{attemptId}/answers/{questionId}/grade | Grade or override score for a question answer 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) RichTextApi | getRichTextAsset | GET /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL RichTextApi | postRichTextAssetComplete | POST /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload RichTextApi | postRichTextAssetUpload | POST /rich-text/assets/uploads | Create a pending rich text asset upload RichTextApi | putRichTextAssetFile | PUT /rich-text/assets/{assetId}/file | Upload a pending rich text asset file through the API RoleApi | assignUserRole | POST /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Assign a role to a user for a portal RoleApi | createRole | POST /roles | Create a custom role scoped to the current portal RoleApi | deleteRole | DELETE /roles/{roleId} | Deactivate a custom role RoleApi | getPermissions | GET /roles/permissions | List all available permissions in the system RoleApi | getRole | GET /roles/{roleId} | Get role details with permissions RoleApi | getRoles | GET /roles | List all roles available to the current portal RoleApi | getUserRoles | GET /roles/users/{userId}/portals/{portalId} | Get all active roles for a user in a portal RoleApi | unassignUserRole | DELETE /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Remove a role from a user for a portal RoleApi | updateRole | PUT /roles/{roleId} | Update a custom role name and description RoleApi | updateRolePermissions | PUT /roles/{roleId}/permissions | Replace all permissions for a custom role SupportTicketApi | closeSupportTicket | POST /support/tickets/{ticketId}/close | Close a support ticket SupportTicketApi | downloadSupportTicketAttachment | GET /support/tickets/{ticketId}/attachments/{attachmentId}/download | Download a ticket attachment SupportTicketApi | getSupportTicket | GET /support/tickets/{ticketId} | Get support ticket details SupportTicketApi | getSupportTicketComments | GET /support/tickets/{ticketId}/comments | Get comments for a ticket SupportTicketApi | getSupportTickets | GET /support/tickets | List support tickets SupportTicketApi | postSupportTicket | POST /support/tickets | Create a support ticket SupportTicketApi | postSupportTicketAttachment | POST /support/tickets/{ticketId}/attachments | Upload an attachment to a ticket SupportTicketApi | postSupportTicketComment | POST /support/tickets/{ticketId}/comments | Add a comment to a ticket SupportTicketApi | putSupportTicket | PUT /support/tickets/{ticketId} | Update a support ticket SystemApi | getSystemBilling | GET /system/billing | List mock platform billing information SystemApi | getSystemMetrics | GET /system/metrics | Get platform-wide metrics SystemApi | getSystemPortal | GET /system/portals/{portalId} | Get platform portal detail SystemApi | getSystemPortals | GET /system/portals | List all platform portals SystemApi | getSystemSupportTickets | GET /system/support/tickets | List open support tickets across the platform UserApi | deleteUserAvatar | DELETE /users/{userId}/avatar | Remove the current user's profile photo UserApi | getAuthCheck | GET /auth/check | Check if a user is logged in UserApi | getCurrentUserPermissions | GET /users/current/permissions | Get the current user's permissions UserApi | getUser | GET /users/{userId} | Get a user by id UserApi | getUserCourses | GET /users/{userId}/courses | Get enrolled courses for a user UserApi | getUserEnrollments | GET /users/{userId}/enrollments | Get user enrollments UserApi | postLogin | POST /auth/login | Post a new login UserApi | postLogout | POST /auth/logout | Logout a user UserApi | postSignupRequest | POST /auth/signup-request | Request a new organization signup UserApi | postUserAvatarUpload | POST /users/{userId}/avatar | Upload a profile photo for the current 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 UserApi | verifySignupRequest | GET /auth/signup/verify | Verify a signup request and provision the portal

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.83.0
Generator version: 7.22.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