@easyedu/js-lsm-api 1.49.0 → 1.50.0

package/dist/esm/apis/CertificateApi.js

@@ -0,0 +1,583 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CertificateFromJSON, CertificateConfigFromJSON, CertificatePublicFromJSON, EffectiveCertificateConfigFromJSON, GetCertificateConfigListFromJSON, GetCertificateListFromJSON, PostCertificateToJSON, PostCertificateConfigToJSON, PostRevokeCertificateToJSON, PutCertificateConfigToJSON, } from '../models/index';
+/**
+ *
+ */
+export class CertificateApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteCertificateConfig without sending the request
+     */
+    deleteCertificateConfigRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['configId'] == null) {
+                throw new runtime.RequiredError('configId', 'Required parameter "configId" was null or undefined when calling deleteCertificateConfig().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/certificate-configs/{configId}`;
+            urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Delete a certificate config
+     */
+    deleteCertificateConfigRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteCertificateConfigRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a certificate config
+     */
+    deleteCertificateConfig(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteCertificateConfigRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCertificate without sending the request
+     */
+    getCertificateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['certificateId'] == null) {
+                throw new runtime.RequiredError('certificateId', 'Required parameter "certificateId" was null or undefined when calling getCertificate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/certificates/{certificateId}`;
+            urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a single certificate
+     */
+    getCertificateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCertificateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a single certificate
+     */
+    getCertificate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCertificateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCertificateConfig without sending the request
+     */
+    getCertificateConfigRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['configId'] == null) {
+                throw new runtime.RequiredError('configId', 'Required parameter "configId" was null or undefined when calling getCertificateConfig().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/certificate-configs/{configId}`;
+            urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a certificate config
+     */
+    getCertificateConfigRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCertificateConfigRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a certificate config
+     */
+    getCertificateConfig(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCertificateConfigRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCertificateConfigs without sending the request
+     */
+    getCertificateConfigsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['courseId'] != null) {
+                queryParameters['course_id'] = requestParameters['courseId'];
+            }
+            if (requestParameters['scope'] != null) {
+                queryParameters['scope'] = requestParameters['scope'];
+            }
+            const headerParameters = {};
+            let urlPath = `/certificate-configs`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List certificate configs in the current portal
+     */
+    getCertificateConfigsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCertificateConfigsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateConfigListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List certificate configs in the current portal
+     */
+    getCertificateConfigs() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getCertificateConfigsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCertificatePdf without sending the request
+     */
+    getCertificatePdfRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['certificateId'] == null) {
+                throw new runtime.RequiredError('certificateId', 'Required parameter "certificateId" was null or undefined when calling getCertificatePdf().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/certificates/{certificateId}/pdf`;
+            urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Download certificate as PDF
+     */
+    getCertificatePdfRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCertificatePdfRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Download certificate as PDF
+     */
+    getCertificatePdf(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCertificatePdfRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCertificates without sending the request
+     */
+    getCertificatesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['userId'] != null) {
+                queryParameters['user_id'] = requestParameters['userId'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['course_id'] = requestParameters['courseId'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            if (requestParameters['issuedAfter'] != null) {
+                queryParameters['issued_after'] = requestParameters['issuedAfter'];
+            }
+            if (requestParameters['issuedBefore'] != null) {
+                queryParameters['issued_before'] = requestParameters['issuedBefore'];
+            }
+            if (requestParameters['expiresAfter'] != null) {
+                queryParameters['expires_after'] = requestParameters['expiresAfter'];
+            }
+            if (requestParameters['expiresBefore'] != null) {
+                queryParameters['expires_before'] = requestParameters['expiresBefore'];
+            }
+            if (requestParameters['expiringWithinDays'] != null) {
+                queryParameters['expiring_within_days'] = requestParameters['expiringWithinDays'];
+            }
+            const headerParameters = {};
+            let urlPath = `/certificates`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List certificates in the current portal
+     */
+    getCertificatesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCertificatesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List certificates in the current portal
+     */
+    getCertificates() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getCertificatesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getCurrentUserCertificates without sending the request
+     */
+    getCurrentUserCertificatesRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/certificates/current`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the authenticated user\'s own certificates
+     */
+    getCurrentUserCertificatesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCurrentUserCertificatesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List the authenticated user\'s own certificates
+     */
+    getCurrentUserCertificates(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCurrentUserCertificatesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getEffectiveCertificateConfig without sending the request
+     */
+    getEffectiveCertificateConfigRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getEffectiveCertificateConfig().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/courses/{courseId}/certificate-config/effective`;
+            urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Resolve effective certificate config for a course
+     */
+    getEffectiveCertificateConfigRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getEffectiveCertificateConfigRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => EffectiveCertificateConfigFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Resolve effective certificate config for a course
+     */
+    getEffectiveCertificateConfig(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getEffectiveCertificateConfigRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postCertificateConfig without sending the request
+     */
+    postCertificateConfigRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postCertificateConfig'] == null) {
+                throw new runtime.RequiredError('postCertificateConfig', 'Required parameter "postCertificateConfig" was null or undefined when calling postCertificateConfig().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/certificate-configs`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostCertificateConfigToJSON(requestParameters['postCertificateConfig']),
+            };
+        });
+    }
+    /**
+     * Create a certificate config
+     */
+    postCertificateConfigRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postCertificateConfigRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a certificate config
+     */
+    postCertificateConfig(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postCertificateConfigRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postCourseCertificate without sending the request
+     */
+    postCourseCertificateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseCertificate().');
+            }
+            if (requestParameters['postCertificate'] == null) {
+                throw new runtime.RequiredError('postCertificate', 'Required parameter "postCertificate" was null or undefined when calling postCourseCertificate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/courses/{courseId}/certificates`;
+            urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostCertificateToJSON(requestParameters['postCertificate']),
+            };
+        });
+    }
+    /**
+     * Manually issue a certificate for a course
+     */
+    postCourseCertificateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postCourseCertificateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Manually issue a certificate for a course
+     */
+    postCourseCertificate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postCourseCertificateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postRevokeCertificate without sending the request
+     */
+    postRevokeCertificateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['certificateId'] == null) {
+                throw new runtime.RequiredError('certificateId', 'Required parameter "certificateId" was null or undefined when calling postRevokeCertificate().');
+            }
+            if (requestParameters['postRevokeCertificate'] == null) {
+                throw new runtime.RequiredError('postRevokeCertificate', 'Required parameter "postRevokeCertificate" was null or undefined when calling postRevokeCertificate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/certificates/{certificateId}/revoke`;
+            urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostRevokeCertificateToJSON(requestParameters['postRevokeCertificate']),
+            };
+        });
+    }
+    /**
+     * Revoke a certificate
+     */
+    postRevokeCertificateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postRevokeCertificateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Revoke a certificate
+     */
+    postRevokeCertificate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postRevokeCertificateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for putCertificateConfig without sending the request
+     */
+    putCertificateConfigRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['configId'] == null) {
+                throw new runtime.RequiredError('configId', 'Required parameter "configId" was null or undefined when calling putCertificateConfig().');
+            }
+            if (requestParameters['putCertificateConfig'] == null) {
+                throw new runtime.RequiredError('putCertificateConfig', 'Required parameter "putCertificateConfig" was null or undefined when calling putCertificateConfig().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/certificate-configs/{configId}`;
+            urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutCertificateConfigToJSON(requestParameters['putCertificateConfig']),
+            };
+        });
+    }
+    /**
+     * Update a certificate config
+     */
+    putCertificateConfigRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putCertificateConfigRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update a certificate config
+     */
+    putCertificateConfig(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putCertificateConfigRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for verifyCertificate without sending the request
+     */
+    verifyCertificateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['certificateId'] == null) {
+                throw new runtime.RequiredError('certificateId', 'Required parameter "certificateId" was null or undefined when calling verifyCertificate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/public/certificates/{certificateId}/verify`;
+            urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Public certificate verification (no auth)
+     */
+    verifyCertificateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.verifyCertificateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CertificatePublicFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Public certificate verification (no auth)
+     */
+    verifyCertificate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.verifyCertificateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const GetCertificateConfigsScopeEnum = {
+    Portal: 'portal',
+    Course: 'course'
+};
+/**
+ * @export
+ */
+export const GetCertificatesStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked'
+};

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

@@ -1,3 +1,4 @@
+export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './CourseApi';

package/dist/esm/apis/index.js

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './CourseApi';