@easyedu/js-lsm-api 1.48.0 → 1.50.0

package/.openapi-generator/FILES

@@ -2,6 +2,10 @@
 .npmignore
 .openapi-generator-ignore
 README.md
+docs/Certificate.md
+docs/CertificateApi.md
+docs/CertificateConfig.md
+docs/CertificatePublic.md
 docs/ChatApi.md
 docs/ContentApi.md
 docs/CourseApi.md
@@ -9,10 +13,13 @@ docs/CriteriaBasedSelection.md
 docs/CriteriaBasedSelectionCriteria.md
 docs/CriteriaBasedSelectionDistribution.md
 docs/DownloadSupportTicketAttachment200Response.md
+docs/EffectiveCertificateConfig.md
 docs/Essay.md
 docs/Essay1.md
 docs/FillInBlank.md
 docs/FillInBlank1.md
+docs/GetCertificateConfigList.md
+docs/GetCertificateList.md
 docs/GetChatMessage.md
 docs/GetContent.md
 docs/GetContentContentData.md
@@ -160,6 +167,8 @@ docs/NoAnswer.md
 docs/OtherApi.md
 docs/Paginated.md
 docs/PortalApi.md
+docs/PostCertificate.md
+docs/PostCertificateConfig.md
 docs/PostContentQuiz.md
 docs/PostContentQuizAssignment.md
 docs/PostContentQuizQuestionSelection.md
@@ -195,6 +204,7 @@ docs/PostQuizQuestions.md
 docs/PostQuizQuestionsQuestionsInner.md
 docs/PostQuizSettings.md
 docs/PostResetPassword.md
+docs/PostRevokeCertificate.md
 docs/PostRole.md
 docs/PostSendResetPassword.md
 docs/PostSupportTicket.md
@@ -202,6 +212,7 @@ docs/PostSupportTicketComment.md
 docs/PostVerifyManifest.md
 docs/PostVerifyManifestItemsInner.md
 docs/PostVerifyManifestResourcesInner.md
+docs/PutCertificateConfig.md
 docs/PutContent.md
 docs/PutContentReorder.md
 docs/PutContentVersion.md
@@ -245,6 +256,7 @@ docs/SupportTicketApi.md
 docs/SupportTicketUser.md
 docs/UserApi.md
 package.json
+src/apis/CertificateApi.ts
 src/apis/ChatApi.ts
 src/apis/ContentApi.ts
 src/apis/CourseApi.ts
@@ -259,14 +271,20 @@ src/apis/SupportTicketApi.ts
 src/apis/UserApi.ts
 src/apis/index.ts
 src/index.ts
+src/models/Certificate.ts
+src/models/CertificateConfig.ts
+src/models/CertificatePublic.ts
 src/models/CriteriaBasedSelection.ts
 src/models/CriteriaBasedSelectionCriteria.ts
 src/models/CriteriaBasedSelectionDistribution.ts
 src/models/DownloadSupportTicketAttachment200Response.ts
+src/models/EffectiveCertificateConfig.ts
 src/models/Essay.ts
 src/models/Essay1.ts
 src/models/FillInBlank.ts
 src/models/FillInBlank1.ts
+src/models/GetCertificateConfigList.ts
+src/models/GetCertificateList.ts
 src/models/GetChatMessage.ts
 src/models/GetContent.ts
 src/models/GetContentContentData.ts
@@ -411,6 +429,8 @@ src/models/MultipleAnswer.ts
 src/models/MultipleAnswer1.ts
 src/models/NoAnswer.ts
 src/models/Paginated.ts
+src/models/PostCertificate.ts
+src/models/PostCertificateConfig.ts
 src/models/PostContentQuiz.ts
 src/models/PostContentQuizAssignment.ts
 src/models/PostContentQuizQuestionSelection.ts
@@ -446,6 +466,7 @@ src/models/PostQuizQuestions.ts
 src/models/PostQuizQuestionsQuestionsInner.ts
 src/models/PostQuizSettings.ts
 src/models/PostResetPassword.ts
+src/models/PostRevokeCertificate.ts
 src/models/PostRole.ts
 src/models/PostSendResetPassword.ts
 src/models/PostSupportTicket.ts
@@ -453,6 +474,7 @@ src/models/PostSupportTicketComment.ts
 src/models/PostVerifyManifest.ts
 src/models/PostVerifyManifestItemsInner.ts
 src/models/PostVerifyManifestResourcesInner.ts
+src/models/PutCertificateConfig.ts
 src/models/PutContent.ts
 src/models/PutContentReorder.ts
 src/models/PutContentVersion.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.48.0
+# @easyedu/js-lsm-api@1.50.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -16,21 +16,21 @@ Next, try it out.
 ```ts
 import {
   Configuration,
-  ChatApi,
+  CertificateApi,
 } from '@easyedu/js-lsm-api';
-import type { DeleteConversationRequest } from '@easyedu/js-lsm-api';
+import type { DeleteCertificateConfigRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
-  const api = new ChatApi();
+  const api = new CertificateApi();
 
   const body = {
     // string
-    conversationId: conversationId_example,
-  } satisfies DeleteConversationRequest;
+    configId: configId_example,
+  } satisfies DeleteCertificateConfigRequest;
 
   try {
-    const data = await api.deleteConversation(body);
+    const data = await api.deleteCertificateConfig(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -50,6 +50,19 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Class | Method | HTTP request | Description
 | ----- | ------ | ------------ | -------------
+*CertificateApi* | [**deleteCertificateConfig**](docs/CertificateApi.md#deletecertificateconfig) | **DELETE** /certificate-configs/{configId} | Delete a certificate config
+*CertificateApi* | [**getCertificate**](docs/CertificateApi.md#getcertificate) | **GET** /certificates/{certificateId} | Get a single certificate
+*CertificateApi* | [**getCertificateConfig**](docs/CertificateApi.md#getcertificateconfig) | **GET** /certificate-configs/{configId} | Get a certificate config
+*CertificateApi* | [**getCertificateConfigs**](docs/CertificateApi.md#getcertificateconfigs) | **GET** /certificate-configs | List certificate configs in the current portal
+*CertificateApi* | [**getCertificatePdf**](docs/CertificateApi.md#getcertificatepdf) | **GET** /certificates/{certificateId}/pdf | Download certificate as PDF
+*CertificateApi* | [**getCertificates**](docs/CertificateApi.md#getcertificates) | **GET** /certificates | List certificates in the current portal
+*CertificateApi* | [**getCurrentUserCertificates**](docs/CertificateApi.md#getcurrentusercertificates) | **GET** /certificates/current | List the authenticated user\'s own certificates
+*CertificateApi* | [**getEffectiveCertificateConfig**](docs/CertificateApi.md#geteffectivecertificateconfig) | **GET** /courses/{courseId}/certificate-config/effective | Resolve effective certificate config for a course
+*CertificateApi* | [**postCertificateConfig**](docs/CertificateApi.md#postcertificateconfig) | **POST** /certificate-configs | Create a certificate config
+*CertificateApi* | [**postCourseCertificate**](docs/CertificateApi.md#postcoursecertificate) | **POST** /courses/{courseId}/certificates | Manually issue a certificate for a course
+*CertificateApi* | [**postRevokeCertificate**](docs/CertificateApi.md#postrevokecertificate) | **POST** /certificates/{certificateId}/revoke | Revoke a certificate
+*CertificateApi* | [**putCertificateConfig**](docs/CertificateApi.md#putcertificateconfig) | **PUT** /certificate-configs/{configId} | Update a certificate config
+*CertificateApi* | [**verifyCertificate**](docs/CertificateApi.md#verifycertificate) | **GET** /public/certificates/{certificateId}/verify | Public certificate verification (no auth)
 *ChatApi* | [**deleteConversation**](docs/ChatApi.md#deleteconversation) | **DELETE** /chat/conversations/{conversationId} | Delete a conversation
 *ChatApi* | [**getConversationMessages**](docs/ChatApi.md#getconversationmessages) | **GET** /chat/conversations/{conversationId}/messages | Get all messages in a conversation
 *ChatApi* | [**getConversations**](docs/ChatApi.md#getconversations) | **GET** /chat/conversations | List conversations for the current user
@@ -178,14 +191,20 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 ### Models
 
+- [Certificate](docs/Certificate.md)
+- [CertificateConfig](docs/CertificateConfig.md)
+- [CertificatePublic](docs/CertificatePublic.md)
 - [CriteriaBasedSelection](docs/CriteriaBasedSelection.md)
 - [CriteriaBasedSelectionCriteria](docs/CriteriaBasedSelectionCriteria.md)
 - [CriteriaBasedSelectionDistribution](docs/CriteriaBasedSelectionDistribution.md)
 - [DownloadSupportTicketAttachment200Response](docs/DownloadSupportTicketAttachment200Response.md)
+- [EffectiveCertificateConfig](docs/EffectiveCertificateConfig.md)
 - [Essay](docs/Essay.md)
 - [Essay1](docs/Essay1.md)
 - [FillInBlank](docs/FillInBlank.md)
 - [FillInBlank1](docs/FillInBlank1.md)
+- [GetCertificateConfigList](docs/GetCertificateConfigList.md)
+- [GetCertificateList](docs/GetCertificateList.md)
 - [GetChatMessage](docs/GetChatMessage.md)
 - [GetContent](docs/GetContent.md)
 - [GetContentContentData](docs/GetContentContentData.md)
@@ -330,6 +349,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [MultipleAnswer1](docs/MultipleAnswer1.md)
 - [NoAnswer](docs/NoAnswer.md)
 - [Paginated](docs/Paginated.md)
+- [PostCertificate](docs/PostCertificate.md)
+- [PostCertificateConfig](docs/PostCertificateConfig.md)
 - [PostContentQuiz](docs/PostContentQuiz.md)
 - [PostContentQuizAssignment](docs/PostContentQuizAssignment.md)
 - [PostContentQuizQuestionSelection](docs/PostContentQuizQuestionSelection.md)
@@ -365,6 +386,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostQuizQuestionsQuestionsInner](docs/PostQuizQuestionsQuestionsInner.md)
 - [PostQuizSettings](docs/PostQuizSettings.md)
 - [PostResetPassword](docs/PostResetPassword.md)
+- [PostRevokeCertificate](docs/PostRevokeCertificate.md)
 - [PostRole](docs/PostRole.md)
 - [PostSendResetPassword](docs/PostSendResetPassword.md)
 - [PostSupportTicket](docs/PostSupportTicket.md)
@@ -372,6 +394,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostVerifyManifest](docs/PostVerifyManifest.md)
 - [PostVerifyManifestItemsInner](docs/PostVerifyManifestItemsInner.md)
 - [PostVerifyManifestResourcesInner](docs/PostVerifyManifestResourcesInner.md)
+- [PutCertificateConfig](docs/PutCertificateConfig.md)
 - [PutContent](docs/PutContent.md)
 - [PutContentReorder](docs/PutContentReorder.md)
 - [PutContentVersion](docs/PutContentVersion.md)
@@ -421,7 +444,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.48.0`
+- Package version: `1.50.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/CertificateApi.d.ts

@@ -0,0 +1,237 @@
+/**
+ * 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 { Certificate, CertificateConfig, CertificatePublic, EffectiveCertificateConfig, GetCertificateConfigList, GetCertificateList, PostCertificate, PostCertificateConfig, PostRevokeCertificate, PutCertificateConfig } from '../models/index';
+export interface DeleteCertificateConfigRequest {
+    configId: string;
+}
+export interface GetCertificateRequest {
+    certificateId: string;
+}
+export interface GetCertificateConfigRequest {
+    configId: string;
+}
+export interface GetCertificateConfigsRequest {
+    courseId?: string;
+    scope?: GetCertificateConfigsScopeEnum;
+}
+export interface GetCertificatePdfRequest {
+    certificateId: string;
+}
+export interface GetCertificatesRequest {
+    userId?: string;
+    courseId?: string;
+    status?: GetCertificatesStatusEnum;
+    issuedAfter?: number;
+    issuedBefore?: number;
+    expiresAfter?: number;
+    expiresBefore?: number;
+    expiringWithinDays?: number;
+}
+export interface GetEffectiveCertificateConfigRequest {
+    courseId: string;
+}
+export interface PostCertificateConfigRequest {
+    postCertificateConfig: PostCertificateConfig;
+}
+export interface PostCourseCertificateRequest {
+    courseId: string;
+    postCertificate: PostCertificate;
+}
+export interface PostRevokeCertificateRequest {
+    certificateId: string;
+    postRevokeCertificate: PostRevokeCertificate;
+}
+export interface PutCertificateConfigRequest {
+    configId: string;
+    putCertificateConfig: PutCertificateConfig;
+}
+export interface VerifyCertificateRequest {
+    certificateId: string;
+}
+/**
+ *
+ */
+export declare class CertificateApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteCertificateConfig without sending the request
+     */
+    deleteCertificateConfigRequestOpts(requestParameters: DeleteCertificateConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a certificate config
+     */
+    deleteCertificateConfigRaw(requestParameters: DeleteCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a certificate config
+     */
+    deleteCertificateConfig(requestParameters: DeleteCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCertificate without sending the request
+     */
+    getCertificateRequestOpts(requestParameters: GetCertificateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a single certificate
+     */
+    getCertificateRaw(requestParameters: GetCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>>;
+    /**
+     * Get a single certificate
+     */
+    getCertificate(requestParameters: GetCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
+    /**
+     * Creates request options for getCertificateConfig without sending the request
+     */
+    getCertificateConfigRequestOpts(requestParameters: GetCertificateConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a certificate config
+     */
+    getCertificateConfigRaw(requestParameters: GetCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateConfig>>;
+    /**
+     * Get a certificate config
+     */
+    getCertificateConfig(requestParameters: GetCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig>;
+    /**
+     * Creates request options for getCertificateConfigs without sending the request
+     */
+    getCertificateConfigsRequestOpts(requestParameters: GetCertificateConfigsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List certificate configs in the current portal
+     */
+    getCertificateConfigsRaw(requestParameters: GetCertificateConfigsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCertificateConfigList>>;
+    /**
+     * List certificate configs in the current portal
+     */
+    getCertificateConfigs(requestParameters?: GetCertificateConfigsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateConfigList>;
+    /**
+     * Creates request options for getCertificatePdf without sending the request
+     */
+    getCertificatePdfRequestOpts(requestParameters: GetCertificatePdfRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Download certificate as PDF
+     */
+    getCertificatePdfRaw(requestParameters: GetCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Download certificate as PDF
+     */
+    getCertificatePdf(requestParameters: GetCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getCertificates without sending the request
+     */
+    getCertificatesRequestOpts(requestParameters: GetCertificatesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List certificates in the current portal
+     */
+    getCertificatesRaw(requestParameters: GetCertificatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCertificateList>>;
+    /**
+     * List certificates in the current portal
+     */
+    getCertificates(requestParameters?: GetCertificatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateList>;
+    /**
+     * Creates request options for getCurrentUserCertificates without sending the request
+     */
+    getCurrentUserCertificatesRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List the authenticated user\'s own certificates
+     */
+    getCurrentUserCertificatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCertificateList>>;
+    /**
+     * List the authenticated user\'s own certificates
+     */
+    getCurrentUserCertificates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateList>;
+    /**
+     * Creates request options for getEffectiveCertificateConfig without sending the request
+     */
+    getEffectiveCertificateConfigRequestOpts(requestParameters: GetEffectiveCertificateConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Resolve effective certificate config for a course
+     */
+    getEffectiveCertificateConfigRaw(requestParameters: GetEffectiveCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EffectiveCertificateConfig>>;
+    /**
+     * Resolve effective certificate config for a course
+     */
+    getEffectiveCertificateConfig(requestParameters: GetEffectiveCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EffectiveCertificateConfig>;
+    /**
+     * Creates request options for postCertificateConfig without sending the request
+     */
+    postCertificateConfigRequestOpts(requestParameters: PostCertificateConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a certificate config
+     */
+    postCertificateConfigRaw(requestParameters: PostCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateConfig>>;
+    /**
+     * Create a certificate config
+     */
+    postCertificateConfig(requestParameters: PostCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig>;
+    /**
+     * Creates request options for postCourseCertificate without sending the request
+     */
+    postCourseCertificateRequestOpts(requestParameters: PostCourseCertificateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Manually issue a certificate for a course
+     */
+    postCourseCertificateRaw(requestParameters: PostCourseCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>>;
+    /**
+     * Manually issue a certificate for a course
+     */
+    postCourseCertificate(requestParameters: PostCourseCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
+    /**
+     * Creates request options for postRevokeCertificate without sending the request
+     */
+    postRevokeCertificateRequestOpts(requestParameters: PostRevokeCertificateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Revoke a certificate
+     */
+    postRevokeCertificateRaw(requestParameters: PostRevokeCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>>;
+    /**
+     * Revoke a certificate
+     */
+    postRevokeCertificate(requestParameters: PostRevokeCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
+    /**
+     * Creates request options for putCertificateConfig without sending the request
+     */
+    putCertificateConfigRequestOpts(requestParameters: PutCertificateConfigRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a certificate config
+     */
+    putCertificateConfigRaw(requestParameters: PutCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateConfig>>;
+    /**
+     * Update a certificate config
+     */
+    putCertificateConfig(requestParameters: PutCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig>;
+    /**
+     * Creates request options for verifyCertificate without sending the request
+     */
+    verifyCertificateRequestOpts(requestParameters: VerifyCertificateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Public certificate verification (no auth)
+     */
+    verifyCertificateRaw(requestParameters: VerifyCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificatePublic>>;
+    /**
+     * Public certificate verification (no auth)
+     */
+    verifyCertificate(requestParameters: VerifyCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificatePublic>;
+}
+/**
+ * @export
+ */
+export declare const GetCertificateConfigsScopeEnum: {
+    readonly Portal: "portal";
+    readonly Course: "course";
+};
+export type GetCertificateConfigsScopeEnum = typeof GetCertificateConfigsScopeEnum[keyof typeof GetCertificateConfigsScopeEnum];
+/**
+ * @export
+ */
+export declare const GetCertificatesStatusEnum: {
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+};
+export type GetCertificatesStatusEnum = typeof GetCertificatesStatusEnum[keyof typeof GetCertificatesStatusEnum];