@easyedu/js-lsm-api 1.85.0 → 1.87.0

package/src/models/CertificateBadgePolicyAlignmentsInner.ts

@@ -0,0 +1,91 @@
+/* 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 CertificateBadgePolicyAlignmentsInner
+ */
+export interface CertificateBadgePolicyAlignmentsInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicyAlignmentsInner
+     */
+    targetName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicyAlignmentsInner
+     */
+    targetUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicyAlignmentsInner
+     */
+    targetFramework?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicyAlignmentsInner
+     */
+    targetCode?: string | null;
+}
+
+/**
+ * Check if a given object implements the CertificateBadgePolicyAlignmentsInner interface.
+ */
+export function instanceOfCertificateBadgePolicyAlignmentsInner(value: object): value is CertificateBadgePolicyAlignmentsInner {
+    if (!('targetName' in value) || value['targetName'] === undefined) return false;
+    if (!('targetUrl' in value) || value['targetUrl'] === undefined) return false;
+    return true;
+}
+
+export function CertificateBadgePolicyAlignmentsInnerFromJSON(json: any): CertificateBadgePolicyAlignmentsInner {
+    return CertificateBadgePolicyAlignmentsInnerFromJSONTyped(json, false);
+}
+
+export function CertificateBadgePolicyAlignmentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateBadgePolicyAlignmentsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'targetName': json['target_name'],
+        'targetUrl': json['target_url'],
+        'targetFramework': json['target_framework'] == null ? undefined : json['target_framework'],
+        'targetCode': json['target_code'] == null ? undefined : json['target_code'],
+    };
+}
+
+export function CertificateBadgePolicyAlignmentsInnerToJSON(json: any): CertificateBadgePolicyAlignmentsInner {
+    return CertificateBadgePolicyAlignmentsInnerToJSONTyped(json, false);
+}
+
+export function CertificateBadgePolicyAlignmentsInnerToJSONTyped(value?: CertificateBadgePolicyAlignmentsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'target_name': value['targetName'],
+        'target_url': value['targetUrl'],
+        'target_framework': value['targetFramework'],
+        'target_code': value['targetCode'],
+    };
+}
+

package/src/models/CertificateCanvasDocument.ts

@@ -0,0 +1,109 @@
+/* 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 { CertificateCanvasElement } from './CertificateCanvasElement';
+import {
+    CertificateCanvasElementFromJSON,
+    CertificateCanvasElementFromJSONTyped,
+    CertificateCanvasElementToJSON,
+    CertificateCanvasElementToJSONTyped,
+} from './CertificateCanvasElement';
+import type { CertificateCanvasDocumentPage } from './CertificateCanvasDocumentPage';
+import {
+    CertificateCanvasDocumentPageFromJSON,
+    CertificateCanvasDocumentPageFromJSONTyped,
+    CertificateCanvasDocumentPageToJSON,
+    CertificateCanvasDocumentPageToJSONTyped,
+} from './CertificateCanvasDocumentPage';
+
+/**
+ * Constrained fixed-page certificate-canvas-v1 document.
+ * @export
+ * @interface CertificateCanvasDocument
+ */
+export interface CertificateCanvasDocument {
+    /**
+     * 
+     * @type {CertificateCanvasDocumentFormatEnum}
+     * @memberof CertificateCanvasDocument
+     */
+    format: CertificateCanvasDocumentFormatEnum;
+    /**
+     * 
+     * @type {CertificateCanvasDocumentPage}
+     * @memberof CertificateCanvasDocument
+     */
+    page: CertificateCanvasDocumentPage;
+    /**
+     * 
+     * @type {Array<CertificateCanvasElement>}
+     * @memberof CertificateCanvasDocument
+     */
+    elements: Array<CertificateCanvasElement>;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateCanvasDocumentFormatEnum = {
+    CertificateCanvasV1: 'certificate-canvas-v1'
+} as const;
+export type CertificateCanvasDocumentFormatEnum = typeof CertificateCanvasDocumentFormatEnum[keyof typeof CertificateCanvasDocumentFormatEnum];
+
+
+/**
+ * Check if a given object implements the CertificateCanvasDocument interface.
+ */
+export function instanceOfCertificateCanvasDocument(value: object): value is CertificateCanvasDocument {
+    if (!('format' in value) || value['format'] === undefined) return false;
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('elements' in value) || value['elements'] === undefined) return false;
+    return true;
+}
+
+export function CertificateCanvasDocumentFromJSON(json: any): CertificateCanvasDocument {
+    return CertificateCanvasDocumentFromJSONTyped(json, false);
+}
+
+export function CertificateCanvasDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateCanvasDocument {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'format': json['format'],
+        'page': CertificateCanvasDocumentPageFromJSON(json['page']),
+        'elements': ((json['elements'] as Array<any>).map(CertificateCanvasElementFromJSON)),
+    };
+}
+
+export function CertificateCanvasDocumentToJSON(json: any): CertificateCanvasDocument {
+    return CertificateCanvasDocumentToJSONTyped(json, false);
+}
+
+export function CertificateCanvasDocumentToJSONTyped(value?: CertificateCanvasDocument | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'format': value['format'],
+        'page': CertificateCanvasDocumentPageToJSON(value['page']),
+        'elements': ((value['elements'] as Array<any>).map(CertificateCanvasElementToJSON)),
+    };
+}
+

package/src/models/CertificateCanvasDocumentPage.ts

@@ -0,0 +1,103 @@
+/* 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 CertificateCanvasDocumentPage
+ */
+export interface CertificateCanvasDocumentPage {
+    /**
+     * 
+     * @type {CertificateCanvasDocumentPageSizeEnum}
+     * @memberof CertificateCanvasDocumentPage
+     */
+    size: CertificateCanvasDocumentPageSizeEnum;
+    /**
+     * 
+     * @type {CertificateCanvasDocumentPageOrientationEnum}
+     * @memberof CertificateCanvasDocumentPage
+     */
+    orientation: CertificateCanvasDocumentPageOrientationEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateCanvasDocumentPage
+     */
+    backgroundColor?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateCanvasDocumentPageSizeEnum = {
+    A4: 'a4',
+    Letter: 'letter'
+} as const;
+export type CertificateCanvasDocumentPageSizeEnum = typeof CertificateCanvasDocumentPageSizeEnum[keyof typeof CertificateCanvasDocumentPageSizeEnum];
+
+/**
+ * @export
+ */
+export const CertificateCanvasDocumentPageOrientationEnum = {
+    Portrait: 'portrait',
+    Landscape: 'landscape'
+} as const;
+export type CertificateCanvasDocumentPageOrientationEnum = typeof CertificateCanvasDocumentPageOrientationEnum[keyof typeof CertificateCanvasDocumentPageOrientationEnum];
+
+
+/**
+ * Check if a given object implements the CertificateCanvasDocumentPage interface.
+ */
+export function instanceOfCertificateCanvasDocumentPage(value: object): value is CertificateCanvasDocumentPage {
+    if (!('size' in value) || value['size'] === undefined) return false;
+    if (!('orientation' in value) || value['orientation'] === undefined) return false;
+    return true;
+}
+
+export function CertificateCanvasDocumentPageFromJSON(json: any): CertificateCanvasDocumentPage {
+    return CertificateCanvasDocumentPageFromJSONTyped(json, false);
+}
+
+export function CertificateCanvasDocumentPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateCanvasDocumentPage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'size': json['size'],
+        'orientation': json['orientation'],
+        'backgroundColor': json['background_color'] == null ? undefined : json['background_color'],
+    };
+}
+
+export function CertificateCanvasDocumentPageToJSON(json: any): CertificateCanvasDocumentPage {
+    return CertificateCanvasDocumentPageToJSONTyped(json, false);
+}
+
+export function CertificateCanvasDocumentPageToJSONTyped(value?: CertificateCanvasDocumentPage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'size': value['size'],
+        'orientation': value['orientation'],
+        'background_color': value['backgroundColor'],
+    };
+}
+

package/src/models/CertificateCanvasElement.ts

@@ -0,0 +1,128 @@
+/* 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 type { CertificateCanvasImageElement } from './CertificateCanvasImageElement';
+import {
+    instanceOfCertificateCanvasImageElement,
+    CertificateCanvasImageElementFromJSON,
+    CertificateCanvasImageElementFromJSONTyped,
+    CertificateCanvasImageElementToJSON,
+} from './CertificateCanvasImageElement';
+import type { CertificateCanvasLineElement } from './CertificateCanvasLineElement';
+import {
+    instanceOfCertificateCanvasLineElement,
+    CertificateCanvasLineElementFromJSON,
+    CertificateCanvasLineElementFromJSONTyped,
+    CertificateCanvasLineElementToJSON,
+} from './CertificateCanvasLineElement';
+import type { CertificateCanvasPortalLogoElement } from './CertificateCanvasPortalLogoElement';
+import {
+    instanceOfCertificateCanvasPortalLogoElement,
+    CertificateCanvasPortalLogoElementFromJSON,
+    CertificateCanvasPortalLogoElementFromJSONTyped,
+    CertificateCanvasPortalLogoElementToJSON,
+} from './CertificateCanvasPortalLogoElement';
+import type { CertificateCanvasShapeElement } from './CertificateCanvasShapeElement';
+import {
+    instanceOfCertificateCanvasShapeElement,
+    CertificateCanvasShapeElementFromJSON,
+    CertificateCanvasShapeElementFromJSONTyped,
+    CertificateCanvasShapeElementToJSON,
+} from './CertificateCanvasShapeElement';
+import type { CertificateCanvasTextElement } from './CertificateCanvasTextElement';
+import {
+    instanceOfCertificateCanvasTextElement,
+    CertificateCanvasTextElementFromJSON,
+    CertificateCanvasTextElementFromJSONTyped,
+    CertificateCanvasTextElementToJSON,
+} from './CertificateCanvasTextElement';
+import type { CertificateCanvasVerificationQrElement } from './CertificateCanvasVerificationQrElement';
+import {
+    instanceOfCertificateCanvasVerificationQrElement,
+    CertificateCanvasVerificationQrElementFromJSON,
+    CertificateCanvasVerificationQrElementFromJSONTyped,
+    CertificateCanvasVerificationQrElementToJSON,
+} from './CertificateCanvasVerificationQrElement';
+
+/**
+ * @type CertificateCanvasElement
+ * A constrained certificate-canvas-v1 element.
+ * @export
+ */
+export type CertificateCanvasElement = CertificateCanvasImageElement | CertificateCanvasLineElement | CertificateCanvasPortalLogoElement | CertificateCanvasShapeElement | CertificateCanvasTextElement | CertificateCanvasVerificationQrElement;
+
+export function CertificateCanvasElementFromJSON(json: any): CertificateCanvasElement {
+    return CertificateCanvasElementFromJSONTyped(json, false);
+}
+
+export function CertificateCanvasElementFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateCanvasElement {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json !== 'object') {
+        return json;
+    }
+    if (instanceOfCertificateCanvasImageElement(json)) {
+        return CertificateCanvasImageElementFromJSONTyped(json, true);
+    }
+    if (instanceOfCertificateCanvasLineElement(json)) {
+        return CertificateCanvasLineElementFromJSONTyped(json, true);
+    }
+    if (instanceOfCertificateCanvasPortalLogoElement(json)) {
+        return CertificateCanvasPortalLogoElementFromJSONTyped(json, true);
+    }
+    if (instanceOfCertificateCanvasShapeElement(json)) {
+        return CertificateCanvasShapeElementFromJSONTyped(json, true);
+    }
+    if (instanceOfCertificateCanvasTextElement(json)) {
+        return CertificateCanvasTextElementFromJSONTyped(json, true);
+    }
+    if (instanceOfCertificateCanvasVerificationQrElement(json)) {
+        return CertificateCanvasVerificationQrElementFromJSONTyped(json, true);
+    }
+    return {} as any;
+}
+
+export function CertificateCanvasElementToJSON(json: any): any {
+    return CertificateCanvasElementToJSONTyped(json, false);
+}
+
+export function CertificateCanvasElementToJSONTyped(value?: CertificateCanvasElement | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value !== 'object') {
+        return value;
+    }
+    if (instanceOfCertificateCanvasImageElement(value)) {
+        return CertificateCanvasImageElementToJSON(value as CertificateCanvasImageElement);
+    }
+    if (instanceOfCertificateCanvasLineElement(value)) {
+        return CertificateCanvasLineElementToJSON(value as CertificateCanvasLineElement);
+    }
+    if (instanceOfCertificateCanvasPortalLogoElement(value)) {
+        return CertificateCanvasPortalLogoElementToJSON(value as CertificateCanvasPortalLogoElement);
+    }
+    if (instanceOfCertificateCanvasShapeElement(value)) {
+        return CertificateCanvasShapeElementToJSON(value as CertificateCanvasShapeElement);
+    }
+    if (instanceOfCertificateCanvasTextElement(value)) {
+        return CertificateCanvasTextElementToJSON(value as CertificateCanvasTextElement);
+    }
+    if (instanceOfCertificateCanvasVerificationQrElement(value)) {
+        return CertificateCanvasVerificationQrElementToJSON(value as CertificateCanvasVerificationQrElement);
+    }
+    return {};
+}
+

package/src/models/CertificateCanvasImageElement.ts

@@ -0,0 +1,148 @@
+/* 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 CertificateCanvasImageElement
+ */
+export interface CertificateCanvasImageElement {
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateCanvasImageElement
+     */
+    id: string;
+    /**
+     * 
+     * @type {CertificateCanvasImageElementTypeEnum}
+     * @memberof CertificateCanvasImageElement
+     */
+    type: CertificateCanvasImageElementTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateCanvasImageElement
+     */
+    x: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateCanvasImageElement
+     */
+    y: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateCanvasImageElement
+     */
+    width: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateCanvasImageElement
+     */
+    height: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateCanvasImageElement
+     */
+    assetId: string;
+    /**
+     * 
+     * @type {CertificateCanvasImageElementFitEnum}
+     * @memberof CertificateCanvasImageElement
+     */
+    fit?: CertificateCanvasImageElementFitEnum;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateCanvasImageElementTypeEnum = {
+    Image: 'image'
+} as const;
+export type CertificateCanvasImageElementTypeEnum = typeof CertificateCanvasImageElementTypeEnum[keyof typeof CertificateCanvasImageElementTypeEnum];
+
+/**
+ * @export
+ */
+export const CertificateCanvasImageElementFitEnum = {
+    Contain: 'contain',
+    Cover: 'cover',
+    Stretch: 'stretch'
+} as const;
+export type CertificateCanvasImageElementFitEnum = typeof CertificateCanvasImageElementFitEnum[keyof typeof CertificateCanvasImageElementFitEnum];
+
+
+/**
+ * Check if a given object implements the CertificateCanvasImageElement interface.
+ */
+export function instanceOfCertificateCanvasImageElement(value: object): value is CertificateCanvasImageElement {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('x' in value) || value['x'] === undefined) return false;
+    if (!('y' in value) || value['y'] === undefined) return false;
+    if (!('width' in value) || value['width'] === undefined) return false;
+    if (!('height' in value) || value['height'] === undefined) return false;
+    if (!('assetId' in value) || value['assetId'] === undefined) return false;
+    return true;
+}
+
+export function CertificateCanvasImageElementFromJSON(json: any): CertificateCanvasImageElement {
+    return CertificateCanvasImageElementFromJSONTyped(json, false);
+}
+
+export function CertificateCanvasImageElementFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateCanvasImageElement {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        'x': json['x'],
+        'y': json['y'],
+        'width': json['width'],
+        'height': json['height'],
+        'assetId': json['asset_id'],
+        'fit': json['fit'] == null ? undefined : json['fit'],
+    };
+}
+
+export function CertificateCanvasImageElementToJSON(json: any): CertificateCanvasImageElement {
+    return CertificateCanvasImageElementToJSONTyped(json, false);
+}
+
+export function CertificateCanvasImageElementToJSONTyped(value?: CertificateCanvasImageElement | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'x': value['x'],
+        'y': value['y'],
+        'width': value['width'],
+        'height': value['height'],
+        'asset_id': value['assetId'],
+        'fit': value['fit'],
+    };
+}
+