@instructure/athena-api-client 2.22.6 → 2.22.7

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

@@ -0,0 +1,65 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CanvasTaxonomyEntity
+ */
+export interface CanvasTaxonomyEntity {
+    /**
+     * Taxonomy UUID
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    id: string;
+    /**
+     * URL slug (e.g. canvas-12345)
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    slug: string;
+    /**
+     * Canvas course name
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    name: string;
+    /**
+     * Current generation status. Poll GET /api/v1/taxonomies/by-slug/{slug} until "active".
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    status: CanvasTaxonomyEntityStatusEnum;
+    /**
+     * True if this call created a new taxonomy record; false if one already existed
+     * @type {boolean}
+     * @memberof CanvasTaxonomyEntity
+     */
+    created: boolean;
+}
+/**
+ * @export
+ */
+export declare const CanvasTaxonomyEntityStatusEnum: {
+    readonly Pending: "pending";
+    readonly Active: "active";
+    readonly Failed: "failed";
+};
+export type CanvasTaxonomyEntityStatusEnum = typeof CanvasTaxonomyEntityStatusEnum[keyof typeof CanvasTaxonomyEntityStatusEnum];
+/**
+ * Check if a given object implements the CanvasTaxonomyEntity interface.
+ */
+export declare function instanceOfCanvasTaxonomyEntity(value: object): value is CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityFromJSON(json: any): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityToJSON(json: any): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityToJSONTyped(value?: CanvasTaxonomyEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CanvasTaxonomyEntity.js

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const CanvasTaxonomyEntityStatusEnum = {
+    Pending: 'pending',
+    Active: 'active',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the CanvasTaxonomyEntity interface.
+ */
+export function instanceOfCanvasTaxonomyEntity(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('created' in value) || value['created'] === undefined)
+        return false;
+    return true;
+}
+export function CanvasTaxonomyEntityFromJSON(json) {
+    return CanvasTaxonomyEntityFromJSONTyped(json, false);
+}
+export function CanvasTaxonomyEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'status': json['status'],
+        'created': json['created'],
+    };
+}
+export function CanvasTaxonomyEntityToJSON(json) {
+    return CanvasTaxonomyEntityToJSONTyped(json, false);
+}
+export function CanvasTaxonomyEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'slug': value['slug'],
+        'name': value['name'],
+        'status': value['status'],
+        'created': value['created'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConceptAssessmentEntity
+ */
+export interface ConceptAssessmentEntity {
+    /**
+     * Concept UUID
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    conceptId: string;
+    /**
+     * Full concept name
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    name: string;
+    /**
+     * Short label (≤ 64 chars)
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    shortName: string;
+    /**
+     * Estimated competency (0–1)
+     * @type {number}
+     * @memberof ConceptAssessmentEntity
+     */
+    strength: number;
+    /**
+     * Confidence in the estimate (0–1)
+     * @type {number}
+     * @memberof ConceptAssessmentEntity
+     */
+    confidence: number;
+}
+/**
+ * Check if a given object implements the ConceptAssessmentEntity interface.
+ */
+export declare function instanceOfConceptAssessmentEntity(value: object): value is ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityFromJSON(json: any): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityToJSON(json: any): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityToJSONTyped(value?: ConceptAssessmentEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptAssessmentEntity.js

@@ -0,0 +1,59 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ConceptAssessmentEntity interface.
+ */
+export function instanceOfConceptAssessmentEntity(value) {
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('shortName' in value) || value['shortName'] === undefined)
+        return false;
+    if (!('strength' in value) || value['strength'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptAssessmentEntityFromJSON(json) {
+    return ConceptAssessmentEntityFromJSONTyped(json, false);
+}
+export function ConceptAssessmentEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'],
+        'name': json['name'],
+        'shortName': json['shortName'],
+        'strength': json['strength'],
+        'confidence': json['confidence'],
+    };
+}
+export function ConceptAssessmentEntityToJSON(json) {
+    return ConceptAssessmentEntityToJSONTyped(json, false);
+}
+export function ConceptAssessmentEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+        'name': value['name'],
+        'shortName': value['shortName'],
+        'strength': value['strength'],
+        'confidence': value['confidence'],
+    };
+}

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

@@ -76,7 +76,9 @@ export interface TaxonomyDetail {
  */
 export declare const TaxonomyDetailStatusEnum: {
     readonly Draft: "draft";
+    readonly Pending: "pending";
     readonly Active: "active";
+    readonly Failed: "failed";
 };
 export type TaxonomyDetailStatusEnum = typeof TaxonomyDetailStatusEnum[keyof typeof TaxonomyDetailStatusEnum];
 /**

package/dist/esm/models/TaxonomyDetail.js

@@ -17,7 +17,9 @@ import { TaxonomyNodeFromJSON, TaxonomyNodeToJSON, } from './TaxonomyNode';
  */
 export const TaxonomyDetailStatusEnum = {
     Draft: 'draft',
-    Active: 'active'
+    Pending: 'pending',
+    Active: 'active',
+    Failed: 'failed'
 };
 /**
  * Check if a given object implements the TaxonomyDetail interface.

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

@@ -63,7 +63,9 @@ export interface TaxonomySummary {
  */
 export declare const TaxonomySummaryStatusEnum: {
     readonly Draft: "draft";
+    readonly Pending: "pending";
     readonly Active: "active";
+    readonly Failed: "failed";
 };
 export type TaxonomySummaryStatusEnum = typeof TaxonomySummaryStatusEnum[keyof typeof TaxonomySummaryStatusEnum];
 /**

package/dist/esm/models/TaxonomySummary.js

@@ -16,7 +16,9 @@
  */
 export const TaxonomySummaryStatusEnum = {
     Draft: 'draft',
-    Active: 'active'
+    Pending: 'pending',
+    Active: 'active',
+    Failed: 'failed'
 };
 /**
  * Check if a given object implements the TaxonomySummary interface.

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

@@ -13,6 +13,8 @@ export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
+export * from './CanvasKnowledgeAssessmentEntity';
+export * from './CanvasTaxonomyEntity';
 export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
@@ -22,6 +24,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ConceptAssessmentEntity';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';

package/dist/esm/models/index.js

@@ -15,6 +15,8 @@ export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserEngagement';
+export * from './CanvasKnowledgeAssessmentEntity';
+export * from './CanvasTaxonomyEntity';
 export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
@@ -24,6 +26,7 @@ export * from './ChatRequestMessageMetadata';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';
+export * from './ConceptAssessmentEntity';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateFeatureDto';

package/dist/models/CanvasKnowledgeAssessmentEntity.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ConceptAssessmentEntity } from './ConceptAssessmentEntity';
+/**
+ *
+ * @export
+ * @interface CanvasKnowledgeAssessmentEntity
+ */
+export interface CanvasKnowledgeAssessmentEntity {
+    /**
+     * Taxonomy UUID the assessment is scoped to
+     * @type {string}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    taxonomyId: string;
+    /**
+     * Number of concepts that received an estimate
+     * @type {number}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    assessed: number;
+    /**
+     *
+     * @type {Array<ConceptAssessmentEntity>}
+     * @memberof CanvasKnowledgeAssessmentEntity
+     */
+    concepts: Array<ConceptAssessmentEntity>;
+}
+/**
+ * Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
+ */
+export declare function instanceOfCanvasKnowledgeAssessmentEntity(value: object): value is CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityFromJSON(json: any): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityToJSON(json: any): CanvasKnowledgeAssessmentEntity;
+export declare function CanvasKnowledgeAssessmentEntityToJSONTyped(value?: CanvasKnowledgeAssessmentEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasKnowledgeAssessmentEntity.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCanvasKnowledgeAssessmentEntity = instanceOfCanvasKnowledgeAssessmentEntity;
+exports.CanvasKnowledgeAssessmentEntityFromJSON = CanvasKnowledgeAssessmentEntityFromJSON;
+exports.CanvasKnowledgeAssessmentEntityFromJSONTyped = CanvasKnowledgeAssessmentEntityFromJSONTyped;
+exports.CanvasKnowledgeAssessmentEntityToJSON = CanvasKnowledgeAssessmentEntityToJSON;
+exports.CanvasKnowledgeAssessmentEntityToJSONTyped = CanvasKnowledgeAssessmentEntityToJSONTyped;
+const ConceptAssessmentEntity_1 = require("./ConceptAssessmentEntity");
+/**
+ * Check if a given object implements the CanvasKnowledgeAssessmentEntity interface.
+ */
+function instanceOfCanvasKnowledgeAssessmentEntity(value) {
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('assessed' in value) || value['assessed'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    return true;
+}
+function CanvasKnowledgeAssessmentEntityFromJSON(json) {
+    return CanvasKnowledgeAssessmentEntityFromJSONTyped(json, false);
+}
+function CanvasKnowledgeAssessmentEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'taxonomyId': json['taxonomyId'],
+        'assessed': json['assessed'],
+        'concepts': (json['concepts'].map(ConceptAssessmentEntity_1.ConceptAssessmentEntityFromJSON)),
+    };
+}
+function CanvasKnowledgeAssessmentEntityToJSON(json) {
+    return CanvasKnowledgeAssessmentEntityToJSONTyped(json, false);
+}
+function CanvasKnowledgeAssessmentEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'taxonomyId': value['taxonomyId'],
+        'assessed': value['assessed'],
+        'concepts': (value['concepts'].map(ConceptAssessmentEntity_1.ConceptAssessmentEntityToJSON)),
+    };
+}

package/dist/models/CanvasTaxonomyEntity.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CanvasTaxonomyEntity
+ */
+export interface CanvasTaxonomyEntity {
+    /**
+     * Taxonomy UUID
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    id: string;
+    /**
+     * URL slug (e.g. canvas-12345)
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    slug: string;
+    /**
+     * Canvas course name
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    name: string;
+    /**
+     * Current generation status. Poll GET /api/v1/taxonomies/by-slug/{slug} until "active".
+     * @type {string}
+     * @memberof CanvasTaxonomyEntity
+     */
+    status: CanvasTaxonomyEntityStatusEnum;
+    /**
+     * True if this call created a new taxonomy record; false if one already existed
+     * @type {boolean}
+     * @memberof CanvasTaxonomyEntity
+     */
+    created: boolean;
+}
+/**
+ * @export
+ */
+export declare const CanvasTaxonomyEntityStatusEnum: {
+    readonly Pending: "pending";
+    readonly Active: "active";
+    readonly Failed: "failed";
+};
+export type CanvasTaxonomyEntityStatusEnum = typeof CanvasTaxonomyEntityStatusEnum[keyof typeof CanvasTaxonomyEntityStatusEnum];
+/**
+ * Check if a given object implements the CanvasTaxonomyEntity interface.
+ */
+export declare function instanceOfCanvasTaxonomyEntity(value: object): value is CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityFromJSON(json: any): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityToJSON(json: any): CanvasTaxonomyEntity;
+export declare function CanvasTaxonomyEntityToJSONTyped(value?: CanvasTaxonomyEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CanvasTaxonomyEntity.js

@@ -0,0 +1,75 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanvasTaxonomyEntityStatusEnum = void 0;
+exports.instanceOfCanvasTaxonomyEntity = instanceOfCanvasTaxonomyEntity;
+exports.CanvasTaxonomyEntityFromJSON = CanvasTaxonomyEntityFromJSON;
+exports.CanvasTaxonomyEntityFromJSONTyped = CanvasTaxonomyEntityFromJSONTyped;
+exports.CanvasTaxonomyEntityToJSON = CanvasTaxonomyEntityToJSON;
+exports.CanvasTaxonomyEntityToJSONTyped = CanvasTaxonomyEntityToJSONTyped;
+/**
+ * @export
+ */
+exports.CanvasTaxonomyEntityStatusEnum = {
+    Pending: 'pending',
+    Active: 'active',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the CanvasTaxonomyEntity interface.
+ */
+function instanceOfCanvasTaxonomyEntity(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('created' in value) || value['created'] === undefined)
+        return false;
+    return true;
+}
+function CanvasTaxonomyEntityFromJSON(json) {
+    return CanvasTaxonomyEntityFromJSONTyped(json, false);
+}
+function CanvasTaxonomyEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'status': json['status'],
+        'created': json['created'],
+    };
+}
+function CanvasTaxonomyEntityToJSON(json) {
+    return CanvasTaxonomyEntityToJSONTyped(json, false);
+}
+function CanvasTaxonomyEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'slug': value['slug'],
+        'name': value['name'],
+        'status': value['status'],
+        'created': value['created'],
+    };
+}

package/dist/models/ConceptAssessmentEntity.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConceptAssessmentEntity
+ */
+export interface ConceptAssessmentEntity {
+    /**
+     * Concept UUID
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    conceptId: string;
+    /**
+     * Full concept name
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    name: string;
+    /**
+     * Short label (≤ 64 chars)
+     * @type {string}
+     * @memberof ConceptAssessmentEntity
+     */
+    shortName: string;
+    /**
+     * Estimated competency (0–1)
+     * @type {number}
+     * @memberof ConceptAssessmentEntity
+     */
+    strength: number;
+    /**
+     * Confidence in the estimate (0–1)
+     * @type {number}
+     * @memberof ConceptAssessmentEntity
+     */
+    confidence: number;
+}
+/**
+ * Check if a given object implements the ConceptAssessmentEntity interface.
+ */
+export declare function instanceOfConceptAssessmentEntity(value: object): value is ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityFromJSON(json: any): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityToJSON(json: any): ConceptAssessmentEntity;
+export declare function ConceptAssessmentEntityToJSONTyped(value?: ConceptAssessmentEntity | null, ignoreDiscriminator?: boolean): any;