@easyedu/js-lsm-api 1.49.0 → 1.50.0

package/dist/esm/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];