@instructure/athena-api-client 3.22.2 → 3.24.0

package/README.md

@@ -147,6 +147,8 @@ 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
+*StudySpacesApi* | [**listStudySpaces**](docs/StudySpacesApi.md#liststudyspaces) | **GET** /api/v1/study-spaces | List the authenticated user\'s study spaces
+*StudySpacesApi* | [**updateStudySpace**](docs/StudySpacesApi.md#updatestudyspace) | **PATCH** /api/v1/study-spaces/{studySpaceId} | Update a study space title
 *SyllabusAnalysisApi* | [**getSyllabusAnalysisStatus**](docs/SyllabusAnalysisApi.md#getsyllabusanalysisstatus) | **GET** /api/v1/syllabus-analysis | Get syllabus analysis status
 *SyllabusAnalysisApi* | [**triggerSyllabusAnalysis**](docs/SyllabusAnalysisApi.md#triggersyllabusanalysisoperation) | **POST** /api/v1/syllabus-analysis | Trigger syllabus analysis
 *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
@@ -287,6 +289,7 @@ All URIs are relative to *http://localhost:3000*
 - [StudyObjectiveFileAttachment](docs/StudyObjectiveFileAttachment.md)
 - [StudyPlan](docs/StudyPlan.md)
 - [StudyPlanActivity](docs/StudyPlanActivity.md)
+- [StudySpace](docs/StudySpace.md)
 - [SubmitQuizResponseRequest](docs/SubmitQuizResponseRequest.md)
 - [SyllabusAnalysisObjective](docs/SyllabusAnalysisObjective.md)
 - [SyllabusAnalysisStatus](docs/SyllabusAnalysisStatus.md)
@@ -312,6 +315,7 @@ All URIs are relative to *http://localhost:3000*
 - [UpdatePlanDto](docs/UpdatePlanDto.md)
 - [UpdateQuizSessionRequest](docs/UpdateQuizSessionRequest.md)
 - [UpdateStudyObjectiveDto](docs/UpdateStudyObjectiveDto.md)
+- [UpdateStudySpaceDto](docs/UpdateStudySpaceDto.md)
 - [UpdateTokenRequest](docs/UpdateTokenRequest.md)
 - [UpdateTokenResponse](docs/UpdateTokenResponse.md)
 - [UploadUrlFile](docs/UploadUrlFile.md)

package/dist/apis/StudySpacesApi.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 { StudySpace, UpdateStudySpaceDto } from '../models/index';
+export interface ListStudySpacesRequest {
+    xUserId: string;
+}
+export interface UpdateStudySpaceRequest {
+    xUserId: string;
+    studySpaceId: string;
+    updateStudySpaceDto: UpdateStudySpaceDto;
+}
+/**
+ *
+ */
+export declare class StudySpacesApi extends runtime.BaseAPI {
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpacesRaw(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StudySpace>>>;
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpaces(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StudySpace>>;
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpaceRaw(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudySpace>>;
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpace(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudySpace>;
+}

package/dist/apis/StudySpacesApi.js

@@ -0,0 +1,116 @@
+"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.StudySpacesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class StudySpacesApi extends runtime.BaseAPI {
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpacesRaw(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 listStudySpaces().');
+            }
+            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-spaces`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.StudySpaceFromJSON));
+        });
+    }
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpaces(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudySpacesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpaceRaw(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 updateStudySpace().');
+            }
+            if (requestParameters['studySpaceId'] == null) {
+                throw new runtime.RequiredError('studySpaceId', 'Required parameter "studySpaceId" was null or undefined when calling updateStudySpace().');
+            }
+            if (requestParameters['updateStudySpaceDto'] == null) {
+                throw new runtime.RequiredError('updateStudySpaceDto', 'Required parameter "updateStudySpaceDto" was null or undefined when calling updateStudySpace().');
+            }
+            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-spaces/{studySpaceId}`;
+            urlPath = urlPath.replace(`{${"studySpaceId"}}`, encodeURIComponent(String(requestParameters['studySpaceId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateStudySpaceDtoToJSON)(requestParameters['updateStudySpaceDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudySpaceFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpace(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateStudySpaceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.StudySpacesApi = StudySpacesApi;

package/dist/apis/index.d.ts

@@ -22,6 +22,7 @@ export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';
 export * from './StudyPrepApi';
+export * from './StudySpacesApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';

package/dist/apis/index.js

@@ -40,6 +40,7 @@ __exportStar(require("./StudyObjectiveConceptsApi"), exports);
 __exportStar(require("./StudyObjectivesApi"), exports);
 __exportStar(require("./StudyPlansApi"), exports);
 __exportStar(require("./StudyPrepApi"), exports);
+__exportStar(require("./StudySpacesApi"), exports);
 __exportStar(require("./SyllabusAnalysisApi"), exports);
 __exportStar(require("./TagsApi"), exports);
 __exportStar(require("./TaxonomiesApi"), exports);

package/dist/esm/apis/StudySpacesApi.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 { StudySpace, UpdateStudySpaceDto } from '../models/index';
+export interface ListStudySpacesRequest {
+    xUserId: string;
+}
+export interface UpdateStudySpaceRequest {
+    xUserId: string;
+    studySpaceId: string;
+    updateStudySpaceDto: UpdateStudySpaceDto;
+}
+/**
+ *
+ */
+export declare class StudySpacesApi extends runtime.BaseAPI {
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpacesRaw(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StudySpace>>>;
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpaces(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StudySpace>>;
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpaceRaw(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudySpace>>;
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpace(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudySpace>;
+}

package/dist/esm/apis/StudySpacesApi.js

@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { StudySpaceFromJSON, UpdateStudySpaceDtoToJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudySpacesApi extends runtime.BaseAPI {
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpacesRaw(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 listStudySpaces().');
+            }
+            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-spaces`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(StudySpaceFromJSON));
+        });
+    }
+    /**
+     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per course, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
+     * List the authenticated user\'s study spaces
+     */
+    listStudySpaces(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudySpacesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpaceRaw(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 updateStudySpace().');
+            }
+            if (requestParameters['studySpaceId'] == null) {
+                throw new runtime.RequiredError('studySpaceId', 'Required parameter "studySpaceId" was null or undefined when calling updateStudySpace().');
+            }
+            if (requestParameters['updateStudySpaceDto'] == null) {
+                throw new runtime.RequiredError('updateStudySpaceDto', 'Required parameter "updateStudySpaceDto" was null or undefined when calling updateStudySpace().');
+            }
+            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-spaces/{studySpaceId}`;
+            urlPath = urlPath.replace(`{${"studySpaceId"}}`, encodeURIComponent(String(requestParameters['studySpaceId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateStudySpaceDtoToJSON(requestParameters['updateStudySpaceDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudySpaceFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
+     * Update a study space title
+     */
+    updateStudySpace(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateStudySpaceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -22,6 +22,7 @@ export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';
 export * from './StudyPrepApi';
+export * from './StudySpacesApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';

package/dist/esm/apis/index.js

@@ -24,6 +24,7 @@ export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
 export * from './StudyPlansApi';
 export * from './StudyPrepApi';
+export * from './StudySpacesApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';
 export * from './TaxonomiesApi';

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

@@ -47,6 +47,12 @@ export interface CreateStudyObjectiveDto {
      * @memberof CreateStudyObjectiveDto
      */
     courseId: string;
+    /**
+     * Display name of the Canvas course. Used to name the learner's study space for this course when it has no name yet; an existing name is never overwritten.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDto
+     */
+    courseName?: string;
     /**
      *
      * @type {CreateStudyObjectiveDtoCanvasObject}

package/dist/esm/models/CreateStudyObjectiveDto.js

@@ -36,6 +36,7 @@ export function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator)
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
         'courseId': json['courseId'],
+        'courseName': json['courseName'] == null ? undefined : json['courseName'],
         'canvasObject': json['canvasObject'] == null ? undefined : CreateStudyObjectiveDtoCanvasObjectFromJSON(json['canvasObject']),
     };
 }
@@ -52,6 +53,7 @@ export function CreateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator =
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'courseId': value['courseId'],
+        'courseName': value['courseName'],
         'canvasObject': CreateStudyObjectiveDtoCanvasObjectToJSON(value['canvasObject']),
     };
 }

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

@@ -0,0 +1,62 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface StudySpace
+ */
+export interface StudySpace {
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpace
+     */
+    id: string;
+    /**
+     * External course identifier (e.g. a Canvas course id) this space is backed by, or null for a space with no course.
+     * @type {string}
+     * @memberof StudySpace
+     */
+    courseId: string | null;
+    /**
+     * Display title. Empty when no title has been set, so clients need a fallback (e.g. the course name).
+     * @type {string}
+     * @memberof StudySpace
+     */
+    title: string;
+    /**
+     * Number of non-archived study objectives in this space.
+     * @type {number}
+     * @memberof StudySpace
+     */
+    activeObjectiveCount: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudySpace
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudySpace
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the StudySpace interface.
+ */
+export declare function instanceOfStudySpace(value: object): value is StudySpace;
+export declare function StudySpaceFromJSON(json: any): StudySpace;
+export declare function StudySpaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpace;
+export declare function StudySpaceToJSON(json: any): StudySpace;
+export declare function StudySpaceToJSONTyped(value?: StudySpace | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudySpace.js

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the StudySpace interface.
+ */
+export function instanceOfStudySpace(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('activeObjectiveCount' in value) || value['activeObjectiveCount'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function StudySpaceFromJSON(json) {
+    return StudySpaceFromJSONTyped(json, false);
+}
+export function StudySpaceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseId': json['courseId'],
+        'title': json['title'],
+        'activeObjectiveCount': json['activeObjectiveCount'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function StudySpaceToJSON(json) {
+    return StudySpaceToJSONTyped(json, false);
+}
+export function StudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'courseId': value['courseId'],
+        'title': value['title'],
+        'activeObjectiveCount': value['activeObjectiveCount'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UpdateStudySpaceDto
+ */
+export interface UpdateStudySpaceDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateStudySpaceDto
+     */
+    title: string;
+}
+/**
+ * Check if a given object implements the UpdateStudySpaceDto interface.
+ */
+export declare function instanceOfUpdateStudySpaceDto(value: object): value is UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoFromJSON(json: any): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoToJSON(json: any): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoToJSONTyped(value?: UpdateStudySpaceDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateStudySpaceDto.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the UpdateStudySpaceDto interface.
+ */
+export function instanceOfUpdateStudySpaceDto(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateStudySpaceDtoFromJSON(json) {
+    return UpdateStudySpaceDtoFromJSONTyped(json, false);
+}
+export function UpdateStudySpaceDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'],
+    };
+}
+export function UpdateStudySpaceDtoToJSON(json) {
+    return UpdateStudySpaceDtoToJSONTyped(json, false);
+}
+export function UpdateStudySpaceDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+    };
+}

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

@@ -109,6 +109,7 @@ export * from './StudyObjectiveConceptSummary';
 export * from './StudyObjectiveFileAttachment';
 export * from './StudyPlan';
 export * from './StudyPlanActivity';
+export * from './StudySpace';
 export * from './SubmitQuizResponseRequest';
 export * from './SyllabusAnalysisObjective';
 export * from './SyllabusAnalysisStatus';
@@ -134,6 +135,7 @@ export * from './UpdateFeatureDto';
 export * from './UpdatePlanDto';
 export * from './UpdateQuizSessionRequest';
 export * from './UpdateStudyObjectiveDto';
+export * from './UpdateStudySpaceDto';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlFile';

package/dist/esm/models/index.js

@@ -111,6 +111,7 @@ export * from './StudyObjectiveConceptSummary';
 export * from './StudyObjectiveFileAttachment';
 export * from './StudyPlan';
 export * from './StudyPlanActivity';
+export * from './StudySpace';
 export * from './SubmitQuizResponseRequest';
 export * from './SyllabusAnalysisObjective';
 export * from './SyllabusAnalysisStatus';
@@ -136,6 +137,7 @@ export * from './UpdateFeatureDto';
 export * from './UpdatePlanDto';
 export * from './UpdateQuizSessionRequest';
 export * from './UpdateStudyObjectiveDto';
+export * from './UpdateStudySpaceDto';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlFile';

package/dist/models/CreateStudyObjectiveDto.d.ts

@@ -47,6 +47,12 @@ export interface CreateStudyObjectiveDto {
      * @memberof CreateStudyObjectiveDto
      */
     courseId: string;
+    /**
+     * Display name of the Canvas course. Used to name the learner's study space for this course when it has no name yet; an existing name is never overwritten.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDto
+     */
+    courseName?: string;
     /**
      *
      * @type {CreateStudyObjectiveDtoCanvasObject}

package/dist/models/CreateStudyObjectiveDto.js

@@ -43,6 +43,7 @@ function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
         'courseId': json['courseId'],
+        'courseName': json['courseName'] == null ? undefined : json['courseName'],
         'canvasObject': json['canvasObject'] == null ? undefined : (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectFromJSON)(json['canvasObject']),
     };
 }
@@ -59,6 +60,7 @@ function CreateStudyObjectiveDtoToJSONTyped(value, ignoreDiscriminator = false)
         'canvasDocuments': value['canvasDocuments'] == null ? undefined : (value['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON)),
         'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
         'courseId': value['courseId'],
+        'courseName': value['courseName'],
         'canvasObject': (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectToJSON)(value['canvasObject']),
     };
 }

package/dist/models/StudySpace.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface StudySpace
+ */
+export interface StudySpace {
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpace
+     */
+    id: string;
+    /**
+     * External course identifier (e.g. a Canvas course id) this space is backed by, or null for a space with no course.
+     * @type {string}
+     * @memberof StudySpace
+     */
+    courseId: string | null;
+    /**
+     * Display title. Empty when no title has been set, so clients need a fallback (e.g. the course name).
+     * @type {string}
+     * @memberof StudySpace
+     */
+    title: string;
+    /**
+     * Number of non-archived study objectives in this space.
+     * @type {number}
+     * @memberof StudySpace
+     */
+    activeObjectiveCount: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudySpace
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudySpace
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the StudySpace interface.
+ */
+export declare function instanceOfStudySpace(value: object): value is StudySpace;
+export declare function StudySpaceFromJSON(json: any): StudySpace;
+export declare function StudySpaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpace;
+export declare function StudySpaceToJSON(json: any): StudySpace;
+export declare function StudySpaceToJSONTyped(value?: StudySpace | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StudySpace.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfStudySpace = instanceOfStudySpace;
+exports.StudySpaceFromJSON = StudySpaceFromJSON;
+exports.StudySpaceFromJSONTyped = StudySpaceFromJSONTyped;
+exports.StudySpaceToJSON = StudySpaceToJSON;
+exports.StudySpaceToJSONTyped = StudySpaceToJSONTyped;
+/**
+ * Check if a given object implements the StudySpace interface.
+ */
+function instanceOfStudySpace(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('activeObjectiveCount' in value) || value['activeObjectiveCount'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function StudySpaceFromJSON(json) {
+    return StudySpaceFromJSONTyped(json, false);
+}
+function StudySpaceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'courseId': json['courseId'],
+        'title': json['title'],
+        'activeObjectiveCount': json['activeObjectiveCount'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+function StudySpaceToJSON(json) {
+    return StudySpaceToJSONTyped(json, false);
+}
+function StudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'courseId': value['courseId'],
+        'title': value['title'],
+        'activeObjectiveCount': value['activeObjectiveCount'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/models/UpdateStudySpaceDto.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UpdateStudySpaceDto
+ */
+export interface UpdateStudySpaceDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateStudySpaceDto
+     */
+    title: string;
+}
+/**
+ * Check if a given object implements the UpdateStudySpaceDto interface.
+ */
+export declare function instanceOfUpdateStudySpaceDto(value: object): value is UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoFromJSON(json: any): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoToJSON(json: any): UpdateStudySpaceDto;
+export declare function UpdateStudySpaceDtoToJSONTyped(value?: UpdateStudySpaceDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateStudySpaceDto.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUpdateStudySpaceDto = instanceOfUpdateStudySpaceDto;
+exports.UpdateStudySpaceDtoFromJSON = UpdateStudySpaceDtoFromJSON;
+exports.UpdateStudySpaceDtoFromJSONTyped = UpdateStudySpaceDtoFromJSONTyped;
+exports.UpdateStudySpaceDtoToJSON = UpdateStudySpaceDtoToJSON;
+exports.UpdateStudySpaceDtoToJSONTyped = UpdateStudySpaceDtoToJSONTyped;
+/**
+ * Check if a given object implements the UpdateStudySpaceDto interface.
+ */
+function instanceOfUpdateStudySpaceDto(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+function UpdateStudySpaceDtoFromJSON(json) {
+    return UpdateStudySpaceDtoFromJSONTyped(json, false);
+}
+function UpdateStudySpaceDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'],
+    };
+}
+function UpdateStudySpaceDtoToJSON(json) {
+    return UpdateStudySpaceDtoToJSONTyped(json, false);
+}
+function UpdateStudySpaceDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+    };
+}

package/dist/models/index.d.ts

@@ -109,6 +109,7 @@ export * from './StudyObjectiveConceptSummary';
 export * from './StudyObjectiveFileAttachment';
 export * from './StudyPlan';
 export * from './StudyPlanActivity';
+export * from './StudySpace';
 export * from './SubmitQuizResponseRequest';
 export * from './SyllabusAnalysisObjective';
 export * from './SyllabusAnalysisStatus';
@@ -134,6 +135,7 @@ export * from './UpdateFeatureDto';
 export * from './UpdatePlanDto';
 export * from './UpdateQuizSessionRequest';
 export * from './UpdateStudyObjectiveDto';
+export * from './UpdateStudySpaceDto';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
 export * from './UploadUrlFile';

package/dist/models/index.js

@@ -127,6 +127,7 @@ __exportStar(require("./StudyObjectiveConceptSummary"), exports);
 __exportStar(require("./StudyObjectiveFileAttachment"), exports);
 __exportStar(require("./StudyPlan"), exports);
 __exportStar(require("./StudyPlanActivity"), exports);
+__exportStar(require("./StudySpace"), exports);
 __exportStar(require("./SubmitQuizResponseRequest"), exports);
 __exportStar(require("./SyllabusAnalysisObjective"), exports);
 __exportStar(require("./SyllabusAnalysisStatus"), exports);
@@ -152,6 +153,7 @@ __exportStar(require("./UpdateFeatureDto"), exports);
 __exportStar(require("./UpdatePlanDto"), exports);
 __exportStar(require("./UpdateQuizSessionRequest"), exports);
 __exportStar(require("./UpdateStudyObjectiveDto"), exports);
+__exportStar(require("./UpdateStudySpaceDto"), exports);
 __exportStar(require("./UpdateTokenRequest"), exports);
 __exportStar(require("./UpdateTokenResponse"), exports);
 __exportStar(require("./UploadUrlFile"), exports);

package/package.json

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