@instructure/athena-api-client 4.0.0 → 4.0.2

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

@@ -74,11 +74,29 @@ export interface AdminConceptDiagramDetail {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptDiagramDetail
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptDiagramDetail
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptDiagramDetail
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptDiagramDetail
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptDiagramDetail.js

@@ -54,6 +54,12 @@ export function instanceOfAdminConceptDiagramDetail(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -106,6 +112,9 @@ export function AdminConceptDiagramDetailFromJSONTyped(json, ignoreDiscriminator
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -142,6 +151,9 @@ export function AdminConceptDiagramDetailToJSONTyped(value, ignoreDiscriminator
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -72,11 +72,29 @@ export interface AdminConceptImage {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptImage
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptImage
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptImage
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImage
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptImage.js

@@ -52,6 +52,12 @@ export function instanceOfAdminConceptImage(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -98,6 +104,9 @@ export function AdminConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -131,6 +140,9 @@ export function AdminConceptImageToJSONTyped(value, ignoreDiscriminator = false)
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -74,11 +74,29 @@ export interface AdminConceptImageDetail {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminConceptImageDetail
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminConceptImageDetail
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminConceptImageDetail
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminConceptImageDetail
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminConceptImageDetail.js

@@ -54,6 +54,12 @@ export function instanceOfAdminConceptImageDetail(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -112,6 +118,9 @@ export function AdminConceptImageDetailFromJSONTyped(json, ignoreDiscriminator)
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -151,6 +160,9 @@ export function AdminConceptImageDetailToJSONTyped(value, ignoreDiscriminator =
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -74,11 +74,29 @@ export interface AdminShownConceptDiagram {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminShownConceptDiagram
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminShownConceptDiagram
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminShownConceptDiagram
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptDiagram
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminShownConceptDiagram.js

@@ -54,6 +54,12 @@ export function instanceOfAdminShownConceptDiagram(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -110,6 +116,9 @@ export function AdminShownConceptDiagramFromJSONTyped(json, ignoreDiscriminator)
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -148,6 +157,9 @@ export function AdminShownConceptDiagramToJSONTyped(value, ignoreDiscriminator =
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -74,11 +74,29 @@ export interface AdminShownConceptImage {
      */
     hiddenAt: Date | null;
     /**
-     * Who hid it, when that account user is in the caller's account.
+     * Who hid it, when that account user is in the caller's account. For a hide from a learner flag (see hiddenByFlag), the learner who flagged it.
      * @type {AdminConceptMediaActor}
      * @memberof AdminShownConceptImage
      */
     hiddenBy: AdminConceptMediaActor | null;
+    /**
+     * True when the current hide came from a learner's thumbs-down flag rather than an admin. False when visible or hidden by an admin. List these with state=flagged.
+     * @type {boolean}
+     * @memberof AdminShownConceptImage
+     */
+    hiddenByFlag: boolean;
+    /**
+     * When an admin last showed (approved) it. A learner flag never hides an approved row. Cleared when an admin hides it again (hide, restore, or showing another version with hideOtherVersions).
+     * @type {Date}
+     * @memberof AdminShownConceptImage
+     */
+    approvedAt: Date | null;
+    /**
+     * Who approved it, when that account user is in the caller's account.
+     * @type {AdminConceptMediaActor}
+     * @memberof AdminShownConceptImage
+     */
+    approvedBy: AdminConceptMediaActor | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/AdminShownConceptImage.js

@@ -54,6 +54,12 @@ export function instanceOfAdminShownConceptImage(value) {
         return false;
     if (!('hiddenBy' in value) || value['hiddenBy'] === undefined)
         return false;
+    if (!('hiddenByFlag' in value) || value['hiddenByFlag'] === undefined)
+        return false;
+    if (!('approvedAt' in value) || value['approvedAt'] === undefined)
+        return false;
+    if (!('approvedBy' in value) || value['approvedBy'] === undefined)
+        return false;
     if (!('deletedAt' in value) || value['deletedAt'] === undefined)
         return false;
     if (!('deletedBy' in value) || value['deletedBy'] === undefined)
@@ -116,6 +122,9 @@ export function AdminShownConceptImageFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': (new Date(json['createdAt'])),
         'hiddenAt': (json['hiddenAt'] == null ? null : new Date(json['hiddenAt'])),
         'hiddenBy': AdminConceptMediaActorFromJSON(json['hiddenBy']),
+        'hiddenByFlag': json['hiddenByFlag'],
+        'approvedAt': (json['approvedAt'] == null ? null : new Date(json['approvedAt'])),
+        'approvedBy': AdminConceptMediaActorFromJSON(json['approvedBy']),
         'deletedAt': (json['deletedAt'] == null ? null : new Date(json['deletedAt'])),
         'deletedBy': AdminConceptMediaActorFromJSON(json['deletedBy']),
         'model': json['model'],
@@ -157,6 +166,9 @@ export function AdminShownConceptImageToJSONTyped(value, ignoreDiscriminator = f
         'createdAt': value['createdAt'].toISOString(),
         'hiddenAt': value['hiddenAt'] == null ? value['hiddenAt'] : value['hiddenAt'].toISOString(),
         'hiddenBy': AdminConceptMediaActorToJSON(value['hiddenBy']),
+        'hiddenByFlag': value['hiddenByFlag'],
+        'approvedAt': value['approvedAt'] == null ? value['approvedAt'] : value['approvedAt'].toISOString(),
+        'approvedBy': AdminConceptMediaActorToJSON(value['approvedBy']),
         'deletedAt': value['deletedAt'] == null ? value['deletedAt'] : value['deletedAt'].toISOString(),
         'deletedBy': AdminConceptMediaActorToJSON(value['deletedBy']),
         'model': value['model'],

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

@@ -36,6 +36,7 @@ export declare const AssociateUserFileRequestKindEnum: {
     readonly Message: "message";
     readonly StudyObjective: "study_objective";
     readonly ObjectiveResource: "objective_resource";
+    readonly StudyGuide: "study_guide";
 };
 export type AssociateUserFileRequestKindEnum = typeof AssociateUserFileRequestKindEnum[keyof typeof AssociateUserFileRequestKindEnum];
 /**

package/dist/esm/models/AssociateUserFileRequest.js

@@ -18,7 +18,8 @@ export const AssociateUserFileRequestKindEnum = {
     Chat: 'chat',
     Message: 'message',
     StudyObjective: 'study_objective',
-    ObjectiveResource: 'objective_resource'
+    ObjectiveResource: 'objective_resource',
+    StudyGuide: 'study_guide'
 };
 /**
  * Check if a given object implements the AssociateUserFileRequest interface.

package/dist/esm/models/ConceptMediaFlagResult.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.
+ */
+/**
+ * The outcome of a learner flagging a concept image or diagram.
+ * @export
+ * @interface ConceptMediaFlagResult
+ */
+export interface ConceptMediaFlagResult {
+    /**
+     * True when the item is kept from learners after this call, whether this flag hid it or it was already hidden or removed. False when an admin has approved it, so the flag left it visible.
+     * @type {boolean}
+     * @memberof ConceptMediaFlagResult
+     */
+    hidden: boolean;
+}
+/**
+ * Check if a given object implements the ConceptMediaFlagResult interface.
+ */
+export declare function instanceOfConceptMediaFlagResult(value: object): value is ConceptMediaFlagResult;
+export declare function ConceptMediaFlagResultFromJSON(json: any): ConceptMediaFlagResult;
+export declare function ConceptMediaFlagResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConceptMediaFlagResult;
+export declare function ConceptMediaFlagResultToJSON(json: any): ConceptMediaFlagResult;
+export declare function ConceptMediaFlagResultToJSONTyped(value?: ConceptMediaFlagResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ConceptMediaFlagResult.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 ConceptMediaFlagResult interface.
+ */
+export function instanceOfConceptMediaFlagResult(value) {
+    if (!('hidden' in value) || value['hidden'] === undefined)
+        return false;
+    return true;
+}
+export function ConceptMediaFlagResultFromJSON(json) {
+    return ConceptMediaFlagResultFromJSONTyped(json, false);
+}
+export function ConceptMediaFlagResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'hidden': json['hidden'],
+    };
+}
+export function ConceptMediaFlagResultToJSON(json) {
+    return ConceptMediaFlagResultToJSONTyped(json, false);
+}
+export function ConceptMediaFlagResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'hidden': value['hidden'],
+    };
+}

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

@@ -0,0 +1,46 @@
+/**
+ * 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 CreateStudyGuideQuizRequest
+ */
+export interface CreateStudyGuideQuizRequest {
+    /**
+     * 'quiz' for a graded practice quiz, 'flashcards' for a deck.
+     * @type {string}
+     * @memberof CreateStudyGuideQuizRequest
+     */
+    mode?: CreateStudyGuideQuizRequestModeEnum;
+    /**
+     * Concepts on the guide to build from. Omit for the whole guide (the 'Take Practice Quiz' button). Ids not on the guide are ignored.
+     * @type {Array<string>}
+     * @memberof CreateStudyGuideQuizRequest
+     */
+    conceptIds?: Array<string>;
+}
+/**
+ * @export
+ */
+export declare const CreateStudyGuideQuizRequestModeEnum: {
+    readonly Quiz: "quiz";
+    readonly Flashcards: "flashcards";
+};
+export type CreateStudyGuideQuizRequestModeEnum = typeof CreateStudyGuideQuizRequestModeEnum[keyof typeof CreateStudyGuideQuizRequestModeEnum];
+/**
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
+ */
+export declare function instanceOfCreateStudyGuideQuizRequest(value: object): value is CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestFromJSON(json: any): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestToJSON(json: any): CreateStudyGuideQuizRequest;
+export declare function CreateStudyGuideQuizRequestToJSONTyped(value?: CreateStudyGuideQuizRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyGuideQuizRequest.js

@@ -0,0 +1,50 @@
+/* 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 CreateStudyGuideQuizRequestModeEnum = {
+    Quiz: 'quiz',
+    Flashcards: 'flashcards'
+};
+/**
+ * Check if a given object implements the CreateStudyGuideQuizRequest interface.
+ */
+export function instanceOfCreateStudyGuideQuizRequest(value) {
+    return true;
+}
+export function CreateStudyGuideQuizRequestFromJSON(json) {
+    return CreateStudyGuideQuizRequestFromJSONTyped(json, false);
+}
+export function CreateStudyGuideQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'mode': json['mode'] == null ? undefined : json['mode'],
+        'conceptIds': json['conceptIds'] == null ? undefined : json['conceptIds'],
+    };
+}
+export function CreateStudyGuideQuizRequestToJSON(json) {
+    return CreateStudyGuideQuizRequestToJSONTyped(json, false);
+}
+export function CreateStudyGuideQuizRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'mode': value['mode'],
+        'conceptIds': value['conceptIds'],
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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 CreateStudyGuideRequest
+ */
+export interface CreateStudyGuideRequest {
+    /**
+     * Study objective the guide is for. Its course, study space, Canvas link, due date, notes, attachments and extracted concepts all feed generation. When set, courseId/studySpaceId/canvasObjectRef are taken from it.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    studyObjectiveId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    studySpaceId?: string;
+    /**
+     * Canvas course id, when the guide is for a Canvas course.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    courseId?: string;
+    /**
+     * The Canvas assessment formatted '{type}:{local_id}' (e.g. 'quiz:123'). Read live (title, description, points, due date) when Canvas credentials are sent.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    canvasObjectRef?: string;
+    /**
+     * The chat the guide was requested from, if any.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    chatId?: string;
+    /**
+     * The assessment's name as the learner gave it, used when there is no Canvas item or objective to read it from.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    assessmentTitle?: string;
+    /**
+     * What the learner says is on the assessment, in their own words (chapters, topics, 'everything since the midterm'). The generator treats it as evidence of scope.
+     * @type {string}
+     * @memberof CreateStudyGuideRequest
+     */
+    learnerContext?: string;
+    /**
+     * Uploaded user files (from POST /api/v1/user-files/upload-url) to attach to the guide and read during generation. Each is associated with the guide as kind 'study_guide'.
+     * @type {Array<string>}
+     * @memberof CreateStudyGuideRequest
+     */
+    userFileIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the CreateStudyGuideRequest interface.
+ */
+export declare function instanceOfCreateStudyGuideRequest(value: object): value is CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestFromJSON(json: any): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestToJSON(json: any): CreateStudyGuideRequest;
+export declare function CreateStudyGuideRequestToJSONTyped(value?: CreateStudyGuideRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyGuideRequest.js

@@ -0,0 +1,55 @@
+/* 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 CreateStudyGuideRequest interface.
+ */
+export function instanceOfCreateStudyGuideRequest(value) {
+    return true;
+}
+export function CreateStudyGuideRequestFromJSON(json) {
+    return CreateStudyGuideRequestFromJSONTyped(json, false);
+}
+export function CreateStudyGuideRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'studyObjectiveId': json['studyObjectiveId'] == null ? undefined : json['studyObjectiveId'],
+        'studySpaceId': json['studySpaceId'] == null ? undefined : json['studySpaceId'],
+        'courseId': json['courseId'] == null ? undefined : json['courseId'],
+        'canvasObjectRef': json['canvasObjectRef'] == null ? undefined : json['canvasObjectRef'],
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'assessmentTitle': json['assessmentTitle'] == null ? undefined : json['assessmentTitle'],
+        'learnerContext': json['learnerContext'] == null ? undefined : json['learnerContext'],
+        'userFileIds': json['userFileIds'] == null ? undefined : json['userFileIds'],
+    };
+}
+export function CreateStudyGuideRequestToJSON(json) {
+    return CreateStudyGuideRequestToJSONTyped(json, false);
+}
+export function CreateStudyGuideRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'studyObjectiveId': value['studyObjectiveId'],
+        'studySpaceId': value['studySpaceId'],
+        'courseId': value['courseId'],
+        'canvasObjectRef': value['canvasObjectRef'],
+        'chatId': value['chatId'],
+        'assessmentTitle': value['assessmentTitle'],
+        'learnerContext': value['learnerContext'],
+        'userFileIds': value['userFileIds'],
+    };
+}