@instructure/athena-api-client 3.24.3 → 3.25.0

package/README.md

@@ -138,7 +138,7 @@ All URIs are relative to *http://localhost:3000*
 *StudyObjectivesApi* | [**getStudyObjective**](docs/StudyObjectivesApi.md#getstudyobjective) | **GET** /api/v1/study-objectives/{studyObjectiveId} | Get a study objective by ID
 *StudyObjectivesApi* | [**listObjectiveResources**](docs/StudyObjectivesApi.md#listobjectiveresources) | **GET** /api/v1/study-objectives/{studyObjectiveId}/resources | List resources attached to a study objective
 *StudyObjectivesApi* | [**listStudyObjectiveQuizzes**](docs/StudyObjectivesApi.md#liststudyobjectivequizzes) | **GET** /api/v1/study-objectives/{studyObjectiveId}/quizzes | List quizzes and flashcards for a study objective
-*StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course
+*StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course or study space
 *StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective
 *StudyPlansApi* | [**deleteStudyPlan**](docs/StudyPlansApi.md#deletestudyplan) | **DELETE** /api/v1/study-plans/{planId} | Delete a study plan
 *StudyPlansApi* | [**getStudyObjectiveStudyPlan**](docs/StudyPlansApi.md#getstudyobjectivestudyplan) | **GET** /api/v1/study-objectives/{studyObjectiveId}/study-plan | Get a study objective\'s plan

package/dist/apis/StudyObjectivesApi.d.ts

@@ -49,9 +49,10 @@ export interface ListStudyObjectiveQuizzesRequest {
 }
 export interface ListStudyObjectivesRequest {
     xUserId: string;
-    courseId: string;
     limit?: number;
     cursor?: string;
+    courseId?: string;
+    studySpaceId?: string;
     status?: ListStudyObjectivesStatusEnum;
 }
 export interface UpdateStudyObjectiveRequest {
@@ -74,12 +75,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjective(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
@@ -128,13 +129,13 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     listStudyObjectiveQuizzes(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectivesRaw(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedStudyObjectives>>;
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
     /**

package/dist/apis/StudyObjectivesApi.js

@@ -76,7 +76,7 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters, initOverrides) {
@@ -111,7 +111,7 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjective(requestParameters, initOverrides) {
@@ -337,17 +337,14 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectivesRaw(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 listStudyObjectives().');
             }
-            if (requestParameters['courseId'] == null) {
-                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling listStudyObjectives().');
-            }
             const queryParameters = {};
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
@@ -358,6 +355,9 @@ class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['courseId'] != null) {
                 queryParameters['courseId'] = requestParameters['courseId'];
             }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
             if (requestParameters['status'] != null) {
                 queryParameters['status'] = requestParameters['status'];
             }
@@ -379,8 +379,8 @@ class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectives(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -49,9 +49,10 @@ export interface ListStudyObjectiveQuizzesRequest {
 }
 export interface ListStudyObjectivesRequest {
     xUserId: string;
-    courseId: string;
     limit?: number;
     cursor?: string;
+    courseId?: string;
+    studySpaceId?: string;
     status?: ListStudyObjectivesStatusEnum;
 }
 export interface UpdateStudyObjectiveRequest {
@@ -74,12 +75,12 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     createObjectiveResource(requestParameters: CreateObjectiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectiveResource>;
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudyObjective>>;
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjective(requestParameters: CreateStudyObjectiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudyObjective>;
@@ -128,13 +129,13 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
      */
     listStudyObjectiveQuizzes(requestParameters: ListStudyObjectiveQuizzesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedQuizzes>;
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectivesRaw(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedStudyObjectives>>;
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
     /**

package/dist/esm/apis/StudyObjectivesApi.js

@@ -73,7 +73,7 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjectiveRaw(requestParameters, initOverrides) {
@@ -108,7 +108,7 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a study objective. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. The X-Canvas-Domain header is required when `canvasObject` is present. Without `canvasObject`, this always inserts a new custom objective.
+     * Creates a study objective in one of the learner\'s study spaces, addressed either by `courseId` (the space for that Canvas course, created on first use) or by `studySpaceId` (an existing space, which is how an objective reaches a space that has no Canvas course). Exactly one of the two is required. An objective filed by `studySpaceId` inherits the space\'s course, so a space with no Canvas course produces an objective with no course id, reachable only through `GET ?studySpaceId=`. When the body includes `canvasObject` metadata, the Canvas object is mirrored into the source-of-truth table (upserted on its Canvas identity) and the objective is upserted on (user, Canvas object): re-syncing the same Canvas item updates the user\'s existing objective rather than inserting a duplicate. `canvasObject` requires `courseId` and the X-Canvas-Domain header. Without `canvasObject`, this always inserts a new custom objective.
      * Create or upsert a study objective
      */
     createStudyObjective(requestParameters, initOverrides) {
@@ -334,17 +334,14 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectivesRaw(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 listStudyObjectives().');
             }
-            if (requestParameters['courseId'] == null) {
-                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling listStudyObjectives().');
-            }
             const queryParameters = {};
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
@@ -355,6 +352,9 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
             if (requestParameters['courseId'] != null) {
                 queryParameters['courseId'] = requestParameters['courseId'];
             }
+            if (requestParameters['studySpaceId'] != null) {
+                queryParameters['studySpaceId'] = requestParameters['studySpaceId'];
+            }
             if (requestParameters['status'] != null) {
                 queryParameters['status'] = requestParameters['status'];
             }
@@ -376,8 +376,8 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
-     * List study objectives for a course
+     * Returns study objectives for the authenticated user within one scope, ordered by creation date (newest first). Scope is either `courseId` (every objective the learner has for that Canvas course) or `studySpaceId` (every objective filed in that space, which is the only way to reach a space that has no Canvas course). Exactly one of the two is required.
+     * List study objectives for a course or study space
      */
     listStudyObjectives(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -46,11 +46,11 @@ export interface AdminStudyObjectiveListItem {
      */
     source: AdminStudyObjectiveListItemSourceEnum;
     /**
-     * External course identifier
+     * External course identifier, or null for an objective in a study space with no Canvas course
      * @type {string}
      * @memberof AdminStudyObjectiveListItem
      */
-    courseId: string;
+    courseId: string | null;
     /**
      *
      * @type {string}

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

@@ -42,13 +42,19 @@ export interface CreateStudyObjectiveDto {
      */
     dueAt?: Date | null;
     /**
-     *
+     * Canvas course the objective belongs to. The learner's study space for this course is resolved (created on first use) and the objective is linked to it. Mutually exclusive with `studySpaceId`; exactly one of the two is required.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDto
+     */
+    courseId?: string;
+    /**
+     * Existing study space to file the objective in, addressed directly rather than through a Canvas course. Use this for a space with no Canvas course; the objective is created with no course id. Mutually exclusive with `courseId`; exactly one of the two is required.
      * @type {string}
      * @memberof CreateStudyObjectiveDto
      */
-    courseId: string;
+    studySpaceId?: 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.
+     * 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. Only meaningful alongside `courseId` — a space addressed by `studySpaceId` already exists and is renamed through the study-spaces endpoint.
      * @type {string}
      * @memberof CreateStudyObjectiveDto
      */

package/dist/esm/models/CreateStudyObjectiveDto.js

@@ -19,8 +19,6 @@ import { CreateStudyObjectiveDtoCanvasObjectFromJSON, CreateStudyObjectiveDtoCan
 export function instanceOfCreateStudyObjectiveDto(value) {
     if (!('title' in value) || value['title'] === undefined)
         return false;
-    if (!('courseId' in value) || value['courseId'] === undefined)
-        return false;
     return true;
 }
 export function CreateStudyObjectiveDtoFromJSON(json) {
@@ -35,7 +33,8 @@ export function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator)
         'notes': json['notes'] == null ? undefined : json['notes'],
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
-        'courseId': json['courseId'],
+        'courseId': json['courseId'] == null ? undefined : json['courseId'],
+        'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
         'courseName': json['courseName'] == null ? undefined : json['courseName'],
         'canvasObject': json['canvasObject'] == null ? undefined : CreateStudyObjectiveDtoCanvasObjectFromJSON(json['canvasObject']),
     };
@@ -53,6 +52,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'],
+        'studySpaceId': value['studySpaceId'],
         'courseName': value['courseName'],
         'canvasObject': CreateStudyObjectiveDtoCanvasObjectToJSON(value['canvasObject']),
     };

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

@@ -30,11 +30,17 @@ export interface StudyObjective {
      */
     accountUserId: string;
     /**
-     *
+     * Canvas course this objective belongs to, or null when it was filed into a study space that has no Canvas course. A null course id means no Canvas surface applies to the objective, and it is discoverable only through the space-scoped list (a single-item GET by id still works).
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    courseId: string | null;
+    /**
+     * study_spaces.id of the space this objective is filed in. The only route from an objective back to its space, which is what a client needs when `courseId` is null and no course can stand in for it. Null only on rows predating the study-space rollout.
      * @type {string}
      * @memberof StudyObjective
      */
-    courseId: string;
+    studySpaceId: string | null;
     /**
      * canvas_objects.id of the mirrored Canvas object this objective derives from, or null for user-created objectives.
      * @type {string}

package/dist/esm/models/StudyObjective.js

@@ -30,6 +30,8 @@ export function instanceOfStudyObjective(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
+        return false;
     if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
         return false;
     if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
@@ -65,6 +67,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
         'courseId': json['courseId'],
+        'studySpaceId': json['studySpaceId'],
         'canvasObjectId': json['canvasObjectId'],
         'canvasObjectRef': json['canvasObjectRef'],
         'source': json['source'],
@@ -89,6 +92,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'accountUserId': value['accountUserId'],
         'courseId': value['courseId'],
+        'studySpaceId': value['studySpaceId'],
         'canvasObjectId': value['canvasObjectId'],
         'canvasObjectRef': value['canvasObjectRef'],
         'source': value['source'],

package/dist/models/AdminStudyObjectiveListItem.d.ts

@@ -46,11 +46,11 @@ export interface AdminStudyObjectiveListItem {
      */
     source: AdminStudyObjectiveListItemSourceEnum;
     /**
-     * External course identifier
+     * External course identifier, or null for an objective in a study space with no Canvas course
      * @type {string}
      * @memberof AdminStudyObjectiveListItem
      */
-    courseId: string;
+    courseId: string | null;
     /**
      *
      * @type {string}

package/dist/models/CreateStudyObjectiveDto.d.ts

@@ -42,13 +42,19 @@ export interface CreateStudyObjectiveDto {
      */
     dueAt?: Date | null;
     /**
-     *
+     * Canvas course the objective belongs to. The learner's study space for this course is resolved (created on first use) and the objective is linked to it. Mutually exclusive with `studySpaceId`; exactly one of the two is required.
+     * @type {string}
+     * @memberof CreateStudyObjectiveDto
+     */
+    courseId?: string;
+    /**
+     * Existing study space to file the objective in, addressed directly rather than through a Canvas course. Use this for a space with no Canvas course; the objective is created with no course id. Mutually exclusive with `courseId`; exactly one of the two is required.
      * @type {string}
      * @memberof CreateStudyObjectiveDto
      */
-    courseId: string;
+    studySpaceId?: 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.
+     * 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. Only meaningful alongside `courseId` — a space addressed by `studySpaceId` already exists and is renamed through the study-spaces endpoint.
      * @type {string}
      * @memberof CreateStudyObjectiveDto
      */

package/dist/models/CreateStudyObjectiveDto.js

@@ -26,8 +26,6 @@ const CreateStudyObjectiveDtoCanvasObject_1 = require("./CreateStudyObjectiveDto
 function instanceOfCreateStudyObjectiveDto(value) {
     if (!('title' in value) || value['title'] === undefined)
         return false;
-    if (!('courseId' in value) || value['courseId'] === undefined)
-        return false;
     return true;
 }
 function CreateStudyObjectiveDtoFromJSON(json) {
@@ -42,7 +40,8 @@ function CreateStudyObjectiveDtoFromJSONTyped(json, ignoreDiscriminator) {
         'notes': json['notes'] == null ? undefined : json['notes'],
         'canvasDocuments': json['canvasDocuments'] == null ? undefined : (json['canvasDocuments'].map(CreateStudyObjectiveDtoCanvasDocumentsInner_1.CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON)),
         'dueAt': json['dueAt'] == null ? undefined : (new Date(json['dueAt'])),
-        'courseId': json['courseId'],
+        'courseId': json['courseId'] == null ? undefined : json['courseId'],
+        'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
         'courseName': json['courseName'] == null ? undefined : json['courseName'],
         'canvasObject': json['canvasObject'] == null ? undefined : (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectFromJSON)(json['canvasObject']),
     };
@@ -60,6 +59,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'],
+        'studySpaceId': value['studySpaceId'],
         'courseName': value['courseName'],
         'canvasObject': (0, CreateStudyObjectiveDtoCanvasObject_1.CreateStudyObjectiveDtoCanvasObjectToJSON)(value['canvasObject']),
     };

package/dist/models/StudyObjective.d.ts

@@ -30,11 +30,17 @@ export interface StudyObjective {
      */
     accountUserId: string;
     /**
-     *
+     * Canvas course this objective belongs to, or null when it was filed into a study space that has no Canvas course. A null course id means no Canvas surface applies to the objective, and it is discoverable only through the space-scoped list (a single-item GET by id still works).
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    courseId: string | null;
+    /**
+     * study_spaces.id of the space this objective is filed in. The only route from an objective back to its space, which is what a client needs when `courseId` is null and no course can stand in for it. Null only on rows predating the study-space rollout.
      * @type {string}
      * @memberof StudyObjective
      */
-    courseId: string;
+    studySpaceId: string | null;
     /**
      * canvas_objects.id of the mirrored Canvas object this objective derives from, or null for user-created objectives.
      * @type {string}

package/dist/models/StudyObjective.js

@@ -38,6 +38,8 @@ function instanceOfStudyObjective(value) {
         return false;
     if (!('courseId' in value) || value['courseId'] === undefined)
         return false;
+    if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
+        return false;
     if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
         return false;
     if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
@@ -73,6 +75,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'accountUserId': json['accountUserId'],
         'courseId': json['courseId'],
+        'studySpaceId': json['studySpaceId'],
         'canvasObjectId': json['canvasObjectId'],
         'canvasObjectRef': json['canvasObjectRef'],
         'source': json['source'],
@@ -97,6 +100,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'accountUserId': value['accountUserId'],
         'courseId': value['courseId'],
+        'studySpaceId': value['studySpaceId'],
         'canvasObjectId': value['canvasObjectId'],
         'canvasObjectRef': value['canvasObjectRef'],
         'source': value['source'],

package/package.json

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