@instructure/athena-api-client 3.38.8 → 3.39.0

package/README.md

@@ -129,6 +129,7 @@ All URIs are relative to *http://localhost:3000*
 *QuizSessionsApi* | [**updateQuizSession**](docs/QuizSessionsApi.md#updatequizsessionoperation) | **PATCH** /api/v1/quiz-sessions/{sessionId} | Update quiz session status
 *QuizzesApi* | [**getQuiz**](docs/QuizzesApi.md#getquiz) | **GET** /api/v1/quizzes/{quizId} | Get quiz with questions
 *QuizzesApi* | [**listQuizzes**](docs/QuizzesApi.md#listquizzes) | **GET** /api/v1/quizzes | List user quizzes
+*ResourcesApi* | [**listResources**](docs/ResourcesApi.md#listresources) | **GET** /api/v1/resources | List the user\'s generated study resources
 *ServiceTokensApi* | [**createServiceToken**](docs/ServiceTokensApi.md#createservicetoken) | **POST** /api/v1/tokens | Create a new service token
 *ServiceTokensApi* | [**deleteServiceToken**](docs/ServiceTokensApi.md#deleteservicetoken) | **DELETE** /api/v1/tokens/{id} | Delete service token
 *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
@@ -298,6 +299,7 @@ All URIs are relative to *http://localhost:3000*
 - [PaginatedObjectiveResources](docs/PaginatedObjectiveResources.md)
 - [PaginatedQuizSessions](docs/PaginatedQuizSessions.md)
 - [PaginatedQuizzes](docs/PaginatedQuizzes.md)
+- [PaginatedResources](docs/PaginatedResources.md)
 - [PaginatedStudyObjectives](docs/PaginatedStudyObjectives.md)
 - [PaginatedTaxonomies](docs/PaginatedTaxonomies.md)
 - [PaginatedUserConcepts](docs/PaginatedUserConcepts.md)
@@ -317,6 +319,12 @@ All URIs are relative to *http://localhost:3000*
 - [QuizSessionSummary](docs/QuizSessionSummary.md)
 - [QuizWithQuestions](docs/QuizWithQuestions.md)
 - [RecordQuizQuestionViewRequest](docs/RecordQuizQuestionViewRequest.md)
+- [ResourceActivity](docs/ResourceActivity.md)
+- [ResourceChat](docs/ResourceChat.md)
+- [ResourceListItem](docs/ResourceListItem.md)
+- [ResourceSession](docs/ResourceSession.md)
+- [ResourceStudyObjective](docs/ResourceStudyObjective.md)
+- [ResourceStudySpace](docs/ResourceStudySpace.md)
 - [Score](docs/Score.md)
 - [ScoreByTypeValue](docs/ScoreByTypeValue.md)
 - [ServiceToken](docs/ServiceToken.md)

package/dist/apis/ResourcesApi.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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 { PaginatedResources } from '../models/index';
+export interface ListResourcesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    type?: ListResourcesTypeEnum;
+    courseId?: string;
+    chatId?: string;
+    studySpaceId?: string;
+    progress?: ListResourcesProgressEnum;
+}
+/**
+ *
+ */
+export declare class ResourcesApi extends runtime.BaseAPI {
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResourcesRaw(requestParameters: ListResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResources>>;
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResources(requestParameters: ListResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResources>;
+}
+/**
+ * @export
+ */
+export declare const ListResourcesTypeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListResourcesTypeEnum = typeof ListResourcesTypeEnum[keyof typeof ListResourcesTypeEnum];
+/**
+ * @export
+ */
+export declare const ListResourcesProgressEnum: {
+    readonly NotStarted: "not-started";
+    readonly InProgress: "in-progress";
+    readonly Completed: "completed";
+};
+export type ListResourcesProgressEnum = typeof ListResourcesProgressEnum[keyof typeof ListResourcesProgressEnum];

package/dist/apis/ResourcesApi.js

@@ -0,0 +1,106 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListResourcesProgressEnum = exports.ListResourcesTypeEnum = exports.ResourcesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ResourcesApi extends runtime.BaseAPI {
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResourcesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listResources().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['chatId'] != null) {
+                queryParameters['chatId'] = requestParameters['chatId'];
+            }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
+            if (requestParameters['progress'] != null) {
+                queryParameters['progress'] = requestParameters['progress'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/resources`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResourcesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResources(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listResourcesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ResourcesApi = ResourcesApi;
+/**
+ * @export
+ */
+exports.ListResourcesTypeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+exports.ListResourcesProgressEnum = {
+    NotStarted: 'not-started',
+    InProgress: 'in-progress',
+    Completed: 'completed'
+};

package/dist/apis/index.d.ts

@@ -18,6 +18,7 @@ export * from './PlansApi';
 export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
+export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';

package/dist/apis/index.js

@@ -36,6 +36,7 @@ __exportStar(require("./PlansApi"), exports);
 __exportStar(require("./PracticeQuizzesApi"), exports);
 __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
+__exportStar(require("./ResourcesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);

package/dist/esm/apis/ResourcesApi.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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 { PaginatedResources } from '../models/index';
+export interface ListResourcesRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    type?: ListResourcesTypeEnum;
+    courseId?: string;
+    chatId?: string;
+    studySpaceId?: string;
+    progress?: ListResourcesProgressEnum;
+}
+/**
+ *
+ */
+export declare class ResourcesApi extends runtime.BaseAPI {
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResourcesRaw(requestParameters: ListResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResources>>;
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResources(requestParameters: ListResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResources>;
+}
+/**
+ * @export
+ */
+export declare const ListResourcesTypeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type ListResourcesTypeEnum = typeof ListResourcesTypeEnum[keyof typeof ListResourcesTypeEnum];
+/**
+ * @export
+ */
+export declare const ListResourcesProgressEnum: {
+    readonly NotStarted: "not-started";
+    readonly InProgress: "in-progress";
+    readonly Completed: "completed";
+};
+export type ListResourcesProgressEnum = typeof ListResourcesProgressEnum[keyof typeof ListResourcesProgressEnum];

package/dist/esm/apis/ResourcesApi.js

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { PaginatedResourcesFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class ResourcesApi extends runtime.BaseAPI {
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResourcesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listResources().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            if (requestParameters['chatId'] != null) {
+                queryParameters['chatId'] = requestParameters['chatId'];
+            }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
+            if (requestParameters['progress'] != null) {
+                queryParameters['progress'] = requestParameters['progress'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/resources`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResourcesFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * List the user\'s generated study resources
+     */
+    listResources(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listResourcesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ListResourcesTypeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const ListResourcesProgressEnum = {
+    NotStarted: 'not-started',
+    InProgress: 'in-progress',
+    Completed: 'completed'
+};

package/dist/esm/apis/index.d.ts

@@ -18,6 +18,7 @@ export * from './PlansApi';
 export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
+export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';

package/dist/esm/apis/index.js

@@ -20,6 +20,7 @@ export * from './PlansApi';
 export * from './PracticeQuizzesApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
+export * from './ResourcesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';

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

@@ -0,0 +1,39 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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 { ResourceListItem } from './ResourceListItem';
+/**
+ *
+ * @export
+ * @interface PaginatedResources
+ */
+export interface PaginatedResources {
+    /**
+     *
+     * @type {Array<ResourceListItem>}
+     * @memberof PaginatedResources
+     */
+    data: Array<ResourceListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedResources
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedResources interface.
+ */
+export declare function instanceOfPaginatedResources(value: object): value is PaginatedResources;
+export declare function PaginatedResourcesFromJSON(json: any): PaginatedResources;
+export declare function PaginatedResourcesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResources;
+export declare function PaginatedResourcesToJSON(json: any): PaginatedResources;
+export declare function PaginatedResourcesToJSONTyped(value?: PaginatedResources | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedResources.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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 { ResourceListItemFromJSON, ResourceListItemToJSON, } from './ResourceListItem';
+/**
+ * Check if a given object implements the PaginatedResources interface.
+ */
+export function instanceOfPaginatedResources(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedResourcesFromJSON(json) {
+    return PaginatedResourcesFromJSONTyped(json, false);
+}
+export function PaginatedResourcesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ResourceListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedResourcesToJSON(json) {
+    return PaginatedResourcesToJSONTyped(json, false);
+}
+export function PaginatedResourcesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ResourceListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,114 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * 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 { ResourceSession } from './ResourceSession';
+/**
+ *
+ * @export
+ * @interface ResourceActivity
+ */
+export interface ResourceActivity {
+    /**
+     * "completed" once any session finished, "in-progress" once any session exists, otherwise "not-started".
+     * @type {string}
+     * @memberof ResourceActivity
+     */
+    progressStatus: ResourceActivityProgressStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    sessionCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    activeSessionCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    completedSessionCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    abandonedSessionCount: number;
+    /**
+     * When the learner first opened this resource.
+     * @type {Date}
+     * @memberof ResourceActivity
+     */
+    firstStartedAt: Date | null;
+    /**
+     * Most recent session start, completion, or answer. Null when never opened.
+     * @type {Date}
+     * @memberof ResourceActivity
+     */
+    lastActivityAt: Date | null;
+    /**
+     * The most recently started session.
+     * @type {ResourceSession}
+     * @memberof ResourceActivity
+     */
+    latestSession: ResourceSession | null;
+    /**
+     * The completed session with the most correct answers. Ties go to the most recent. Null until a session completes.
+     * @type {ResourceSession}
+     * @memberof ResourceActivity
+     */
+    bestSession: ResourceSession | null;
+    /**
+     * Answers and ratings submitted across every session.
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    totalAnsweredCount: number;
+    /**
+     * Correct answers and known ratings across every session.
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    totalCorrectCount: number;
+    /**
+     * Distinct questions the learner has viewed at least once. For flashcards this is the number of cards flipped through.
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    viewedQuestionCount: number;
+    /**
+     * Every recorded question view, including repeat views.
+     * @type {number}
+     * @memberof ResourceActivity
+     */
+    totalViewCount: number;
+}
+/**
+ * @export
+ */
+export declare const ResourceActivityProgressStatusEnum: {
+    readonly NotStarted: "not-started";
+    readonly InProgress: "in-progress";
+    readonly Completed: "completed";
+};
+export type ResourceActivityProgressStatusEnum = typeof ResourceActivityProgressStatusEnum[keyof typeof ResourceActivityProgressStatusEnum];
+/**
+ * Check if a given object implements the ResourceActivity interface.
+ */
+export declare function instanceOfResourceActivity(value: object): value is ResourceActivity;
+export declare function ResourceActivityFromJSON(json: any): ResourceActivity;
+export declare function ResourceActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceActivity;
+export declare function ResourceActivityToJSON(json: any): ResourceActivity;
+export declare function ResourceActivityToJSONTyped(value?: ResourceActivity | null, ignoreDiscriminator?: boolean): any;