@easyedu/js-lsm-api 1.49.0 → 1.51.0

package/src/models/GetCertificateConfigList.ts

@@ -0,0 +1,74 @@
+/* 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';
+import type { CertificateConfig } from './CertificateConfig';
+import {
+    CertificateConfigFromJSON,
+    CertificateConfigFromJSONTyped,
+    CertificateConfigToJSON,
+    CertificateConfigToJSONTyped,
+} from './CertificateConfig';
+
+/**
+ * 
+ * @export
+ * @interface GetCertificateConfigList
+ */
+export interface GetCertificateConfigList {
+    /**
+     * 
+     * @type {Array<CertificateConfig>}
+     * @memberof GetCertificateConfigList
+     */
+    items: Array<CertificateConfig>;
+}
+
+/**
+ * Check if a given object implements the GetCertificateConfigList interface.
+ */
+export function instanceOfGetCertificateConfigList(value: object): value is GetCertificateConfigList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCertificateConfigListFromJSON(json: any): GetCertificateConfigList {
+    return GetCertificateConfigListFromJSONTyped(json, false);
+}
+
+export function GetCertificateConfigListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateConfigList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(CertificateConfigFromJSON)),
+    };
+}
+
+export function GetCertificateConfigListToJSON(json: any): GetCertificateConfigList {
+    return GetCertificateConfigListToJSONTyped(json, false);
+}
+
+export function GetCertificateConfigListToJSONTyped(value?: GetCertificateConfigList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(CertificateConfigToJSON)),
+    };
+}
+

package/src/models/GetCertificateList.ts

@@ -0,0 +1,74 @@
+/* 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';
+import type { Certificate } from './Certificate';
+import {
+    CertificateFromJSON,
+    CertificateFromJSONTyped,
+    CertificateToJSON,
+    CertificateToJSONTyped,
+} from './Certificate';
+
+/**
+ * 
+ * @export
+ * @interface GetCertificateList
+ */
+export interface GetCertificateList {
+    /**
+     * 
+     * @type {Array<Certificate>}
+     * @memberof GetCertificateList
+     */
+    items: Array<Certificate>;
+}
+
+/**
+ * Check if a given object implements the GetCertificateList interface.
+ */
+export function instanceOfGetCertificateList(value: object): value is GetCertificateList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCertificateListFromJSON(json: any): GetCertificateList {
+    return GetCertificateListFromJSONTyped(json, false);
+}
+
+export function GetCertificateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(CertificateFromJSON)),
+    };
+}
+
+export function GetCertificateListToJSON(json: any): GetCertificateList {
+    return GetCertificateListToJSONTyped(json, false);
+}
+
+export function GetCertificateListToJSONTyped(value?: GetCertificateList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(CertificateToJSON)),
+    };
+}
+

package/src/models/PostCertificate.ts

@@ -0,0 +1,90 @@
+/* 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';
+/**
+ * Manually issue a certificate
+ * @export
+ * @interface PostCertificate
+ */
+export interface PostCertificate {
+    /**
+     * External ID of the recipient
+     * @type {string}
+     * @memberof PostCertificate
+     */
+    userId: string;
+    /**
+     * Unix epoch timestamp; null = never expires
+     * @type {number}
+     * @memberof PostCertificate
+     */
+    expiresAt?: number | null;
+    /**
+     * Optional override for backfilled historical data
+     * @type {number}
+     * @memberof PostCertificate
+     */
+    issuedAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificate
+     */
+    note?: string | null;
+}
+
+/**
+ * Check if a given object implements the PostCertificate interface.
+ */
+export function instanceOfPostCertificate(value: object): value is PostCertificate {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateFromJSON(json: any): PostCertificate {
+    return PostCertificateFromJSONTyped(json, false);
+}
+
+export function PostCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+        'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
+        'issuedAt': json['issued_at'] == null ? undefined : json['issued_at'],
+        'note': json['note'] == null ? undefined : json['note'],
+    };
+}
+
+export function PostCertificateToJSON(json: any): PostCertificate {
+    return PostCertificateToJSONTyped(json, false);
+}
+
+export function PostCertificateToJSONTyped(value?: PostCertificate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+        'expires_at': value['expiresAt'],
+        'issued_at': value['issuedAt'],
+        'note': value['note'],
+    };
+}
+

package/src/models/PostCertificateConfig.ts

@@ -0,0 +1,106 @@
+/* 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 PostCertificateConfig
+ */
+export interface PostCertificateConfig {
+    /**
+     * Omit or null for the portal default config
+     * @type {string}
+     * @memberof PostCertificateConfig
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCertificateConfig
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCertificateConfig
+     */
+    requireQuizPass?: boolean | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateConfig
+     */
+    quizConfigId?: string | null;
+}
+
+/**
+ * Check if a given object implements the PostCertificateConfig interface.
+ */
+export function instanceOfPostCertificateConfig(value: object): value is PostCertificateConfig {
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateConfigFromJSON(json: any): PostCertificateConfig {
+    return PostCertificateConfigFromJSONTyped(json, false);
+}
+
+export function PostCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateConfig {
+    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'],
+    };
+}
+
+export function PostCertificateConfigToJSON(json: any): PostCertificateConfig {
+    return PostCertificateConfigToJSONTyped(json, false);
+}
+
+export function PostCertificateConfigToJSONTyped(value?: PostCertificateConfig | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PostRevokeCertificate.ts

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

package/src/models/PutCertificateConfig.ts

@@ -0,0 +1,97 @@
+/* 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 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 function instanceOfPutCertificateConfig(value: object): value is PutCertificateConfig {
+    return true;
+}
+
+export function PutCertificateConfigFromJSON(json: any): PutCertificateConfig {
+    return PutCertificateConfigFromJSONTyped(json, false);
+}
+
+export function PutCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCertificateConfig {
+    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'],
+    };
+}
+
+export function PutCertificateConfigToJSON(json: any): PutCertificateConfig {
+    return PutCertificateConfigToJSONTyped(json, false);
+}
+
+export function PutCertificateConfigToJSONTyped(value?: PutCertificateConfig | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/index.ts

@@ -1,13 +1,19 @@
 /* tslint:disable */
 /* eslint-disable */
+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';
@@ -152,6 +158,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';
@@ -187,6 +195,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';
@@ -194,6 +203,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';