@easyedu/js-lsm-api 1.48.0 → 1.50.0

package/dist/models/PostCertificateConfig.js

@@ -0,0 +1,60 @@
+"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.instanceOfPostCertificateConfig = instanceOfPostCertificateConfig;
+exports.PostCertificateConfigFromJSON = PostCertificateConfigFromJSON;
+exports.PostCertificateConfigFromJSONTyped = PostCertificateConfigFromJSONTyped;
+exports.PostCertificateConfigToJSON = PostCertificateConfigToJSON;
+exports.PostCertificateConfigToJSONTyped = PostCertificateConfigToJSONTyped;
+/**
+ * Check if a given object implements the PostCertificateConfig interface.
+ */
+function instanceOfPostCertificateConfig(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    return true;
+}
+function PostCertificateConfigFromJSON(json) {
+    return PostCertificateConfigFromJSONTyped(json, false);
+}
+function PostCertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'enabled': json['enabled'],
+        'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
+        'requireQuizPass': json['require_quiz_pass'] == null ? undefined : json['require_quiz_pass'],
+        'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
+        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+    };
+}
+function PostCertificateConfigToJSON(json) {
+    return PostCertificateConfigToJSONTyped(json, false);
+}
+function PostCertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'course_id': value['courseId'],
+        'enabled': value['enabled'],
+        'expiry_months': value['expiryMonths'],
+        'require_quiz_pass': value['requireQuizPass'],
+        'min_quiz_score': value['minQuizScore'],
+        'quiz_config_id': value['quizConfigId'],
+    };
+}

package/dist/models/PostRevokeCertificate.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 PostRevokeCertificate
+ */
+export interface PostRevokeCertificate {
+    /**
+     *
+     * @type {string}
+     * @memberof PostRevokeCertificate
+     */
+    reason?: string | null;
+}
+/**
+ * Check if a given object implements the PostRevokeCertificate interface.
+ */
+export declare function instanceOfPostRevokeCertificate(value: object): value is PostRevokeCertificate;
+export declare function PostRevokeCertificateFromJSON(json: any): PostRevokeCertificate;
+export declare function PostRevokeCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRevokeCertificate;
+export declare function PostRevokeCertificateToJSON(json: any): PostRevokeCertificate;
+export declare function PostRevokeCertificateToJSONTyped(value?: PostRevokeCertificate | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostRevokeCertificate.js

@@ -0,0 +1,48 @@
+"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.instanceOfPostRevokeCertificate = instanceOfPostRevokeCertificate;
+exports.PostRevokeCertificateFromJSON = PostRevokeCertificateFromJSON;
+exports.PostRevokeCertificateFromJSONTyped = PostRevokeCertificateFromJSONTyped;
+exports.PostRevokeCertificateToJSON = PostRevokeCertificateToJSON;
+exports.PostRevokeCertificateToJSONTyped = PostRevokeCertificateToJSONTyped;
+/**
+ * Check if a given object implements the PostRevokeCertificate interface.
+ */
+function instanceOfPostRevokeCertificate(value) {
+    return true;
+}
+function PostRevokeCertificateFromJSON(json) {
+    return PostRevokeCertificateFromJSONTyped(json, false);
+}
+function PostRevokeCertificateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+function PostRevokeCertificateToJSON(json) {
+    return PostRevokeCertificateToJSONTyped(json, false);
+}
+function PostRevokeCertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reason': value['reason'],
+    };
+}

package/dist/models/PutCertificateConfig.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 PutCertificateConfig
+ */
+export interface PutCertificateConfig {
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutCertificateConfig
+     */
+    enabled?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutCertificateConfig
+     */
+    requireQuizPass?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PutCertificateConfig
+     */
+    quizConfigId?: string | null;
+}
+/**
+ * Check if a given object implements the PutCertificateConfig interface.
+ */
+export declare function instanceOfPutCertificateConfig(value: object): value is PutCertificateConfig;
+export declare function PutCertificateConfigFromJSON(json: any): PutCertificateConfig;
+export declare function PutCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCertificateConfig;
+export declare function PutCertificateConfigToJSON(json: any): PutCertificateConfig;
+export declare function PutCertificateConfigToJSONTyped(value?: PutCertificateConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutCertificateConfig.js

@@ -0,0 +1,56 @@
+"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.instanceOfPutCertificateConfig = instanceOfPutCertificateConfig;
+exports.PutCertificateConfigFromJSON = PutCertificateConfigFromJSON;
+exports.PutCertificateConfigFromJSONTyped = PutCertificateConfigFromJSONTyped;
+exports.PutCertificateConfigToJSON = PutCertificateConfigToJSON;
+exports.PutCertificateConfigToJSONTyped = PutCertificateConfigToJSONTyped;
+/**
+ * Check if a given object implements the PutCertificateConfig interface.
+ */
+function instanceOfPutCertificateConfig(value) {
+    return true;
+}
+function PutCertificateConfigFromJSON(json) {
+    return PutCertificateConfigFromJSONTyped(json, false);
+}
+function PutCertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
+        'requireQuizPass': json['require_quiz_pass'] == null ? undefined : json['require_quiz_pass'],
+        'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
+        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+    };
+}
+function PutCertificateConfigToJSON(json) {
+    return PutCertificateConfigToJSONTyped(json, false);
+}
+function PutCertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'expiry_months': value['expiryMonths'],
+        'require_quiz_pass': value['requireQuizPass'],
+        'min_quiz_score': value['minQuizScore'],
+        'quiz_config_id': value['quizConfigId'],
+    };
+}

package/dist/models/index.d.ts

@@ -1,11 +1,17 @@
+export * from './Certificate';
+export * from './CertificateConfig';
+export * from './CertificatePublic';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
 export * from './DownloadSupportTicketAttachment200Response';
+export * from './EffectiveCertificateConfig';
 export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
 export * from './FillInBlank1';
+export * from './GetCertificateConfigList';
+export * from './GetCertificateList';
 export * from './GetChatMessage';
 export * from './GetContent';
 export * from './GetContentContentData';
@@ -150,6 +156,8 @@ export * from './MultipleAnswer';
 export * from './MultipleAnswer1';
 export * from './NoAnswer';
 export * from './Paginated';
+export * from './PostCertificate';
+export * from './PostCertificateConfig';
 export * from './PostContentQuiz';
 export * from './PostContentQuizAssignment';
 export * from './PostContentQuizQuestionSelection';
@@ -185,6 +193,7 @@ export * from './PostQuizQuestions';
 export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
+export * from './PostRevokeCertificate';
 export * from './PostRole';
 export * from './PostSendResetPassword';
 export * from './PostSupportTicket';
@@ -192,6 +201,7 @@ export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
+export * from './PutCertificateConfig';
 export * from './PutContent';
 export * from './PutContentReorder';
 export * from './PutContentVersion';

package/dist/models/index.js

@@ -16,14 +16,20 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./Certificate"), exports);
+__exportStar(require("./CertificateConfig"), exports);
+__exportStar(require("./CertificatePublic"), exports);
 __exportStar(require("./CriteriaBasedSelection"), exports);
 __exportStar(require("./CriteriaBasedSelectionCriteria"), exports);
 __exportStar(require("./CriteriaBasedSelectionDistribution"), exports);
 __exportStar(require("./DownloadSupportTicketAttachment200Response"), exports);
+__exportStar(require("./EffectiveCertificateConfig"), exports);
 __exportStar(require("./Essay"), exports);
 __exportStar(require("./Essay1"), exports);
 __exportStar(require("./FillInBlank"), exports);
 __exportStar(require("./FillInBlank1"), exports);
+__exportStar(require("./GetCertificateConfigList"), exports);
+__exportStar(require("./GetCertificateList"), exports);
 __exportStar(require("./GetChatMessage"), exports);
 __exportStar(require("./GetContent"), exports);
 __exportStar(require("./GetContentContentData"), exports);
@@ -168,6 +174,8 @@ __exportStar(require("./MultipleAnswer"), exports);
 __exportStar(require("./MultipleAnswer1"), exports);
 __exportStar(require("./NoAnswer"), exports);
 __exportStar(require("./Paginated"), exports);
+__exportStar(require("./PostCertificate"), exports);
+__exportStar(require("./PostCertificateConfig"), exports);
 __exportStar(require("./PostContentQuiz"), exports);
 __exportStar(require("./PostContentQuizAssignment"), exports);
 __exportStar(require("./PostContentQuizQuestionSelection"), exports);
@@ -203,6 +211,7 @@ __exportStar(require("./PostQuizQuestions"), exports);
 __exportStar(require("./PostQuizQuestionsQuestionsInner"), exports);
 __exportStar(require("./PostQuizSettings"), exports);
 __exportStar(require("./PostResetPassword"), exports);
+__exportStar(require("./PostRevokeCertificate"), exports);
 __exportStar(require("./PostRole"), exports);
 __exportStar(require("./PostSendResetPassword"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
@@ -210,6 +219,7 @@ __exportStar(require("./PostSupportTicketComment"), exports);
 __exportStar(require("./PostVerifyManifest"), exports);
 __exportStar(require("./PostVerifyManifestItemsInner"), exports);
 __exportStar(require("./PostVerifyManifestResourcesInner"), exports);
+__exportStar(require("./PutCertificateConfig"), exports);
 __exportStar(require("./PutContent"), exports);
 __exportStar(require("./PutContentReorder"), exports);
 __exportStar(require("./PutContentVersion"), exports);

package/docs/Certificate.md

@@ -0,0 +1,68 @@
+
+# Certificate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`portalId` | string
+`userId` | string
+`courseId` | string
+`enrollmentId` | string
+`issuedAt` | number
+`expiresAt` | number
+`issuedByUserId` | string
+`issuanceReason` | string
+`status` | string
+`revokedAt` | number
+`revokedByUserId` | string
+`revocationReason` | string
+`learnerName` | string
+`courseName` | string
+`portalName` | string
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { Certificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "portalId": null,
+  "userId": null,
+  "courseId": null,
+  "enrollmentId": null,
+  "issuedAt": null,
+  "expiresAt": null,
+  "issuedByUserId": null,
+  "issuanceReason": null,
+  "status": null,
+  "revokedAt": null,
+  "revokedByUserId": null,
+  "revocationReason": null,
+  "learnerName": null,
+  "courseName": null,
+  "portalName": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies Certificate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Certificate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+