@instructure/athena-api-client 3.39.3 → 3.41.0

package/dist/esm/models/ResourceSharing.js

@@ -0,0 +1,51 @@
+/* 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 ResourceSharing interface.
+ */
+export function instanceOfResourceSharing(value) {
+    if (!('isShared' in value) || value['isShared'] === undefined)
+        return false;
+    if (!('shareToken' in value) || value['shareToken'] === undefined)
+        return false;
+    if (!('sharedAt' in value) || value['sharedAt'] === undefined)
+        return false;
+    return true;
+}
+export function ResourceSharingFromJSON(json) {
+    return ResourceSharingFromJSONTyped(json, false);
+}
+export function ResourceSharingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'isShared': json['isShared'],
+        'shareToken': json['shareToken'],
+        'sharedAt': (json['sharedAt'] == null ? null : new Date(json['sharedAt'])),
+    };
+}
+export function ResourceSharingToJSON(json) {
+    return ResourceSharingToJSONTyped(json, false);
+}
+export function ResourceSharingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'isShared': value['isShared'],
+        'shareToken': value['shareToken'],
+        'sharedAt': value['sharedAt'] == null ? value['sharedAt'] : value['sharedAt'].toISOString(),
+    };
+}

package/dist/esm/models/ScheduleStudySpaceTemplateDto.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 ScheduleStudySpaceTemplateDto
+ */
+export interface ScheduleStudySpaceTemplateDto {
+    /**
+     *
+     * @type {number}
+     * @memberof ScheduleStudySpaceTemplateDto
+     */
+    startIndex: number | null;
+}
+/**
+ * Check if a given object implements the ScheduleStudySpaceTemplateDto interface.
+ */
+export declare function instanceOfScheduleStudySpaceTemplateDto(value: object): value is ScheduleStudySpaceTemplateDto;
+export declare function ScheduleStudySpaceTemplateDtoFromJSON(json: any): ScheduleStudySpaceTemplateDto;
+export declare function ScheduleStudySpaceTemplateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleStudySpaceTemplateDto;
+export declare function ScheduleStudySpaceTemplateDtoToJSON(json: any): ScheduleStudySpaceTemplateDto;
+export declare function ScheduleStudySpaceTemplateDtoToJSONTyped(value?: ScheduleStudySpaceTemplateDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ScheduleStudySpaceTemplateDto.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 ScheduleStudySpaceTemplateDto interface.
+ */
+export function instanceOfScheduleStudySpaceTemplateDto(value) {
+    if (!('startIndex' in value) || value['startIndex'] === undefined)
+        return false;
+    return true;
+}
+export function ScheduleStudySpaceTemplateDtoFromJSON(json) {
+    return ScheduleStudySpaceTemplateDtoFromJSONTyped(json, false);
+}
+export function ScheduleStudySpaceTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'startIndex': json['startIndex'],
+    };
+}
+export function ScheduleStudySpaceTemplateDtoToJSON(json) {
+    return ScheduleStudySpaceTemplateDtoToJSONTyped(json, false);
+}
+export function ScheduleStudySpaceTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'startIndex': value['startIndex'],
+    };
+}

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

@@ -0,0 +1,97 @@
+/**
+ * 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 SharedQuiz
+ */
+export interface SharedQuiz {
+    /**
+     *
+     * @type {string}
+     * @memberof SharedQuiz
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedQuiz
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedQuiz
+     */
+    topic: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedQuiz
+     */
+    mode: SharedQuizModeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedQuiz
+     */
+    generationStatus: SharedQuizGenerationStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedQuiz
+     */
+    expectedQuestionCount: number | null;
+    /**
+     * Questions (or cards) persisted so far.
+     * @type {number}
+     * @memberof SharedQuiz
+     */
+    questionCount: number;
+    /**
+     * True when the caller is the quiz's owner following their own link.
+     * @type {boolean}
+     * @memberof SharedQuiz
+     */
+    isOwner: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof SharedQuiz
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const SharedQuizModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type SharedQuizModeEnum = typeof SharedQuizModeEnum[keyof typeof SharedQuizModeEnum];
+/**
+ * @export
+ */
+export declare const SharedQuizGenerationStatusEnum: {
+    readonly Generating: "generating";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type SharedQuizGenerationStatusEnum = typeof SharedQuizGenerationStatusEnum[keyof typeof SharedQuizGenerationStatusEnum];
+/**
+ * Check if a given object implements the SharedQuiz interface.
+ */
+export declare function instanceOfSharedQuiz(value: object): value is SharedQuiz;
+export declare function SharedQuizFromJSON(json: any): SharedQuiz;
+export declare function SharedQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): SharedQuiz;
+export declare function SharedQuizToJSON(json: any): SharedQuiz;
+export declare function SharedQuizToJSONTyped(value?: SharedQuiz | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SharedQuiz.js

@@ -0,0 +1,90 @@
+/* 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 SharedQuizModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * @export
+ */
+export const SharedQuizGenerationStatusEnum = {
+    Generating: 'generating',
+    Ready: 'ready',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the SharedQuiz interface.
+ */
+export function instanceOfSharedQuiz(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('generationStatus' in value) || value['generationStatus'] === undefined)
+        return false;
+    if (!('expectedQuestionCount' in value) || value['expectedQuestionCount'] === undefined)
+        return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined)
+        return false;
+    if (!('isOwner' in value) || value['isOwner'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function SharedQuizFromJSON(json) {
+    return SharedQuizFromJSONTyped(json, false);
+}
+export function SharedQuizFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'topic': json['topic'],
+        'mode': json['mode'],
+        'generationStatus': json['generationStatus'],
+        'expectedQuestionCount': json['expectedQuestionCount'],
+        'questionCount': json['questionCount'],
+        'isOwner': json['isOwner'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function SharedQuizToJSON(json) {
+    return SharedQuizToJSONTyped(json, false);
+}
+export function SharedQuizToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'topic': value['topic'],
+        'mode': value['mode'],
+        'generationStatus': value['generationStatus'],
+        'expectedQuestionCount': value['expectedQuestionCount'],
+        'questionCount': value['questionCount'],
+        'isOwner': value['isOwner'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -54,11 +54,17 @@ export interface StudyObjective {
      */
     canvasObjectRef: string | null;
     /**
-     * Origin of the objective: 'user' (client-created) or 'syllabus' (derived internally). Read-only.
+     * Origin of the objective: 'user' (client-created), 'syllabus' (derived internally) or 'template' (copied from a study-space template when the space was created; edits like 'user'). Read-only.
      * @type {string}
      * @memberof StudyObjective
      */
     source: StudyObjectiveSourceEnum;
+    /**
+     * For a 'template' objective, `<template slug>/<objective key>` of the package entry it was copied from; null for every other source. Read-only.
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    templateKey: string | null;
     /**
      *
      * @type {string}
@@ -114,6 +120,7 @@ export interface StudyObjective {
 export declare const StudyObjectiveSourceEnum: {
     readonly User: "user";
     readonly Syllabus: "syllabus";
+    readonly Template: "template";
 };
 export type StudyObjectiveSourceEnum = typeof StudyObjectiveSourceEnum[keyof typeof StudyObjectiveSourceEnum];
 /**

package/dist/esm/models/StudyObjective.js

@@ -18,7 +18,8 @@ import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSO
  */
 export const StudyObjectiveSourceEnum = {
     User: 'user',
-    Syllabus: 'syllabus'
+    Syllabus: 'syllabus',
+    Template: 'template'
 };
 /**
  * Check if a given object implements the StudyObjective interface.
@@ -38,6 +39,8 @@ export function instanceOfStudyObjective(value) {
         return false;
     if (!('source' in value) || value['source'] === undefined)
         return false;
+    if (!('templateKey' in value) || value['templateKey'] === undefined)
+        return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
     if (!('notes' in value) || value['notes'] === undefined)
@@ -71,6 +74,7 @@ export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
         'canvasObjectId': json['canvasObjectId'],
         'canvasObjectRef': json['canvasObjectRef'],
         'source': json['source'],
+        'templateKey': json['templateKey'],
         'title': json['title'],
         'notes': json['notes'],
         'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
@@ -96,6 +100,7 @@ export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
         'canvasObjectId': value['canvasObjectId'],
         'canvasObjectRef': value['canvasObjectRef'],
         'source': value['source'],
+        'templateKey': value['templateKey'],
         'title': value['title'],
         'notes': value['notes'],
         'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),

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

@@ -33,6 +33,18 @@ export interface StudySpace {
      * @memberof StudySpace
      */
     title: string;
+    /**
+     * Slug of the study-space template this space was created from, or null for a space that wasn't created from a template.
+     * @type {string}
+     * @memberof StudySpace
+     */
+    templateSlug: string | null;
+    /**
+     * Version of the template package the space was copied from (a later version never changes an existing space), or null when templateSlug is null.
+     * @type {string}
+     * @memberof StudySpace
+     */
+    templateVersion: string | null;
     /**
      * Number of non-archived study objectives in this space.
      * @type {number}

package/dist/esm/models/StudySpace.js

@@ -21,6 +21,10 @@ export function instanceOfStudySpace(value) {
         return false;
     if (!('title' in value) || value['title'] === undefined)
         return false;
+    if (!('templateSlug' in value) || value['templateSlug'] === undefined)
+        return false;
+    if (!('templateVersion' in value) || value['templateVersion'] === undefined)
+        return false;
     if (!('activeObjectiveCount' in value) || value['activeObjectiveCount'] === undefined)
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
@@ -40,6 +44,8 @@ export function StudySpaceFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'courseId': json['courseId'],
         'title': json['title'],
+        'templateSlug': json['templateSlug'],
+        'templateVersion': json['templateVersion'],
         'activeObjectiveCount': json['activeObjectiveCount'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
@@ -56,6 +62,8 @@ export function StudySpaceToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'courseId': value['courseId'],
         'title': value['title'],
+        'templateSlug': value['templateSlug'],
+        'templateVersion': value['templateVersion'],
         'activeObjectiveCount': value['activeObjectiveCount'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { StudySpace } from './StudySpace';
+import type { StudyObjective } from './StudyObjective';
+/**
+ *
+ * @export
+ * @interface StudySpaceFromTemplate
+ */
+export interface StudySpaceFromTemplate {
+    /**
+     *
+     * @type {StudySpace}
+     * @memberof StudySpaceFromTemplate
+     */
+    space: StudySpace;
+    /**
+     * The space's objectives in schedule order
+     * @type {Array<StudyObjective>}
+     * @memberof StudySpaceFromTemplate
+     */
+    objectives: Array<StudyObjective>;
+}
+/**
+ * Check if a given object implements the StudySpaceFromTemplate interface.
+ */
+export declare function instanceOfStudySpaceFromTemplate(value: object): value is StudySpaceFromTemplate;
+export declare function StudySpaceFromTemplateFromJSON(json: any): StudySpaceFromTemplate;
+export declare function StudySpaceFromTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceFromTemplate;
+export declare function StudySpaceFromTemplateToJSON(json: any): StudySpaceFromTemplate;
+export declare function StudySpaceFromTemplateToJSONTyped(value?: StudySpaceFromTemplate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudySpaceFromTemplate.js

@@ -0,0 +1,49 @@
+/* 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 { StudySpaceFromJSON, StudySpaceToJSON, } from './StudySpace';
+import { StudyObjectiveFromJSON, StudyObjectiveToJSON, } from './StudyObjective';
+/**
+ * Check if a given object implements the StudySpaceFromTemplate interface.
+ */
+export function instanceOfStudySpaceFromTemplate(value) {
+    if (!('space' in value) || value['space'] === undefined)
+        return false;
+    if (!('objectives' in value) || value['objectives'] === undefined)
+        return false;
+    return true;
+}
+export function StudySpaceFromTemplateFromJSON(json) {
+    return StudySpaceFromTemplateFromJSONTyped(json, false);
+}
+export function StudySpaceFromTemplateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'space': StudySpaceFromJSON(json['space']),
+        'objectives': (json['objectives'].map(StudyObjectiveFromJSON)),
+    };
+}
+export function StudySpaceFromTemplateToJSON(json) {
+    return StudySpaceFromTemplateToJSONTyped(json, false);
+}
+export function StudySpaceFromTemplateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'space': StudySpaceToJSON(value['space']),
+        'objectives': (value['objectives'].map(StudyObjectiveToJSON)),
+    };
+}

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

@@ -0,0 +1,117 @@
+/**
+ * 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 { StudySpaceTemplateProvenance } from './StudySpaceTemplateProvenance';
+import type { StudySpaceTemplateConfirm } from './StudySpaceTemplateConfirm';
+import type { StudySpaceTemplateLegal } from './StudySpaceTemplateLegal';
+import type { StudySpaceTemplateSchedule } from './StudySpaceTemplateSchedule';
+import type { StudySpaceTemplateObjective } from './StudySpaceTemplateObjective';
+import type { StudySpaceTemplateAnchor } from './StudySpaceTemplateAnchor';
+import type { StudySpaceTemplateLink } from './StudySpaceTemplateLink';
+/**
+ *
+ * @export
+ * @interface StudySpaceTemplate
+ */
+export interface StudySpaceTemplate {
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    slug: string;
+    /**
+     * Content version of the package
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    version: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    tagline: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    scopeNote: string | null;
+    /**
+     *
+     * @type {Array<StudySpaceTemplateLink>}
+     * @memberof StudySpaceTemplate
+     */
+    links: Array<StudySpaceTemplateLink>;
+    /**
+     *
+     * @type {StudySpaceTemplateLegal}
+     * @memberof StudySpaceTemplate
+     */
+    legal: StudySpaceTemplateLegal | null;
+    /**
+     *
+     * @type {StudySpaceTemplateProvenance}
+     * @memberof StudySpaceTemplate
+     */
+    provenance: StudySpaceTemplateProvenance;
+    /**
+     *
+     * @type {StudySpaceTemplateAnchor}
+     * @memberof StudySpaceTemplate
+     */
+    anchor: StudySpaceTemplateAnchor;
+    /**
+     *
+     * @type {StudySpaceTemplateSchedule}
+     * @memberof StudySpaceTemplate
+     */
+    schedule: StudySpaceTemplateSchedule;
+    /**
+     * The objectives the template creates, in course order
+     * @type {Array<StudySpaceTemplateObjective>}
+     * @memberof StudySpaceTemplate
+     */
+    objectives: Array<StudySpaceTemplateObjective>;
+    /**
+     * Distinct concepts across the units, counted by name as the template lists them
+     * @type {number}
+     * @memberof StudySpaceTemplate
+     */
+    conceptCount: number;
+    /**
+     *
+     * @type {StudySpaceTemplateConfirm}
+     * @memberof StudySpaceTemplate
+     */
+    confirm: StudySpaceTemplateConfirm;
+    /**
+     * The caller's newest space created from this template, if any — creating another is still allowed
+     * @type {string}
+     * @memberof StudySpaceTemplate
+     */
+    existingSpaceId: string | null;
+}
+/**
+ * Check if a given object implements the StudySpaceTemplate interface.
+ */
+export declare function instanceOfStudySpaceTemplate(value: object): value is StudySpaceTemplate;
+export declare function StudySpaceTemplateFromJSON(json: any): StudySpaceTemplate;
+export declare function StudySpaceTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudySpaceTemplate;
+export declare function StudySpaceTemplateToJSON(json: any): StudySpaceTemplate;
+export declare function StudySpaceTemplateToJSONTyped(value?: StudySpaceTemplate | null, ignoreDiscriminator?: boolean): any;