@easyedu/js-lsm-api 1.86.0 → 1.87.0

package/src/models/GetCertificateTemplateList.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 { CertificateTemplate } from './CertificateTemplate';
+import {
+    CertificateTemplateFromJSON,
+    CertificateTemplateFromJSONTyped,
+    CertificateTemplateToJSON,
+    CertificateTemplateToJSONTyped,
+} from './CertificateTemplate';
+
+/**
+ * 
+ * @export
+ * @interface GetCertificateTemplateList
+ */
+export interface GetCertificateTemplateList {
+    /**
+     * 
+     * @type {Array<CertificateTemplate>}
+     * @memberof GetCertificateTemplateList
+     */
+    items: Array<CertificateTemplate>;
+}
+
+/**
+ * Check if a given object implements the GetCertificateTemplateList interface.
+ */
+export function instanceOfGetCertificateTemplateList(value: object): value is GetCertificateTemplateList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCertificateTemplateListFromJSON(json: any): GetCertificateTemplateList {
+    return GetCertificateTemplateListFromJSONTyped(json, false);
+}
+
+export function GetCertificateTemplateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateTemplateList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(CertificateTemplateFromJSON)),
+    };
+}
+
+export function GetCertificateTemplateListToJSON(json: any): GetCertificateTemplateList {
+    return GetCertificateTemplateListToJSONTyped(json, false);
+}
+
+export function GetCertificateTemplateListToJSONTyped(value?: GetCertificateTemplateList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(CertificateTemplateToJSON)),
+    };
+}
+

package/src/models/GetPublicBadgeCredentialStatus200Response.ts

@@ -0,0 +1,88 @@
+/* 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 GetPublicBadgeCredentialStatus200Response
+ */
+export interface GetPublicBadgeCredentialStatus200Response {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetPublicBadgeCredentialStatus200Response
+     */
+    active: boolean;
+    /**
+     * 
+     * @type {GetPublicBadgeCredentialStatus200ResponseStatusEnum}
+     * @memberof GetPublicBadgeCredentialStatus200Response
+     */
+    status: GetPublicBadgeCredentialStatus200ResponseStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetPublicBadgeCredentialStatus200ResponseStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked',
+    Superseded: 'superseded',
+    Expired: 'expired'
+} as const;
+export type GetPublicBadgeCredentialStatus200ResponseStatusEnum = typeof GetPublicBadgeCredentialStatus200ResponseStatusEnum[keyof typeof GetPublicBadgeCredentialStatus200ResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetPublicBadgeCredentialStatus200Response interface.
+ */
+export function instanceOfGetPublicBadgeCredentialStatus200Response(value: object): value is GetPublicBadgeCredentialStatus200Response {
+    if (!('active' in value) || value['active'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function GetPublicBadgeCredentialStatus200ResponseFromJSON(json: any): GetPublicBadgeCredentialStatus200Response {
+    return GetPublicBadgeCredentialStatus200ResponseFromJSONTyped(json, false);
+}
+
+export function GetPublicBadgeCredentialStatus200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicBadgeCredentialStatus200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'active': json['active'],
+        'status': json['status'],
+    };
+}
+
+export function GetPublicBadgeCredentialStatus200ResponseToJSON(json: any): GetPublicBadgeCredentialStatus200Response {
+    return GetPublicBadgeCredentialStatus200ResponseToJSONTyped(json, false);
+}
+
+export function GetPublicBadgeCredentialStatus200ResponseToJSONTyped(value?: GetPublicBadgeCredentialStatus200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'active': value['active'],
+        'status': value['status'],
+    };
+}
+

package/src/models/GetUserCourseListItemCertificate.ts

@@ -58,7 +58,8 @@ export interface GetUserCourseListItemCertificate {
 export const GetUserCourseListItemCertificateStatusEnum = {
     Active: 'active',
     Expired: 'expired',
-    Revoked: 'revoked'
+    Revoked: 'revoked',
+    Superseded: 'superseded'
 } as const;
 export type GetUserCourseListItemCertificateStatusEnum = typeof GetUserCourseListItemCertificateStatusEnum[keyof typeof GetUserCourseListItemCertificateStatusEnum];
 

package/src/models/PostCertificateAssetComplete.ts

@@ -0,0 +1,66 @@
+/* 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 PostCertificateAssetComplete
+ */
+export interface PostCertificateAssetComplete {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateAssetComplete
+     */
+    checksumSha256: string;
+}
+
+/**
+ * Check if a given object implements the PostCertificateAssetComplete interface.
+ */
+export function instanceOfPostCertificateAssetComplete(value: object): value is PostCertificateAssetComplete {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateAssetCompleteFromJSON(json: any): PostCertificateAssetComplete {
+    return PostCertificateAssetCompleteFromJSONTyped(json, false);
+}
+
+export function PostCertificateAssetCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateAssetComplete {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+
+export function PostCertificateAssetCompleteToJSON(json: any): PostCertificateAssetComplete {
+    return PostCertificateAssetCompleteToJSONTyped(json, false);
+}
+
+export function PostCertificateAssetCompleteToJSONTyped(value?: PostCertificateAssetComplete | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'checksum_sha256': value['checksumSha256'],
+    };
+}
+

package/src/models/PostCertificateAssetUpload.ts

@@ -0,0 +1,96 @@
+/* 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 PostCertificateAssetUpload
+ */
+export interface PostCertificateAssetUpload {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateAssetUpload
+     */
+    filename: string;
+    /**
+     * 
+     * @type {PostCertificateAssetUploadContentTypeEnum}
+     * @memberof PostCertificateAssetUpload
+     */
+    contentType: PostCertificateAssetUploadContentTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCertificateAssetUpload
+     */
+    byteSize: number;
+}
+
+
+/**
+ * @export
+ */
+export const PostCertificateAssetUploadContentTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp'
+} as const;
+export type PostCertificateAssetUploadContentTypeEnum = typeof PostCertificateAssetUploadContentTypeEnum[keyof typeof PostCertificateAssetUploadContentTypeEnum];
+
+
+/**
+ * Check if a given object implements the PostCertificateAssetUpload interface.
+ */
+export function instanceOfPostCertificateAssetUpload(value: object): value is PostCertificateAssetUpload {
+    if (!('filename' in value) || value['filename'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateAssetUploadFromJSON(json: any): PostCertificateAssetUpload {
+    return PostCertificateAssetUploadFromJSONTyped(json, false);
+}
+
+export function PostCertificateAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'filename': json['filename'],
+        'contentType': json['content_type'],
+        'byteSize': json['byte_size'],
+    };
+}
+
+export function PostCertificateAssetUploadToJSON(json: any): PostCertificateAssetUpload {
+    return PostCertificateAssetUploadToJSONTyped(json, false);
+}
+
+export function PostCertificateAssetUploadToJSONTyped(value?: PostCertificateAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filename': value['filename'],
+        'content_type': value['contentType'],
+        'byte_size': value['byteSize'],
+    };
+}
+

package/src/models/PostCertificateConfig.ts

@@ -13,6 +13,28 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CertificateNotificationPolicy } from './CertificateNotificationPolicy';
+import {
+    CertificateNotificationPolicyFromJSON,
+    CertificateNotificationPolicyFromJSONTyped,
+    CertificateNotificationPolicyToJSON,
+    CertificateNotificationPolicyToJSONTyped,
+} from './CertificateNotificationPolicy';
+import type { CertificateRenewalPolicy } from './CertificateRenewalPolicy';
+import {
+    CertificateRenewalPolicyFromJSON,
+    CertificateRenewalPolicyFromJSONTyped,
+    CertificateRenewalPolicyToJSON,
+    CertificateRenewalPolicyToJSONTyped,
+} from './CertificateRenewalPolicy';
+import type { CertificateBadgePolicy } from './CertificateBadgePolicy';
+import {
+    CertificateBadgePolicyFromJSON,
+    CertificateBadgePolicyFromJSONTyped,
+    CertificateBadgePolicyToJSON,
+    CertificateBadgePolicyToJSONTyped,
+} from './CertificateBadgePolicy';
+
 /**
  * 
  * @export
@@ -55,6 +77,30 @@ export interface PostCertificateConfig {
      * @memberof PostCertificateConfig
      */
     quizConfigId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateConfig
+     */
+    certificateTemplateId?: string | null;
+    /**
+     * 
+     * @type {CertificateRenewalPolicy}
+     * @memberof PostCertificateConfig
+     */
+    renewalPolicy?: CertificateRenewalPolicy | null;
+    /**
+     * 
+     * @type {CertificateNotificationPolicy}
+     * @memberof PostCertificateConfig
+     */
+    notificationPolicy?: CertificateNotificationPolicy | null;
+    /**
+     * 
+     * @type {CertificateBadgePolicy}
+     * @memberof PostCertificateConfig
+     */
+    badgePolicy?: CertificateBadgePolicy | null;
 }
 
 /**
@@ -81,6 +127,10 @@ export function PostCertificateConfigFromJSONTyped(json: any, ignoreDiscriminato
         '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'],
+        'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
+        'renewalPolicy': json['renewal_policy'] == null ? undefined : CertificateRenewalPolicyFromJSON(json['renewal_policy']),
+        'notificationPolicy': json['notification_policy'] == null ? undefined : CertificateNotificationPolicyFromJSON(json['notification_policy']),
+        'badgePolicy': json['badge_policy'] == null ? undefined : CertificateBadgePolicyFromJSON(json['badge_policy']),
     };
 }
 
@@ -101,6 +151,10 @@ export function PostCertificateConfigToJSONTyped(value?: PostCertificateConfig |
         'require_quiz_pass': value['requireQuizPass'],
         'min_quiz_score': value['minQuizScore'],
         'quiz_config_id': value['quizConfigId'],
+        'certificate_template_id': value['certificateTemplateId'],
+        'renewal_policy': CertificateRenewalPolicyToJSON(value['renewalPolicy']),
+        'notification_policy': CertificateNotificationPolicyToJSON(value['notificationPolicy']),
+        'badge_policy': CertificateBadgePolicyToJSON(value['badgePolicy']),
     };
 }
 

package/src/models/PostCertificateLifecycleAction.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';
+/**
+ * 
+ * @export
+ * @interface PostCertificateLifecycleAction
+ */
+export interface PostCertificateLifecycleAction {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateLifecycleAction
+     */
+    reason: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostCertificateLifecycleAction
+     */
+    expiresAt?: number | null;
+}
+
+/**
+ * Check if a given object implements the PostCertificateLifecycleAction interface.
+ */
+export function instanceOfPostCertificateLifecycleAction(value: object): value is PostCertificateLifecycleAction {
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateLifecycleActionFromJSON(json: any): PostCertificateLifecycleAction {
+    return PostCertificateLifecycleActionFromJSONTyped(json, false);
+}
+
+export function PostCertificateLifecycleActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateLifecycleAction {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reason': json['reason'],
+        'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
+    };
+}
+
+export function PostCertificateLifecycleActionToJSON(json: any): PostCertificateLifecycleAction {
+    return PostCertificateLifecycleActionToJSONTyped(json, false);
+}
+
+export function PostCertificateLifecycleActionToJSONTyped(value?: PostCertificateLifecycleAction | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reason': value['reason'],
+        'expires_at': value['expiresAt'],
+    };
+}
+

package/src/models/PostCertificateTemplate.ts

@@ -0,0 +1,98 @@
+/* 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 { CertificateCanvasDocument } from './CertificateCanvasDocument';
+import {
+    CertificateCanvasDocumentFromJSON,
+    CertificateCanvasDocumentFromJSONTyped,
+    CertificateCanvasDocumentToJSON,
+    CertificateCanvasDocumentToJSONTyped,
+} from './CertificateCanvasDocument';
+
+/**
+ * 
+ * @export
+ * @interface PostCertificateTemplate
+ */
+export interface PostCertificateTemplate {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateTemplate
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateTemplate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCertificateTemplate
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {CertificateCanvasDocument}
+     * @memberof PostCertificateTemplate
+     */
+    designDocument?: CertificateCanvasDocument;
+}
+
+/**
+ * Check if a given object implements the PostCertificateTemplate interface.
+ */
+export function instanceOfPostCertificateTemplate(value: object): value is PostCertificateTemplate {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateTemplateFromJSON(json: any): PostCertificateTemplate {
+    return PostCertificateTemplateFromJSONTyped(json, false);
+}
+
+export function PostCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateTemplate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'designDocument': json['design_document'] == null ? undefined : CertificateCanvasDocumentFromJSON(json['design_document']),
+    };
+}
+
+export function PostCertificateTemplateToJSON(json: any): PostCertificateTemplate {
+    return PostCertificateTemplateToJSONTyped(json, false);
+}
+
+export function PostCertificateTemplateToJSONTyped(value?: PostCertificateTemplate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'design_document': CertificateCanvasDocumentToJSON(value['designDocument']),
+    };
+}
+

package/src/models/PostCertificateTemplateClone.ts

@@ -0,0 +1,82 @@
+/* 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 PostCertificateTemplateClone
+ */
+export interface PostCertificateTemplateClone {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateTemplateClone
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostCertificateTemplateClone
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostCertificateTemplateClone
+     */
+    isDefault?: boolean;
+}
+
+/**
+ * Check if a given object implements the PostCertificateTemplateClone interface.
+ */
+export function instanceOfPostCertificateTemplateClone(value: object): value is PostCertificateTemplateClone {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostCertificateTemplateCloneFromJSON(json: any): PostCertificateTemplateClone {
+    return PostCertificateTemplateCloneFromJSONTyped(json, false);
+}
+
+export function PostCertificateTemplateCloneFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateTemplateClone {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+    };
+}
+
+export function PostCertificateTemplateCloneToJSON(json: any): PostCertificateTemplateClone {
+    return PostCertificateTemplateCloneToJSONTyped(json, false);
+}
+
+export function PostCertificateTemplateCloneToJSONTyped(value?: PostCertificateTemplateClone | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+    };
+}
+