@easyedu/js-lsm-api 1.77.0 → 1.79.0

package/dist/esm/models/PortalUserFieldDefinition.d.ts

@@ -0,0 +1,108 @@
+/**
+ * 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 { PortalUserFieldOption } from './PortalUserFieldOption';
+/**
+ *
+ * @export
+ * @interface PortalUserFieldDefinition
+ */
+export interface PortalUserFieldDefinition {
+    /**
+     * Existing field external ID. Omit on PUT to match by key or create.
+     * @type {string}
+     * @memberof PortalUserFieldDefinition
+     */
+    id?: string | null;
+    /**
+     * External ID or key of the group this field belongs to.
+     * @type {string}
+     * @memberof PortalUserFieldDefinition
+     */
+    groupId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldDefinition
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldDefinition
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldDefinition
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {PortalUserFieldDefinitionFieldTypeEnum}
+     * @memberof PortalUserFieldDefinition
+     */
+    fieldType: PortalUserFieldDefinitionFieldTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortalUserFieldDefinition
+     */
+    isRequired: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortalUserFieldDefinition
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PortalUserFieldDefinition
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {object}
+     * @memberof PortalUserFieldDefinition
+     */
+    validation?: object | null;
+    /**
+     *
+     * @type {Array<PortalUserFieldOption>}
+     * @memberof PortalUserFieldDefinition
+     */
+    options: Array<PortalUserFieldOption>;
+}
+/**
+ * @export
+ */
+export declare const PortalUserFieldDefinitionFieldTypeEnum: {
+    readonly Text: "text";
+    readonly Textarea: "textarea";
+    readonly Email: "email";
+    readonly Phone: "phone";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+    readonly Date: "date";
+    readonly Select: "select";
+    readonly MultiSelect: "multi_select";
+};
+export type PortalUserFieldDefinitionFieldTypeEnum = typeof PortalUserFieldDefinitionFieldTypeEnum[keyof typeof PortalUserFieldDefinitionFieldTypeEnum];
+/**
+ * Check if a given object implements the PortalUserFieldDefinition interface.
+ */
+export declare function instanceOfPortalUserFieldDefinition(value: object): value is PortalUserFieldDefinition;
+export declare function PortalUserFieldDefinitionFromJSON(json: any): PortalUserFieldDefinition;
+export declare function PortalUserFieldDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldDefinition;
+export declare function PortalUserFieldDefinitionToJSON(json: any): PortalUserFieldDefinition;
+export declare function PortalUserFieldDefinitionToJSONTyped(value?: PortalUserFieldDefinition | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PortalUserFieldDefinition.js

@@ -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 { PortalUserFieldOptionFromJSON, PortalUserFieldOptionToJSON, } from './PortalUserFieldOption';
+/**
+ * @export
+ */
+export const PortalUserFieldDefinitionFieldTypeEnum = {
+    Text: 'text',
+    Textarea: 'textarea',
+    Email: 'email',
+    Phone: 'phone',
+    Number: 'number',
+    Boolean: 'boolean',
+    Date: 'date',
+    Select: 'select',
+    MultiSelect: 'multi_select'
+};
+/**
+ * Check if a given object implements the PortalUserFieldDefinition interface.
+ */
+export function instanceOfPortalUserFieldDefinition(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('fieldType' in value) || value['fieldType'] === undefined)
+        return false;
+    if (!('isRequired' in value) || value['isRequired'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('options' in value) || value['options'] === undefined)
+        return false;
+    return true;
+}
+export function PortalUserFieldDefinitionFromJSON(json) {
+    return PortalUserFieldDefinitionFromJSONTyped(json, false);
+}
+export function PortalUserFieldDefinitionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'groupId': json['group_id'] == null ? undefined : json['group_id'],
+        'key': json['key'],
+        'label': json['label'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'fieldType': json['field_type'],
+        'isRequired': json['is_required'],
+        'isActive': json['is_active'],
+        'displayOrder': json['display_order'],
+        'validation': json['validation'] == null ? undefined : json['validation'],
+        'options': (json['options'].map(PortalUserFieldOptionFromJSON)),
+    };
+}
+export function PortalUserFieldDefinitionToJSON(json) {
+    return PortalUserFieldDefinitionToJSONTyped(json, false);
+}
+export function PortalUserFieldDefinitionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'group_id': value['groupId'],
+        'key': value['key'],
+        'label': value['label'],
+        'description': value['description'],
+        'field_type': value['fieldType'],
+        'is_required': value['isRequired'],
+        'is_active': value['isActive'],
+        'display_order': value['displayOrder'],
+        'validation': value['validation'],
+        'options': (value['options'].map(PortalUserFieldOptionToJSON)),
+    };
+}

package/dist/esm/models/PortalUserFieldGroup.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PortalUserFieldGroup
+ */
+export interface PortalUserFieldGroup {
+    /**
+     * Existing group external ID. Omit on PUT to match by key or create.
+     * @type {string}
+     * @memberof PortalUserFieldGroup
+     */
+    id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldGroup
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldGroup
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldGroup
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PortalUserFieldGroup
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortalUserFieldGroup
+     */
+    isActive: boolean;
+}
+/**
+ * Check if a given object implements the PortalUserFieldGroup interface.
+ */
+export declare function instanceOfPortalUserFieldGroup(value: object): value is PortalUserFieldGroup;
+export declare function PortalUserFieldGroupFromJSON(json: any): PortalUserFieldGroup;
+export declare function PortalUserFieldGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldGroup;
+export declare function PortalUserFieldGroupToJSON(json: any): PortalUserFieldGroup;
+export declare function PortalUserFieldGroupToJSONTyped(value?: PortalUserFieldGroup | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PortalUserFieldGroup.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PortalUserFieldGroup interface.
+ */
+export function instanceOfPortalUserFieldGroup(value) {
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    return true;
+}
+export function PortalUserFieldGroupFromJSON(json) {
+    return PortalUserFieldGroupFromJSONTyped(json, false);
+}
+export function PortalUserFieldGroupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'key': json['key'],
+        'label': json['label'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'displayOrder': json['display_order'],
+        'isActive': json['is_active'],
+    };
+}
+export function PortalUserFieldGroupToJSON(json) {
+    return PortalUserFieldGroupToJSONTyped(json, false);
+}
+export function PortalUserFieldGroupToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'key': value['key'],
+        'label': value['label'],
+        'description': value['description'],
+        'display_order': value['displayOrder'],
+        'is_active': value['isActive'],
+    };
+}

package/dist/esm/models/PortalUserFieldMissingRequired.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PortalUserFieldMissingRequired
+ */
+export interface PortalUserFieldMissingRequired {
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldMissingRequired
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldMissingRequired
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldMissingRequired
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldMissingRequired
+     */
+    groupId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldMissingRequired
+     */
+    groupLabel?: string | null;
+}
+/**
+ * Check if a given object implements the PortalUserFieldMissingRequired interface.
+ */
+export declare function instanceOfPortalUserFieldMissingRequired(value: object): value is PortalUserFieldMissingRequired;
+export declare function PortalUserFieldMissingRequiredFromJSON(json: any): PortalUserFieldMissingRequired;
+export declare function PortalUserFieldMissingRequiredFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldMissingRequired;
+export declare function PortalUserFieldMissingRequiredToJSON(json: any): PortalUserFieldMissingRequired;
+export declare function PortalUserFieldMissingRequiredToJSONTyped(value?: PortalUserFieldMissingRequired | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PortalUserFieldMissingRequired.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PortalUserFieldMissingRequired interface.
+ */
+export function instanceOfPortalUserFieldMissingRequired(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('key' in value) || value['key'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    return true;
+}
+export function PortalUserFieldMissingRequiredFromJSON(json) {
+    return PortalUserFieldMissingRequiredFromJSONTyped(json, false);
+}
+export function PortalUserFieldMissingRequiredFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'key': json['key'],
+        'label': json['label'],
+        'groupId': json['group_id'] == null ? undefined : json['group_id'],
+        'groupLabel': json['group_label'] == null ? undefined : json['group_label'],
+    };
+}
+export function PortalUserFieldMissingRequiredToJSON(json) {
+    return PortalUserFieldMissingRequiredToJSONTyped(json, false);
+}
+export function PortalUserFieldMissingRequiredToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'key': value['key'],
+        'label': value['label'],
+        'group_id': value['groupId'],
+        'group_label': value['groupLabel'],
+    };
+}

package/dist/esm/models/PortalUserFieldOption.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PortalUserFieldOption
+ */
+export interface PortalUserFieldOption {
+    /**
+     * Existing option external ID. Omit on PUT to match by value or create.
+     * @type {string}
+     * @memberof PortalUserFieldOption
+     */
+    id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldOption
+     */
+    value: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldOption
+     */
+    label: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PortalUserFieldOption
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortalUserFieldOption
+     */
+    isActive: boolean;
+}
+/**
+ * Check if a given object implements the PortalUserFieldOption interface.
+ */
+export declare function instanceOfPortalUserFieldOption(value: object): value is PortalUserFieldOption;
+export declare function PortalUserFieldOptionFromJSON(json: any): PortalUserFieldOption;
+export declare function PortalUserFieldOptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldOption;
+export declare function PortalUserFieldOptionToJSON(json: any): PortalUserFieldOption;
+export declare function PortalUserFieldOptionToJSONTyped(value?: PortalUserFieldOption | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PortalUserFieldOption.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PortalUserFieldOption interface.
+ */
+export function instanceOfPortalUserFieldOption(value) {
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    return true;
+}
+export function PortalUserFieldOptionFromJSON(json) {
+    return PortalUserFieldOptionFromJSONTyped(json, false);
+}
+export function PortalUserFieldOptionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'value': json['value'],
+        'label': json['label'],
+        'displayOrder': json['display_order'],
+        'isActive': json['is_active'],
+    };
+}
+export function PortalUserFieldOptionToJSON(json) {
+    return PortalUserFieldOptionToJSONTyped(json, false);
+}
+export function PortalUserFieldOptionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'value': value['value'],
+        'label': value['label'],
+        'display_order': value['displayOrder'],
+        'is_active': value['isActive'],
+    };
+}

package/dist/esm/models/PortalUserFieldValueField.d.ts

@@ -0,0 +1,96 @@
+/**
+ * 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 { PortalUserFieldOption } from './PortalUserFieldOption';
+/**
+ *
+ * @export
+ * @interface PortalUserFieldValueField
+ */
+export interface PortalUserFieldValueField {
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldValueField
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldValueField
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldValueField
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PortalUserFieldValueField
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {PortalUserFieldValueFieldFieldTypeEnum}
+     * @memberof PortalUserFieldValueField
+     */
+    fieldType: PortalUserFieldValueFieldFieldTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PortalUserFieldValueField
+     */
+    isRequired: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PortalUserFieldValueField
+     */
+    displayOrder: number;
+    /**
+     *
+     * @type {object}
+     * @memberof PortalUserFieldValueField
+     */
+    value?: object | null;
+    /**
+     *
+     * @type {Array<PortalUserFieldOption>}
+     * @memberof PortalUserFieldValueField
+     */
+    options: Array<PortalUserFieldOption>;
+}
+/**
+ * @export
+ */
+export declare const PortalUserFieldValueFieldFieldTypeEnum: {
+    readonly Text: "text";
+    readonly Textarea: "textarea";
+    readonly Email: "email";
+    readonly Phone: "phone";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+    readonly Date: "date";
+    readonly Select: "select";
+    readonly MultiSelect: "multi_select";
+};
+export type PortalUserFieldValueFieldFieldTypeEnum = typeof PortalUserFieldValueFieldFieldTypeEnum[keyof typeof PortalUserFieldValueFieldFieldTypeEnum];
+/**
+ * Check if a given object implements the PortalUserFieldValueField interface.
+ */
+export declare function instanceOfPortalUserFieldValueField(value: object): value is PortalUserFieldValueField;
+export declare function PortalUserFieldValueFieldFromJSON(json: any): PortalUserFieldValueField;
+export declare function PortalUserFieldValueFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldValueField;
+export declare function PortalUserFieldValueFieldToJSON(json: any): PortalUserFieldValueField;
+export declare function PortalUserFieldValueFieldToJSONTyped(value?: PortalUserFieldValueField | null, ignoreDiscriminator?: boolean): any;