@easyedu/js-lsm-api 1.77.0 → 1.79.0

package/src/models/PortalUserFieldGroup.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';
+/**
+ * 
+ * @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 function instanceOfPortalUserFieldGroup(value: object): value is PortalUserFieldGroup {
+    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: any): PortalUserFieldGroup {
+    return PortalUserFieldGroupFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldGroup {
+    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: any): PortalUserFieldGroup {
+    return PortalUserFieldGroupToJSONTyped(json, false);
+}
+
+export function PortalUserFieldGroupToJSONTyped(value?: PortalUserFieldGroup | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PortalUserFieldMissingRequired.ts

@@ -0,0 +1,100 @@
+/* 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 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 function instanceOfPortalUserFieldMissingRequired(value: object): value is PortalUserFieldMissingRequired {
+    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: any): PortalUserFieldMissingRequired {
+    return PortalUserFieldMissingRequiredFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldMissingRequiredFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldMissingRequired {
+    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: any): PortalUserFieldMissingRequired {
+    return PortalUserFieldMissingRequiredToJSONTyped(json, false);
+}
+
+export function PortalUserFieldMissingRequiredToJSONTyped(value?: PortalUserFieldMissingRequired | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'key': value['key'],
+        'label': value['label'],
+        'group_id': value['groupId'],
+        'group_label': value['groupLabel'],
+    };
+}
+

package/src/models/PortalUserFieldOption.ts

@@ -0,0 +1,101 @@
+/* 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 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 function instanceOfPortalUserFieldOption(value: object): value is PortalUserFieldOption {
+    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: any): PortalUserFieldOption {
+    return PortalUserFieldOptionFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldOptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldOption {
+    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: any): PortalUserFieldOption {
+    return PortalUserFieldOptionToJSONTyped(json, false);
+}
+
+export function PortalUserFieldOptionToJSONTyped(value?: PortalUserFieldOption | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'value': value['value'],
+        'label': value['label'],
+        'display_order': value['displayOrder'],
+        'is_active': value['isActive'],
+    };
+}
+

package/src/models/PortalUserFieldValueField.ts

@@ -0,0 +1,162 @@
+/* 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 { PortalUserFieldOption } from './PortalUserFieldOption';
+import {
+    PortalUserFieldOptionFromJSON,
+    PortalUserFieldOptionFromJSONTyped,
+    PortalUserFieldOptionToJSON,
+    PortalUserFieldOptionToJSONTyped,
+} 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 const PortalUserFieldValueFieldFieldTypeEnum = {
+    Text: 'text',
+    Textarea: 'textarea',
+    Email: 'email',
+    Phone: 'phone',
+    Number: 'number',
+    Boolean: 'boolean',
+    Date: 'date',
+    Select: 'select',
+    MultiSelect: 'multi_select'
+} as const;
+export type PortalUserFieldValueFieldFieldTypeEnum = typeof PortalUserFieldValueFieldFieldTypeEnum[keyof typeof PortalUserFieldValueFieldFieldTypeEnum];
+
+
+/**
+ * Check if a given object implements the PortalUserFieldValueField interface.
+ */
+export function instanceOfPortalUserFieldValueField(value: object): value is PortalUserFieldValueField {
+    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;
+    if (!('fieldType' in value) || value['fieldType'] === undefined) return false;
+    if (!('isRequired' in value) || value['isRequired'] === 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 PortalUserFieldValueFieldFromJSON(json: any): PortalUserFieldValueField {
+    return PortalUserFieldValueFieldFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldValueField {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'key': json['key'],
+        'label': json['label'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'fieldType': json['field_type'],
+        'isRequired': json['is_required'],
+        'displayOrder': json['display_order'],
+        'value': json['value'] == null ? undefined : json['value'],
+        'options': ((json['options'] as Array<any>).map(PortalUserFieldOptionFromJSON)),
+    };
+}
+
+export function PortalUserFieldValueFieldToJSON(json: any): PortalUserFieldValueField {
+    return PortalUserFieldValueFieldToJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueFieldToJSONTyped(value?: PortalUserFieldValueField | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'key': value['key'],
+        'label': value['label'],
+        'description': value['description'],
+        'field_type': value['fieldType'],
+        'is_required': value['isRequired'],
+        'display_order': value['displayOrder'],
+        'value': value['value'],
+        'options': ((value['options'] as Array<any>).map(PortalUserFieldOptionToJSON)),
+    };
+}
+

package/src/models/PortalUserFieldValueGroup.ts

@@ -0,0 +1,110 @@
+/* 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 { PortalUserFieldValueField } from './PortalUserFieldValueField';
+import {
+    PortalUserFieldValueFieldFromJSON,
+    PortalUserFieldValueFieldFromJSONTyped,
+    PortalUserFieldValueFieldToJSON,
+    PortalUserFieldValueFieldToJSONTyped,
+} from './PortalUserFieldValueField';
+
+/**
+ * 
+ * @export
+ * @interface PortalUserFieldValueGroup
+ */
+export interface PortalUserFieldValueGroup {
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalUserFieldValueGroup
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalUserFieldValueGroup
+     */
+    key: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PortalUserFieldValueGroup
+     */
+    label: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PortalUserFieldValueGroup
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {Array<PortalUserFieldValueField>}
+     * @memberof PortalUserFieldValueGroup
+     */
+    fields: Array<PortalUserFieldValueField>;
+}
+
+/**
+ * Check if a given object implements the PortalUserFieldValueGroup interface.
+ */
+export function instanceOfPortalUserFieldValueGroup(value: object): value is PortalUserFieldValueGroup {
+    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;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('fields' in value) || value['fields'] === undefined) return false;
+    return true;
+}
+
+export function PortalUserFieldValueGroupFromJSON(json: any): PortalUserFieldValueGroup {
+    return PortalUserFieldValueGroupFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldValueGroup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'key': json['key'],
+        'label': json['label'],
+        'displayOrder': json['display_order'],
+        'fields': ((json['fields'] as Array<any>).map(PortalUserFieldValueFieldFromJSON)),
+    };
+}
+
+export function PortalUserFieldValueGroupToJSON(json: any): PortalUserFieldValueGroup {
+    return PortalUserFieldValueGroupToJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueGroupToJSONTyped(value?: PortalUserFieldValueGroup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'key': value['key'],
+        'label': value['label'],
+        'display_order': value['displayOrder'],
+        'fields': ((value['fields'] as Array<any>).map(PortalUserFieldValueFieldToJSON)),
+    };
+}
+

package/src/models/PortalUserFieldValueInput.ts

@@ -0,0 +1,75 @@
+/* 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 PortalUserFieldValueInput
+ */
+export interface PortalUserFieldValueInput {
+    /**
+     * Field external ID or stable key.
+     * @type {string}
+     * @memberof PortalUserFieldValueInput
+     */
+    fieldId: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof PortalUserFieldValueInput
+     */
+    value: object | null;
+}
+
+/**
+ * Check if a given object implements the PortalUserFieldValueInput interface.
+ */
+export function instanceOfPortalUserFieldValueInput(value: object): value is PortalUserFieldValueInput {
+    if (!('fieldId' in value) || value['fieldId'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function PortalUserFieldValueInputFromJSON(json: any): PortalUserFieldValueInput {
+    return PortalUserFieldValueInputFromJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldValueInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fieldId': json['field_id'],
+        'value': json['value'],
+    };
+}
+
+export function PortalUserFieldValueInputToJSON(json: any): PortalUserFieldValueInput {
+    return PortalUserFieldValueInputToJSONTyped(json, false);
+}
+
+export function PortalUserFieldValueInputToJSONTyped(value?: PortalUserFieldValueInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'field_id': value['fieldId'],
+        'value': value['value'],
+    };
+}
+