@easyedu/js-lsm-api 1.0.0-677fab496294ee48248fd8a03fee59e3bf0dcf02

package/src/apis/ModuleApi.ts

@@ -0,0 +1,166 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  GetModule,
+  GetModuleList,
+  PostModule,
+} from '../models/index';
+import {
+    GetModuleFromJSON,
+    GetModuleToJSON,
+    GetModuleListFromJSON,
+    GetModuleListToJSON,
+    PostModuleFromJSON,
+    PostModuleToJSON,
+} from '../models/index';
+
+export interface GetModuleRequest {
+    moduleId: string;
+    courseId: string;
+}
+
+export interface GetModuleListRequest {
+    courseId: string;
+}
+
+export interface PostModuleRequest {
+    courseId: string;
+    postModule: PostModule;
+}
+
+/**
+ * 
+ */
+export class ModuleApi extends runtime.BaseAPI {
+
+    /**
+     * get a course module
+     */
+    async getModuleRaw(requestParameters: GetModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModule>> {
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling getModule().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getModule().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules/{moduleId}`.replace(`{${"moduleId"}}`, encodeURIComponent(String(requestParameters['moduleId']))).replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleFromJSON(jsonValue));
+    }
+
+    /**
+     * get a course module
+     */
+    async getModule(requestParameters: GetModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModule> {
+        const response = await this.getModuleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * get module list
+     */
+    async getModuleListRaw(requestParameters: GetModuleListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModuleList>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getModuleList().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleListFromJSON(jsonValue));
+    }
+
+    /**
+     * get module list
+     */
+    async getModuleList(requestParameters: GetModuleListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModuleList> {
+        const response = await this.getModuleListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * post module
+     */
+    async postModuleRaw(requestParameters: PostModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetModule>> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postModule().'
+            );
+        }
+
+        if (requestParameters['postModule'] == null) {
+            throw new runtime.RequiredError(
+                'postModule',
+                'Required parameter "postModule" was null or undefined when calling postModule().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/courses/{courseId}/modules`.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostModuleToJSON(requestParameters['postModule']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModuleFromJSON(jsonValue));
+    }
+
+    /**
+     * post module
+     */
+    async postModule(requestParameters: PostModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetModule> {
+        const response = await this.postModuleRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/OtherApi.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+
+/**
+ * 
+ */
+export class OtherApi extends runtime.BaseAPI {
+
+    /**
+     * Health check endpoint
+     */
+    async getHealthRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/health`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Health check endpoint
+     */
+    async getHealth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getHealthRaw(initOverrides);
+    }
+
+}

package/src/apis/UserApi.ts

@@ -0,0 +1,156 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  GetUser,
+  LoginRes,
+  PostLogin,
+  PostUser,
+} from '../models/index';
+import {
+    GetUserFromJSON,
+    GetUserToJSON,
+    LoginResFromJSON,
+    LoginResToJSON,
+    PostLoginFromJSON,
+    PostLoginToJSON,
+    PostUserFromJSON,
+    PostUserToJSON,
+} from '../models/index';
+
+export interface GetUserRequest {
+    userId: string;
+}
+
+export interface PostLoginRequest {
+    postLogin: PostLogin;
+}
+
+export interface PostUserRequest {
+    postUser: PostUser;
+}
+
+/**
+ * 
+ */
+export class UserApi extends runtime.BaseAPI {
+
+    /**
+     * get user
+     */
+    async getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling getUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/users/{userId}`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
+    }
+
+    /**
+     * get user
+     */
+    async getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser> {
+        const response = await this.getUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * post login
+     */
+    async postLoginRaw(requestParameters: PostLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginRes>> {
+        if (requestParameters['postLogin'] == null) {
+            throw new runtime.RequiredError(
+                'postLogin',
+                'Required parameter "postLogin" was null or undefined when calling postLogin().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/auth/login`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostLoginToJSON(requestParameters['postLogin']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginResFromJSON(jsonValue));
+    }
+
+    /**
+     * post login
+     */
+    async postLogin(requestParameters: PostLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginRes> {
+        const response = await this.postLoginRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * post user
+     */
+    async postUserRaw(requestParameters: PostUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUser>> {
+        if (requestParameters['postUser'] == null) {
+            throw new runtime.RequiredError(
+                'postUser',
+                'Required parameter "postUser" was null or undefined when calling postUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostUserToJSON(requestParameters['postUser']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUserFromJSON(jsonValue));
+    }
+
+    /**
+     * post user
+     */
+    async postUser(requestParameters: PostUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUser> {
+        const response = await this.postUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ContentApi';
+export * from './CourseApi';
+export * from './ModuleApi';
+export * from './OtherApi';
+export * from './UserApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/GetContent.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetContent
+ */
+export interface GetContent {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetContent
+     */
+    readonly id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetContent
+     */
+    moduleId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetContent
+     */
+    name: string;
+}
+
+/**
+ * Check if a given object implements the GetContent interface.
+ */
+export function instanceOfGetContent(value: object): value is GetContent {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function GetContentFromJSON(json: any): GetContent {
+    return GetContentFromJSONTyped(json, false);
+}
+
+export function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'moduleId': json['module_id'],
+        'name': json['name'],
+    };
+}
+
+export function GetContentToJSON(json: any): GetContent {
+    return GetContentToJSONTyped(json, false);
+}
+
+export function GetContentToJSONTyped(value?: Omit<GetContent, 'id'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'module_id': value['moduleId'],
+        'name': value['name'],
+    };
+}
+

package/src/models/GetContentList.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { GetContent } from './GetContent';
+import {
+    GetContentFromJSON,
+    GetContentFromJSONTyped,
+    GetContentToJSON,
+    GetContentToJSONTyped,
+} from './GetContent';
+
+/**
+ * A list of content within a module
+ * @export
+ * @interface GetContentList
+ */
+export interface GetContentList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetContentList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetContent>}
+     * @memberof GetContentList
+     */
+    items: Array<GetContent>;
+}
+
+/**
+ * Check if a given object implements the GetContentList interface.
+ */
+export function instanceOfGetContentList(value: object): value is GetContentList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetContentListFromJSON(json: any): GetContentList {
+    return GetContentListFromJSONTyped(json, false);
+}
+
+export function GetContentListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetContentFromJSON)),
+    };
+}
+
+export function GetContentListToJSON(json: any): GetContentList {
+    return GetContentListToJSONTyped(json, false);
+}
+
+export function GetContentListToJSONTyped(value?: GetContentList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetContentToJSON)),
+    };
+}
+

package/src/models/GetContentSession.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A content session
+ * @export
+ * @interface GetContentSession
+ */
+export interface GetContentSession {
+    /**
+     * The id of the content
+     * @type {string}
+     * @memberof GetContentSession
+     */
+    contentId: string;
+    /**
+     * The id of the user
+     * @type {string}
+     * @memberof GetContentSession
+     */
+    userId: string;
+    /**
+     * The url of the content
+     * @type {string}
+     * @memberof GetContentSession
+     */
+    lanchUrl: string;
+    /**
+     * The date and time the content session was created
+     * @type {number}
+     * @memberof GetContentSession
+     */
+    createdAt: number;
+}
+
+/**
+ * Check if a given object implements the GetContentSession interface.
+ */
+export function instanceOfGetContentSession(value: object): value is GetContentSession {
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('lanchUrl' in value) || value['lanchUrl'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function GetContentSessionFromJSON(json: any): GetContentSession {
+    return GetContentSessionFromJSONTyped(json, false);
+}
+
+export function GetContentSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentId': json['content_id'],
+        'userId': json['user_id'],
+        'lanchUrl': json['lanch_url'],
+        'createdAt': json['created_at'],
+    };
+}
+
+export function GetContentSessionToJSON(json: any): GetContentSession {
+    return GetContentSessionToJSONTyped(json, false);
+}
+
+export function GetContentSessionToJSONTyped(value?: GetContentSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_id': value['contentId'],
+        'user_id': value['userId'],
+        'lanch_url': value['lanchUrl'],
+        'created_at': value['createdAt'],
+    };
+}
+