@instructure/athena-api-client 3.39.3 → 3.41.0

package/dist/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/apis/StudyObjectivesApi.js

@@ -389,7 +389,7 @@ 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) {
@@ -422,7 +422,7 @@ 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/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/apis/StudySpaceTemplatesApi.js

@@ -0,0 +1,162 @@
+"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.StudySpaceTemplatesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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: (0, index_1.CreateStudySpaceFromTemplateDtoToJSON)(requestParameters['createStudySpaceFromTemplateDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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(index_1.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: (0, index_1.ScheduleStudySpaceTemplateDtoToJSON)(requestParameters['scheduleStudySpaceTemplateDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.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();
+        });
+    }
+}
+exports.StudySpaceTemplatesApi = StudySpaceTemplatesApi;

package/dist/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/apis/index.js

@@ -38,10 +38,12 @@ __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ResourcesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
+__exportStar(require("./SharedQuizzesApi"), exports);
 __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);
 __exportStar(require("./StudyPlansApi"), exports);
 __exportStar(require("./StudyPrepApi"), exports);
+__exportStar(require("./StudySpaceTemplatesApi"), exports);
 __exportStar(require("./StudySpacesApi"), exports);
 __exportStar(require("./SyllabusAnalysisApi"), exports);
 __exportStar(require("./TagsApi"), exports);

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatCanvasUsage, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizParticipantSessions, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -72,6 +72,12 @@ export interface AdminListLastExchangesRequest {
     maxUserMessages?: number;
     inactiveDays?: number;
 }
+export interface AdminListQuizParticipantSessionsRequest {
+    xUserId: string;
+    quizId: string;
+    limit?: number;
+    cursor?: string;
+}
 export interface AdminListQuizSessionsRequest {
     xUserId: string;
     limit?: number;
@@ -239,6 +245,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * List the final user message and assistant reply for low-engagement new users
      */
     adminListLastExchanges(requestParameters: AdminListLastExchangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedLastExchanges>;
+    /**
+     * Admin-only. Returns a paginated list of all sessions on one quiz, newest first, across the quiz owner and every learner who opened it by share link. Each item identifies the learner by external id and says whether that learner is the quiz owner. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation, so the quiz must belong to a user within the caller\'s account. Like the other admin quiz endpoints, this is not gated on the `enhanced-quizzing` feature flag.
+     * List every learner\'s sessions on a quiz within the account
+     */
+    adminListQuizParticipantSessionsRaw(requestParameters: AdminListQuizParticipantSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedQuizParticipantSessions>>;
+    /**
+     * Admin-only. Returns a paginated list of all sessions on one quiz, newest first, across the quiz owner and every learner who opened it by share link. Each item identifies the learner by external id and says whether that learner is the quiz owner. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation, so the quiz must belong to a user within the caller\'s account. Like the other admin quiz endpoints, this is not gated on the `enhanced-quizzing` feature flag.
+     * List every learner\'s sessions on a quiz within the account
+     */
+    adminListQuizParticipantSessions(requestParameters: AdminListQuizParticipantSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedQuizParticipantSessions>;
     /**
      * Returns a paginated list of quiz sessions belonging to users within the caller\'s account, ordered by start date (newest first), with embedded quiz info, the owning user\'s external id, and a score summary (including the number of questions answered). Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Questions and responses are not included; fetch them per session via the summary endpoint. Like the summary endpoint, this is not gated on the `enhanced-quizzing` feature flag.
      * List recent quiz sessions across all account users

package/dist/esm/apis/AdminApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatCanvasUsageFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizParticipantSessionsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -576,6 +576,53 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Admin-only. Returns a paginated list of all sessions on one quiz, newest first, across the quiz owner and every learner who opened it by share link. Each item identifies the learner by external id and says whether that learner is the quiz owner. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation, so the quiz must belong to a user within the caller\'s account. Like the other admin quiz endpoints, this is not gated on the `enhanced-quizzing` feature flag.
+     * List every learner\'s sessions on a quiz within the account
+     */
+    adminListQuizParticipantSessionsRaw(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 adminListQuizParticipantSessions().');
+            }
+            if (requestParameters['quizId'] == null) {
+                throw new runtime.RequiredError('quizId', 'Required parameter "quizId" was null or undefined when calling adminListQuizParticipantSessions().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            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/admin/quizzes/{quizId}/sessions`;
+            urlPath = urlPath.replace(`{${"quizId"}}`, encodeURIComponent(String(requestParameters['quizId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AdminPaginatedQuizParticipantSessionsFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Admin-only. Returns a paginated list of all sessions on one quiz, newest first, across the quiz owner and every learner who opened it by share link. Each item identifies the learner by external id and says whether that learner is the quiz owner. Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation, so the quiz must belong to a user within the caller\'s account. Like the other admin quiz endpoints, this is not gated on the `enhanced-quizzing` feature flag.
+     * List every learner\'s sessions on a quiz within the account
+     */
+    adminListQuizParticipantSessions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListQuizParticipantSessionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns a paginated list of quiz sessions belonging to users within the caller\'s account, ordered by start date (newest first), with embedded quiz info, the owning user\'s external id, and a score summary (including the number of questions answered). Intended for admin-style views in calling applications; authorization on whether the calling user is allowed to act as an admin is the calling application\'s responsibility - this endpoint only enforces account isolation. Questions and responses are not included; fetch them per session via the summary endpoint. Like the summary endpoint, this is not gated on the `enhanced-quizzing` feature flag.
      * List recent quiz sessions across all account users

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

@@ -10,17 +10,26 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PaginatedQuizzes, QuizWithQuestions } from '../models/index';
+import type { PaginatedQuizzes, QuizSharing, QuizWithQuestions, UpdateQuizSharingRequest } from '../models/index';
 export interface GetQuizRequest {
     quizId: string;
     xUserId: string;
 }
+export interface GetQuizSharingRequest {
+    quizId: string;
+    xUserId: string;
+}
 export interface ListQuizzesRequest {
     xUserId: string;
     limit?: number;
     cursor?: string;
     mode?: ListQuizzesModeEnum;
 }
+export interface UpdateQuizSharingOperationRequest {
+    quizId: string;
+    xUserId: string;
+    updateQuizSharingRequest: UpdateQuizSharingRequest;
+}
 /**
  *
  */
@@ -35,6 +44,16 @@ export declare class QuizzesApi extends runtime.BaseAPI {
      * Get quiz with questions
      */
     getQuiz(requestParameters: GetQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizWithQuestions>;
+    /**
+     * Returns whether the quiz is open to other learners by link, and the link token if so. Only the quiz owner can read this.
+     * Get a quiz\'s sharing state
+     */
+    getQuizSharingRaw(requestParameters: GetQuizSharingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuizSharing>>;
+    /**
+     * Returns whether the quiz is open to other learners by link, and the link token if so. Only the quiz owner can read this.
+     * Get a quiz\'s sharing state
+     */
+    getQuizSharing(requestParameters: GetQuizSharingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSharing>;
     /**
      * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
      * List user quizzes
@@ -45,6 +64,16 @@ export declare class QuizzesApi extends runtime.BaseAPI {
      * List user quizzes
      */
     listQuizzes(requestParameters: ListQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
+    /**
+     * Enabling issues a link token other learners can redeem to take the quiz under their own sessions; enabling an already-shared quiz keeps its token. Disabling revokes the token so the link stops resolving. Sessions learners already started stay theirs. Only the quiz owner can change this.
+     * Turn link sharing on or off for a quiz
+     */
+    updateQuizSharingRaw(requestParameters: UpdateQuizSharingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuizSharing>>;
+    /**
+     * Enabling issues a link token other learners can redeem to take the quiz under their own sessions; enabling an already-shared quiz keeps its token. Disabling revokes the token so the link stops resolving. Sessions learners already started stay theirs. Only the quiz owner can change this.
+     * Turn link sharing on or off for a quiz
+     */
+    updateQuizSharing(requestParameters: UpdateQuizSharingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuizSharing>;
 }
 /**
  * @export

package/dist/esm/apis/QuizzesApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedQuizzesFromJSON, QuizWithQuestionsFromJSON, } from '../models/index';
+import { PaginatedQuizzesFromJSON, QuizSharingFromJSON, QuizWithQuestionsFromJSON, UpdateQuizSharingRequestToJSON, } from '../models/index';
 /**
  *
  */
@@ -67,6 +67,47 @@ export class QuizzesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns whether the quiz is open to other learners by link, and the link token if so. Only the quiz owner can read this.
+     * Get a quiz\'s sharing state
+     */
+    getQuizSharingRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['quizId'] == null) {
+                throw new runtime.RequiredError('quizId', 'Required parameter "quizId" was null or undefined when calling getQuizSharing().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getQuizSharing().');
+            }
+            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/quizzes/{quizId}/sharing`;
+            urlPath = urlPath.replace(`{${"quizId"}}`, encodeURIComponent(String(requestParameters['quizId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => QuizSharingFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns whether the quiz is open to other learners by link, and the link token if so. Only the quiz owner can read this.
+     * Get a quiz\'s sharing state
+     */
+    getQuizSharing(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getQuizSharingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns a paginated list of quizzes owned by the authenticated user, ordered by creation date (newest first).
      * List user quizzes
@@ -113,6 +154,52 @@ export class QuizzesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Enabling issues a link token other learners can redeem to take the quiz under their own sessions; enabling an already-shared quiz keeps its token. Disabling revokes the token so the link stops resolving. Sessions learners already started stay theirs. Only the quiz owner can change this.
+     * Turn link sharing on or off for a quiz
+     */
+    updateQuizSharingRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['quizId'] == null) {
+                throw new runtime.RequiredError('quizId', 'Required parameter "quizId" was null or undefined when calling updateQuizSharing().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling updateQuizSharing().');
+            }
+            if (requestParameters['updateQuizSharingRequest'] == null) {
+                throw new runtime.RequiredError('updateQuizSharingRequest', 'Required parameter "updateQuizSharingRequest" was null or undefined when calling updateQuizSharing().');
+            }
+            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/quizzes/{quizId}/sharing`;
+            urlPath = urlPath.replace(`{${"quizId"}}`, encodeURIComponent(String(requestParameters['quizId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateQuizSharingRequestToJSON(requestParameters['updateQuizSharingRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => QuizSharingFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Enabling issues a link token other learners can redeem to take the quiz under their own sessions; enabling an already-shared quiz keeps its token. Disabling revokes the token so the link stops resolving. Sessions learners already started stay theirs. Only the quiz owner can change this.
+     * Turn link sharing on or off for a quiz
+     */
+    updateQuizSharing(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateQuizSharingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }
 /**
  * @export

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

@@ -16,6 +16,7 @@ export interface ListResourcesRequest {
     limit?: number;
     cursor?: string;
     type?: ListResourcesTypeEnum;
+    ownership?: ListResourcesOwnershipEnum;
     courseId?: string;
     chatId?: string;
     studySpaceId?: string;
@@ -26,12 +27,12 @@ export interface ListResourcesRequest {
  */
 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.
+     * 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: 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.
+     * 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: ListResourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResources>;
@@ -44,6 +45,14 @@ export declare const ListResourcesTypeEnum: {
     readonly Flashcards: "flashcards";
 };
 export type ListResourcesTypeEnum = typeof ListResourcesTypeEnum[keyof typeof ListResourcesTypeEnum];
+/**
+ * @export
+ */
+export declare const ListResourcesOwnershipEnum: {
+    readonly Owned: "owned";
+    readonly Shared: "shared";
+};
+export type ListResourcesOwnershipEnum = typeof ListResourcesOwnershipEnum[keyof typeof ListResourcesOwnershipEnum];
 /**
  * @export
  */