@instructure/athena-api-client 3.33.7 → 3.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/apis/StudyObjectivesApi.d.ts +16 -1
- package/dist/apis/StudyObjectivesApi.js +43 -0
- package/dist/esm/apis/StudyObjectivesApi.d.ts +16 -1
- package/dist/esm/apis/StudyObjectivesApi.js +44 -1
- package/dist/esm/models/UpcomingStudyObjective.d.ts +132 -0
- package/dist/esm/models/UpcomingStudyObjective.js +112 -0
- package/dist/esm/models/UpcomingStudyObjectives.d.ts +33 -0
- package/dist/esm/models/UpcomingStudyObjectives.js +44 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/UpcomingStudyObjective.d.ts +132 -0
- package/dist/models/UpcomingStudyObjective.js +120 -0
- package/dist/models/UpcomingStudyObjectives.d.ts +33 -0
- package/dist/models/UpcomingStudyObjectives.js +51 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -143,6 +143,7 @@ All URIs are relative to *http://localhost:3000*
|
|
|
143
143
|
*StudyObjectivesApi* | [**listObjectiveResources**](docs/StudyObjectivesApi.md#listobjectiveresources) | **GET** /api/v1/study-objectives/{studyObjectiveId}/resources | List resources attached to a study objective
|
|
144
144
|
*StudyObjectivesApi* | [**listStudyObjectiveQuizzes**](docs/StudyObjectivesApi.md#liststudyobjectivequizzes) | **GET** /api/v1/study-objectives/{studyObjectiveId}/quizzes | List quizzes and flashcards for a study objective
|
|
145
145
|
*StudyObjectivesApi* | [**listStudyObjectives**](docs/StudyObjectivesApi.md#liststudyobjectives) | **GET** /api/v1/study-objectives | List study objectives for a course or study space
|
|
146
|
+
*StudyObjectivesApi* | [**listUpcomingStudyObjectives**](docs/StudyObjectivesApi.md#listupcomingstudyobjectives) | **GET** /api/v1/study-objectives/upcoming | List the learner\'s study objectives falling due soon
|
|
146
147
|
*StudyObjectivesApi* | [**updateStudyObjective**](docs/StudyObjectivesApi.md#updatestudyobjective) | **PATCH** /api/v1/study-objectives/{studyObjectiveId} | Update a study objective
|
|
147
148
|
*StudyPlansApi* | [**deleteStudyPlan**](docs/StudyPlansApi.md#deletestudyplan) | **DELETE** /api/v1/study-plans/{planId} | Delete a study plan
|
|
148
149
|
*StudyPlansApi* | [**getChatStudyPlanActivity**](docs/StudyPlansApi.md#getchatstudyplanactivity) | **GET** /api/v1/chats/{chatId}/study-plan-activity | Get the study plan activity a chat was launched from
|
|
@@ -328,6 +329,8 @@ All URIs are relative to *http://localhost:3000*
|
|
|
328
329
|
- [TriggerStudyObjectiveConceptExtractionResponse](docs/TriggerStudyObjectiveConceptExtractionResponse.md)
|
|
329
330
|
- [TriggerSyllabusAnalysisRequest](docs/TriggerSyllabusAnalysisRequest.md)
|
|
330
331
|
- [TriggerSyllabusAnalysisRequestFile](docs/TriggerSyllabusAnalysisRequestFile.md)
|
|
332
|
+
- [UpcomingStudyObjective](docs/UpcomingStudyObjective.md)
|
|
333
|
+
- [UpcomingStudyObjectives](docs/UpcomingStudyObjectives.md)
|
|
331
334
|
- [UpdateAccountDto](docs/UpdateAccountDto.md)
|
|
332
335
|
- [UpdateActivityCompletionDto](docs/UpdateActivityCompletionDto.md)
|
|
333
336
|
- [UpdateChatRequest](docs/UpdateChatRequest.md)
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
|
|
13
|
+
import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpcomingStudyObjectives, UpdateStudyObjectiveDto } from '../models/index';
|
|
14
14
|
export interface CreateObjectiveResourceRequest {
|
|
15
15
|
xUserId: string;
|
|
16
16
|
studyObjectiveId: string;
|
|
@@ -55,6 +55,11 @@ export interface ListStudyObjectivesRequest {
|
|
|
55
55
|
studySpaceId?: string;
|
|
56
56
|
status?: ListStudyObjectivesStatusEnum;
|
|
57
57
|
}
|
|
58
|
+
export interface ListUpcomingStudyObjectivesRequest {
|
|
59
|
+
xUserId: string;
|
|
60
|
+
withinDays?: number;
|
|
61
|
+
limit?: number;
|
|
62
|
+
}
|
|
58
63
|
export interface UpdateStudyObjectiveRequest {
|
|
59
64
|
xUserId: string;
|
|
60
65
|
studyObjectiveId: string;
|
|
@@ -138,6 +143,16 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
|
|
|
138
143
|
* List study objectives for a course or study space
|
|
139
144
|
*/
|
|
140
145
|
listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
|
|
146
|
+
/**
|
|
147
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
148
|
+
* List the learner\'s study objectives falling due soon
|
|
149
|
+
*/
|
|
150
|
+
listUpcomingStudyObjectivesRaw(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpcomingStudyObjectives>>;
|
|
151
|
+
/**
|
|
152
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
153
|
+
* List the learner\'s study objectives falling due soon
|
|
154
|
+
*/
|
|
155
|
+
listUpcomingStudyObjectives(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpcomingStudyObjectives>;
|
|
141
156
|
/**
|
|
142
157
|
* Update a study objective
|
|
143
158
|
*/
|
|
@@ -388,6 +388,49 @@ class StudyObjectivesApi extends runtime.BaseAPI {
|
|
|
388
388
|
return yield response.value();
|
|
389
389
|
});
|
|
390
390
|
}
|
|
391
|
+
/**
|
|
392
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
393
|
+
* List the learner\'s study objectives falling due soon
|
|
394
|
+
*/
|
|
395
|
+
listUpcomingStudyObjectivesRaw(requestParameters, initOverrides) {
|
|
396
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
397
|
+
if (requestParameters['xUserId'] == null) {
|
|
398
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listUpcomingStudyObjectives().');
|
|
399
|
+
}
|
|
400
|
+
const queryParameters = {};
|
|
401
|
+
if (requestParameters['withinDays'] != null) {
|
|
402
|
+
queryParameters['withinDays'] = requestParameters['withinDays'];
|
|
403
|
+
}
|
|
404
|
+
if (requestParameters['limit'] != null) {
|
|
405
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
406
|
+
}
|
|
407
|
+
const headerParameters = {};
|
|
408
|
+
if (requestParameters['xUserId'] != null) {
|
|
409
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
410
|
+
}
|
|
411
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
412
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
413
|
+
}
|
|
414
|
+
let urlPath = `/api/v1/study-objectives/upcoming`;
|
|
415
|
+
const response = yield this.request({
|
|
416
|
+
path: urlPath,
|
|
417
|
+
method: 'GET',
|
|
418
|
+
headers: headerParameters,
|
|
419
|
+
query: queryParameters,
|
|
420
|
+
}, initOverrides);
|
|
421
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpcomingStudyObjectivesFromJSON)(jsonValue));
|
|
422
|
+
});
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
426
|
+
* List the learner\'s study objectives falling due soon
|
|
427
|
+
*/
|
|
428
|
+
listUpcomingStudyObjectives(requestParameters, initOverrides) {
|
|
429
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
430
|
+
const response = yield this.listUpcomingStudyObjectivesRaw(requestParameters, initOverrides);
|
|
431
|
+
return yield response.value();
|
|
432
|
+
});
|
|
433
|
+
}
|
|
391
434
|
/**
|
|
392
435
|
* Update a study objective
|
|
393
436
|
*/
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpdateStudyObjectiveDto } from '../models/index';
|
|
13
|
+
import type { CreateObjectiveResourceDto, CreateStudyObjectiveDto, ObjectiveResource, PaginatedObjectiveResources, PaginatedQuizzes, PaginatedStudyObjectives, StudyObjective, UpcomingStudyObjectives, UpdateStudyObjectiveDto } from '../models/index';
|
|
14
14
|
export interface CreateObjectiveResourceRequest {
|
|
15
15
|
xUserId: string;
|
|
16
16
|
studyObjectiveId: string;
|
|
@@ -55,6 +55,11 @@ export interface ListStudyObjectivesRequest {
|
|
|
55
55
|
studySpaceId?: string;
|
|
56
56
|
status?: ListStudyObjectivesStatusEnum;
|
|
57
57
|
}
|
|
58
|
+
export interface ListUpcomingStudyObjectivesRequest {
|
|
59
|
+
xUserId: string;
|
|
60
|
+
withinDays?: number;
|
|
61
|
+
limit?: number;
|
|
62
|
+
}
|
|
58
63
|
export interface UpdateStudyObjectiveRequest {
|
|
59
64
|
xUserId: string;
|
|
60
65
|
studyObjectiveId: string;
|
|
@@ -138,6 +143,16 @@ export declare class StudyObjectivesApi extends runtime.BaseAPI {
|
|
|
138
143
|
* List study objectives for a course or study space
|
|
139
144
|
*/
|
|
140
145
|
listStudyObjectives(requestParameters: ListStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedStudyObjectives>;
|
|
146
|
+
/**
|
|
147
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
148
|
+
* List the learner\'s study objectives falling due soon
|
|
149
|
+
*/
|
|
150
|
+
listUpcomingStudyObjectivesRaw(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpcomingStudyObjectives>>;
|
|
151
|
+
/**
|
|
152
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
153
|
+
* List the learner\'s study objectives falling due soon
|
|
154
|
+
*/
|
|
155
|
+
listUpcomingStudyObjectives(requestParameters: ListUpcomingStudyObjectivesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpcomingStudyObjectives>;
|
|
141
156
|
/**
|
|
142
157
|
* Update a study objective
|
|
143
158
|
*/
|
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { CreateObjectiveResourceDtoToJSON, CreateStudyObjectiveDtoToJSON, ObjectiveResourceFromJSON, PaginatedObjectiveResourcesFromJSON, PaginatedQuizzesFromJSON, PaginatedStudyObjectivesFromJSON, StudyObjectiveFromJSON, UpdateStudyObjectiveDtoToJSON, } from '../models/index';
|
|
24
|
+
import { CreateObjectiveResourceDtoToJSON, CreateStudyObjectiveDtoToJSON, ObjectiveResourceFromJSON, PaginatedObjectiveResourcesFromJSON, PaginatedQuizzesFromJSON, PaginatedStudyObjectivesFromJSON, StudyObjectiveFromJSON, UpcomingStudyObjectivesFromJSON, UpdateStudyObjectiveDtoToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -385,6 +385,49 @@ export class StudyObjectivesApi extends runtime.BaseAPI {
|
|
|
385
385
|
return yield response.value();
|
|
386
386
|
});
|
|
387
387
|
}
|
|
388
|
+
/**
|
|
389
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
390
|
+
* List the learner\'s study objectives falling due soon
|
|
391
|
+
*/
|
|
392
|
+
listUpcomingStudyObjectivesRaw(requestParameters, initOverrides) {
|
|
393
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
394
|
+
if (requestParameters['xUserId'] == null) {
|
|
395
|
+
throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listUpcomingStudyObjectives().');
|
|
396
|
+
}
|
|
397
|
+
const queryParameters = {};
|
|
398
|
+
if (requestParameters['withinDays'] != null) {
|
|
399
|
+
queryParameters['withinDays'] = requestParameters['withinDays'];
|
|
400
|
+
}
|
|
401
|
+
if (requestParameters['limit'] != null) {
|
|
402
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
403
|
+
}
|
|
404
|
+
const headerParameters = {};
|
|
405
|
+
if (requestParameters['xUserId'] != null) {
|
|
406
|
+
headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
|
|
407
|
+
}
|
|
408
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
409
|
+
headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
|
|
410
|
+
}
|
|
411
|
+
let urlPath = `/api/v1/study-objectives/upcoming`;
|
|
412
|
+
const response = yield this.request({
|
|
413
|
+
path: urlPath,
|
|
414
|
+
method: 'GET',
|
|
415
|
+
headers: headerParameters,
|
|
416
|
+
query: queryParameters,
|
|
417
|
+
}, initOverrides);
|
|
418
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => UpcomingStudyObjectivesFromJSON(jsonValue));
|
|
419
|
+
});
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* Returns the authenticated user\'s active study objectives whose due date falls inside a look-ahead window, soonest due first. This is the only study-objective read scoped to the user rather than to a course or a study space: it spans every study space the learner has, including spaces with no Canvas course (whose objectives carry a null `courseId` and are otherwise reachable only by knowing the space id), so a caller building date-aware outreach does not have to fan out per space and re-sort client-side. A row is included when it has a due date, that date is in the future, and it is no further out than `withinDays`. Overdue objectives are excluded — the window starts at the current time, not at the start of today — as are objectives with no due date and objectives the learner has archived. Both `source` values (`user` and `syllabus`) are returned; nothing here distinguishes an objective the learner typed from one derived from a syllabus. Ordering is by due date ascending, then by id ascending, so objectives sharing a due date come back in a stable order across calls. Each item carries the full study-objective shape plus `studySpaceTitle`, the name of the space it belongs to, for copy that needs to name the course. There is no cursor: the window and `limit` bound the response, and a caller that needs more should widen `withinDays` rather than page.
|
|
423
|
+
* List the learner\'s study objectives falling due soon
|
|
424
|
+
*/
|
|
425
|
+
listUpcomingStudyObjectives(requestParameters, initOverrides) {
|
|
426
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
427
|
+
const response = yield this.listUpcomingStudyObjectivesRaw(requestParameters, initOverrides);
|
|
428
|
+
return yield response.value();
|
|
429
|
+
});
|
|
430
|
+
}
|
|
388
431
|
/**
|
|
389
432
|
* Update a study objective
|
|
390
433
|
*/
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { StudyObjectiveFileAttachment } from './StudyObjectiveFileAttachment';
|
|
13
|
+
import type { StudyObjectiveCanvasDocument } from './StudyObjectiveCanvasDocument';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface UpcomingStudyObjective
|
|
18
|
+
*/
|
|
19
|
+
export interface UpcomingStudyObjective {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof UpcomingStudyObjective
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof UpcomingStudyObjective
|
|
30
|
+
*/
|
|
31
|
+
accountUserId: string;
|
|
32
|
+
/**
|
|
33
|
+
* 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).
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof UpcomingStudyObjective
|
|
36
|
+
*/
|
|
37
|
+
courseId: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* 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.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof UpcomingStudyObjective
|
|
42
|
+
*/
|
|
43
|
+
studySpaceId: string | null;
|
|
44
|
+
/**
|
|
45
|
+
* canvas_objects.id of the mirrored Canvas object this objective derives from, or null for user-created objectives.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof UpcomingStudyObjective
|
|
48
|
+
*/
|
|
49
|
+
canvasObjectId: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* Canvas-native reference of the mirrored object ('{type}:{local_id}', e.g. 'assignment:67890'), or null for custom/syllabus objectives. A stable join key for pairing a read-back objective with its live Canvas candidate without an upsert round-trip.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof UpcomingStudyObjective
|
|
54
|
+
*/
|
|
55
|
+
canvasObjectRef: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof UpcomingStudyObjective
|
|
60
|
+
*/
|
|
61
|
+
source: UpcomingStudyObjectiveSourceEnum;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof UpcomingStudyObjective
|
|
66
|
+
*/
|
|
67
|
+
title: string;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof UpcomingStudyObjective
|
|
72
|
+
*/
|
|
73
|
+
notes: string | null;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {Array<StudyObjectiveFileAttachment>}
|
|
77
|
+
* @memberof UpcomingStudyObjective
|
|
78
|
+
*/
|
|
79
|
+
fileAttachments: Array<StudyObjectiveFileAttachment>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {Array<StudyObjectiveCanvasDocument>}
|
|
83
|
+
* @memberof UpcomingStudyObjective
|
|
84
|
+
*/
|
|
85
|
+
canvasDocuments: Array<StudyObjectiveCanvasDocument>;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {Date}
|
|
89
|
+
* @memberof UpcomingStudyObjective
|
|
90
|
+
*/
|
|
91
|
+
dueAt: Date | null;
|
|
92
|
+
/**
|
|
93
|
+
* When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
|
|
94
|
+
* @type {Date}
|
|
95
|
+
* @memberof UpcomingStudyObjective
|
|
96
|
+
*/
|
|
97
|
+
archivedAt: Date | null;
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @type {Date}
|
|
101
|
+
* @memberof UpcomingStudyObjective
|
|
102
|
+
*/
|
|
103
|
+
createdAt: Date;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {Date}
|
|
107
|
+
* @memberof UpcomingStudyObjective
|
|
108
|
+
*/
|
|
109
|
+
updatedAt: Date;
|
|
110
|
+
/**
|
|
111
|
+
* Title of the study space this objective is filed in, so a caller can name the course without a second round trip per objective. Null when the objective has no study space, or when the space has not been named yet — a space's title is empty until a course name or a rename fills it, and an empty title is reported as null rather than as a blank string so callers have one 'no name' case to handle.
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof UpcomingStudyObjective
|
|
114
|
+
*/
|
|
115
|
+
studySpaceTitle: string | null;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* @export
|
|
119
|
+
*/
|
|
120
|
+
export declare const UpcomingStudyObjectiveSourceEnum: {
|
|
121
|
+
readonly User: "user";
|
|
122
|
+
readonly Syllabus: "syllabus";
|
|
123
|
+
};
|
|
124
|
+
export type UpcomingStudyObjectiveSourceEnum = typeof UpcomingStudyObjectiveSourceEnum[keyof typeof UpcomingStudyObjectiveSourceEnum];
|
|
125
|
+
/**
|
|
126
|
+
* Check if a given object implements the UpcomingStudyObjective interface.
|
|
127
|
+
*/
|
|
128
|
+
export declare function instanceOfUpcomingStudyObjective(value: object): value is UpcomingStudyObjective;
|
|
129
|
+
export declare function UpcomingStudyObjectiveFromJSON(json: any): UpcomingStudyObjective;
|
|
130
|
+
export declare function UpcomingStudyObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpcomingStudyObjective;
|
|
131
|
+
export declare function UpcomingStudyObjectiveToJSON(json: any): UpcomingStudyObjective;
|
|
132
|
+
export declare function UpcomingStudyObjectiveToJSONTyped(value?: UpcomingStudyObjective | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { StudyObjectiveFileAttachmentFromJSON, StudyObjectiveFileAttachmentToJSON, } from './StudyObjectiveFileAttachment';
|
|
15
|
+
import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSON, } from './StudyObjectiveCanvasDocument';
|
|
16
|
+
/**
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const UpcomingStudyObjectiveSourceEnum = {
|
|
20
|
+
User: 'user',
|
|
21
|
+
Syllabus: 'syllabus'
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the UpcomingStudyObjective interface.
|
|
25
|
+
*/
|
|
26
|
+
export function instanceOfUpcomingStudyObjective(value) {
|
|
27
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('accountUserId' in value) || value['accountUserId'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('notes' in value) || value['notes'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('canvasDocuments' in value) || value['canvasDocuments'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('dueAt' in value) || value['dueAt'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('archivedAt' in value) || value['archivedAt'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('studySpaceTitle' in value) || value['studySpaceTitle'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
return true;
|
|
60
|
+
}
|
|
61
|
+
export function UpcomingStudyObjectiveFromJSON(json) {
|
|
62
|
+
return UpcomingStudyObjectiveFromJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
export function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
|
|
65
|
+
if (json == null) {
|
|
66
|
+
return json;
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
'id': json['id'],
|
|
70
|
+
'accountUserId': json['accountUserId'],
|
|
71
|
+
'courseId': json['courseId'],
|
|
72
|
+
'studySpaceId': json['studySpaceId'],
|
|
73
|
+
'canvasObjectId': json['canvasObjectId'],
|
|
74
|
+
'canvasObjectRef': json['canvasObjectRef'],
|
|
75
|
+
'source': json['source'],
|
|
76
|
+
'title': json['title'],
|
|
77
|
+
'notes': json['notes'],
|
|
78
|
+
'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
|
|
79
|
+
'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
|
|
80
|
+
'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
|
|
81
|
+
'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
|
|
82
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
83
|
+
'updatedAt': (new Date(json['updatedAt'])),
|
|
84
|
+
'studySpaceTitle': json['studySpaceTitle'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
export function UpcomingStudyObjectiveToJSON(json) {
|
|
88
|
+
return UpcomingStudyObjectiveToJSONTyped(json, false);
|
|
89
|
+
}
|
|
90
|
+
export function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
|
|
91
|
+
if (value == null) {
|
|
92
|
+
return value;
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
'id': value['id'],
|
|
96
|
+
'accountUserId': value['accountUserId'],
|
|
97
|
+
'courseId': value['courseId'],
|
|
98
|
+
'studySpaceId': value['studySpaceId'],
|
|
99
|
+
'canvasObjectId': value['canvasObjectId'],
|
|
100
|
+
'canvasObjectRef': value['canvasObjectRef'],
|
|
101
|
+
'source': value['source'],
|
|
102
|
+
'title': value['title'],
|
|
103
|
+
'notes': value['notes'],
|
|
104
|
+
'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
|
|
105
|
+
'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
|
|
106
|
+
'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
|
|
107
|
+
'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
|
|
108
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
109
|
+
'updatedAt': value['updatedAt'].toISOString(),
|
|
110
|
+
'studySpaceTitle': value['studySpaceTitle'],
|
|
111
|
+
};
|
|
112
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { UpcomingStudyObjective } from './UpcomingStudyObjective';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpcomingStudyObjectives
|
|
17
|
+
*/
|
|
18
|
+
export interface UpcomingStudyObjectives {
|
|
19
|
+
/**
|
|
20
|
+
* Upcoming study objectives, soonest due first. No cursor: the response is bounded by the window and the limit.
|
|
21
|
+
* @type {Array<UpcomingStudyObjective>}
|
|
22
|
+
* @memberof UpcomingStudyObjectives
|
|
23
|
+
*/
|
|
24
|
+
data: Array<UpcomingStudyObjective>;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the UpcomingStudyObjectives interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfUpcomingStudyObjectives(value: object): value is UpcomingStudyObjectives;
|
|
30
|
+
export declare function UpcomingStudyObjectivesFromJSON(json: any): UpcomingStudyObjectives;
|
|
31
|
+
export declare function UpcomingStudyObjectivesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpcomingStudyObjectives;
|
|
32
|
+
export declare function UpcomingStudyObjectivesToJSON(json: any): UpcomingStudyObjectives;
|
|
33
|
+
export declare function UpcomingStudyObjectivesToJSONTyped(value?: UpcomingStudyObjectives | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Athena API
|
|
5
|
+
* REST API for the Athena system
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { UpcomingStudyObjectiveFromJSON, UpcomingStudyObjectiveToJSON, } from './UpcomingStudyObjective';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the UpcomingStudyObjectives interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfUpcomingStudyObjectives(value) {
|
|
19
|
+
if (!('data' in value) || value['data'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
return true;
|
|
22
|
+
}
|
|
23
|
+
export function UpcomingStudyObjectivesFromJSON(json) {
|
|
24
|
+
return UpcomingStudyObjectivesFromJSONTyped(json, false);
|
|
25
|
+
}
|
|
26
|
+
export function UpcomingStudyObjectivesFromJSONTyped(json, ignoreDiscriminator) {
|
|
27
|
+
if (json == null) {
|
|
28
|
+
return json;
|
|
29
|
+
}
|
|
30
|
+
return {
|
|
31
|
+
'data': (json['data'].map(UpcomingStudyObjectiveFromJSON)),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function UpcomingStudyObjectivesToJSON(json) {
|
|
35
|
+
return UpcomingStudyObjectivesToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function UpcomingStudyObjectivesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'data': (value['data'].map(UpcomingStudyObjectiveToJSON)),
|
|
43
|
+
};
|
|
44
|
+
}
|
|
@@ -141,6 +141,8 @@ export * from './TriggerStudyObjectiveConceptExtractionRequest';
|
|
|
141
141
|
export * from './TriggerStudyObjectiveConceptExtractionResponse';
|
|
142
142
|
export * from './TriggerSyllabusAnalysisRequest';
|
|
143
143
|
export * from './TriggerSyllabusAnalysisRequestFile';
|
|
144
|
+
export * from './UpcomingStudyObjective';
|
|
145
|
+
export * from './UpcomingStudyObjectives';
|
|
144
146
|
export * from './UpdateAccountDto';
|
|
145
147
|
export * from './UpdateActivityCompletionDto';
|
|
146
148
|
export * from './UpdateChatRequest';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -143,6 +143,8 @@ export * from './TriggerStudyObjectiveConceptExtractionRequest';
|
|
|
143
143
|
export * from './TriggerStudyObjectiveConceptExtractionResponse';
|
|
144
144
|
export * from './TriggerSyllabusAnalysisRequest';
|
|
145
145
|
export * from './TriggerSyllabusAnalysisRequestFile';
|
|
146
|
+
export * from './UpcomingStudyObjective';
|
|
147
|
+
export * from './UpcomingStudyObjectives';
|
|
146
148
|
export * from './UpdateAccountDto';
|
|
147
149
|
export * from './UpdateActivityCompletionDto';
|
|
148
150
|
export * from './UpdateChatRequest';
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { StudyObjectiveFileAttachment } from './StudyObjectiveFileAttachment';
|
|
13
|
+
import type { StudyObjectiveCanvasDocument } from './StudyObjectiveCanvasDocument';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface UpcomingStudyObjective
|
|
18
|
+
*/
|
|
19
|
+
export interface UpcomingStudyObjective {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof UpcomingStudyObjective
|
|
24
|
+
*/
|
|
25
|
+
id: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof UpcomingStudyObjective
|
|
30
|
+
*/
|
|
31
|
+
accountUserId: string;
|
|
32
|
+
/**
|
|
33
|
+
* 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).
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof UpcomingStudyObjective
|
|
36
|
+
*/
|
|
37
|
+
courseId: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* 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.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof UpcomingStudyObjective
|
|
42
|
+
*/
|
|
43
|
+
studySpaceId: string | null;
|
|
44
|
+
/**
|
|
45
|
+
* canvas_objects.id of the mirrored Canvas object this objective derives from, or null for user-created objectives.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof UpcomingStudyObjective
|
|
48
|
+
*/
|
|
49
|
+
canvasObjectId: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* Canvas-native reference of the mirrored object ('{type}:{local_id}', e.g. 'assignment:67890'), or null for custom/syllabus objectives. A stable join key for pairing a read-back objective with its live Canvas candidate without an upsert round-trip.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof UpcomingStudyObjective
|
|
54
|
+
*/
|
|
55
|
+
canvasObjectRef: string | null;
|
|
56
|
+
/**
|
|
57
|
+
* Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof UpcomingStudyObjective
|
|
60
|
+
*/
|
|
61
|
+
source: UpcomingStudyObjectiveSourceEnum;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof UpcomingStudyObjective
|
|
66
|
+
*/
|
|
67
|
+
title: string;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof UpcomingStudyObjective
|
|
72
|
+
*/
|
|
73
|
+
notes: string | null;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {Array<StudyObjectiveFileAttachment>}
|
|
77
|
+
* @memberof UpcomingStudyObjective
|
|
78
|
+
*/
|
|
79
|
+
fileAttachments: Array<StudyObjectiveFileAttachment>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {Array<StudyObjectiveCanvasDocument>}
|
|
83
|
+
* @memberof UpcomingStudyObjective
|
|
84
|
+
*/
|
|
85
|
+
canvasDocuments: Array<StudyObjectiveCanvasDocument>;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {Date}
|
|
89
|
+
* @memberof UpcomingStudyObjective
|
|
90
|
+
*/
|
|
91
|
+
dueAt: Date | null;
|
|
92
|
+
/**
|
|
93
|
+
* When this objective was archived, or null if it is active. Per-user state; archiving never affects the shared Canvas object or other students' objectives.
|
|
94
|
+
* @type {Date}
|
|
95
|
+
* @memberof UpcomingStudyObjective
|
|
96
|
+
*/
|
|
97
|
+
archivedAt: Date | null;
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @type {Date}
|
|
101
|
+
* @memberof UpcomingStudyObjective
|
|
102
|
+
*/
|
|
103
|
+
createdAt: Date;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {Date}
|
|
107
|
+
* @memberof UpcomingStudyObjective
|
|
108
|
+
*/
|
|
109
|
+
updatedAt: Date;
|
|
110
|
+
/**
|
|
111
|
+
* Title of the study space this objective is filed in, so a caller can name the course without a second round trip per objective. Null when the objective has no study space, or when the space has not been named yet — a space's title is empty until a course name or a rename fills it, and an empty title is reported as null rather than as a blank string so callers have one 'no name' case to handle.
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof UpcomingStudyObjective
|
|
114
|
+
*/
|
|
115
|
+
studySpaceTitle: string | null;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* @export
|
|
119
|
+
*/
|
|
120
|
+
export declare const UpcomingStudyObjectiveSourceEnum: {
|
|
121
|
+
readonly User: "user";
|
|
122
|
+
readonly Syllabus: "syllabus";
|
|
123
|
+
};
|
|
124
|
+
export type UpcomingStudyObjectiveSourceEnum = typeof UpcomingStudyObjectiveSourceEnum[keyof typeof UpcomingStudyObjectiveSourceEnum];
|
|
125
|
+
/**
|
|
126
|
+
* Check if a given object implements the UpcomingStudyObjective interface.
|
|
127
|
+
*/
|
|
128
|
+
export declare function instanceOfUpcomingStudyObjective(value: object): value is UpcomingStudyObjective;
|
|
129
|
+
export declare function UpcomingStudyObjectiveFromJSON(json: any): UpcomingStudyObjective;
|
|
130
|
+
export declare function UpcomingStudyObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpcomingStudyObjective;
|
|
131
|
+
export declare function UpcomingStudyObjectiveToJSON(json: any): UpcomingStudyObjective;
|
|
132
|
+
export declare function UpcomingStudyObjectiveToJSONTyped(value?: UpcomingStudyObjective | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.UpcomingStudyObjectiveSourceEnum = void 0;
|
|
17
|
+
exports.instanceOfUpcomingStudyObjective = instanceOfUpcomingStudyObjective;
|
|
18
|
+
exports.UpcomingStudyObjectiveFromJSON = UpcomingStudyObjectiveFromJSON;
|
|
19
|
+
exports.UpcomingStudyObjectiveFromJSONTyped = UpcomingStudyObjectiveFromJSONTyped;
|
|
20
|
+
exports.UpcomingStudyObjectiveToJSON = UpcomingStudyObjectiveToJSON;
|
|
21
|
+
exports.UpcomingStudyObjectiveToJSONTyped = UpcomingStudyObjectiveToJSONTyped;
|
|
22
|
+
const StudyObjectiveFileAttachment_1 = require("./StudyObjectiveFileAttachment");
|
|
23
|
+
const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.UpcomingStudyObjectiveSourceEnum = {
|
|
28
|
+
User: 'user',
|
|
29
|
+
Syllabus: 'syllabus'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the UpcomingStudyObjective interface.
|
|
33
|
+
*/
|
|
34
|
+
function instanceOfUpcomingStudyObjective(value) {
|
|
35
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('accountUserId' in value) || value['accountUserId'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('studySpaceId' in value) || value['studySpaceId'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('canvasObjectRef' in value) || value['canvasObjectRef'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('notes' in value) || value['notes'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('canvasDocuments' in value) || value['canvasDocuments'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('dueAt' in value) || value['dueAt'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
if (!('archivedAt' in value) || value['archivedAt'] === undefined)
|
|
60
|
+
return false;
|
|
61
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('studySpaceTitle' in value) || value['studySpaceTitle'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
return true;
|
|
68
|
+
}
|
|
69
|
+
function UpcomingStudyObjectiveFromJSON(json) {
|
|
70
|
+
return UpcomingStudyObjectiveFromJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
function UpcomingStudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
|
|
73
|
+
if (json == null) {
|
|
74
|
+
return json;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
'id': json['id'],
|
|
78
|
+
'accountUserId': json['accountUserId'],
|
|
79
|
+
'courseId': json['courseId'],
|
|
80
|
+
'studySpaceId': json['studySpaceId'],
|
|
81
|
+
'canvasObjectId': json['canvasObjectId'],
|
|
82
|
+
'canvasObjectRef': json['canvasObjectRef'],
|
|
83
|
+
'source': json['source'],
|
|
84
|
+
'title': json['title'],
|
|
85
|
+
'notes': json['notes'],
|
|
86
|
+
'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
|
|
87
|
+
'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentFromJSON)),
|
|
88
|
+
'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
|
|
89
|
+
'archivedAt': (json['archivedAt'] == null ? null : new Date(json['archivedAt'])),
|
|
90
|
+
'createdAt': (new Date(json['createdAt'])),
|
|
91
|
+
'updatedAt': (new Date(json['updatedAt'])),
|
|
92
|
+
'studySpaceTitle': json['studySpaceTitle'],
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
function UpcomingStudyObjectiveToJSON(json) {
|
|
96
|
+
return UpcomingStudyObjectiveToJSONTyped(json, false);
|
|
97
|
+
}
|
|
98
|
+
function UpcomingStudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
|
|
99
|
+
if (value == null) {
|
|
100
|
+
return value;
|
|
101
|
+
}
|
|
102
|
+
return {
|
|
103
|
+
'id': value['id'],
|
|
104
|
+
'accountUserId': value['accountUserId'],
|
|
105
|
+
'courseId': value['courseId'],
|
|
106
|
+
'studySpaceId': value['studySpaceId'],
|
|
107
|
+
'canvasObjectId': value['canvasObjectId'],
|
|
108
|
+
'canvasObjectRef': value['canvasObjectRef'],
|
|
109
|
+
'source': value['source'],
|
|
110
|
+
'title': value['title'],
|
|
111
|
+
'notes': value['notes'],
|
|
112
|
+
'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
|
|
113
|
+
'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocument_1.StudyObjectiveCanvasDocumentToJSON)),
|
|
114
|
+
'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
|
|
115
|
+
'archivedAt': value['archivedAt'] == null ? value['archivedAt'] : value['archivedAt'].toISOString(),
|
|
116
|
+
'createdAt': value['createdAt'].toISOString(),
|
|
117
|
+
'updatedAt': value['updatedAt'].toISOString(),
|
|
118
|
+
'studySpaceTitle': value['studySpaceTitle'],
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Athena API
|
|
3
|
+
* REST API for the Athena system
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { UpcomingStudyObjective } from './UpcomingStudyObjective';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface UpcomingStudyObjectives
|
|
17
|
+
*/
|
|
18
|
+
export interface UpcomingStudyObjectives {
|
|
19
|
+
/**
|
|
20
|
+
* Upcoming study objectives, soonest due first. No cursor: the response is bounded by the window and the limit.
|
|
21
|
+
* @type {Array<UpcomingStudyObjective>}
|
|
22
|
+
* @memberof UpcomingStudyObjectives
|
|
23
|
+
*/
|
|
24
|
+
data: Array<UpcomingStudyObjective>;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the UpcomingStudyObjectives interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfUpcomingStudyObjectives(value: object): value is UpcomingStudyObjectives;
|
|
30
|
+
export declare function UpcomingStudyObjectivesFromJSON(json: any): UpcomingStudyObjectives;
|
|
31
|
+
export declare function UpcomingStudyObjectivesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpcomingStudyObjectives;
|
|
32
|
+
export declare function UpcomingStudyObjectivesToJSON(json: any): UpcomingStudyObjectives;
|
|
33
|
+
export declare function UpcomingStudyObjectivesToJSONTyped(value?: UpcomingStudyObjectives | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Athena API
|
|
6
|
+
* REST API for the Athena system
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfUpcomingStudyObjectives = instanceOfUpcomingStudyObjectives;
|
|
17
|
+
exports.UpcomingStudyObjectivesFromJSON = UpcomingStudyObjectivesFromJSON;
|
|
18
|
+
exports.UpcomingStudyObjectivesFromJSONTyped = UpcomingStudyObjectivesFromJSONTyped;
|
|
19
|
+
exports.UpcomingStudyObjectivesToJSON = UpcomingStudyObjectivesToJSON;
|
|
20
|
+
exports.UpcomingStudyObjectivesToJSONTyped = UpcomingStudyObjectivesToJSONTyped;
|
|
21
|
+
const UpcomingStudyObjective_1 = require("./UpcomingStudyObjective");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the UpcomingStudyObjectives interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfUpcomingStudyObjectives(value) {
|
|
26
|
+
if (!('data' in value) || value['data'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function UpcomingStudyObjectivesFromJSON(json) {
|
|
31
|
+
return UpcomingStudyObjectivesFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function UpcomingStudyObjectivesFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'data': (json['data'].map(UpcomingStudyObjective_1.UpcomingStudyObjectiveFromJSON)),
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
function UpcomingStudyObjectivesToJSON(json) {
|
|
42
|
+
return UpcomingStudyObjectivesToJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function UpcomingStudyObjectivesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
45
|
+
if (value == null) {
|
|
46
|
+
return value;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'data': (value['data'].map(UpcomingStudyObjective_1.UpcomingStudyObjectiveToJSON)),
|
|
50
|
+
};
|
|
51
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -141,6 +141,8 @@ export * from './TriggerStudyObjectiveConceptExtractionRequest';
|
|
|
141
141
|
export * from './TriggerStudyObjectiveConceptExtractionResponse';
|
|
142
142
|
export * from './TriggerSyllabusAnalysisRequest';
|
|
143
143
|
export * from './TriggerSyllabusAnalysisRequestFile';
|
|
144
|
+
export * from './UpcomingStudyObjective';
|
|
145
|
+
export * from './UpcomingStudyObjectives';
|
|
144
146
|
export * from './UpdateAccountDto';
|
|
145
147
|
export * from './UpdateActivityCompletionDto';
|
|
146
148
|
export * from './UpdateChatRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -159,6 +159,8 @@ __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequest"), exports
|
|
|
159
159
|
__exportStar(require("./TriggerStudyObjectiveConceptExtractionResponse"), exports);
|
|
160
160
|
__exportStar(require("./TriggerSyllabusAnalysisRequest"), exports);
|
|
161
161
|
__exportStar(require("./TriggerSyllabusAnalysisRequestFile"), exports);
|
|
162
|
+
__exportStar(require("./UpcomingStudyObjective"), exports);
|
|
163
|
+
__exportStar(require("./UpcomingStudyObjectives"), exports);
|
|
162
164
|
__exportStar(require("./UpdateAccountDto"), exports);
|
|
163
165
|
__exportStar(require("./UpdateActivityCompletionDto"), exports);
|
|
164
166
|
__exportStar(require("./UpdateChatRequest"), exports);
|