@easyedu/js-lsm-api 1.51.0 → 1.53.0

package/src/apis/CourseCatalogApi.ts

@@ -0,0 +1,447 @@
+/* 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 {
+  CourseCatalog,
+  GetCourse,
+  PostCourseCatalog,
+  PutCourseCatalog,
+} from '../models/index';
+import {
+    CourseCatalogFromJSON,
+    CourseCatalogToJSON,
+    GetCourseFromJSON,
+    GetCourseToJSON,
+    PostCourseCatalogFromJSON,
+    PostCourseCatalogToJSON,
+    PutCourseCatalogFromJSON,
+    PutCourseCatalogToJSON,
+} from '../models/index';
+
+export interface AddCourseToCatalogRequest {
+    catalogId: string;
+    courseId: string;
+}
+
+export interface DeleteCourseCatalogRequest {
+    catalogId: string;
+}
+
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
+
+export interface GetCourseCatalogRequest {
+    catalogId: string;
+}
+
+export interface PostCourseCatalogRequest {
+    postCourseCatalog: PostCourseCatalog;
+}
+
+export interface PutCourseCatalogRequest {
+    catalogId: string;
+    putCourseCatalog: PutCourseCatalog;
+}
+
+export interface RemoveCourseFromCatalogRequest {
+    catalogId: string;
+    courseId: string;
+}
+
+/**
+ * 
+ */
+export class CourseCatalogApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for addCourseToCatalog without sending the request
+     */
+    async addCourseToCatalogRequestOpts(requestParameters: AddCourseToCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling addCourseToCatalog().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling addCourseToCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}/courses/{courseId}`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Add a course to a catalog
+     */
+    async addCourseToCatalogRaw(requestParameters: AddCourseToCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.addCourseToCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Add a course to a catalog
+     */
+    async addCourseToCatalog(requestParameters: AddCourseToCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.addCourseToCatalogRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for deleteCourseCatalog without sending the request
+     */
+    async deleteCourseCatalogRequestOpts(requestParameters: DeleteCourseCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling deleteCourseCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a catalog
+     */
+    async deleteCourseCatalogRaw(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a catalog
+     */
+    async deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseCatalogRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    async getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}/courses`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>> {
+        const requestOptions = await this.getCatalogCoursesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>> {
+        const response = await this.getCatalogCoursesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getCourseCatalog without sending the request
+     */
+    async getCourseCatalogRequestOpts(requestParameters: GetCourseCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling getCourseCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a catalog
+     */
+    async getCourseCatalogRaw(requestParameters: GetCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>> {
+        const requestOptions = await this.getCourseCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a catalog
+     */
+    async getCourseCatalog(requestParameters: GetCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog> {
+        const response = await this.getCourseCatalogRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getCourseCatalogs without sending the request
+     */
+    async getCourseCatalogsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List catalogs in the current portal
+     */
+    async getCourseCatalogsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseCatalog>>> {
+        const requestOptions = await this.getCourseCatalogsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseCatalogFromJSON));
+    }
+
+    /**
+     * List catalogs in the current portal
+     */
+    async getCourseCatalogs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseCatalog>> {
+        const response = await this.getCourseCatalogsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postCourseCatalog without sending the request
+     */
+    async postCourseCatalogRequestOpts(requestParameters: PostCourseCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postCourseCatalog'] == null) {
+            throw new runtime.RequiredError(
+                'postCourseCatalog',
+                'Required parameter "postCourseCatalog" was null or undefined when calling postCourseCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/catalogs`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostCourseCatalogToJSON(requestParameters['postCourseCatalog']),
+        };
+    }
+
+    /**
+     * Create a course catalog
+     */
+    async postCourseCatalogRaw(requestParameters: PostCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>> {
+        const requestOptions = await this.postCourseCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a course catalog
+     */
+    async postCourseCatalog(requestParameters: PostCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog> {
+        const response = await this.postCourseCatalogRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putCourseCatalog without sending the request
+     */
+    async putCourseCatalogRequestOpts(requestParameters: PutCourseCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling putCourseCatalog().'
+            );
+        }
+
+        if (requestParameters['putCourseCatalog'] == null) {
+            throw new runtime.RequiredError(
+                'putCourseCatalog',
+                'Required parameter "putCourseCatalog" was null or undefined when calling putCourseCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/catalogs/{catalogId}`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutCourseCatalogToJSON(requestParameters['putCourseCatalog']),
+        };
+    }
+
+    /**
+     * Update a catalog
+     */
+    async putCourseCatalogRaw(requestParameters: PutCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CourseCatalog>> {
+        const requestOptions = await this.putCourseCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CourseCatalogFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a catalog
+     */
+    async putCourseCatalog(requestParameters: PutCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CourseCatalog> {
+        const response = await this.putCourseCatalogRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for removeCourseFromCatalog without sending the request
+     */
+    async removeCourseFromCatalogRequestOpts(requestParameters: RemoveCourseFromCatalogRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling removeCourseFromCatalog().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling removeCourseFromCatalog().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}/courses/{courseId}`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove a course from a catalog
+     */
+    async removeCourseFromCatalogRaw(requestParameters: RemoveCourseFromCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.removeCourseFromCatalogRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove a course from a catalog
+     */
+    async removeCourseFromCatalog(requestParameters: RemoveCourseFromCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.removeCourseFromCatalogRaw(requestParameters, initOverrides);
+    }
+
+}