@instructure/athena-api-client 3.39.3 → 3.41.0

package/README.md

@@ -70,6 +70,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminListActiveStreaks**](docs/AdminApi.md#adminlistactivestreaks) | **GET** /api/v1/admin/streaks/active | List all active streaks (currentDays > 0) across the account, paginated
 *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
 *AdminApi* | [**adminListLastExchanges**](docs/AdminApi.md#adminlistlastexchanges) | **GET** /api/v1/admin/last-exchanges | List the final user message and assistant reply for low-engagement new users
+*AdminApi* | [**adminListQuizParticipantSessions**](docs/AdminApi.md#adminlistquizparticipantsessions) | **GET** /api/v1/admin/quizzes/{quizId}/sessions | List every learner\'s sessions on a quiz within the account
 *AdminApi* | [**adminListQuizSessions**](docs/AdminApi.md#adminlistquizsessions) | **GET** /api/v1/admin/quiz-sessions | List recent quiz sessions across all account users
 *AdminApi* | [**adminListStudyObjectives**](docs/AdminApi.md#adminliststudyobjectives) | **GET** /api/v1/admin/study-objectives | List study objectives across all account users
 *AdminApi* | [**adminListStudyObjectivesByUser**](docs/AdminApi.md#adminliststudyobjectivesbyuser) | **GET** /api/v1/admin/study-objectives/by-user | Per-user study-objective counts across all account users
@@ -128,13 +129,17 @@ All URIs are relative to *http://localhost:3000*
 *QuizSessionsApi* | [**submitQuizResponse**](docs/QuizSessionsApi.md#submitquizresponseoperation) | **POST** /api/v1/quiz-sessions/{sessionId}/responses | Submit a quiz response
 *QuizSessionsApi* | [**updateQuizSession**](docs/QuizSessionsApi.md#updatequizsessionoperation) | **PATCH** /api/v1/quiz-sessions/{sessionId} | Update quiz session status
 *QuizzesApi* | [**getQuiz**](docs/QuizzesApi.md#getquiz) | **GET** /api/v1/quizzes/{quizId} | Get quiz with questions
+*QuizzesApi* | [**getQuizSharing**](docs/QuizzesApi.md#getquizsharing) | **GET** /api/v1/quizzes/{quizId}/sharing | Get a quiz\'s sharing state
 *QuizzesApi* | [**listQuizzes**](docs/QuizzesApi.md#listquizzes) | **GET** /api/v1/quizzes | List user quizzes
+*QuizzesApi* | [**updateQuizSharing**](docs/QuizzesApi.md#updatequizsharingoperation) | **PATCH** /api/v1/quizzes/{quizId}/sharing | Turn link sharing on or off for a quiz
 *ResourcesApi* | [**listResources**](docs/ResourcesApi.md#listresources) | **GET** /api/v1/resources | List the user\'s generated study resources
 *ServiceTokensApi* | [**createServiceToken**](docs/ServiceTokensApi.md#createservicetoken) | **POST** /api/v1/tokens | Create a new service token
 *ServiceTokensApi* | [**deleteServiceToken**](docs/ServiceTokensApi.md#deleteservicetoken) | **DELETE** /api/v1/tokens/{id} | Delete service token
 *ServiceTokensApi* | [**getServiceToken**](docs/ServiceTokensApi.md#getservicetoken) | **GET** /api/v1/tokens/{id} | Get service token by ID
 *ServiceTokensApi* | [**listServiceTokens**](docs/ServiceTokensApi.md#listservicetokens) | **GET** /api/v1/tokens | List all service tokens
 *ServiceTokensApi* | [**updateServiceToken**](docs/ServiceTokensApi.md#updateservicetoken) | **PATCH** /api/v1/tokens/{id} | Update service token status
+*SharedQuizzesApi* | [**getSharedQuiz**](docs/SharedQuizzesApi.md#getsharedquiz) | **GET** /api/v1/shared-quizzes/{token} | Resolve a quiz share link
+*SharedQuizzesApi* | [**startSharedQuizSession**](docs/SharedQuizzesApi.md#startsharedquizsession) | **POST** /api/v1/shared-quizzes/{token}/sessions | Start or resume the caller\'s session on a shared quiz
 *StudyObjectiveConceptsApi* | [**listStudyObjectiveConcepts**](docs/StudyObjectiveConceptsApi.md#liststudyobjectiveconcepts) | **GET** /api/v1/study-objective-concepts | List study-objective concept attachments
 *StudyObjectiveConceptsApi* | [**triggerStudyObjectiveConceptExtraction**](docs/StudyObjectiveConceptsApi.md#triggerstudyobjectiveconceptextractionoperation) | **POST** /api/v1/study-objective-concepts/extract | Trigger study-objective concept extraction
 *StudyObjectivesApi* | [**createObjectiveResource**](docs/StudyObjectivesApi.md#createobjectiveresource) | **POST** /api/v1/study-objectives/{studyObjectiveId}/resources | Attach a chat resource to a study objective
@@ -155,6 +160,9 @@ All URIs are relative to *http://localhost:3000*
 *StudyPrepApi* | [**assessCanvasKnowledge**](docs/StudyPrepApi.md#assesscanvasknowledge) | **POST** /api/v1/study-prep/knowledge-assessment | Assess user knowledge from Canvas course grades
 *StudyPrepApi* | [**generateCanvasTaxonomy**](docs/StudyPrepApi.md#generatecanvastaxonomy) | **POST** /api/v1/study-prep/taxonomies | Generate a taxonomy from a Canvas course
 *StudyPrepApi* | [**syncCanvasUserProfile**](docs/StudyPrepApi.md#synccanvasuserprofile) | **POST** /api/v1/study-prep/user-profile | Sync user profile from Canvas
+*StudySpaceTemplatesApi* | [**createStudySpaceFromTemplate**](docs/StudySpaceTemplatesApi.md#createstudyspacefromtemplate) | **POST** /api/v1/study-space-templates/{slug}/spaces | Create a study space from a template
+*StudySpaceTemplatesApi* | [**listStudySpaceTemplates**](docs/StudySpaceTemplatesApi.md#liststudyspacetemplates) | **GET** /api/v1/study-space-templates | List the study space templates a learner can start from
+*StudySpaceTemplatesApi* | [**previewStudySpaceTemplateSchedule**](docs/StudySpaceTemplatesApi.md#previewstudyspacetemplateschedule) | **POST** /api/v1/study-space-templates/{slug}/schedule-preview | Preview the objectives a template would create
 *StudySpacesApi* | [**createStudySpace**](docs/StudySpacesApi.md#createstudyspace) | **POST** /api/v1/study-spaces | Create a study space the learner names
 *StudySpacesApi* | [**deleteStudySpace**](docs/StudySpacesApi.md#deletestudyspace) | **DELETE** /api/v1/study-spaces/{studySpaceId} | Delete a study space the learner created
 *StudySpacesApi* | [**listStudySpaces**](docs/StudySpacesApi.md#liststudyspaces) | **GET** /api/v1/study-spaces | List the authenticated user\'s study spaces
@@ -213,12 +221,15 @@ All URIs are relative to *http://localhost:3000*
 - [AdminPaginatedActiveStreaks](docs/AdminPaginatedActiveStreaks.md)
 - [AdminPaginatedChats](docs/AdminPaginatedChats.md)
 - [AdminPaginatedLastExchanges](docs/AdminPaginatedLastExchanges.md)
+- [AdminPaginatedQuizParticipantSessions](docs/AdminPaginatedQuizParticipantSessions.md)
 - [AdminPaginatedQuizSessions](docs/AdminPaginatedQuizSessions.md)
 - [AdminPaginatedStudyObjectiveUserCounts](docs/AdminPaginatedStudyObjectiveUserCounts.md)
 - [AdminPaginatedStudyObjectives](docs/AdminPaginatedStudyObjectives.md)
 - [AdminPaginatedTaxonomyEnrollments](docs/AdminPaginatedTaxonomyEnrollments.md)
 - [AdminQuizGeneration](docs/AdminQuizGeneration.md)
 - [AdminQuizGenerationInput](docs/AdminQuizGenerationInput.md)
+- [AdminQuizParticipantSessionListItem](docs/AdminQuizParticipantSessionListItem.md)
+- [AdminQuizParticipantSessionScore](docs/AdminQuizParticipantSessionScore.md)
 - [AdminQuizSessionListItem](docs/AdminQuizSessionListItem.md)
 - [AdminQuizSessionScore](docs/AdminQuizSessionScore.md)
 - [AdminQuizSourceFile](docs/AdminQuizSourceFile.md)
@@ -275,6 +286,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreateStudyPlanDto](docs/CreateStudyPlanDto.md)
 - [CreateStudyPlanDtoActivitiesInner](docs/CreateStudyPlanDtoActivitiesInner.md)
 - [CreateStudySpaceDto](docs/CreateStudySpaceDto.md)
+- [CreateStudySpaceFromTemplateDto](docs/CreateStudySpaceFromTemplateDto.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
@@ -317,17 +329,21 @@ All URIs are relative to *http://localhost:3000*
 - [QuizSessionListItem](docs/QuizSessionListItem.md)
 - [QuizSessionScore](docs/QuizSessionScore.md)
 - [QuizSessionSummary](docs/QuizSessionSummary.md)
+- [QuizSharing](docs/QuizSharing.md)
 - [QuizWithQuestions](docs/QuizWithQuestions.md)
 - [RecordQuizQuestionViewRequest](docs/RecordQuizQuestionViewRequest.md)
 - [ResourceActivity](docs/ResourceActivity.md)
 - [ResourceChat](docs/ResourceChat.md)
 - [ResourceListItem](docs/ResourceListItem.md)
 - [ResourceSession](docs/ResourceSession.md)
+- [ResourceSharing](docs/ResourceSharing.md)
 - [ResourceStudyObjective](docs/ResourceStudyObjective.md)
 - [ResourceStudySpace](docs/ResourceStudySpace.md)
+- [ScheduleStudySpaceTemplateDto](docs/ScheduleStudySpaceTemplateDto.md)
 - [Score](docs/Score.md)
 - [ScoreByTypeValue](docs/ScoreByTypeValue.md)
 - [ServiceToken](docs/ServiceToken.md)
+- [SharedQuiz](docs/SharedQuiz.md)
 - [StudyObjective](docs/StudyObjective.md)
 - [StudyObjectiveCanvasDocument](docs/StudyObjectiveCanvasDocument.md)
 - [StudyObjectiveConceptAttachment](docs/StudyObjectiveConceptAttachment.md)
@@ -337,6 +353,17 @@ All URIs are relative to *http://localhost:3000*
 - [StudyPlan](docs/StudyPlan.md)
 - [StudyPlanActivity](docs/StudyPlanActivity.md)
 - [StudySpace](docs/StudySpace.md)
+- [StudySpaceFromTemplate](docs/StudySpaceFromTemplate.md)
+- [StudySpaceTemplate](docs/StudySpaceTemplate.md)
+- [StudySpaceTemplateAnchor](docs/StudySpaceTemplateAnchor.md)
+- [StudySpaceTemplateConfirm](docs/StudySpaceTemplateConfirm.md)
+- [StudySpaceTemplateLegal](docs/StudySpaceTemplateLegal.md)
+- [StudySpaceTemplateLink](docs/StudySpaceTemplateLink.md)
+- [StudySpaceTemplateNotice](docs/StudySpaceTemplateNotice.md)
+- [StudySpaceTemplateObjective](docs/StudySpaceTemplateObjective.md)
+- [StudySpaceTemplateProvenance](docs/StudySpaceTemplateProvenance.md)
+- [StudySpaceTemplateSchedule](docs/StudySpaceTemplateSchedule.md)
+- [StudySpaceTemplateScheduleItem](docs/StudySpaceTemplateScheduleItem.md)
 - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
 - [SubmittedQuizResponse](docs/SubmittedQuizResponse.md)
 - [SyllabusAnalysisObjective](docs/SyllabusAnalysisObjective.md)
@@ -364,6 +391,7 @@ All URIs are relative to *http://localhost:3000*
 - [UpdateFeatureDto](docs/UpdateFeatureDto.md)
 - [UpdatePlanDto](docs/UpdatePlanDto.md)
 - [UpdateQuizSessionRequest](docs/UpdateQuizSessionRequest.md)
+- [UpdateQuizSharingRequest](docs/UpdateQuizSharingRequest.md)
 - [UpdateStudyObjectiveDto](docs/UpdateStudyObjectiveDto.md)
 - [UpdateStudySpaceDto](docs/UpdateStudySpaceDto.md)
 - [UpdateTokenRequest](docs/UpdateTokenRequest.md)

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

@@ -579,6 +579,53 @@ 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) => (0, index_1.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/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/apis/QuizzesApi.js

@@ -70,6 +70,47 @@ 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) => (0, index_1.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
@@ -116,6 +157,52 @@ 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: (0, index_1.UpdateQuizSharingRequestToJSON)(requestParameters['updateQuizSharingRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.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();
+        });
+    }
 }
 exports.QuizzesApi = QuizzesApi;
 /**

package/dist/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
  */

package/dist/apis/ResourcesApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListResourcesProgressEnum = exports.ListResourcesTypeEnum = exports.ResourcesApi = void 0;
+exports.ListResourcesProgressEnum = exports.ListResourcesOwnershipEnum = exports.ListResourcesTypeEnum = exports.ResourcesApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
  */
 class ResourcesApi extends runtime.BaseAPI {
     /**
-     * Returns the authenticated user\'s quizzes and flashcard sets, newest first, each with its question rollup, originating chat, course attribution, study objective, and session activity. Intended for a library view, so every row carries enough to render a card without a follow-up request.
+     * 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) {
@@ -48,6 +48,9 @@ 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'];
             }
@@ -78,7 +81,7 @@ 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) {
@@ -96,6 +99,13 @@ exports.ListResourcesTypeEnum = {
     Quiz: 'quiz',
     Flashcards: 'flashcards'
 };
+/**
+ * @export
+ */
+exports.ListResourcesOwnershipEnum = {
+    Owned: 'owned',
+    Shared: 'shared'
+};
 /**
  * @export
  */

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

@@ -0,0 +1,115 @@
+"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.SharedQuizzesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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) => (0, index_1.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) => (0, index_1.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();
+        });
+    }
+}
+exports.SharedQuizzesApi = SharedQuizzesApi;