@instructure/athena-api-client 3.3.1 → 3.4.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 +7 -0
- package/dist/apis/SyllabusAnalysisApi.d.ts +48 -0
- package/dist/apis/SyllabusAnalysisApi.js +127 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/SyllabusAnalysisApi.d.ts +48 -0
- package/dist/esm/apis/SyllabusAnalysisApi.js +123 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/StudyObjective.d.ts +14 -0
- package/dist/esm/models/StudyObjective.js +11 -0
- package/dist/esm/models/SyllabusAnalysisObjective.d.ts +64 -0
- package/dist/esm/models/SyllabusAnalysisObjective.js +66 -0
- package/dist/esm/models/SyllabusAnalysisStatus.d.ts +56 -0
- package/dist/esm/models/SyllabusAnalysisStatus.js +62 -0
- package/dist/esm/models/SyllabusAnalysisStatusView.d.ts +55 -0
- package/dist/esm/models/SyllabusAnalysisStatusView.js +61 -0
- package/dist/esm/models/TriggerSyllabusAnalysisRequest.d.ts +51 -0
- package/dist/esm/models/TriggerSyllabusAnalysisRequest.js +52 -0
- package/dist/esm/models/TriggerSyllabusAnalysisRequestFile.d.ts +50 -0
- package/dist/esm/models/TriggerSyllabusAnalysisRequestFile.js +55 -0
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.js +5 -0
- package/dist/models/StudyObjective.d.ts +14 -0
- package/dist/models/StudyObjective.js +12 -0
- package/dist/models/SyllabusAnalysisObjective.d.ts +64 -0
- package/dist/models/SyllabusAnalysisObjective.js +74 -0
- package/dist/models/SyllabusAnalysisStatus.d.ts +56 -0
- package/dist/models/SyllabusAnalysisStatus.js +70 -0
- package/dist/models/SyllabusAnalysisStatusView.d.ts +55 -0
- package/dist/models/SyllabusAnalysisStatusView.js +69 -0
- package/dist/models/TriggerSyllabusAnalysisRequest.d.ts +51 -0
- package/dist/models/TriggerSyllabusAnalysisRequest.js +59 -0
- package/dist/models/TriggerSyllabusAnalysisRequestFile.d.ts +50 -0
- package/dist/models/TriggerSyllabusAnalysisRequestFile.js +62 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/package.json +1 -1
|
@@ -0,0 +1,56 @@
|
|
|
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 { SyllabusAnalysisObjective } from './SyllabusAnalysisObjective';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface SyllabusAnalysisStatus
|
|
17
|
+
*/
|
|
18
|
+
export interface SyllabusAnalysisStatus {
|
|
19
|
+
/**
|
|
20
|
+
* Sidecar status snapshot at the moment the trigger returned. `not_configured` means the feature is disabled and nothing was enqueued.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof SyllabusAnalysisStatus
|
|
23
|
+
*/
|
|
24
|
+
status: SyllabusAnalysisStatusStatusEnum;
|
|
25
|
+
/**
|
|
26
|
+
* Number of exams found by the last completed analysis (0 is a valid terminal outcome).
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof SyllabusAnalysisStatus
|
|
29
|
+
*/
|
|
30
|
+
foundCount: number;
|
|
31
|
+
/**
|
|
32
|
+
* Syllabus-derived study objectives for this course. Populated only when status is 'analyzed'; empty otherwise.
|
|
33
|
+
* @type {Array<SyllabusAnalysisObjective>}
|
|
34
|
+
* @memberof SyllabusAnalysisStatus
|
|
35
|
+
*/
|
|
36
|
+
objectives: Array<SyllabusAnalysisObjective>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @export
|
|
40
|
+
*/
|
|
41
|
+
export declare const SyllabusAnalysisStatusStatusEnum: {
|
|
42
|
+
readonly NotConfigured: "not_configured";
|
|
43
|
+
readonly Pending: "pending";
|
|
44
|
+
readonly Running: "running";
|
|
45
|
+
readonly Analyzed: "analyzed";
|
|
46
|
+
readonly Failed: "failed";
|
|
47
|
+
};
|
|
48
|
+
export type SyllabusAnalysisStatusStatusEnum = typeof SyllabusAnalysisStatusStatusEnum[keyof typeof SyllabusAnalysisStatusStatusEnum];
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the SyllabusAnalysisStatus interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfSyllabusAnalysisStatus(value: object): value is SyllabusAnalysisStatus;
|
|
53
|
+
export declare function SyllabusAnalysisStatusFromJSON(json: any): SyllabusAnalysisStatus;
|
|
54
|
+
export declare function SyllabusAnalysisStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyllabusAnalysisStatus;
|
|
55
|
+
export declare function SyllabusAnalysisStatusToJSON(json: any): SyllabusAnalysisStatus;
|
|
56
|
+
export declare function SyllabusAnalysisStatusToJSONTyped(value?: SyllabusAnalysisStatus | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,62 @@
|
|
|
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 { SyllabusAnalysisObjectiveFromJSON, SyllabusAnalysisObjectiveToJSON, } from './SyllabusAnalysisObjective';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const SyllabusAnalysisStatusStatusEnum = {
|
|
19
|
+
NotConfigured: 'not_configured',
|
|
20
|
+
Pending: 'pending',
|
|
21
|
+
Running: 'running',
|
|
22
|
+
Analyzed: 'analyzed',
|
|
23
|
+
Failed: 'failed'
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Check if a given object implements the SyllabusAnalysisStatus interface.
|
|
27
|
+
*/
|
|
28
|
+
export function instanceOfSyllabusAnalysisStatus(value) {
|
|
29
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('foundCount' in value) || value['foundCount'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('objectives' in value) || value['objectives'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
export function SyllabusAnalysisStatusFromJSON(json) {
|
|
38
|
+
return SyllabusAnalysisStatusFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
export function SyllabusAnalysisStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'status': json['status'],
|
|
46
|
+
'foundCount': json['foundCount'],
|
|
47
|
+
'objectives': (json['objectives'].map(SyllabusAnalysisObjectiveFromJSON)),
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
export function SyllabusAnalysisStatusToJSON(json) {
|
|
51
|
+
return SyllabusAnalysisStatusToJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
export function SyllabusAnalysisStatusToJSONTyped(value, ignoreDiscriminator = false) {
|
|
54
|
+
if (value == null) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'status': value['status'],
|
|
59
|
+
'foundCount': value['foundCount'],
|
|
60
|
+
'objectives': (value['objectives'].map(SyllabusAnalysisObjectiveToJSON)),
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SyllabusAnalysisStatusView
|
|
16
|
+
*/
|
|
17
|
+
export interface SyllabusAnalysisStatusView {
|
|
18
|
+
/**
|
|
19
|
+
* Analysis lifecycle for this student+course. `not_yet` means no analysis has run (a normal state, never a 404).
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SyllabusAnalysisStatusView
|
|
22
|
+
*/
|
|
23
|
+
status: SyllabusAnalysisStatusViewStatusEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Number of exams found by the last completed analysis (0 is a valid terminal outcome; 0 when not_yet).
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof SyllabusAnalysisStatusView
|
|
28
|
+
*/
|
|
29
|
+
foundCount: number;
|
|
30
|
+
/**
|
|
31
|
+
* ISO 8601 timestamp of the last successful analysis, or null when none has completed.
|
|
32
|
+
* @type {Date}
|
|
33
|
+
* @memberof SyllabusAnalysisStatusView
|
|
34
|
+
*/
|
|
35
|
+
analyzedAt: Date | null;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const SyllabusAnalysisStatusViewStatusEnum: {
|
|
41
|
+
readonly NotYet: "not_yet";
|
|
42
|
+
readonly Pending: "pending";
|
|
43
|
+
readonly Running: "running";
|
|
44
|
+
readonly Analyzed: "analyzed";
|
|
45
|
+
readonly Failed: "failed";
|
|
46
|
+
};
|
|
47
|
+
export type SyllabusAnalysisStatusViewStatusEnum = typeof SyllabusAnalysisStatusViewStatusEnum[keyof typeof SyllabusAnalysisStatusViewStatusEnum];
|
|
48
|
+
/**
|
|
49
|
+
* Check if a given object implements the SyllabusAnalysisStatusView interface.
|
|
50
|
+
*/
|
|
51
|
+
export declare function instanceOfSyllabusAnalysisStatusView(value: object): value is SyllabusAnalysisStatusView;
|
|
52
|
+
export declare function SyllabusAnalysisStatusViewFromJSON(json: any): SyllabusAnalysisStatusView;
|
|
53
|
+
export declare function SyllabusAnalysisStatusViewFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyllabusAnalysisStatusView;
|
|
54
|
+
export declare function SyllabusAnalysisStatusViewToJSON(json: any): SyllabusAnalysisStatusView;
|
|
55
|
+
export declare function SyllabusAnalysisStatusViewToJSONTyped(value?: SyllabusAnalysisStatusView | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,61 @@
|
|
|
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
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const SyllabusAnalysisStatusViewStatusEnum = {
|
|
18
|
+
NotYet: 'not_yet',
|
|
19
|
+
Pending: 'pending',
|
|
20
|
+
Running: 'running',
|
|
21
|
+
Analyzed: 'analyzed',
|
|
22
|
+
Failed: 'failed'
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Check if a given object implements the SyllabusAnalysisStatusView interface.
|
|
26
|
+
*/
|
|
27
|
+
export function instanceOfSyllabusAnalysisStatusView(value) {
|
|
28
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('foundCount' in value) || value['foundCount'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('analyzedAt' in value) || value['analyzedAt'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
export function SyllabusAnalysisStatusViewFromJSON(json) {
|
|
37
|
+
return SyllabusAnalysisStatusViewFromJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function SyllabusAnalysisStatusViewFromJSONTyped(json, ignoreDiscriminator) {
|
|
40
|
+
if (json == null) {
|
|
41
|
+
return json;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'status': json['status'],
|
|
45
|
+
'foundCount': json['foundCount'],
|
|
46
|
+
'analyzedAt': (json['analyzedAt'] == null ? null : new Date(json['analyzedAt'])),
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
export function SyllabusAnalysisStatusViewToJSON(json) {
|
|
50
|
+
return SyllabusAnalysisStatusViewToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
export function SyllabusAnalysisStatusViewToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'status': value['status'],
|
|
58
|
+
'foundCount': value['foundCount'],
|
|
59
|
+
'analyzedAt': value['analyzedAt'] == null ? value['analyzedAt'] : value['analyzedAt'].toISOString(),
|
|
60
|
+
};
|
|
61
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
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 { TriggerSyllabusAnalysisRequestFile } from './TriggerSyllabusAnalysisRequestFile';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface TriggerSyllabusAnalysisRequest
|
|
17
|
+
*/
|
|
18
|
+
export interface TriggerSyllabusAnalysisRequest {
|
|
19
|
+
/**
|
|
20
|
+
* External course identifier (e.g. a Canvas course id).
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof TriggerSyllabusAnalysisRequest
|
|
23
|
+
*/
|
|
24
|
+
courseId: string;
|
|
25
|
+
/**
|
|
26
|
+
* Canvas host domain (e.g. 'university.instructure.com').
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof TriggerSyllabusAnalysisRequest
|
|
29
|
+
*/
|
|
30
|
+
canvasDomain: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof TriggerSyllabusAnalysisRequest
|
|
35
|
+
*/
|
|
36
|
+
syllabusHtml?: string | null;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {TriggerSyllabusAnalysisRequestFile}
|
|
40
|
+
* @memberof TriggerSyllabusAnalysisRequest
|
|
41
|
+
*/
|
|
42
|
+
file?: TriggerSyllabusAnalysisRequestFile | null;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the TriggerSyllabusAnalysisRequest interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfTriggerSyllabusAnalysisRequest(value: object): value is TriggerSyllabusAnalysisRequest;
|
|
48
|
+
export declare function TriggerSyllabusAnalysisRequestFromJSON(json: any): TriggerSyllabusAnalysisRequest;
|
|
49
|
+
export declare function TriggerSyllabusAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerSyllabusAnalysisRequest;
|
|
50
|
+
export declare function TriggerSyllabusAnalysisRequestToJSON(json: any): TriggerSyllabusAnalysisRequest;
|
|
51
|
+
export declare function TriggerSyllabusAnalysisRequestToJSONTyped(value?: TriggerSyllabusAnalysisRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
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 { TriggerSyllabusAnalysisRequestFileFromJSON, TriggerSyllabusAnalysisRequestFileToJSON, } from './TriggerSyllabusAnalysisRequestFile';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the TriggerSyllabusAnalysisRequest interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfTriggerSyllabusAnalysisRequest(value) {
|
|
19
|
+
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('canvasDomain' in value) || value['canvasDomain'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
export function TriggerSyllabusAnalysisRequestFromJSON(json) {
|
|
26
|
+
return TriggerSyllabusAnalysisRequestFromJSONTyped(json, false);
|
|
27
|
+
}
|
|
28
|
+
export function TriggerSyllabusAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
29
|
+
if (json == null) {
|
|
30
|
+
return json;
|
|
31
|
+
}
|
|
32
|
+
return {
|
|
33
|
+
'courseId': json['courseId'],
|
|
34
|
+
'canvasDomain': json['canvasDomain'],
|
|
35
|
+
'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
|
|
36
|
+
'file': json['file'] == null ? undefined : TriggerSyllabusAnalysisRequestFileFromJSON(json['file']),
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function TriggerSyllabusAnalysisRequestToJSON(json) {
|
|
40
|
+
return TriggerSyllabusAnalysisRequestToJSONTyped(json, false);
|
|
41
|
+
}
|
|
42
|
+
export function TriggerSyllabusAnalysisRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
43
|
+
if (value == null) {
|
|
44
|
+
return value;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'courseId': value['courseId'],
|
|
48
|
+
'canvasDomain': value['canvasDomain'],
|
|
49
|
+
'syllabusHtml': value['syllabusHtml'],
|
|
50
|
+
'file': TriggerSyllabusAnalysisRequestFileToJSON(value['file']),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
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
|
+
/**
|
|
13
|
+
* Canvas file reference for a syllabus delivered as a document.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface TriggerSyllabusAnalysisRequestFile
|
|
16
|
+
*/
|
|
17
|
+
export interface TriggerSyllabusAnalysisRequestFile {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof TriggerSyllabusAnalysisRequestFile
|
|
22
|
+
*/
|
|
23
|
+
canonicalId: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof TriggerSyllabusAnalysisRequestFile
|
|
28
|
+
*/
|
|
29
|
+
displayName: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof TriggerSyllabusAnalysisRequestFile
|
|
34
|
+
*/
|
|
35
|
+
filename: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof TriggerSyllabusAnalysisRequestFile
|
|
40
|
+
*/
|
|
41
|
+
contentType: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the TriggerSyllabusAnalysisRequestFile interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfTriggerSyllabusAnalysisRequestFile(value: object): value is TriggerSyllabusAnalysisRequestFile;
|
|
47
|
+
export declare function TriggerSyllabusAnalysisRequestFileFromJSON(json: any): TriggerSyllabusAnalysisRequestFile;
|
|
48
|
+
export declare function TriggerSyllabusAnalysisRequestFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): TriggerSyllabusAnalysisRequestFile;
|
|
49
|
+
export declare function TriggerSyllabusAnalysisRequestFileToJSON(json: any): TriggerSyllabusAnalysisRequestFile;
|
|
50
|
+
export declare function TriggerSyllabusAnalysisRequestFileToJSONTyped(value?: TriggerSyllabusAnalysisRequestFile | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
/**
|
|
15
|
+
* Check if a given object implements the TriggerSyllabusAnalysisRequestFile interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfTriggerSyllabusAnalysisRequestFile(value) {
|
|
18
|
+
if (!('canonicalId' in value) || value['canonicalId'] === undefined)
|
|
19
|
+
return false;
|
|
20
|
+
if (!('displayName' in value) || value['displayName'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('filename' in value) || value['filename'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('contentType' in value) || value['contentType'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
export function TriggerSyllabusAnalysisRequestFileFromJSON(json) {
|
|
29
|
+
return TriggerSyllabusAnalysisRequestFileFromJSONTyped(json, false);
|
|
30
|
+
}
|
|
31
|
+
export function TriggerSyllabusAnalysisRequestFileFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if (json == null) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'canonicalId': json['canonicalId'],
|
|
37
|
+
'displayName': json['displayName'],
|
|
38
|
+
'filename': json['filename'],
|
|
39
|
+
'contentType': json['contentType'],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
export function TriggerSyllabusAnalysisRequestFileToJSON(json) {
|
|
43
|
+
return TriggerSyllabusAnalysisRequestFileToJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
export function TriggerSyllabusAnalysisRequestFileToJSONTyped(value, ignoreDiscriminator = false) {
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'canonicalId': value['canonicalId'],
|
|
51
|
+
'displayName': value['displayName'],
|
|
52
|
+
'filename': value['filename'],
|
|
53
|
+
'contentType': value['contentType'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
@@ -90,6 +90,9 @@ export * from './StudyObjectiveConceptAttachmentList';
|
|
|
90
90
|
export * from './StudyObjectiveConceptSummary';
|
|
91
91
|
export * from './StudyObjectiveFileAttachment';
|
|
92
92
|
export * from './SubmitQuizResponseRequest';
|
|
93
|
+
export * from './SyllabusAnalysisObjective';
|
|
94
|
+
export * from './SyllabusAnalysisStatus';
|
|
95
|
+
export * from './SyllabusAnalysisStatusView';
|
|
93
96
|
export * from './Tag';
|
|
94
97
|
export * from './TaxonomyDetail';
|
|
95
98
|
export * from './TaxonomyEnrollment';
|
|
@@ -105,6 +108,8 @@ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
|
|
|
105
108
|
export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
|
|
106
109
|
export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
|
|
107
110
|
export * from './TriggerStudyObjectiveConceptExtractionResponse';
|
|
111
|
+
export * from './TriggerSyllabusAnalysisRequest';
|
|
112
|
+
export * from './TriggerSyllabusAnalysisRequestFile';
|
|
108
113
|
export * from './UpdateAccountDto';
|
|
109
114
|
export * from './UpdateChatRequest';
|
|
110
115
|
export * from './UpdateFeatureDto';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -92,6 +92,9 @@ export * from './StudyObjectiveConceptAttachmentList';
|
|
|
92
92
|
export * from './StudyObjectiveConceptSummary';
|
|
93
93
|
export * from './StudyObjectiveFileAttachment';
|
|
94
94
|
export * from './SubmitQuizResponseRequest';
|
|
95
|
+
export * from './SyllabusAnalysisObjective';
|
|
96
|
+
export * from './SyllabusAnalysisStatus';
|
|
97
|
+
export * from './SyllabusAnalysisStatusView';
|
|
95
98
|
export * from './Tag';
|
|
96
99
|
export * from './TaxonomyDetail';
|
|
97
100
|
export * from './TaxonomyEnrollment';
|
|
@@ -107,6 +110,8 @@ export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInner';
|
|
|
107
110
|
export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf';
|
|
108
111
|
export * from './TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1';
|
|
109
112
|
export * from './TriggerStudyObjectiveConceptExtractionResponse';
|
|
113
|
+
export * from './TriggerSyllabusAnalysisRequest';
|
|
114
|
+
export * from './TriggerSyllabusAnalysisRequestFile';
|
|
110
115
|
export * from './UpdateAccountDto';
|
|
111
116
|
export * from './UpdateChatRequest';
|
|
112
117
|
export * from './UpdateFeatureDto';
|
|
@@ -35,6 +35,12 @@ export interface StudyObjective {
|
|
|
35
35
|
* @memberof StudyObjective
|
|
36
36
|
*/
|
|
37
37
|
courseId: string;
|
|
38
|
+
/**
|
|
39
|
+
* Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof StudyObjective
|
|
42
|
+
*/
|
|
43
|
+
source: StudyObjectiveSourceEnum;
|
|
38
44
|
/**
|
|
39
45
|
*
|
|
40
46
|
* @type {string}
|
|
@@ -78,6 +84,14 @@ export interface StudyObjective {
|
|
|
78
84
|
*/
|
|
79
85
|
updatedAt: Date;
|
|
80
86
|
}
|
|
87
|
+
/**
|
|
88
|
+
* @export
|
|
89
|
+
*/
|
|
90
|
+
export declare const StudyObjectiveSourceEnum: {
|
|
91
|
+
readonly User: "user";
|
|
92
|
+
readonly Syllabus: "syllabus";
|
|
93
|
+
};
|
|
94
|
+
export type StudyObjectiveSourceEnum = typeof StudyObjectiveSourceEnum[keyof typeof StudyObjectiveSourceEnum];
|
|
81
95
|
/**
|
|
82
96
|
* Check if a given object implements the StudyObjective interface.
|
|
83
97
|
*/
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.StudyObjectiveSourceEnum = void 0;
|
|
16
17
|
exports.instanceOfStudyObjective = instanceOfStudyObjective;
|
|
17
18
|
exports.StudyObjectiveFromJSON = StudyObjectiveFromJSON;
|
|
18
19
|
exports.StudyObjectiveFromJSONTyped = StudyObjectiveFromJSONTyped;
|
|
@@ -20,6 +21,13 @@ exports.StudyObjectiveToJSON = StudyObjectiveToJSON;
|
|
|
20
21
|
exports.StudyObjectiveToJSONTyped = StudyObjectiveToJSONTyped;
|
|
21
22
|
const StudyObjectiveFileAttachment_1 = require("./StudyObjectiveFileAttachment");
|
|
22
23
|
const StudyObjectiveCanvasDocument_1 = require("./StudyObjectiveCanvasDocument");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.StudyObjectiveSourceEnum = {
|
|
28
|
+
User: 'user',
|
|
29
|
+
Syllabus: 'syllabus'
|
|
30
|
+
};
|
|
23
31
|
/**
|
|
24
32
|
* Check if a given object implements the StudyObjective interface.
|
|
25
33
|
*/
|
|
@@ -30,6 +38,8 @@ function instanceOfStudyObjective(value) {
|
|
|
30
38
|
return false;
|
|
31
39
|
if (!('courseId' in value) || value['courseId'] === undefined)
|
|
32
40
|
return false;
|
|
41
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
42
|
+
return false;
|
|
33
43
|
if (!('title' in value) || value['title'] === undefined)
|
|
34
44
|
return false;
|
|
35
45
|
if (!('notes' in value) || value['notes'] === undefined)
|
|
@@ -57,6 +67,7 @@ function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
67
|
'id': json['id'],
|
|
58
68
|
'accountUserId': json['accountUserId'],
|
|
59
69
|
'courseId': json['courseId'],
|
|
70
|
+
'source': json['source'],
|
|
60
71
|
'title': json['title'],
|
|
61
72
|
'notes': json['notes'],
|
|
62
73
|
'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentFromJSON)),
|
|
@@ -77,6 +88,7 @@ function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
77
88
|
'id': value['id'],
|
|
78
89
|
'accountUserId': value['accountUserId'],
|
|
79
90
|
'courseId': value['courseId'],
|
|
91
|
+
'source': value['source'],
|
|
80
92
|
'title': value['title'],
|
|
81
93
|
'notes': value['notes'],
|
|
82
94
|
'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachment_1.StudyObjectiveFileAttachmentToJSON)),
|
|
@@ -0,0 +1,64 @@
|
|
|
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
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SyllabusAnalysisObjective
|
|
16
|
+
*/
|
|
17
|
+
export interface SyllabusAnalysisObjective {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SyllabusAnalysisObjective
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SyllabusAnalysisObjective
|
|
28
|
+
*/
|
|
29
|
+
courseId: string;
|
|
30
|
+
/**
|
|
31
|
+
* Origin of the objective. Always 'syllabus' for analysis results.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SyllabusAnalysisObjective
|
|
34
|
+
*/
|
|
35
|
+
source: SyllabusAnalysisObjectiveSourceEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SyllabusAnalysisObjective
|
|
40
|
+
*/
|
|
41
|
+
title: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {Date}
|
|
45
|
+
* @memberof SyllabusAnalysisObjective
|
|
46
|
+
*/
|
|
47
|
+
dueAt: Date | null;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export declare const SyllabusAnalysisObjectiveSourceEnum: {
|
|
53
|
+
readonly User: "user";
|
|
54
|
+
readonly Syllabus: "syllabus";
|
|
55
|
+
};
|
|
56
|
+
export type SyllabusAnalysisObjectiveSourceEnum = typeof SyllabusAnalysisObjectiveSourceEnum[keyof typeof SyllabusAnalysisObjectiveSourceEnum];
|
|
57
|
+
/**
|
|
58
|
+
* Check if a given object implements the SyllabusAnalysisObjective interface.
|
|
59
|
+
*/
|
|
60
|
+
export declare function instanceOfSyllabusAnalysisObjective(value: object): value is SyllabusAnalysisObjective;
|
|
61
|
+
export declare function SyllabusAnalysisObjectiveFromJSON(json: any): SyllabusAnalysisObjective;
|
|
62
|
+
export declare function SyllabusAnalysisObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): SyllabusAnalysisObjective;
|
|
63
|
+
export declare function SyllabusAnalysisObjectiveToJSON(json: any): SyllabusAnalysisObjective;
|
|
64
|
+
export declare function SyllabusAnalysisObjectiveToJSONTyped(value?: SyllabusAnalysisObjective | null, ignoreDiscriminator?: boolean): any;
|