@instructure/athena-api-client 3.39.3 → 3.41.0

package/dist/esm/apis/ResourcesApi.js

@@ -27,7 +27,7 @@ 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.
+     * 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. By default lists what the user generated; `ownership=shared` lists other learners\' resources the user has opened through a share link, with the owner\'s chat, objective, space, and course withheld.
      * List the user\'s generated study resources
      */
     listResourcesRaw(requestParameters, initOverrides) {
@@ -45,6 +45,9 @@ export class ResourcesApi extends runtime.BaseAPI {
             if (requestParameters['type'] != null) {
                 queryParameters['type'] = requestParameters['type'];
             }
+            if (requestParameters['ownership'] != null) {
+                queryParameters['ownership'] = requestParameters['ownership'];
+            }
             if (requestParameters['courseId'] != null) {
                 queryParameters['courseId'] = requestParameters['courseId'];
             }
@@ -75,7 +78,7 @@ 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.
+     * 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. By default lists what the user generated; `ownership=shared` lists other learners\' resources the user has opened through a share link, with the owner\'s chat, objective, space, and course withheld.
      * List the user\'s generated study resources
      */
     listResources(requestParameters, initOverrides) {
@@ -92,6 +95,13 @@ export const ListResourcesTypeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+export const ListResourcesOwnershipEnum = {
+    Owned: 'owned',
+    Shared: 'shared'
+};
 /**
  * @export
  */

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

@@ -0,0 +1,46 @@
+/**
+ * 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 { QuizSession, SharedQuiz } from '../models/index';
+export interface GetSharedQuizRequest {
+    token: string;
+    xUserId: string;
+}
+export interface StartSharedQuizSessionRequest {
+    token: string;
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class SharedQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Returns the quiz behind a share link: enough to render a landing card and start a session, without identifying the owner.
+     * Resolve a quiz share link
+     */
+    getSharedQuizRaw(requestParameters: GetSharedQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SharedQuiz>>;
+    /**
+     * Returns the quiz behind a share link: enough to render a landing card and start a session, without identifying the owner.
+     * Resolve a quiz share link
+     */
+    getSharedQuiz(requestParameters: GetSharedQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SharedQuiz>;
+    /**
+     * Returns the caller\'s active session on the quiz behind the link, creating one if none is active. The session belongs to the caller; its answers never touch the owner\'s progress. Returns 201 whether the session was created or resumed.
+     * Start or resume the caller\'s session on a shared quiz
+     */
+    startSharedQuizSessionRaw(requestParameters: StartSharedQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuizSession>>;
+    /**
+     * Returns the caller\'s active session on the quiz behind the link, creating one if none is active. The session belongs to the caller; its answers never touch the owner\'s progress. Returns 201 whether the session was created or resumed.
+     * Start or resume the caller\'s session on a shared quiz
+     */
+    startSharedQuizSession(requestParameters: StartSharedQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSession>;
+}

package/dist/esm/apis/SharedQuizzesApi.js

@@ -0,0 +1,111 @@
+/* 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 { QuizSessionFromJSON, SharedQuizFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class SharedQuizzesApi extends runtime.BaseAPI {
+    /**
+     * Returns the quiz behind a share link: enough to render a landing card and start a session, without identifying the owner.
+     * Resolve a quiz share link
+     */
+    getSharedQuizRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['token'] == null) {
+                throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling getSharedQuiz().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getSharedQuiz().');
+            }
+            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/shared-quizzes/{token}`;
+            urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => SharedQuizFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the quiz behind a share link: enough to render a landing card and start a session, without identifying the owner.
+     * Resolve a quiz share link
+     */
+    getSharedQuiz(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSharedQuizRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns the caller\'s active session on the quiz behind the link, creating one if none is active. The session belongs to the caller; its answers never touch the owner\'s progress. Returns 201 whether the session was created or resumed.
+     * Start or resume the caller\'s session on a shared quiz
+     */
+    startSharedQuizSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['token'] == null) {
+                throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling startSharedQuizSession().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling startSharedQuizSession().');
+            }
+            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/shared-quizzes/{token}/sessions`;
+            urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => QuizSessionFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the caller\'s active session on the quiz behind the link, creating one if none is active. The session belongs to the caller; its answers never touch the owner\'s progress. Returns 201 whether the session was created or resumed.
+     * Start or resume the caller\'s session on a shared quiz
+     */
+    startSharedQuizSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.startSharedQuizSessionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -144,12 +144,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
     /**
-     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
+     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Every `source` value (`user`, `syllabus` and `template`) is returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus or created from a template.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
      * List the learner\'s study objectives falling due soon
      */
     listUpcomingStudyObjectivesRaw(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpcomingStudyObjectives>>;
     /**
-     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
+     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Every `source` value (`user`, `syllabus` and `template`) is returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus or created from a template.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
      * List the learner\'s study objectives falling due soon
      */
     listUpcomingStudyObjectives(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpcomingStudyObjectives>;

package/dist/esm/apis/StudyObjectivesApi.js

@@ -386,7 +386,7 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
+     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Every `source` value (`user`, `syllabus` and `template`) is returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus or created from a template.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
      * List the learner\'s study objectives falling due soon
      */
     listUpcomingStudyObjectivesRaw(requestParameters, initOverrides) {
@@ -419,7 +419,7 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
+     * Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side.  A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Every `source` value (`user`, `syllabus` and `template`) is returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus or created from a template.  Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course.  There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
      * List the learner\'s study objectives falling due soon
      */
     listUpcomingStudyObjectives(requestParameters, initOverrides) {

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

@@ -0,0 +1,61 @@
+/**
+ * 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 { CreateStudySpaceFromTemplateDto, ScheduleStudySpaceTemplateDto, StudySpaceFromTemplate, StudySpaceTemplate, StudySpaceTemplateScheduleItem } from '../models/index';
+export interface CreateStudySpaceFromTemplateRequest {
+    xUserId: string;
+    slug: string;
+    createStudySpaceFromTemplateDto: CreateStudySpaceFromTemplateDto;
+}
+export interface ListStudySpaceTemplatesRequest {
+    xUserId: string;
+}
+export interface PreviewStudySpaceTemplateScheduleRequest {
+    xUserId: string;
+    slug: string;
+    scheduleStudySpaceTemplateDto: ScheduleStudySpaceTemplateDto;
+}
+/**
+ *
+ */
+export declare class StudySpaceTemplatesApi extends runtime.BaseAPI {
+    /**
+     * Creates a course-less study space for the authenticated user holding the template\'s objectives, scheduled as the preview describes, each with the template\'s concepts already attached — nothing is extracted. The objectives are the learner\'s own from then on: editable and archivable like any they typed. Everything is written in one transaction. `name` defaults to the template\'s title.
+     * Create a study space from a template
+     */
+    createStudySpaceFromTemplateRaw(requestParameters: CreateStudySpaceFromTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudySpaceFromTemplate>>;
+    /**
+     * Creates a course-less study space for the authenticated user holding the template\'s objectives, scheduled as the preview describes, each with the template\'s concepts already attached — nothing is extracted. The objectives are the learner\'s own from then on: editable and archivable like any they typed. Everything is written in one transaction. `name` defaults to the template\'s title.
+     * Create a study space from a template
+     */
+    createStudySpaceFromTemplate(requestParameters: CreateStudySpaceFromTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudySpaceFromTemplate>;
+    /**
+     * Returns every bundled template with what a client needs to offer it and to ask where the learner is in the course: its units in order, its anchor date, notices to show before confirming, and the caller\'s newest space already created from it (`existingSpaceId`, or null). Creating another is still allowed.
+     * List the study space templates a learner can start from
+     */
+    listStudySpaceTemplatesRaw(requestParameters: ListStudySpaceTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StudySpaceTemplate>>>;
+    /**
+     * Returns every bundled template with what a client needs to offer it and to ask where the learner is in the course: its units in order, its anchor date, notices to show before confirming, and the caller\'s newest space already created from it (`existingSpaceId`, or null). Creating another is still allowed.
+     * List the study space templates a learner can start from
+     */
+    listStudySpaceTemplates(requestParameters: ListStudySpaceTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StudySpaceTemplate>>;
+    /**
+     * Computes, without writing anything, the objectives and due dates `createStudySpaceFromTemplate` would create right now for the learner\'s timezone: units still to learn spread up to the review window, covered units as review, then the anchor. `startIndex` is the index of the first unit the learner hasn\'t covered; null means every unit is covered (review only).
+     * Preview the objectives a template would create
+     */
+    previewStudySpaceTemplateScheduleRaw(requestParameters: PreviewStudySpaceTemplateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StudySpaceTemplateScheduleItem>>>;
+    /**
+     * Computes, without writing anything, the objectives and due dates `createStudySpaceFromTemplate` would create right now for the learner\'s timezone: units still to learn spread up to the review window, covered units as review, then the anchor. `startIndex` is the index of the first unit the learner hasn\'t covered; null means every unit is covered (review only).
+     * Preview the objectives a template would create
+     */
+    previewStudySpaceTemplateSchedule(requestParameters: PreviewStudySpaceTemplateScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StudySpaceTemplateScheduleItem>>;
+}

package/dist/esm/apis/StudySpaceTemplatesApi.js

@@ -0,0 +1,158 @@
+/* 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 { CreateStudySpaceFromTemplateDtoToJSON, ScheduleStudySpaceTemplateDtoToJSON, StudySpaceFromTemplateFromJSON, StudySpaceTemplateFromJSON, StudySpaceTemplateScheduleItemFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudySpaceTemplatesApi extends runtime.BaseAPI {
+    /**
+     * Creates a course-less study space for the authenticated user holding the template\'s objectives, scheduled as the preview describes, each with the template\'s concepts already attached — nothing is extracted. The objectives are the learner\'s own from then on: editable and archivable like any they typed. Everything is written in one transaction. `name` defaults to the template\'s title.
+     * Create a study space from a template
+     */
+    createStudySpaceFromTemplateRaw(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 createStudySpaceFromTemplate().');
+            }
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling createStudySpaceFromTemplate().');
+            }
+            if (requestParameters['createStudySpaceFromTemplateDto'] == null) {
+                throw new runtime.RequiredError('createStudySpaceFromTemplateDto', 'Required parameter "createStudySpaceFromTemplateDto" was null or undefined when calling createStudySpaceFromTemplate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/study-space-templates/{slug}/spaces`;
+            urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudySpaceFromTemplateDtoToJSON(requestParameters['createStudySpaceFromTemplateDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudySpaceFromTemplateFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a course-less study space for the authenticated user holding the template\'s objectives, scheduled as the preview describes, each with the template\'s concepts already attached — nothing is extracted. The objectives are the learner\'s own from then on: editable and archivable like any they typed. Everything is written in one transaction. `name` defaults to the template\'s title.
+     * Create a study space from a template
+     */
+    createStudySpaceFromTemplate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudySpaceFromTemplateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns every bundled template with what a client needs to offer it and to ask where the learner is in the course: its units in order, its anchor date, notices to show before confirming, and the caller\'s newest space already created from it (`existingSpaceId`, or null). Creating another is still allowed.
+     * List the study space templates a learner can start from
+     */
+    listStudySpaceTemplatesRaw(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 listStudySpaceTemplates().');
+            }
+            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/study-space-templates`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StudySpaceTemplateFromJSON));
+        });
+    }
+    /**
+     * Returns every bundled template with what a client needs to offer it and to ask where the learner is in the course: its units in order, its anchor date, notices to show before confirming, and the caller\'s newest space already created from it (`existingSpaceId`, or null). Creating another is still allowed.
+     * List the study space templates a learner can start from
+     */
+    listStudySpaceTemplates(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudySpaceTemplatesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Computes, without writing anything, the objectives and due dates `createStudySpaceFromTemplate` would create right now for the learner\'s timezone: units still to learn spread up to the review window, covered units as review, then the anchor. `startIndex` is the index of the first unit the learner hasn\'t covered; null means every unit is covered (review only).
+     * Preview the objectives a template would create
+     */
+    previewStudySpaceTemplateScheduleRaw(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 previewStudySpaceTemplateSchedule().');
+            }
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling previewStudySpaceTemplateSchedule().');
+            }
+            if (requestParameters['scheduleStudySpaceTemplateDto'] == null) {
+                throw new runtime.RequiredError('scheduleStudySpaceTemplateDto', 'Required parameter "scheduleStudySpaceTemplateDto" was null or undefined when calling previewStudySpaceTemplateSchedule().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            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/study-space-templates/{slug}/schedule-preview`;
+            urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ScheduleStudySpaceTemplateDtoToJSON(requestParameters['scheduleStudySpaceTemplateDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StudySpaceTemplateScheduleItemFromJSON));
+        });
+    }
+    /**
+     * Computes, without writing anything, the objectives and due dates `createStudySpaceFromTemplate` would create right now for the learner\'s timezone: units still to learn spread up to the review window, covered units as review, then the anchor. `startIndex` is the index of the first unit the learner hasn\'t covered; null means every unit is covered (review only).
+     * Preview the objectives a template would create
+     */
+    previewStudySpaceTemplateSchedule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.previewStudySpaceTemplateScheduleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -20,10 +20,12 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
+export * from './SharedQuizzesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';
 export * from './StudyPrepApi';
+export * from './StudySpaceTemplatesApi';
 export * from './StudySpacesApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';

package/dist/esm/apis/index.js

@@ -22,10 +22,12 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ResourcesApi';
 export * from './ServiceTokensApi';
+export * from './SharedQuizzesApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';
 export * from './StudyPrepApi';
+export * from './StudySpaceTemplatesApi';
 export * from './StudySpacesApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';

package/dist/esm/models/AdminPaginatedQuizParticipantSessions.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 { AdminQuizParticipantSessionListItem } from './AdminQuizParticipantSessionListItem';
+/**
+ *
+ * @export
+ * @interface AdminPaginatedQuizParticipantSessions
+ */
+export interface AdminPaginatedQuizParticipantSessions {
+    /**
+     *
+     * @type {Array<AdminQuizParticipantSessionListItem>}
+     * @memberof AdminPaginatedQuizParticipantSessions
+     */
+    data: Array<AdminQuizParticipantSessionListItem>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof AdminPaginatedQuizParticipantSessions
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
+ */
+export declare function instanceOfAdminPaginatedQuizParticipantSessions(value: object): value is AdminPaginatedQuizParticipantSessions;
+export declare function AdminPaginatedQuizParticipantSessionsFromJSON(json: any): AdminPaginatedQuizParticipantSessions;
+export declare function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedQuizParticipantSessions;
+export declare function AdminPaginatedQuizParticipantSessionsToJSON(json: any): AdminPaginatedQuizParticipantSessions;
+export declare function AdminPaginatedQuizParticipantSessionsToJSONTyped(value?: AdminPaginatedQuizParticipantSessions | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminPaginatedQuizParticipantSessions.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 { AdminQuizParticipantSessionListItemFromJSON, AdminQuizParticipantSessionListItemToJSON, } from './AdminQuizParticipantSessionListItem';
+/**
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
+ */
+export function instanceOfAdminPaginatedQuizParticipantSessions(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function AdminPaginatedQuizParticipantSessionsFromJSON(json) {
+    return AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, false);
+}
+export function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminQuizParticipantSessionListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function AdminPaginatedQuizParticipantSessionsToJSON(json) {
+    return AdminPaginatedQuizParticipantSessionsToJSONTyped(json, false);
+}
+export function AdminPaginatedQuizParticipantSessionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminQuizParticipantSessionListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}