@instructure/athena-api-client 2.5.0 → 2.7.0

package/dist/esm/models/TaxonomyDetail.js

@@ -0,0 +1,83 @@
+/* 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.
+ */
+import { TaxonomyNodeFromJSON, TaxonomyNodeToJSON, } from './TaxonomyNode';
+/**
+ * @export
+ */
+export const TaxonomyDetailStatusEnum = {
+    Draft: 'draft',
+    Active: 'active'
+};
+/**
+ * Check if a given object implements the TaxonomyDetail interface.
+ */
+export function instanceOfTaxonomyDetail(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 (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('masteryThreshold' in value) || value['masteryThreshold'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if (!('nodes' in value) || value['nodes'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyDetailFromJSON(json) {
+    return TaxonomyDetailFromJSONTyped(json, false);
+}
+export function TaxonomyDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'slug': json['slug'],
+        'name': json['name'],
+        'description': json['description'],
+        'status': json['status'],
+        'masteryThreshold': json['masteryThreshold'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'nodes': (json['nodes'].map(TaxonomyNodeFromJSON)),
+    };
+}
+export function TaxonomyDetailToJSON(json) {
+    return TaxonomyDetailToJSONTyped(json, false);
+}
+export function TaxonomyDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'slug': value['slug'],
+        'name': value['name'],
+        'description': value['description'],
+        'status': value['status'],
+        'masteryThreshold': value['masteryThreshold'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+        'nodes': (value['nodes'].map(TaxonomyNodeToJSON)),
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 TaxonomyEnrollment
+ */
+export interface TaxonomyEnrollment {
+    /**
+     * Enrollment ID
+     * @type {string}
+     * @memberof TaxonomyEnrollment
+     */
+    id: string;
+    /**
+     * Account user ID
+     * @type {string}
+     * @memberof TaxonomyEnrollment
+     */
+    accountUserId: string;
+    /**
+     * Taxonomy ID
+     * @type {string}
+     * @memberof TaxonomyEnrollment
+     */
+    taxonomyId: string;
+    /**
+     * Enrollment timestamp
+     * @type {Date}
+     * @memberof TaxonomyEnrollment
+     */
+    enrolledAt: Date;
+    /**
+     * Enrollment status
+     * @type {string}
+     * @memberof TaxonomyEnrollment
+     */
+    status: TaxonomyEnrollmentStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const TaxonomyEnrollmentStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+};
+export type TaxonomyEnrollmentStatusEnum = typeof TaxonomyEnrollmentStatusEnum[keyof typeof TaxonomyEnrollmentStatusEnum];
+/**
+ * Check if a given object implements the TaxonomyEnrollment interface.
+ */
+export declare function instanceOfTaxonomyEnrollment(value: object): value is TaxonomyEnrollment;
+export declare function TaxonomyEnrollmentFromJSON(json: any): TaxonomyEnrollment;
+export declare function TaxonomyEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyEnrollment;
+export declare function TaxonomyEnrollmentToJSON(json: any): TaxonomyEnrollment;
+export declare function TaxonomyEnrollmentToJSONTyped(value?: TaxonomyEnrollment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyEnrollment.js

@@ -0,0 +1,66 @@
+/* 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 TaxonomyEnrollmentStatusEnum = {
+    Active: 'active',
+    Paused: 'paused'
+};
+/**
+ * Check if a given object implements the TaxonomyEnrollment interface.
+ */
+export function instanceOfTaxonomyEnrollment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('enrolledAt' in value) || value['enrolledAt'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyEnrollmentFromJSON(json) {
+    return TaxonomyEnrollmentFromJSONTyped(json, false);
+}
+export function TaxonomyEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'taxonomyId': json['taxonomyId'],
+        'enrolledAt': (new Date(json['enrolledAt'])),
+        'status': json['status'],
+    };
+}
+export function TaxonomyEnrollmentToJSON(json) {
+    return TaxonomyEnrollmentToJSONTyped(json, false);
+}
+export function TaxonomyEnrollmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'taxonomyId': value['taxonomyId'],
+        'enrolledAt': value['enrolledAt'].toISOString(),
+        'status': value['status'],
+    };
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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 { EnrollmentTaxonomy } from './EnrollmentTaxonomy';
+/**
+ *
+ * @export
+ * @interface TaxonomyEnrollmentWithTaxonomy
+ */
+export interface TaxonomyEnrollmentWithTaxonomy {
+    /**
+     * Enrollment ID
+     * @type {string}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    id: string;
+    /**
+     * Account user ID
+     * @type {string}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    accountUserId: string;
+    /**
+     * Taxonomy ID
+     * @type {string}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    taxonomyId: string;
+    /**
+     * Enrollment timestamp
+     * @type {Date}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    enrolledAt: Date;
+    /**
+     * Enrollment status
+     * @type {string}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    status: TaxonomyEnrollmentWithTaxonomyStatusEnum;
+    /**
+     * Taxonomy metadata
+     * @type {EnrollmentTaxonomy}
+     * @memberof TaxonomyEnrollmentWithTaxonomy
+     */
+    taxonomy: EnrollmentTaxonomy;
+}
+/**
+ * @export
+ */
+export declare const TaxonomyEnrollmentWithTaxonomyStatusEnum: {
+    readonly Active: "active";
+    readonly Paused: "paused";
+};
+export type TaxonomyEnrollmentWithTaxonomyStatusEnum = typeof TaxonomyEnrollmentWithTaxonomyStatusEnum[keyof typeof TaxonomyEnrollmentWithTaxonomyStatusEnum];
+/**
+ * Check if a given object implements the TaxonomyEnrollmentWithTaxonomy interface.
+ */
+export declare function instanceOfTaxonomyEnrollmentWithTaxonomy(value: object): value is TaxonomyEnrollmentWithTaxonomy;
+export declare function TaxonomyEnrollmentWithTaxonomyFromJSON(json: any): TaxonomyEnrollmentWithTaxonomy;
+export declare function TaxonomyEnrollmentWithTaxonomyFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyEnrollmentWithTaxonomy;
+export declare function TaxonomyEnrollmentWithTaxonomyToJSON(json: any): TaxonomyEnrollmentWithTaxonomy;
+export declare function TaxonomyEnrollmentWithTaxonomyToJSONTyped(value?: TaxonomyEnrollmentWithTaxonomy | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyEnrollmentWithTaxonomy.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+import { EnrollmentTaxonomyFromJSON, EnrollmentTaxonomyToJSON, } from './EnrollmentTaxonomy';
+/**
+ * @export
+ */
+export const TaxonomyEnrollmentWithTaxonomyStatusEnum = {
+    Active: 'active',
+    Paused: 'paused'
+};
+/**
+ * Check if a given object implements the TaxonomyEnrollmentWithTaxonomy interface.
+ */
+export function instanceOfTaxonomyEnrollmentWithTaxonomy(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('taxonomyId' in value) || value['taxonomyId'] === undefined)
+        return false;
+    if (!('enrolledAt' in value) || value['enrolledAt'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('taxonomy' in value) || value['taxonomy'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyEnrollmentWithTaxonomyFromJSON(json) {
+    return TaxonomyEnrollmentWithTaxonomyFromJSONTyped(json, false);
+}
+export function TaxonomyEnrollmentWithTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'taxonomyId': json['taxonomyId'],
+        'enrolledAt': (new Date(json['enrolledAt'])),
+        'status': json['status'],
+        'taxonomy': EnrollmentTaxonomyFromJSON(json['taxonomy']),
+    };
+}
+export function TaxonomyEnrollmentWithTaxonomyToJSON(json) {
+    return TaxonomyEnrollmentWithTaxonomyToJSONTyped(json, false);
+}
+export function TaxonomyEnrollmentWithTaxonomyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'taxonomyId': value['taxonomyId'],
+        'enrolledAt': value['enrolledAt'].toISOString(),
+        'status': value['status'],
+        'taxonomy': EnrollmentTaxonomyToJSON(value['taxonomy']),
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { TaxonomyNodeConcept } from './TaxonomyNodeConcept';
+/**
+ *
+ * @export
+ * @interface TaxonomyNode
+ */
+export interface TaxonomyNode {
+    /**
+     * Node ID
+     * @type {string}
+     * @memberof TaxonomyNode
+     */
+    id: string;
+    /**
+     * Node name
+     * @type {string}
+     * @memberof TaxonomyNode
+     */
+    name: string;
+    /**
+     * Node description
+     * @type {string}
+     * @memberof TaxonomyNode
+     */
+    description: string;
+    /**
+     * Node weight (decimal)
+     * @type {string}
+     * @memberof TaxonomyNode
+     */
+    weight: string | null;
+    /**
+     * Concepts mapped to this node
+     * @type {Array<TaxonomyNodeConcept>}
+     * @memberof TaxonomyNode
+     */
+    concepts: Array<TaxonomyNodeConcept>;
+    /**
+     * Child nodes
+     * @type {Array<TaxonomyNode>}
+     * @memberof TaxonomyNode
+     */
+    children: Array<TaxonomyNode>;
+}
+/**
+ * Check if a given object implements the TaxonomyNode interface.
+ */
+export declare function instanceOfTaxonomyNode(value: object): value is TaxonomyNode;
+export declare function TaxonomyNodeFromJSON(json: any): TaxonomyNode;
+export declare function TaxonomyNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyNode;
+export declare function TaxonomyNodeToJSON(json: any): TaxonomyNode;
+export declare function TaxonomyNodeToJSONTyped(value?: TaxonomyNode | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyNode.js

@@ -0,0 +1,64 @@
+/* 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.
+ */
+import { TaxonomyNodeConceptFromJSON, TaxonomyNodeConceptToJSON, } from './TaxonomyNodeConcept';
+/**
+ * Check if a given object implements the TaxonomyNode interface.
+ */
+export function instanceOfTaxonomyNode(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('weight' in value) || value['weight'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    if (!('children' in value) || value['children'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyNodeFromJSON(json) {
+    return TaxonomyNodeFromJSONTyped(json, false);
+}
+export function TaxonomyNodeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'weight': json['weight'],
+        'concepts': (json['concepts'].map(TaxonomyNodeConceptFromJSON)),
+        'children': (json['children'].map(TaxonomyNodeFromJSON)),
+    };
+}
+export function TaxonomyNodeToJSON(json) {
+    return TaxonomyNodeToJSONTyped(json, false);
+}
+export function TaxonomyNodeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'weight': value['weight'],
+        'concepts': (value['concepts'].map(TaxonomyNodeConceptToJSON)),
+        'children': (value['children'].map(TaxonomyNodeToJSON)),
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 TaxonomyNodeConcept
+ */
+export interface TaxonomyNodeConcept {
+    /**
+     * Concept ID
+     * @type {string}
+     * @memberof TaxonomyNodeConcept
+     */
+    conceptId: string;
+}
+/**
+ * Check if a given object implements the TaxonomyNodeConcept interface.
+ */
+export declare function instanceOfTaxonomyNodeConcept(value: object): value is TaxonomyNodeConcept;
+export declare function TaxonomyNodeConceptFromJSON(json: any): TaxonomyNodeConcept;
+export declare function TaxonomyNodeConceptFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomyNodeConcept;
+export declare function TaxonomyNodeConceptToJSON(json: any): TaxonomyNodeConcept;
+export declare function TaxonomyNodeConceptToJSONTyped(value?: TaxonomyNodeConcept | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TaxonomyNodeConcept.js

@@ -0,0 +1,43 @@
+/* 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 TaxonomyNodeConcept interface.
+ */
+export function instanceOfTaxonomyNodeConcept(value) {
+    if (!('conceptId' in value) || value['conceptId'] === undefined)
+        return false;
+    return true;
+}
+export function TaxonomyNodeConceptFromJSON(json) {
+    return TaxonomyNodeConceptFromJSONTyped(json, false);
+}
+export function TaxonomyNodeConceptFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conceptId': json['conceptId'],
+    };
+}
+export function TaxonomyNodeConceptToJSON(json) {
+    return TaxonomyNodeConceptToJSONTyped(json, false);
+}
+export function TaxonomyNodeConceptToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conceptId': value['conceptId'],
+    };
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 TaxonomySummary
+ */
+export interface TaxonomySummary {
+    /**
+     * Taxonomy ID
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    id: string;
+    /**
+     * URL slug
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    slug: string;
+    /**
+     * Taxonomy name
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    name: string;
+    /**
+     * Taxonomy description
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    description: string;
+    /**
+     * Taxonomy status
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    status: TaxonomySummaryStatusEnum;
+    /**
+     * Mastery threshold (decimal)
+     * @type {string}
+     * @memberof TaxonomySummary
+     */
+    masteryThreshold: string | null;
+}
+/**
+ * @export
+ */
+export declare const TaxonomySummaryStatusEnum: {
+    readonly Draft: "draft";
+    readonly Active: "active";
+};
+export type TaxonomySummaryStatusEnum = typeof TaxonomySummaryStatusEnum[keyof typeof TaxonomySummaryStatusEnum];
+/**
+ * Check if a given object implements the TaxonomySummary interface.
+ */
+export declare function instanceOfTaxonomySummary(value: object): value is TaxonomySummary;
+export declare function TaxonomySummaryFromJSON(json: any): TaxonomySummary;
+export declare function TaxonomySummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): TaxonomySummary;
+export declare function TaxonomySummaryToJSON(json: any): TaxonomySummary;
+export declare function TaxonomySummaryToJSONTyped(value?: TaxonomySummary | null, ignoreDiscriminator?: boolean): any;