@easyedu/js-lsm-api 1.63.0 → 1.64.0

package/src/apis/CourseApi.ts

@@ -84,6 +84,10 @@ import {
     PutCourseEnrollmentToJSON,
 } from '../models/PutCourseEnrollment';
 
+export interface DeleteCourseRequest {
+    courseId: string;
+}
+
 export interface DeleteCourseImageRequest {
     courseId: string;
 }
@@ -167,6 +171,52 @@ export interface PutCourseEnrollmentRequest {
  */
 export class CourseApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteCourse without sending the request
+     */
+    async deleteCourseRequestOpts(requestParameters: DeleteCourseRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteCourse().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-deletes the course and its modules/content.
+     * Delete a course by id
+     */
+    async deleteCourseRaw(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Soft-deletes the course and its modules/content.
+     * Delete a course by id
+     */
+    async deleteCourse(requestParameters: DeleteCourseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for deleteCourseImage without sending the request
      */

package/src/apis/ModuleApi.ts

@@ -44,6 +44,11 @@ import {
     PutModuleReorderToJSON,
 } from '../models/PutModuleReorder';
 
+export interface DeleteModuleRequest {
+    moduleId: string;
+    courseId: string;
+}
+
 export interface GetModuleRequest {
     moduleId: string;
     courseId: string;
@@ -80,6 +85,60 @@ export interface PutModuleReorderRequest {
  */
 export class ModuleApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteModule without sending the request
+     */
+    async deleteModuleRequestOpts(requestParameters: DeleteModuleRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling deleteModule().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteModule().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}`;
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    async deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteModuleRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    async deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteModuleRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getModule without sending the request
      */

package/src/apis/UserApi.ts

@@ -43,6 +43,16 @@ import {
     PostSendResetPasswordFromJSON,
     PostSendResetPasswordToJSON,
 } from '../models/PostSendResetPassword';
+import {
+    type PostSignupRequest,
+    PostSignupRequestFromJSON,
+    PostSignupRequestToJSON,
+} from '../models/PostSignupRequest';
+import {
+    type PostSignupRequestResponse,
+    PostSignupRequestResponseFromJSON,
+    PostSignupRequestResponseToJSON,
+} from '../models/PostSignupRequestResponse';
 import {
     type PutUser,
     PutUserFromJSON,
@@ -61,6 +71,10 @@ export interface PostLoginRequest {
     postLogin: PostLogin;
 }
 
+export interface PostSignupRequestRequest {
+    postSignupRequest: PostSignupRequest;
+}
+
 export interface PostUserAvatarUploadRequest {
     userId: string;
     file: Blob;
@@ -79,6 +93,10 @@ export interface SendResetPasswordRequest {
     postSendResetPassword: PostSendResetPassword;
 }
 
+export interface VerifySignupRequestRequest {
+    token: string;
+}
+
 /**
  * 
  */
@@ -331,6 +349,53 @@ export class UserApi extends runtime.BaseAPI {
         await this.postLogoutRaw(initOverrides);
     }
 
+    /**
+     * Creates request options for postSignupRequest without sending the request
+     */
+    async postSignupRequestRequestOpts(requestParameters: PostSignupRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postSignupRequest'] == null) {
+            throw new runtime.RequiredError(
+                'postSignupRequest',
+                'Required parameter "postSignupRequest" was null or undefined when calling postSignupRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/auth/signup-request`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostSignupRequestToJSON(requestParameters['postSignupRequest']),
+        };
+    }
+
+    /**
+     * Request a new organization signup
+     */
+    async postSignupRequestRaw(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostSignupRequestResponse>> {
+        const requestOptions = await this.postSignupRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostSignupRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Request a new organization signup
+     */
+    async postSignupRequest(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostSignupRequestResponse> {
+        const response = await this.postSignupRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postUserAvatarUpload without sending the request
      */
@@ -551,4 +616,51 @@ export class UserApi extends runtime.BaseAPI {
         await this.sendResetPasswordRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for verifySignupRequest without sending the request
+     */
+    async verifySignupRequestRequestOpts(requestParameters: VerifySignupRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling verifySignupRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['token'] != null) {
+            queryParameters['token'] = requestParameters['token'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/auth/signup/verify`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Verify a signup request and provision the portal
+     */
+    async verifySignupRequestRaw(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.verifySignupRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Verify a signup request and provision the portal
+     */
+    async verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.verifySignupRequestRaw(requestParameters, initOverrides);
+    }
+
 }

package/src/models/PostSignupRequest.ts

@@ -0,0 +1,120 @@
+/* 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 PostSignupRequest
+ */
+export interface PostSignupRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    lastName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    password: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    organization: string;
+    /**
+     * Signup/onboarding role supplied by the user; not an LMS RBAC role.
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    jobRole: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostSignupRequest
+     */
+    learnerCount: number;
+}
+
+/**
+ * Check if a given object implements the PostSignupRequest interface.
+ */
+export function instanceOfPostSignupRequest(value: object): value is PostSignupRequest {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('password' in value) || value['password'] === undefined) return false;
+    if (!('organization' in value) || value['organization'] === undefined) return false;
+    if (!('jobRole' in value) || value['jobRole'] === undefined) return false;
+    if (!('learnerCount' in value) || value['learnerCount'] === undefined) return false;
+    return true;
+}
+
+export function PostSignupRequestFromJSON(json: any): PostSignupRequest {
+    return PostSignupRequestFromJSONTyped(json, false);
+}
+
+export function PostSignupRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'email': json['email'],
+        'password': json['password'],
+        'organization': json['organization'],
+        'jobRole': json['job_role'],
+        'learnerCount': json['learner_count'],
+    };
+}
+
+export function PostSignupRequestToJSON(json: any): PostSignupRequest {
+    return PostSignupRequestToJSONTyped(json, false);
+}
+
+export function PostSignupRequestToJSONTyped(value?: PostSignupRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'email': value['email'],
+        'password': value['password'],
+        'organization': value['organization'],
+        'job_role': value['jobRole'],
+        'learner_count': value['learnerCount'],
+    };
+}
+

package/src/models/PostSignupRequestResponse.ts

@@ -0,0 +1,66 @@
+/* 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 PostSignupRequestResponse
+ */
+export interface PostSignupRequestResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostSignupRequestResponse
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the PostSignupRequestResponse interface.
+ */
+export function instanceOfPostSignupRequestResponse(value: object): value is PostSignupRequestResponse {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function PostSignupRequestResponseFromJSON(json: any): PostSignupRequestResponse {
+    return PostSignupRequestResponseFromJSONTyped(json, false);
+}
+
+export function PostSignupRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequestResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+    };
+}
+
+export function PostSignupRequestResponseToJSON(json: any): PostSignupRequestResponse {
+    return PostSignupRequestResponseToJSONTyped(json, false);
+}
+
+export function PostSignupRequestResponseToJSONTyped(value?: PostSignupRequestResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+    };
+}
+

package/src/models/index.ts

@@ -212,6 +212,8 @@ export * from './PostResetPassword';
 export * from './PostRevokeCertificate';
 export * from './PostRole';
 export * from './PostSendResetPassword';
+export * from './PostSignupRequest';
+export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';