@instructure/athena-api-client 2.7.2 → 2.9.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 CHANGED
@@ -115,6 +115,7 @@ All URIs are relative to *http://localhost:3000*
115
115
  *TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /api/v1/tags | List all tags
116
116
  *TaxonomiesApi* | [**getTaxonomy**](docs/TaxonomiesApi.md#gettaxonomy) | **GET** /api/v1/taxonomies/{id} | Get taxonomy by ID with full tree
117
117
  *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
118
+ *TaxonomiesApi* | [**getTaxonomyProgress**](docs/TaxonomiesApi.md#gettaxonomyprogress) | **GET** /api/v1/taxonomies/{id}/progress | Get progress and readiness for a taxonomy
118
119
  *TaxonomiesApi* | [**listTaxonomies**](docs/TaxonomiesApi.md#listtaxonomies) | **GET** /api/v1/taxonomies | List available taxonomies
119
120
  *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomies/{id}/enroll | Enroll in a taxonomy
120
121
  *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomies/enrollments | List current user\'s active enrollments
@@ -190,6 +191,8 @@ All URIs are relative to *http://localhost:3000*
190
191
  - [TaxonomyEnrollmentWithTaxonomy](docs/TaxonomyEnrollmentWithTaxonomy.md)
191
192
  - [TaxonomyNode](docs/TaxonomyNode.md)
192
193
  - [TaxonomyNodeConcept](docs/TaxonomyNodeConcept.md)
194
+ - [TaxonomyProgress](docs/TaxonomyProgress.md)
195
+ - [TaxonomyProgressNode](docs/TaxonomyProgressNode.md)
193
196
  - [TaxonomySummary](docs/TaxonomySummary.md)
194
197
  - [UpdateAccountDto](docs/UpdateAccountDto.md)
195
198
  - [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 { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
13
+ import type { PaginatedTaxonomies, TaxonomyDetail, TaxonomyProgress } from '../models/index';
14
14
  export interface GetTaxonomyRequest {
15
15
  id: string;
16
16
  xUserId: string;
@@ -19,6 +19,10 @@ export interface GetTaxonomyBySlugRequest {
19
19
  slug: string;
20
20
  xUserId: string;
21
21
  }
22
+ export interface GetTaxonomyProgressRequest {
23
+ id: string;
24
+ xUserId: string;
25
+ }
22
26
  export interface ListTaxonomiesRequest {
23
27
  xUserId: string;
24
28
  status?: ListTaxonomiesStatusEnum;
@@ -45,6 +49,16 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
45
49
  * Get taxonomy by slug
46
50
  */
47
51
  getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
52
+ /**
53
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
54
+ * Get progress and readiness for a taxonomy
55
+ */
56
+ getTaxonomyProgressRaw(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyProgress>>;
57
+ /**
58
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
59
+ * Get progress and readiness for a taxonomy
60
+ */
61
+ getTaxonomyProgress(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyProgress>;
48
62
  /**
49
63
  * List available taxonomies
50
64
  */
@@ -107,6 +107,47 @@ class TaxonomiesApi extends runtime.BaseAPI {
107
107
  return yield response.value();
108
108
  });
109
109
  }
110
+ /**
111
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
112
+ * Get progress and readiness for a taxonomy
113
+ */
114
+ getTaxonomyProgressRaw(requestParameters, initOverrides) {
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ if (requestParameters['id'] == null) {
117
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomyProgress().');
118
+ }
119
+ if (requestParameters['xUserId'] == null) {
120
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyProgress().');
121
+ }
122
+ const queryParameters = {};
123
+ const headerParameters = {};
124
+ if (requestParameters['xUserId'] != null) {
125
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
126
+ }
127
+ if (this.configuration && this.configuration.apiKey) {
128
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
129
+ }
130
+ let urlPath = `/api/v1/taxonomies/{id}/progress`;
131
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
132
+ const response = yield this.request({
133
+ path: urlPath,
134
+ method: 'GET',
135
+ headers: headerParameters,
136
+ query: queryParameters,
137
+ }, initOverrides);
138
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TaxonomyProgressFromJSON)(jsonValue));
139
+ });
140
+ }
141
+ /**
142
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
143
+ * Get progress and readiness for a taxonomy
144
+ */
145
+ getTaxonomyProgress(requestParameters, initOverrides) {
146
+ return __awaiter(this, void 0, void 0, function* () {
147
+ const response = yield this.getTaxonomyProgressRaw(requestParameters, initOverrides);
148
+ return yield response.value();
149
+ });
150
+ }
110
151
  /**
111
152
  * List available taxonomies
112
153
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { PaginatedTaxonomies, TaxonomyDetail } from '../models/index';
13
+ import type { PaginatedTaxonomies, TaxonomyDetail, TaxonomyProgress } from '../models/index';
14
14
  export interface GetTaxonomyRequest {
15
15
  id: string;
16
16
  xUserId: string;
@@ -19,6 +19,10 @@ export interface GetTaxonomyBySlugRequest {
19
19
  slug: string;
20
20
  xUserId: string;
21
21
  }
22
+ export interface GetTaxonomyProgressRequest {
23
+ id: string;
24
+ xUserId: string;
25
+ }
22
26
  export interface ListTaxonomiesRequest {
23
27
  xUserId: string;
24
28
  status?: ListTaxonomiesStatusEnum;
@@ -45,6 +49,16 @@ export declare class TaxonomiesApi extends runtime.BaseAPI {
45
49
  * Get taxonomy by slug
46
50
  */
47
51
  getTaxonomyBySlug(requestParameters: GetTaxonomyBySlugRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyDetail>;
52
+ /**
53
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
54
+ * Get progress and readiness for a taxonomy
55
+ */
56
+ getTaxonomyProgressRaw(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TaxonomyProgress>>;
57
+ /**
58
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
59
+ * Get progress and readiness for a taxonomy
60
+ */
61
+ getTaxonomyProgress(requestParameters: GetTaxonomyProgressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TaxonomyProgress>;
48
62
  /**
49
63
  * List available taxonomies
50
64
  */
@@ -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 { PaginatedTaxonomiesFromJSON, TaxonomyDetailFromJSON, } from '../models/index';
24
+ import { PaginatedTaxonomiesFromJSON, TaxonomyDetailFromJSON, TaxonomyProgressFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -104,6 +104,47 @@ export class TaxonomiesApi extends runtime.BaseAPI {
104
104
  return yield response.value();
105
105
  });
106
106
  }
107
+ /**
108
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
109
+ * Get progress and readiness for a taxonomy
110
+ */
111
+ getTaxonomyProgressRaw(requestParameters, initOverrides) {
112
+ return __awaiter(this, void 0, void 0, function* () {
113
+ if (requestParameters['id'] == null) {
114
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getTaxonomyProgress().');
115
+ }
116
+ if (requestParameters['xUserId'] == null) {
117
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getTaxonomyProgress().');
118
+ }
119
+ const queryParameters = {};
120
+ const headerParameters = {};
121
+ if (requestParameters['xUserId'] != null) {
122
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
123
+ }
124
+ if (this.configuration && this.configuration.apiKey) {
125
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
126
+ }
127
+ let urlPath = `/api/v1/taxonomies/{id}/progress`;
128
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
129
+ const response = yield this.request({
130
+ path: urlPath,
131
+ method: 'GET',
132
+ headers: headerParameters,
133
+ query: queryParameters,
134
+ }, initOverrides);
135
+ return new runtime.JSONApiResponse(response, (jsonValue) => TaxonomyProgressFromJSON(jsonValue));
136
+ });
137
+ }
138
+ /**
139
+ * Returns the readiness score and full mastery tree for the current user on the given taxonomy.
140
+ * Get progress and readiness for a taxonomy
141
+ */
142
+ getTaxonomyProgress(requestParameters, initOverrides) {
143
+ return __awaiter(this, void 0, void 0, function* () {
144
+ const response = yield this.getTaxonomyProgressRaw(requestParameters, initOverrides);
145
+ return yield response.value();
146
+ });
147
+ }
107
148
  /**
108
149
  * List available taxonomies
109
150
  */
@@ -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 { TaxonomyProgressNode } from './TaxonomyProgressNode';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TaxonomyProgress
17
+ */
18
+ export interface TaxonomyProgress {
19
+ /**
20
+ * Root-level weighted average of strength (0–1)
21
+ * @type {number}
22
+ * @memberof TaxonomyProgress
23
+ */
24
+ readinessScore: number;
25
+ /**
26
+ * Total concepts in the taxonomy
27
+ * @type {number}
28
+ * @memberof TaxonomyProgress
29
+ */
30
+ totalConcepts: number;
31
+ /**
32
+ * Number of concepts with a user_concepts row
33
+ * @type {number}
34
+ * @memberof TaxonomyProgress
35
+ */
36
+ assessedConcepts: number;
37
+ /**
38
+ * Root-level progress nodes
39
+ * @type {Array<TaxonomyProgressNode>}
40
+ * @memberof TaxonomyProgress
41
+ */
42
+ nodes: Array<TaxonomyProgressNode>;
43
+ }
44
+ /**
45
+ * Check if a given object implements the TaxonomyProgress interface.
46
+ */
47
+ export declare function instanceOfTaxonomyProgress(value: object): value is TaxonomyProgress;
48
+ export declare function TaxonomyProgressFromJSON(json: any): TaxonomyProgress;
49
+ export declare function TaxonomyProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgress;
50
+ export declare function TaxonomyProgressToJSON(json: any): TaxonomyProgress;
51
+ export declare function TaxonomyProgressToJSONTyped(value?: TaxonomyProgress | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
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 { TaxonomyProgressNodeFromJSON, TaxonomyProgressNodeToJSON, } from './TaxonomyProgressNode';
15
+ /**
16
+ * Check if a given object implements the TaxonomyProgress interface.
17
+ */
18
+ export function instanceOfTaxonomyProgress(value) {
19
+ if (!('readinessScore' in value) || value['readinessScore'] === undefined)
20
+ return false;
21
+ if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
22
+ return false;
23
+ if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
24
+ return false;
25
+ if (!('nodes' in value) || value['nodes'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ export function TaxonomyProgressFromJSON(json) {
30
+ return TaxonomyProgressFromJSONTyped(json, false);
31
+ }
32
+ export function TaxonomyProgressFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'readinessScore': json['readinessScore'],
38
+ 'totalConcepts': json['totalConcepts'],
39
+ 'assessedConcepts': json['assessedConcepts'],
40
+ 'nodes': (json['nodes'].map(TaxonomyProgressNodeFromJSON)),
41
+ };
42
+ }
43
+ export function TaxonomyProgressToJSON(json) {
44
+ return TaxonomyProgressToJSONTyped(json, false);
45
+ }
46
+ export function TaxonomyProgressToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'readinessScore': value['readinessScore'],
52
+ 'totalConcepts': value['totalConcepts'],
53
+ 'assessedConcepts': value['assessedConcepts'],
54
+ 'nodes': (value['nodes'].map(TaxonomyProgressNodeToJSON)),
55
+ };
56
+ }
@@ -0,0 +1,74 @@
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 TaxonomyProgressNode
16
+ */
17
+ export interface TaxonomyProgressNode {
18
+ /**
19
+ * Node ID
20
+ * @type {string}
21
+ * @memberof TaxonomyProgressNode
22
+ */
23
+ id: string;
24
+ /**
25
+ * Node name
26
+ * @type {string}
27
+ * @memberof TaxonomyProgressNode
28
+ */
29
+ name: string;
30
+ /**
31
+ * Node weight (normalized among siblings)
32
+ * @type {number}
33
+ * @memberof TaxonomyProgressNode
34
+ */
35
+ weight: number | null;
36
+ /**
37
+ * Average strength of concepts (0–1)
38
+ * @type {number}
39
+ * @memberof TaxonomyProgressNode
40
+ */
41
+ strength: number;
42
+ /**
43
+ * Average confidence of concepts (0–1)
44
+ * @type {number}
45
+ * @memberof TaxonomyProgressNode
46
+ */
47
+ confidence: number;
48
+ /**
49
+ * Total concepts under this node (including descendants)
50
+ * @type {number}
51
+ * @memberof TaxonomyProgressNode
52
+ */
53
+ totalConcepts: number;
54
+ /**
55
+ * Number of concepts with a user_concepts row (including descendants)
56
+ * @type {number}
57
+ * @memberof TaxonomyProgressNode
58
+ */
59
+ assessedConcepts: number;
60
+ /**
61
+ * Child nodes
62
+ * @type {Array<TaxonomyProgressNode>}
63
+ * @memberof TaxonomyProgressNode
64
+ */
65
+ children: Array<TaxonomyProgressNode>;
66
+ }
67
+ /**
68
+ * Check if a given object implements the TaxonomyProgressNode interface.
69
+ */
70
+ export declare function instanceOfTaxonomyProgressNode(value: object): value is TaxonomyProgressNode;
71
+ export declare function TaxonomyProgressNodeFromJSON(json: any): TaxonomyProgressNode;
72
+ export declare function TaxonomyProgressNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgressNode;
73
+ export declare function TaxonomyProgressNodeToJSON(json: any): TaxonomyProgressNode;
74
+ export declare function TaxonomyProgressNodeToJSONTyped(value?: TaxonomyProgressNode | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,71 @@
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 TaxonomyProgressNode interface.
16
+ */
17
+ export function instanceOfTaxonomyProgressNode(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('weight' in value) || value['weight'] === undefined)
23
+ return false;
24
+ if (!('strength' in value) || value['strength'] === undefined)
25
+ return false;
26
+ if (!('confidence' in value) || value['confidence'] === undefined)
27
+ return false;
28
+ if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
29
+ return false;
30
+ if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
31
+ return false;
32
+ if (!('children' in value) || value['children'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ export function TaxonomyProgressNodeFromJSON(json) {
37
+ return TaxonomyProgressNodeFromJSONTyped(json, false);
38
+ }
39
+ export function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'id': json['id'],
45
+ 'name': json['name'],
46
+ 'weight': json['weight'],
47
+ 'strength': json['strength'],
48
+ 'confidence': json['confidence'],
49
+ 'totalConcepts': json['totalConcepts'],
50
+ 'assessedConcepts': json['assessedConcepts'],
51
+ 'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
52
+ };
53
+ }
54
+ export function TaxonomyProgressNodeToJSON(json) {
55
+ return TaxonomyProgressNodeToJSONTyped(json, false);
56
+ }
57
+ export function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = false) {
58
+ if (value == null) {
59
+ return value;
60
+ }
61
+ return {
62
+ 'id': value['id'],
63
+ 'name': value['name'],
64
+ 'weight': value['weight'],
65
+ 'strength': value['strength'],
66
+ 'confidence': value['confidence'],
67
+ 'totalConcepts': value['totalConcepts'],
68
+ 'assessedConcepts': value['assessedConcepts'],
69
+ 'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
70
+ };
71
+ }
@@ -61,6 +61,8 @@ export * from './TaxonomyEnrollment';
61
61
  export * from './TaxonomyEnrollmentWithTaxonomy';
62
62
  export * from './TaxonomyNode';
63
63
  export * from './TaxonomyNodeConcept';
64
+ export * from './TaxonomyProgress';
65
+ export * from './TaxonomyProgressNode';
64
66
  export * from './TaxonomySummary';
65
67
  export * from './UpdateAccountDto';
66
68
  export * from './UpdateChatRequest';
@@ -63,6 +63,8 @@ export * from './TaxonomyEnrollment';
63
63
  export * from './TaxonomyEnrollmentWithTaxonomy';
64
64
  export * from './TaxonomyNode';
65
65
  export * from './TaxonomyNodeConcept';
66
+ export * from './TaxonomyProgress';
67
+ export * from './TaxonomyProgressNode';
66
68
  export * from './TaxonomySummary';
67
69
  export * from './UpdateAccountDto';
68
70
  export * from './UpdateChatRequest';
@@ -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 { TaxonomyProgressNode } from './TaxonomyProgressNode';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface TaxonomyProgress
17
+ */
18
+ export interface TaxonomyProgress {
19
+ /**
20
+ * Root-level weighted average of strength (0–1)
21
+ * @type {number}
22
+ * @memberof TaxonomyProgress
23
+ */
24
+ readinessScore: number;
25
+ /**
26
+ * Total concepts in the taxonomy
27
+ * @type {number}
28
+ * @memberof TaxonomyProgress
29
+ */
30
+ totalConcepts: number;
31
+ /**
32
+ * Number of concepts with a user_concepts row
33
+ * @type {number}
34
+ * @memberof TaxonomyProgress
35
+ */
36
+ assessedConcepts: number;
37
+ /**
38
+ * Root-level progress nodes
39
+ * @type {Array<TaxonomyProgressNode>}
40
+ * @memberof TaxonomyProgress
41
+ */
42
+ nodes: Array<TaxonomyProgressNode>;
43
+ }
44
+ /**
45
+ * Check if a given object implements the TaxonomyProgress interface.
46
+ */
47
+ export declare function instanceOfTaxonomyProgress(value: object): value is TaxonomyProgress;
48
+ export declare function TaxonomyProgressFromJSON(json: any): TaxonomyProgress;
49
+ export declare function TaxonomyProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgress;
50
+ export declare function TaxonomyProgressToJSON(json: any): TaxonomyProgress;
51
+ export declare function TaxonomyProgressToJSONTyped(value?: TaxonomyProgress | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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.instanceOfTaxonomyProgress = instanceOfTaxonomyProgress;
17
+ exports.TaxonomyProgressFromJSON = TaxonomyProgressFromJSON;
18
+ exports.TaxonomyProgressFromJSONTyped = TaxonomyProgressFromJSONTyped;
19
+ exports.TaxonomyProgressToJSON = TaxonomyProgressToJSON;
20
+ exports.TaxonomyProgressToJSONTyped = TaxonomyProgressToJSONTyped;
21
+ const TaxonomyProgressNode_1 = require("./TaxonomyProgressNode");
22
+ /**
23
+ * Check if a given object implements the TaxonomyProgress interface.
24
+ */
25
+ function instanceOfTaxonomyProgress(value) {
26
+ if (!('readinessScore' in value) || value['readinessScore'] === undefined)
27
+ return false;
28
+ if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
29
+ return false;
30
+ if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
31
+ return false;
32
+ if (!('nodes' in value) || value['nodes'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ function TaxonomyProgressFromJSON(json) {
37
+ return TaxonomyProgressFromJSONTyped(json, false);
38
+ }
39
+ function TaxonomyProgressFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'readinessScore': json['readinessScore'],
45
+ 'totalConcepts': json['totalConcepts'],
46
+ 'assessedConcepts': json['assessedConcepts'],
47
+ 'nodes': (json['nodes'].map(TaxonomyProgressNode_1.TaxonomyProgressNodeFromJSON)),
48
+ };
49
+ }
50
+ function TaxonomyProgressToJSON(json) {
51
+ return TaxonomyProgressToJSONTyped(json, false);
52
+ }
53
+ function TaxonomyProgressToJSONTyped(value, ignoreDiscriminator = false) {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'readinessScore': value['readinessScore'],
59
+ 'totalConcepts': value['totalConcepts'],
60
+ 'assessedConcepts': value['assessedConcepts'],
61
+ 'nodes': (value['nodes'].map(TaxonomyProgressNode_1.TaxonomyProgressNodeToJSON)),
62
+ };
63
+ }
@@ -0,0 +1,74 @@
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 TaxonomyProgressNode
16
+ */
17
+ export interface TaxonomyProgressNode {
18
+ /**
19
+ * Node ID
20
+ * @type {string}
21
+ * @memberof TaxonomyProgressNode
22
+ */
23
+ id: string;
24
+ /**
25
+ * Node name
26
+ * @type {string}
27
+ * @memberof TaxonomyProgressNode
28
+ */
29
+ name: string;
30
+ /**
31
+ * Node weight (normalized among siblings)
32
+ * @type {number}
33
+ * @memberof TaxonomyProgressNode
34
+ */
35
+ weight: number | null;
36
+ /**
37
+ * Average strength of concepts (0–1)
38
+ * @type {number}
39
+ * @memberof TaxonomyProgressNode
40
+ */
41
+ strength: number;
42
+ /**
43
+ * Average confidence of concepts (0–1)
44
+ * @type {number}
45
+ * @memberof TaxonomyProgressNode
46
+ */
47
+ confidence: number;
48
+ /**
49
+ * Total concepts under this node (including descendants)
50
+ * @type {number}
51
+ * @memberof TaxonomyProgressNode
52
+ */
53
+ totalConcepts: number;
54
+ /**
55
+ * Number of concepts with a user_concepts row (including descendants)
56
+ * @type {number}
57
+ * @memberof TaxonomyProgressNode
58
+ */
59
+ assessedConcepts: number;
60
+ /**
61
+ * Child nodes
62
+ * @type {Array<TaxonomyProgressNode>}
63
+ * @memberof TaxonomyProgressNode
64
+ */
65
+ children: Array<TaxonomyProgressNode>;
66
+ }
67
+ /**
68
+ * Check if a given object implements the TaxonomyProgressNode interface.
69
+ */
70
+ export declare function instanceOfTaxonomyProgressNode(value: object): value is TaxonomyProgressNode;
71
+ export declare function TaxonomyProgressNodeFromJSON(json: any): TaxonomyProgressNode;
72
+ export declare function TaxonomyProgressNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyProgressNode;
73
+ export declare function TaxonomyProgressNodeToJSON(json: any): TaxonomyProgressNode;
74
+ export declare function TaxonomyProgressNodeToJSONTyped(value?: TaxonomyProgressNode | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,78 @@
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.instanceOfTaxonomyProgressNode = instanceOfTaxonomyProgressNode;
17
+ exports.TaxonomyProgressNodeFromJSON = TaxonomyProgressNodeFromJSON;
18
+ exports.TaxonomyProgressNodeFromJSONTyped = TaxonomyProgressNodeFromJSONTyped;
19
+ exports.TaxonomyProgressNodeToJSON = TaxonomyProgressNodeToJSON;
20
+ exports.TaxonomyProgressNodeToJSONTyped = TaxonomyProgressNodeToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the TaxonomyProgressNode interface.
23
+ */
24
+ function instanceOfTaxonomyProgressNode(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('name' in value) || value['name'] === undefined)
28
+ return false;
29
+ if (!('weight' in value) || value['weight'] === undefined)
30
+ return false;
31
+ if (!('strength' in value) || value['strength'] === undefined)
32
+ return false;
33
+ if (!('confidence' in value) || value['confidence'] === undefined)
34
+ return false;
35
+ if (!('totalConcepts' in value) || value['totalConcepts'] === undefined)
36
+ return false;
37
+ if (!('assessedConcepts' in value) || value['assessedConcepts'] === undefined)
38
+ return false;
39
+ if (!('children' in value) || value['children'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ function TaxonomyProgressNodeFromJSON(json) {
44
+ return TaxonomyProgressNodeFromJSONTyped(json, false);
45
+ }
46
+ function TaxonomyProgressNodeFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'id': json['id'],
52
+ 'name': json['name'],
53
+ 'weight': json['weight'],
54
+ 'strength': json['strength'],
55
+ 'confidence': json['confidence'],
56
+ 'totalConcepts': json['totalConcepts'],
57
+ 'assessedConcepts': json['assessedConcepts'],
58
+ 'children': (json['children'].map(TaxonomyProgressNodeFromJSON)),
59
+ };
60
+ }
61
+ function TaxonomyProgressNodeToJSON(json) {
62
+ return TaxonomyProgressNodeToJSONTyped(json, false);
63
+ }
64
+ function TaxonomyProgressNodeToJSONTyped(value, ignoreDiscriminator = false) {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+ return {
69
+ 'id': value['id'],
70
+ 'name': value['name'],
71
+ 'weight': value['weight'],
72
+ 'strength': value['strength'],
73
+ 'confidence': value['confidence'],
74
+ 'totalConcepts': value['totalConcepts'],
75
+ 'assessedConcepts': value['assessedConcepts'],
76
+ 'children': (value['children'].map(TaxonomyProgressNodeToJSON)),
77
+ };
78
+ }
@@ -61,6 +61,8 @@ export * from './TaxonomyEnrollment';
61
61
  export * from './TaxonomyEnrollmentWithTaxonomy';
62
62
  export * from './TaxonomyNode';
63
63
  export * from './TaxonomyNodeConcept';
64
+ export * from './TaxonomyProgress';
65
+ export * from './TaxonomyProgressNode';
64
66
  export * from './TaxonomySummary';
65
67
  export * from './UpdateAccountDto';
66
68
  export * from './UpdateChatRequest';
@@ -79,6 +79,8 @@ __exportStar(require("./TaxonomyEnrollment"), exports);
79
79
  __exportStar(require("./TaxonomyEnrollmentWithTaxonomy"), exports);
80
80
  __exportStar(require("./TaxonomyNode"), exports);
81
81
  __exportStar(require("./TaxonomyNodeConcept"), exports);
82
+ __exportStar(require("./TaxonomyProgress"), exports);
83
+ __exportStar(require("./TaxonomyProgressNode"), exports);
82
84
  __exportStar(require("./TaxonomySummary"), exports);
83
85
  __exportStar(require("./UpdateAccountDto"), exports);
84
86
  __exportStar(require("./UpdateChatRequest"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.7.2",
4
+ "version": "2.9.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {