@easyedu/js-lsm-api 1.129.0 → 1.131.0

package/src/models/GetReportQueryResult.ts

@@ -0,0 +1,153 @@
+/* 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 { ReportColumn } from './ReportColumn';
+import {
+    ReportColumnFromJSON,
+    ReportColumnFromJSONTyped,
+    ReportColumnToJSON,
+    ReportColumnToJSONTyped,
+} from './ReportColumn';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} from './ReportSort';
+
+/**
+ * 
+ * @export
+ * @interface GetReportQueryResult
+ */
+export interface GetReportQueryResult {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetReportQueryResult
+     */
+    reportKey: string;
+    /**
+     * 
+     * @type {Array<ReportColumn>}
+     * @memberof GetReportQueryResult
+     */
+    columns: Array<ReportColumn>;
+    /**
+     * One object per row, keyed by column key.
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof GetReportQueryResult
+     */
+    rows: Array<{ [key: string]: any; }>;
+    /**
+     * 
+     * @type {ReportSort}
+     * @memberof GetReportQueryResult
+     */
+    sort: ReportSort;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    pageSize: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    totalPages: number;
+    /**
+     * Unix timestamp in seconds.
+     * @type {number}
+     * @memberof GetReportQueryResult
+     */
+    generatedAt: number;
+}
+
+/**
+ * Check if a given object implements the GetReportQueryResult interface.
+ */
+export function instanceOfGetReportQueryResult(value: object): value is GetReportQueryResult {
+    if (!('reportKey' in value) || value['reportKey'] === undefined) return false;
+    if (!('columns' in value) || value['columns'] === undefined) return false;
+    if (!('rows' in value) || value['rows'] === undefined) return false;
+    if (!('sort' in value) || value['sort'] === undefined) return false;
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('generatedAt' in value) || value['generatedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetReportQueryResultFromJSON(json: any): GetReportQueryResult {
+    return GetReportQueryResultFromJSONTyped(json, false);
+}
+
+export function GetReportQueryResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetReportQueryResult {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reportKey': json['report_key'],
+        'columns': ((json['columns'] as Array<any>).map(ReportColumnFromJSON)),
+        'rows': json['rows'],
+        'sort': ReportSortFromJSON(json['sort']),
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'totalPages': json['total_pages'],
+        'generatedAt': json['generated_at'],
+    };
+}
+
+export function GetReportQueryResultToJSON(json: any): GetReportQueryResult {
+    return GetReportQueryResultToJSONTyped(json, false);
+}
+
+export function GetReportQueryResultToJSONTyped(value?: GetReportQueryResult | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'report_key': value['reportKey'],
+        'columns': ((value['columns'] as Array<any>).map(ReportColumnToJSON)),
+        'rows': value['rows'],
+        'sort': ReportSortToJSON(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'total_pages': value['totalPages'],
+        'generated_at': value['generatedAt'],
+    };
+}
+

package/src/models/PostDemoRequest.ts

@@ -0,0 +1,157 @@
+/* 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 PostDemoRequest
+ */
+export interface PostDemoRequest {
+    /**
+     * Stable for retries of the same submission; use a new UUID when details change.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    submissionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    fullName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    organization: string;
+    /**
+     * 
+     * @type {PostDemoRequestLearnerRangeEnum}
+     * @memberof PostDemoRequest
+     */
+    learnerRange?: PostDemoRequestLearnerRangeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    message?: string;
+    /**
+     * 
+     * @type {PostDemoRequestInquiryTypeEnum}
+     * @memberof PostDemoRequest
+     */
+    inquiryType?: PostDemoRequestInquiryTypeEnum;
+    /**
+     * Originating site pathname; query strings and fragments are removed.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourcePath?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourceCta?: string;
+}
+
+
+/**
+ * @export
+ */
+export const PostDemoRequestLearnerRangeEnum = {
+    _150: '1-50',
+    _511000: '51-1000',
+    _10013000: '1001-3000',
+    _3001: '3001+'
+} as const;
+export type PostDemoRequestLearnerRangeEnum = typeof PostDemoRequestLearnerRangeEnum[keyof typeof PostDemoRequestLearnerRangeEnum];
+
+/**
+ * @export
+ */
+export const PostDemoRequestInquiryTypeEnum = {
+    Demo: 'demo',
+    Enterprise: 'enterprise',
+    Migration: 'migration',
+    Sales: 'sales'
+} as const;
+export type PostDemoRequestInquiryTypeEnum = typeof PostDemoRequestInquiryTypeEnum[keyof typeof PostDemoRequestInquiryTypeEnum];
+
+
+/**
+ * Check if a given object implements the PostDemoRequest interface.
+ */
+export function instanceOfPostDemoRequest(value: object): value is PostDemoRequest {
+    if (!('submissionId' in value) || value['submissionId'] === undefined) return false;
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('organization' in value) || value['organization'] === undefined) return false;
+    return true;
+}
+
+export function PostDemoRequestFromJSON(json: any): PostDemoRequest {
+    return PostDemoRequestFromJSONTyped(json, false);
+}
+
+export function PostDemoRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'submissionId': json['submission_id'],
+        'fullName': json['full_name'],
+        'email': json['email'],
+        'organization': json['organization'],
+        'learnerRange': json['learner_range'] == null ? undefined : json['learner_range'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'inquiryType': json['inquiry_type'] == null ? undefined : json['inquiry_type'],
+        'sourcePath': json['source_path'] == null ? undefined : json['source_path'],
+        'sourceCta': json['source_cta'] == null ? undefined : json['source_cta'],
+    };
+}
+
+export function PostDemoRequestToJSON(json: any): PostDemoRequest {
+    return PostDemoRequestToJSONTyped(json, false);
+}
+
+export function PostDemoRequestToJSONTyped(value?: PostDemoRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'submission_id': value['submissionId'],
+        'full_name': value['fullName'],
+        'email': value['email'],
+        'organization': value['organization'],
+        'learner_range': value['learnerRange'],
+        'message': value['message'],
+        'inquiry_type': value['inquiryType'],
+        'source_path': value['sourcePath'],
+        'source_cta': value['sourceCta'],
+    };
+}
+

package/src/models/PostDemoRequestResponse.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 PostDemoRequestResponse
+ */
+export interface PostDemoRequestResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    requestId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the PostDemoRequestResponse interface.
+ */
+export function instanceOfPostDemoRequestResponse(value: object): value is PostDemoRequestResponse {
+    if (!('requestId' in value) || value['requestId'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function PostDemoRequestResponseFromJSON(json: any): PostDemoRequestResponse {
+    return PostDemoRequestResponseFromJSONTyped(json, false);
+}
+
+export function PostDemoRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequestResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'requestId': json['request_id'],
+        'message': json['message'],
+    };
+}
+
+export function PostDemoRequestResponseToJSON(json: any): PostDemoRequestResponse {
+    return PostDemoRequestResponseToJSONTyped(json, false);
+}
+
+export function PostDemoRequestResponseToJSONTyped(value?: PostDemoRequestResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'request_id': value['requestId'],
+        'message': value['message'],
+    };
+}
+

package/src/models/PostReportExport.ts

@@ -0,0 +1,108 @@
+/* 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 { ReportFilters } from './ReportFilters';
+import {
+    ReportFiltersFromJSON,
+    ReportFiltersFromJSONTyped,
+    ReportFiltersToJSON,
+    ReportFiltersToJSONTyped,
+} from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} from './ReportSort';
+
+/**
+ * 
+ * @export
+ * @interface PostReportExport
+ */
+export interface PostReportExport {
+    /**
+     * 
+     * @type {ReportFilters}
+     * @memberof PostReportExport
+     */
+    filters?: ReportFilters;
+    /**
+     * 
+     * @type {ReportSort}
+     * @memberof PostReportExport
+     */
+    sort?: ReportSort;
+    /**
+     * 
+     * @type {PostReportExportFormatEnum}
+     * @memberof PostReportExport
+     */
+    format: PostReportExportFormatEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostReportExportFormatEnum = {
+    Csv: 'csv',
+    Xlsx: 'xlsx'
+} as const;
+export type PostReportExportFormatEnum = typeof PostReportExportFormatEnum[keyof typeof PostReportExportFormatEnum];
+
+
+/**
+ * Check if a given object implements the PostReportExport interface.
+ */
+export function instanceOfPostReportExport(value: object): value is PostReportExport {
+    if (!('format' in value) || value['format'] === undefined) return false;
+    return true;
+}
+
+export function PostReportExportFromJSON(json: any): PostReportExport {
+    return PostReportExportFromJSONTyped(json, false);
+}
+
+export function PostReportExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportExport {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'filters': json['filters'] == null ? undefined : ReportFiltersFromJSON(json['filters']),
+        'sort': json['sort'] == null ? undefined : ReportSortFromJSON(json['sort']),
+        'format': json['format'],
+    };
+}
+
+export function PostReportExportToJSON(json: any): PostReportExport {
+    return PostReportExportToJSONTyped(json, false);
+}
+
+export function PostReportExportToJSONTyped(value?: PostReportExport | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filters': ReportFiltersToJSON(value['filters']),
+        'sort': ReportSortToJSON(value['sort']),
+        'format': value['format'],
+    };
+}
+

package/src/models/PostReportQuery.ts

@@ -0,0 +1,104 @@
+/* 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 { ReportFilters } from './ReportFilters';
+import {
+    ReportFiltersFromJSON,
+    ReportFiltersFromJSONTyped,
+    ReportFiltersToJSON,
+    ReportFiltersToJSONTyped,
+} from './ReportFilters';
+import type { ReportSort } from './ReportSort';
+import {
+    ReportSortFromJSON,
+    ReportSortFromJSONTyped,
+    ReportSortToJSON,
+    ReportSortToJSONTyped,
+} from './ReportSort';
+
+/**
+ * 
+ * @export
+ * @interface PostReportQuery
+ */
+export interface PostReportQuery {
+    /**
+     * 
+     * @type {ReportFilters}
+     * @memberof PostReportQuery
+     */
+    filters?: ReportFilters;
+    /**
+     * 
+     * @type {ReportSort}
+     * @memberof PostReportQuery
+     */
+    sort?: ReportSort;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostReportQuery
+     */
+    page?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostReportQuery
+     */
+    pageSize?: number;
+}
+
+/**
+ * Check if a given object implements the PostReportQuery interface.
+ */
+export function instanceOfPostReportQuery(value: object): value is PostReportQuery {
+    return true;
+}
+
+export function PostReportQueryFromJSON(json: any): PostReportQuery {
+    return PostReportQueryFromJSONTyped(json, false);
+}
+
+export function PostReportQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostReportQuery {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'filters': json['filters'] == null ? undefined : ReportFiltersFromJSON(json['filters']),
+        'sort': json['sort'] == null ? undefined : ReportSortFromJSON(json['sort']),
+        'page': json['page'] == null ? undefined : json['page'],
+        'pageSize': json['page_size'] == null ? undefined : json['page_size'],
+    };
+}
+
+export function PostReportQueryToJSON(json: any): PostReportQuery {
+    return PostReportQueryToJSONTyped(json, false);
+}
+
+export function PostReportQueryToJSONTyped(value?: PostReportQuery | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'filters': ReportFiltersToJSON(value['filters']),
+        'sort': ReportSortToJSON(value['sort']),
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}
+

package/src/models/ReportCategory.ts

@@ -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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ReportCategory
+ */
+export interface ReportCategory {
+    /**
+     * 
+     * @type {ReportCategoryKeyEnum}
+     * @memberof ReportCategory
+     */
+    key: ReportCategoryKeyEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportCategory
+     */
+    label: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReportCategoryKeyEnum = {
+    Learners: 'learners',
+    Content: 'content',
+    Tags: 'tags',
+    Managers: 'managers',
+    Compliance: 'compliance',
+    Trends: 'trends'
+} as const;
+export type ReportCategoryKeyEnum = typeof ReportCategoryKeyEnum[keyof typeof ReportCategoryKeyEnum];
+
+
+/**
+ * Check if a given object implements the ReportCategory interface.
+ */
+export function instanceOfReportCategory(value: object): value is ReportCategory {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('label' in value) || value['label'] === undefined) return false;
+    return true;
+}
+
+export function ReportCategoryFromJSON(json: any): ReportCategory {
+    return ReportCategoryFromJSONTyped(json, false);
+}
+
+export function ReportCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReportCategory {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'label': json['label'],
+    };
+}
+
+export function ReportCategoryToJSON(json: any): ReportCategory {
+    return ReportCategoryToJSONTyped(json, false);
+}
+
+export function ReportCategoryToJSONTyped(value?: ReportCategory | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'label': value['label'],
+    };
+}
+