@instructure/athena-api-client 3.3.1 → 3.4.1

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.
Files changed (38) hide show
  1. package/README.md +7 -0
  2. package/dist/apis/SyllabusAnalysisApi.d.ts +48 -0
  3. package/dist/apis/SyllabusAnalysisApi.js +127 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/SyllabusAnalysisApi.d.ts +48 -0
  7. package/dist/esm/apis/SyllabusAnalysisApi.js +123 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/StudyObjective.d.ts +14 -0
  11. package/dist/esm/models/StudyObjective.js +11 -0
  12. package/dist/esm/models/SyllabusAnalysisObjective.d.ts +64 -0
  13. package/dist/esm/models/SyllabusAnalysisObjective.js +66 -0
  14. package/dist/esm/models/SyllabusAnalysisStatus.d.ts +56 -0
  15. package/dist/esm/models/SyllabusAnalysisStatus.js +62 -0
  16. package/dist/esm/models/SyllabusAnalysisStatusView.d.ts +55 -0
  17. package/dist/esm/models/SyllabusAnalysisStatusView.js +61 -0
  18. package/dist/esm/models/TriggerSyllabusAnalysisRequest.d.ts +51 -0
  19. package/dist/esm/models/TriggerSyllabusAnalysisRequest.js +52 -0
  20. package/dist/esm/models/TriggerSyllabusAnalysisRequestFile.d.ts +50 -0
  21. package/dist/esm/models/TriggerSyllabusAnalysisRequestFile.js +55 -0
  22. package/dist/esm/models/index.d.ts +5 -0
  23. package/dist/esm/models/index.js +5 -0
  24. package/dist/models/StudyObjective.d.ts +14 -0
  25. package/dist/models/StudyObjective.js +12 -0
  26. package/dist/models/SyllabusAnalysisObjective.d.ts +64 -0
  27. package/dist/models/SyllabusAnalysisObjective.js +74 -0
  28. package/dist/models/SyllabusAnalysisStatus.d.ts +56 -0
  29. package/dist/models/SyllabusAnalysisStatus.js +70 -0
  30. package/dist/models/SyllabusAnalysisStatusView.d.ts +55 -0
  31. package/dist/models/SyllabusAnalysisStatusView.js +69 -0
  32. package/dist/models/TriggerSyllabusAnalysisRequest.d.ts +51 -0
  33. package/dist/models/TriggerSyllabusAnalysisRequest.js +59 -0
  34. package/dist/models/TriggerSyllabusAnalysisRequestFile.d.ts +50 -0
  35. package/dist/models/TriggerSyllabusAnalysisRequestFile.js +62 -0
  36. package/dist/models/index.d.ts +5 -0
  37. package/dist/models/index.js +5 -0
  38. package/package.json +1 -1
@@ -0,0 +1,74 @@
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.SyllabusAnalysisObjectiveSourceEnum = void 0;
17
+ exports.instanceOfSyllabusAnalysisObjective = instanceOfSyllabusAnalysisObjective;
18
+ exports.SyllabusAnalysisObjectiveFromJSON = SyllabusAnalysisObjectiveFromJSON;
19
+ exports.SyllabusAnalysisObjectiveFromJSONTyped = SyllabusAnalysisObjectiveFromJSONTyped;
20
+ exports.SyllabusAnalysisObjectiveToJSON = SyllabusAnalysisObjectiveToJSON;
21
+ exports.SyllabusAnalysisObjectiveToJSONTyped = SyllabusAnalysisObjectiveToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.SyllabusAnalysisObjectiveSourceEnum = {
26
+ User: 'user',
27
+ Syllabus: 'syllabus'
28
+ };
29
+ /**
30
+ * Check if a given object implements the SyllabusAnalysisObjective interface.
31
+ */
32
+ function instanceOfSyllabusAnalysisObjective(value) {
33
+ if (!('id' in value) || value['id'] === undefined)
34
+ return false;
35
+ if (!('courseId' in value) || value['courseId'] === undefined)
36
+ return false;
37
+ if (!('source' in value) || value['source'] === undefined)
38
+ return false;
39
+ if (!('title' in value) || value['title'] === undefined)
40
+ return false;
41
+ if (!('dueAt' in value) || value['dueAt'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ function SyllabusAnalysisObjectiveFromJSON(json) {
46
+ return SyllabusAnalysisObjectiveFromJSONTyped(json, false);
47
+ }
48
+ function SyllabusAnalysisObjectiveFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'id': json['id'],
54
+ 'courseId': json['courseId'],
55
+ 'source': json['source'],
56
+ 'title': json['title'],
57
+ 'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
58
+ };
59
+ }
60
+ function SyllabusAnalysisObjectiveToJSON(json) {
61
+ return SyllabusAnalysisObjectiveToJSONTyped(json, false);
62
+ }
63
+ function SyllabusAnalysisObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
64
+ if (value == null) {
65
+ return value;
66
+ }
67
+ return {
68
+ 'id': value['id'],
69
+ 'courseId': value['courseId'],
70
+ 'source': value['source'],
71
+ 'title': value['title'],
72
+ 'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
73
+ };
74
+ }
@@ -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,70 @@
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.SyllabusAnalysisStatusStatusEnum = void 0;
17
+ exports.instanceOfSyllabusAnalysisStatus = instanceOfSyllabusAnalysisStatus;
18
+ exports.SyllabusAnalysisStatusFromJSON = SyllabusAnalysisStatusFromJSON;
19
+ exports.SyllabusAnalysisStatusFromJSONTyped = SyllabusAnalysisStatusFromJSONTyped;
20
+ exports.SyllabusAnalysisStatusToJSON = SyllabusAnalysisStatusToJSON;
21
+ exports.SyllabusAnalysisStatusToJSONTyped = SyllabusAnalysisStatusToJSONTyped;
22
+ const SyllabusAnalysisObjective_1 = require("./SyllabusAnalysisObjective");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.SyllabusAnalysisStatusStatusEnum = {
27
+ NotConfigured: 'not_configured',
28
+ Pending: 'pending',
29
+ Running: 'running',
30
+ Analyzed: 'analyzed',
31
+ Failed: 'failed'
32
+ };
33
+ /**
34
+ * Check if a given object implements the SyllabusAnalysisStatus interface.
35
+ */
36
+ function instanceOfSyllabusAnalysisStatus(value) {
37
+ if (!('status' in value) || value['status'] === undefined)
38
+ return false;
39
+ if (!('foundCount' in value) || value['foundCount'] === undefined)
40
+ return false;
41
+ if (!('objectives' in value) || value['objectives'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ function SyllabusAnalysisStatusFromJSON(json) {
46
+ return SyllabusAnalysisStatusFromJSONTyped(json, false);
47
+ }
48
+ function SyllabusAnalysisStatusFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'status': json['status'],
54
+ 'foundCount': json['foundCount'],
55
+ 'objectives': (json['objectives'].map(SyllabusAnalysisObjective_1.SyllabusAnalysisObjectiveFromJSON)),
56
+ };
57
+ }
58
+ function SyllabusAnalysisStatusToJSON(json) {
59
+ return SyllabusAnalysisStatusToJSONTyped(json, false);
60
+ }
61
+ function SyllabusAnalysisStatusToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'status': value['status'],
67
+ 'foundCount': value['foundCount'],
68
+ 'objectives': (value['objectives'].map(SyllabusAnalysisObjective_1.SyllabusAnalysisObjectiveToJSON)),
69
+ };
70
+ }
@@ -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,69 @@
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.SyllabusAnalysisStatusViewStatusEnum = void 0;
17
+ exports.instanceOfSyllabusAnalysisStatusView = instanceOfSyllabusAnalysisStatusView;
18
+ exports.SyllabusAnalysisStatusViewFromJSON = SyllabusAnalysisStatusViewFromJSON;
19
+ exports.SyllabusAnalysisStatusViewFromJSONTyped = SyllabusAnalysisStatusViewFromJSONTyped;
20
+ exports.SyllabusAnalysisStatusViewToJSON = SyllabusAnalysisStatusViewToJSON;
21
+ exports.SyllabusAnalysisStatusViewToJSONTyped = SyllabusAnalysisStatusViewToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.SyllabusAnalysisStatusViewStatusEnum = {
26
+ NotYet: 'not_yet',
27
+ Pending: 'pending',
28
+ Running: 'running',
29
+ Analyzed: 'analyzed',
30
+ Failed: 'failed'
31
+ };
32
+ /**
33
+ * Check if a given object implements the SyllabusAnalysisStatusView interface.
34
+ */
35
+ function instanceOfSyllabusAnalysisStatusView(value) {
36
+ if (!('status' in value) || value['status'] === undefined)
37
+ return false;
38
+ if (!('foundCount' in value) || value['foundCount'] === undefined)
39
+ return false;
40
+ if (!('analyzedAt' in value) || value['analyzedAt'] === undefined)
41
+ return false;
42
+ return true;
43
+ }
44
+ function SyllabusAnalysisStatusViewFromJSON(json) {
45
+ return SyllabusAnalysisStatusViewFromJSONTyped(json, false);
46
+ }
47
+ function SyllabusAnalysisStatusViewFromJSONTyped(json, ignoreDiscriminator) {
48
+ if (json == null) {
49
+ return json;
50
+ }
51
+ return {
52
+ 'status': json['status'],
53
+ 'foundCount': json['foundCount'],
54
+ 'analyzedAt': (json['analyzedAt'] == null ? null : new Date(json['analyzedAt'])),
55
+ };
56
+ }
57
+ function SyllabusAnalysisStatusViewToJSON(json) {
58
+ return SyllabusAnalysisStatusViewToJSONTyped(json, false);
59
+ }
60
+ function SyllabusAnalysisStatusViewToJSONTyped(value, ignoreDiscriminator = false) {
61
+ if (value == null) {
62
+ return value;
63
+ }
64
+ return {
65
+ 'status': value['status'],
66
+ 'foundCount': value['foundCount'],
67
+ 'analyzedAt': value['analyzedAt'] == null ? value['analyzedAt'] : value['analyzedAt'].toISOString(),
68
+ };
69
+ }
@@ -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,59 @@
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.instanceOfTriggerSyllabusAnalysisRequest = instanceOfTriggerSyllabusAnalysisRequest;
17
+ exports.TriggerSyllabusAnalysisRequestFromJSON = TriggerSyllabusAnalysisRequestFromJSON;
18
+ exports.TriggerSyllabusAnalysisRequestFromJSONTyped = TriggerSyllabusAnalysisRequestFromJSONTyped;
19
+ exports.TriggerSyllabusAnalysisRequestToJSON = TriggerSyllabusAnalysisRequestToJSON;
20
+ exports.TriggerSyllabusAnalysisRequestToJSONTyped = TriggerSyllabusAnalysisRequestToJSONTyped;
21
+ const TriggerSyllabusAnalysisRequestFile_1 = require("./TriggerSyllabusAnalysisRequestFile");
22
+ /**
23
+ * Check if a given object implements the TriggerSyllabusAnalysisRequest interface.
24
+ */
25
+ function instanceOfTriggerSyllabusAnalysisRequest(value) {
26
+ if (!('courseId' in value) || value['courseId'] === undefined)
27
+ return false;
28
+ if (!('canvasDomain' in value) || value['canvasDomain'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ function TriggerSyllabusAnalysisRequestFromJSON(json) {
33
+ return TriggerSyllabusAnalysisRequestFromJSONTyped(json, false);
34
+ }
35
+ function TriggerSyllabusAnalysisRequestFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'courseId': json['courseId'],
41
+ 'canvasDomain': json['canvasDomain'],
42
+ 'syllabusHtml': json['syllabusHtml'] == null ? undefined : json['syllabusHtml'],
43
+ 'file': json['file'] == null ? undefined : (0, TriggerSyllabusAnalysisRequestFile_1.TriggerSyllabusAnalysisRequestFileFromJSON)(json['file']),
44
+ };
45
+ }
46
+ function TriggerSyllabusAnalysisRequestToJSON(json) {
47
+ return TriggerSyllabusAnalysisRequestToJSONTyped(json, false);
48
+ }
49
+ function TriggerSyllabusAnalysisRequestToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'courseId': value['courseId'],
55
+ 'canvasDomain': value['canvasDomain'],
56
+ 'syllabusHtml': value['syllabusHtml'],
57
+ 'file': (0, TriggerSyllabusAnalysisRequestFile_1.TriggerSyllabusAnalysisRequestFileToJSON)(value['file']),
58
+ };
59
+ }
@@ -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,62 @@
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.instanceOfTriggerSyllabusAnalysisRequestFile = instanceOfTriggerSyllabusAnalysisRequestFile;
17
+ exports.TriggerSyllabusAnalysisRequestFileFromJSON = TriggerSyllabusAnalysisRequestFileFromJSON;
18
+ exports.TriggerSyllabusAnalysisRequestFileFromJSONTyped = TriggerSyllabusAnalysisRequestFileFromJSONTyped;
19
+ exports.TriggerSyllabusAnalysisRequestFileToJSON = TriggerSyllabusAnalysisRequestFileToJSON;
20
+ exports.TriggerSyllabusAnalysisRequestFileToJSONTyped = TriggerSyllabusAnalysisRequestFileToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the TriggerSyllabusAnalysisRequestFile interface.
23
+ */
24
+ function instanceOfTriggerSyllabusAnalysisRequestFile(value) {
25
+ if (!('canonicalId' in value) || value['canonicalId'] === undefined)
26
+ return false;
27
+ if (!('displayName' in value) || value['displayName'] === undefined)
28
+ return false;
29
+ if (!('filename' in value) || value['filename'] === undefined)
30
+ return false;
31
+ if (!('contentType' in value) || value['contentType'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function TriggerSyllabusAnalysisRequestFileFromJSON(json) {
36
+ return TriggerSyllabusAnalysisRequestFileFromJSONTyped(json, false);
37
+ }
38
+ function TriggerSyllabusAnalysisRequestFileFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'canonicalId': json['canonicalId'],
44
+ 'displayName': json['displayName'],
45
+ 'filename': json['filename'],
46
+ 'contentType': json['contentType'],
47
+ };
48
+ }
49
+ function TriggerSyllabusAnalysisRequestFileToJSON(json) {
50
+ return TriggerSyllabusAnalysisRequestFileToJSONTyped(json, false);
51
+ }
52
+ function TriggerSyllabusAnalysisRequestFileToJSONTyped(value, ignoreDiscriminator = false) {
53
+ if (value == null) {
54
+ return value;
55
+ }
56
+ return {
57
+ 'canonicalId': value['canonicalId'],
58
+ 'displayName': value['displayName'],
59
+ 'filename': value['filename'],
60
+ 'contentType': value['contentType'],
61
+ };
62
+ }
@@ -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';
@@ -108,6 +108,9 @@ __exportStar(require("./StudyObjectiveConceptAttachmentList"), exports);
108
108
  __exportStar(require("./StudyObjectiveConceptSummary"), exports);
109
109
  __exportStar(require("./StudyObjectiveFileAttachment"), exports);
110
110
  __exportStar(require("./SubmitQuizResponseRequest"), exports);
111
+ __exportStar(require("./SyllabusAnalysisObjective"), exports);
112
+ __exportStar(require("./SyllabusAnalysisStatus"), exports);
113
+ __exportStar(require("./SyllabusAnalysisStatusView"), exports);
111
114
  __exportStar(require("./Tag"), exports);
112
115
  __exportStar(require("./TaxonomyDetail"), exports);
113
116
  __exportStar(require("./TaxonomyEnrollment"), exports);
@@ -123,6 +126,8 @@ __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInner"
123
126
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf"), exports);
124
127
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionRequestItemsInnerAnyOf1"), exports);
125
128
  __exportStar(require("./TriggerStudyObjectiveConceptExtractionResponse"), exports);
129
+ __exportStar(require("./TriggerSyllabusAnalysisRequest"), exports);
130
+ __exportStar(require("./TriggerSyllabusAnalysisRequestFile"), exports);
126
131
  __exportStar(require("./UpdateAccountDto"), exports);
127
132
  __exportStar(require("./UpdateChatRequest"), exports);
128
133
  __exportStar(require("./UpdateFeatureDto"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "3.3.1",
4
+ "version": "3.4.1",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {