@instructure/athena-api-client 2.0.0 → 2.0.1

package/README.md

@@ -71,6 +71,8 @@ All URIs are relative to *http://localhost:3000*
 *ChatsApi* | [**markChatAsViewed**](docs/ChatsApi.md#markchatasviewed) | **PATCH** /api/v1/chats/{chatId}/viewed | Mark chat as viewed
 *ChatsApi* | [**sendChatMessage**](docs/ChatsApi.md#sendchatmessage) | **POST** /api/v1/chat | Send a message to a chat
 *ChatsApi* | [**updateChat**](docs/ChatsApi.md#updatechatoperation) | **PATCH** /api/v1/chats/{chatId} | Update a chat
+*DailyQuizApi* | [**createDailyQuiz**](docs/DailyQuizApi.md#createdailyquiz) | **POST** /api/v1/daily-quiz | Get or create today\'s daily quiz
+*DailyQuizApi* | [**getDailyQuiz**](docs/DailyQuizApi.md#getdailyquiz) | **GET** /api/v1/daily-quiz | Get today\'s daily quiz
 *FeatureOverridesApi* | [**deleteFeatureOverride**](docs/FeatureOverridesApi.md#deletefeatureoverride) | **DELETE** /api/v1/feature-overrides/{id} | Delete a feature override
 *FeatureOverridesApi* | [**listFeatureOverrides**](docs/FeatureOverridesApi.md#listfeatureoverrides) | **GET** /api/v1/feature-overrides | List feature overrides
 *FeatureOverridesApi* | [**upsertFeatureOverride**](docs/FeatureOverridesApi.md#upsertfeatureoverride) | **PUT** /api/v1/feature-overrides | Upsert a feature override for an account
@@ -136,6 +138,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreatePlanDto](docs/CreatePlanDto.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
+- [DailyQuizStatus](docs/DailyQuizStatus.md)
 - [FeatureEntity](docs/FeatureEntity.md)
 - [FeatureOverrideEntity](docs/FeatureOverrideEntity.md)
 - [HealthCheck](docs/HealthCheck.md)

package/dist/apis/DailyQuizApi.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { DailyQuizStatus } from '../models/index';
+export interface CreateDailyQuizRequest {
+    xUserId: string;
+}
+export interface GetDailyQuizRequest {
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class DailyQuizApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuizRaw(requestParameters: CreateDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DailyQuizStatus>>;
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuiz(requestParameters: CreateDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DailyQuizStatus>;
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuizRaw(requestParameters: GetDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DailyQuizStatus>>;
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuiz(requestParameters: GetDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DailyQuizStatus>;
+}

package/dist/apis/DailyQuizApi.js

@@ -0,0 +1,107 @@
+"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.DailyQuizApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class DailyQuizApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuizRaw(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 createDailyQuiz().');
+            }
+            const queryParameters = {};
+            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/daily-quiz`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DailyQuizStatusFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDailyQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuizRaw(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 getDailyQuiz().');
+            }
+            const queryParameters = {};
+            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/daily-quiz`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DailyQuizStatusFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDailyQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.DailyQuizApi = DailyQuizApi;

package/dist/apis/index.d.ts

@@ -2,6 +2,7 @@ export * from './AccountsApi';
 export * from './AdminApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
+export * from './DailyQuizApi';
 export * from './FeatureOverridesApi';
 export * from './FeaturesApi';
 export * from './FilesApi';

package/dist/apis/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./AccountsApi"), exports);
 __exportStar(require("./AdminApi"), exports);
 __exportStar(require("./ChatAnalysisApi"), exports);
 __exportStar(require("./ChatsApi"), exports);
+__exportStar(require("./DailyQuizApi"), exports);
 __exportStar(require("./FeatureOverridesApi"), exports);
 __exportStar(require("./FeaturesApi"), exports);
 __exportStar(require("./FilesApi"), exports);

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

@@ -0,0 +1,44 @@
+/**
+ * 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 { DailyQuizStatus } from '../models/index';
+export interface CreateDailyQuizRequest {
+    xUserId: string;
+}
+export interface GetDailyQuizRequest {
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class DailyQuizApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuizRaw(requestParameters: CreateDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DailyQuizStatus>>;
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuiz(requestParameters: CreateDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DailyQuizStatus>;
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuizRaw(requestParameters: GetDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DailyQuizStatus>>;
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuiz(requestParameters: GetDailyQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DailyQuizStatus>;
+}

package/dist/esm/apis/DailyQuizApi.js

@@ -0,0 +1,103 @@
+/* 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 { DailyQuizStatusFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DailyQuizApi extends runtime.BaseAPI {
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuizRaw(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 createDailyQuiz().');
+            }
+            const queryParameters = {};
+            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/daily-quiz`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DailyQuizStatusFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Atomically finds today\'s daily-quiz chat or creates one if none exists. Returns featureEnabled: false when the user lacks enhanced-quizzing.
+     * Get or create today\'s daily quiz
+     */
+    createDailyQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDailyQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuizRaw(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 getDailyQuiz().');
+            }
+            const queryParameters = {};
+            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/daily-quiz`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DailyQuizStatusFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns entitlement (featureEnabled), today\'s calendar label in the user\'s timezone (todayDate), and chatId when a daily-quiz chat already exists for that calendar day. featureEnabled reflects enhanced-quizzing; chatId distinguishes \"not started today\" (null) vs \"already have today\'s chat\" (uuid).
+     * Get today\'s daily quiz
+     */
+    getDailyQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDailyQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -2,6 +2,7 @@ export * from './AccountsApi';
 export * from './AdminApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
+export * from './DailyQuizApi';
 export * from './FeatureOverridesApi';
 export * from './FeaturesApi';
 export * from './FilesApi';

package/dist/esm/apis/index.js

@@ -4,6 +4,7 @@ export * from './AccountsApi';
 export * from './AdminApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
+export * from './DailyQuizApi';
 export * from './FeatureOverridesApi';
 export * from './FeaturesApi';
 export * from './FilesApi';

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DailyQuizStatus
+ */
+export interface DailyQuizStatus {
+    /**
+     * True when the user has the enhanced-quizzing feature (daily quiz is offered). When false, chatId is always null. This does not mean "quiz already completed" — use chatId after checking featureEnabled.
+     * @type {boolean}
+     * @memberof DailyQuizStatus
+     */
+    featureEnabled: boolean;
+    /**
+     * Id of today's daily-quiz chat in the user's timezone (see todayDate), if one exists. Null when featureEnabled is false, or when no daily-quiz chat exists yet for that calendar day.
+     * @type {string}
+     * @memberof DailyQuizStatus
+     */
+    chatId: string | null;
+    /**
+     * Human-readable calendar date for "today" in the user's timezone (e.g. for titling a new chat). Returned regardless of featureEnabled so clients can stay consistent with server-side date boundaries.
+     * @type {string}
+     * @memberof DailyQuizStatus
+     */
+    todayDate: string;
+}
+/**
+ * Check if a given object implements the DailyQuizStatus interface.
+ */
+export declare function instanceOfDailyQuizStatus(value: object): value is DailyQuizStatus;
+export declare function DailyQuizStatusFromJSON(json: any): DailyQuizStatus;
+export declare function DailyQuizStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): DailyQuizStatus;
+export declare function DailyQuizStatusToJSON(json: any): DailyQuizStatus;
+export declare function DailyQuizStatusToJSONTyped(value?: DailyQuizStatus | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DailyQuizStatus.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DailyQuizStatus interface.
+ */
+export function instanceOfDailyQuizStatus(value) {
+    if (!('featureEnabled' in value) || value['featureEnabled'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('todayDate' in value) || value['todayDate'] === undefined)
+        return false;
+    return true;
+}
+export function DailyQuizStatusFromJSON(json) {
+    return DailyQuizStatusFromJSONTyped(json, false);
+}
+export function DailyQuizStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'featureEnabled': json['featureEnabled'],
+        'chatId': json['chatId'],
+        'todayDate': json['todayDate'],
+    };
+}
+export function DailyQuizStatusToJSON(json) {
+    return DailyQuizStatusToJSONTyped(json, false);
+}
+export function DailyQuizStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'featureEnabled': value['featureEnabled'],
+        'chatId': value['chatId'],
+        'todayDate': value['todayDate'],
+    };
+}

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

@@ -21,6 +21,7 @@ export * from './CreateMessagesResponse';
 export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
+export * from './DailyQuizStatus';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/esm/models/index.js

@@ -23,6 +23,7 @@ export * from './CreateMessagesResponse';
 export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
+export * from './DailyQuizStatus';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/models/DailyQuizStatus.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface DailyQuizStatus
+ */
+export interface DailyQuizStatus {
+    /**
+     * True when the user has the enhanced-quizzing feature (daily quiz is offered). When false, chatId is always null. This does not mean "quiz already completed" — use chatId after checking featureEnabled.
+     * @type {boolean}
+     * @memberof DailyQuizStatus
+     */
+    featureEnabled: boolean;
+    /**
+     * Id of today's daily-quiz chat in the user's timezone (see todayDate), if one exists. Null when featureEnabled is false, or when no daily-quiz chat exists yet for that calendar day.
+     * @type {string}
+     * @memberof DailyQuizStatus
+     */
+    chatId: string | null;
+    /**
+     * Human-readable calendar date for "today" in the user's timezone (e.g. for titling a new chat). Returned regardless of featureEnabled so clients can stay consistent with server-side date boundaries.
+     * @type {string}
+     * @memberof DailyQuizStatus
+     */
+    todayDate: string;
+}
+/**
+ * Check if a given object implements the DailyQuizStatus interface.
+ */
+export declare function instanceOfDailyQuizStatus(value: object): value is DailyQuizStatus;
+export declare function DailyQuizStatusFromJSON(json: any): DailyQuizStatus;
+export declare function DailyQuizStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): DailyQuizStatus;
+export declare function DailyQuizStatusToJSON(json: any): DailyQuizStatus;
+export declare function DailyQuizStatusToJSONTyped(value?: DailyQuizStatus | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DailyQuizStatus.js

@@ -0,0 +1,58 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfDailyQuizStatus = instanceOfDailyQuizStatus;
+exports.DailyQuizStatusFromJSON = DailyQuizStatusFromJSON;
+exports.DailyQuizStatusFromJSONTyped = DailyQuizStatusFromJSONTyped;
+exports.DailyQuizStatusToJSON = DailyQuizStatusToJSON;
+exports.DailyQuizStatusToJSONTyped = DailyQuizStatusToJSONTyped;
+/**
+ * Check if a given object implements the DailyQuizStatus interface.
+ */
+function instanceOfDailyQuizStatus(value) {
+    if (!('featureEnabled' in value) || value['featureEnabled'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('todayDate' in value) || value['todayDate'] === undefined)
+        return false;
+    return true;
+}
+function DailyQuizStatusFromJSON(json) {
+    return DailyQuizStatusFromJSONTyped(json, false);
+}
+function DailyQuizStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'featureEnabled': json['featureEnabled'],
+        'chatId': json['chatId'],
+        'todayDate': json['todayDate'],
+    };
+}
+function DailyQuizStatusToJSON(json) {
+    return DailyQuizStatusToJSONTyped(json, false);
+}
+function DailyQuizStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'featureEnabled': value['featureEnabled'],
+        'chatId': value['chatId'],
+        'todayDate': value['todayDate'],
+    };
+}

package/dist/models/index.d.ts

@@ -21,6 +21,7 @@ export * from './CreateMessagesResponse';
 export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
+export * from './DailyQuizStatus';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';
 export * from './HealthCheck';

package/dist/models/index.js

@@ -39,6 +39,7 @@ __exportStar(require("./CreateMessagesResponse"), exports);
 __exportStar(require("./CreatePlanDto"), exports);
 __exportStar(require("./CreateTokenRequest"), exports);
 __exportStar(require("./CreateTokenResponse"), exports);
+__exportStar(require("./DailyQuizStatus"), exports);
 __exportStar(require("./FeatureEntity"), exports);
 __exportStar(require("./FeatureOverrideEntity"), exports);
 __exportStar(require("./HealthCheck"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {