@easyedu/js-lsm-api 1.63.0 → 1.64.0

package/dist/esm/apis/ModuleApi.d.ts

@@ -16,6 +16,10 @@ import { type PostDuplicate1 } from '../models/PostDuplicate1';
 import { type PostModule } from '../models/PostModule';
 import { type PutModule } from '../models/PutModule';
 import { type PutModuleReorder } from '../models/PutModuleReorder';
+export interface DeleteModuleRequest {
+    moduleId: string;
+    courseId: string;
+}
 export interface GetModuleRequest {
     moduleId: string;
     courseId: string;
@@ -45,6 +49,20 @@ export interface PutModuleReorderRequest {
  *
  */
 export declare class ModuleApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteModule without sending the request
+     */
+    deleteModuleRequestOpts(requestParameters: DeleteModuleRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for getModule without sending the request
      */

package/dist/esm/apis/ModuleApi.js

@@ -31,6 +31,50 @@ import { PutModuleReorderToJSON, } from '../models/PutModuleReorder';
  *
  */
 export class ModuleApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteModule without sending the request
+     */
+    deleteModuleRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            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
+     */
+    deleteModuleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteModuleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Soft-deletes the module and its content.
+     * Delete a module by id
+     */
+    deleteModule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteModuleRaw(requestParameters, initOverrides);
+        });
+    }
     /**
      * Creates request options for getModule without sending the request
      */

package/dist/esm/apis/UserApi.d.ts

@@ -16,6 +16,8 @@ import { type LoginRes } from '../models/LoginRes';
 import { type PostLogin } from '../models/PostLogin';
 import { type PostResetPassword } from '../models/PostResetPassword';
 import { type PostSendResetPassword } from '../models/PostSendResetPassword';
+import { type PostSignupRequest } from '../models/PostSignupRequest';
+import { type PostSignupRequestResponse } from '../models/PostSignupRequestResponse';
 import { type PutUser } from '../models/PutUser';
 export interface DeleteUserAvatarRequest {
     userId: string;
@@ -26,6 +28,9 @@ export interface GetUserRequest {
 export interface PostLoginRequest {
     postLogin: PostLogin;
 }
+export interface PostSignupRequestRequest {
+    postSignupRequest: PostSignupRequest;
+}
 export interface PostUserAvatarUploadRequest {
     userId: string;
     file: Blob;
@@ -40,6 +45,9 @@ export interface ResetPasswordRequest {
 export interface SendResetPasswordRequest {
     postSendResetPassword: PostSendResetPassword;
 }
+export interface VerifySignupRequestRequest {
+    token: string;
+}
 /**
  *
  */
@@ -118,6 +126,18 @@ export declare class UserApi extends runtime.BaseAPI {
      * Logout a user
      */
     postLogout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for postSignupRequest without sending the request
+     */
+    postSignupRequestRequestOpts(requestParameters: PostSignupRequestRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Request a new organization signup
+     */
+    postSignupRequestRaw(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostSignupRequestResponse>>;
+    /**
+     * Request a new organization signup
+     */
+    postSignupRequest(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostSignupRequestResponse>;
     /**
      * Creates request options for postUserAvatarUpload without sending the request
      */
@@ -166,4 +186,16 @@ export declare class UserApi extends runtime.BaseAPI {
      * Send a reset password email
      */
     sendResetPassword(requestParameters: SendResetPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for verifySignupRequest without sending the request
+     */
+    verifySignupRequestRequestOpts(requestParameters: VerifySignupRequestRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Verify a signup request and provision the portal
+     */
+    verifySignupRequestRaw(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Verify a signup request and provision the portal
+     */
+    verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/esm/apis/UserApi.js

@@ -27,6 +27,8 @@ import { LoginResFromJSON, } from '../models/LoginRes';
 import { PostLoginToJSON, } from '../models/PostLogin';
 import { PostResetPasswordToJSON, } from '../models/PostResetPassword';
 import { PostSendResetPasswordToJSON, } from '../models/PostSendResetPassword';
+import { PostSignupRequestToJSON, } from '../models/PostSignupRequest';
+import { PostSignupRequestResponseFromJSON, } from '../models/PostSignupRequestResponse';
 import { PutUserToJSON, } from '../models/PutUser';
 /**
  *
@@ -254,6 +256,46 @@ export class UserApi extends runtime.BaseAPI {
             yield this.postLogoutRaw(initOverrides);
         });
     }
+    /**
+     * Creates request options for postSignupRequest without sending the request
+     */
+    postSignupRequestRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postSignupRequest'] == null) {
+                throw new runtime.RequiredError('postSignupRequest', 'Required parameter "postSignupRequest" was null or undefined when calling postSignupRequest().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    postSignupRequestRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postSignupRequestRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PostSignupRequestResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Request a new organization signup
+     */
+    postSignupRequest(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postSignupRequestRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for postUserAvatarUpload without sending the request
      */
@@ -437,4 +479,44 @@ export class UserApi extends runtime.BaseAPI {
             yield this.sendResetPasswordRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for verifySignupRequest without sending the request
+     */
+    verifySignupRequestRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['token'] == null) {
+                throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling verifySignupRequest().');
+            }
+            const queryParameters = {};
+            if (requestParameters['token'] != null) {
+                queryParameters['token'] = requestParameters['token'];
+            }
+            const headerParameters = {};
+            let urlPath = `/auth/signup/verify`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Verify a signup request and provision the portal
+     */
+    verifySignupRequestRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.verifySignupRequestRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Verify a signup request and provision the portal
+     */
+    verifySignupRequest(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.verifySignupRequestRaw(requestParameters, initOverrides);
+        });
+    }
 }

package/dist/esm/models/PostSignupRequest.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfPostSignupRequest(value: object): value is PostSignupRequest;
+export declare function PostSignupRequestFromJSON(json: any): PostSignupRequest;
+export declare function PostSignupRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequest;
+export declare function PostSignupRequestToJSON(json: any): PostSignupRequest;
+export declare function PostSignupRequestToJSONTyped(value?: PostSignupRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostSignupRequest.js

@@ -0,0 +1,67 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostSignupRequest interface.
+ */
+export function instanceOfPostSignupRequest(value) {
+    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) {
+    return PostSignupRequestFromJSONTyped(json, false);
+}
+export function PostSignupRequestFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostSignupRequestToJSONTyped(json, false);
+}
+export function PostSignupRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/PostSignupRequestResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PostSignupRequestResponse
+ */
+export interface PostSignupRequestResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PostSignupRequestResponse
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the PostSignupRequestResponse interface.
+ */
+export declare function instanceOfPostSignupRequestResponse(value: object): value is PostSignupRequestResponse;
+export declare function PostSignupRequestResponseFromJSON(json: any): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseToJSON(json: any): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseToJSONTyped(value?: PostSignupRequestResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostSignupRequestResponse.js

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

package/dist/esm/models/index.d.ts

@@ -210,6 +210,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';

package/dist/esm/models/index.js

@@ -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';

package/dist/models/PostSignupRequest.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfPostSignupRequest(value: object): value is PostSignupRequest;
+export declare function PostSignupRequestFromJSON(json: any): PostSignupRequest;
+export declare function PostSignupRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequest;
+export declare function PostSignupRequestToJSON(json: any): PostSignupRequest;
+export declare function PostSignupRequestToJSONTyped(value?: PostSignupRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostSignupRequest.js

@@ -0,0 +1,74 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostSignupRequest = instanceOfPostSignupRequest;
+exports.PostSignupRequestFromJSON = PostSignupRequestFromJSON;
+exports.PostSignupRequestFromJSONTyped = PostSignupRequestFromJSONTyped;
+exports.PostSignupRequestToJSON = PostSignupRequestToJSON;
+exports.PostSignupRequestToJSONTyped = PostSignupRequestToJSONTyped;
+/**
+ * Check if a given object implements the PostSignupRequest interface.
+ */
+function instanceOfPostSignupRequest(value) {
+    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;
+}
+function PostSignupRequestFromJSON(json) {
+    return PostSignupRequestFromJSONTyped(json, false);
+}
+function PostSignupRequestFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function PostSignupRequestToJSON(json) {
+    return PostSignupRequestToJSONTyped(json, false);
+}
+function PostSignupRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/PostSignupRequestResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PostSignupRequestResponse
+ */
+export interface PostSignupRequestResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PostSignupRequestResponse
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the PostSignupRequestResponse interface.
+ */
+export declare function instanceOfPostSignupRequestResponse(value: object): value is PostSignupRequestResponse;
+export declare function PostSignupRequestResponseFromJSON(json: any): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseToJSON(json: any): PostSignupRequestResponse;
+export declare function PostSignupRequestResponseToJSONTyped(value?: PostSignupRequestResponse | null, ignoreDiscriminator?: boolean): any;