@instructure/athena-api-client 3.39.3 → 3.41.0

package/dist/models/AdminPaginatedQuizParticipantSessions.js

@@ -0,0 +1,55 @@
+"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.instanceOfAdminPaginatedQuizParticipantSessions = instanceOfAdminPaginatedQuizParticipantSessions;
+exports.AdminPaginatedQuizParticipantSessionsFromJSON = AdminPaginatedQuizParticipantSessionsFromJSON;
+exports.AdminPaginatedQuizParticipantSessionsFromJSONTyped = AdminPaginatedQuizParticipantSessionsFromJSONTyped;
+exports.AdminPaginatedQuizParticipantSessionsToJSON = AdminPaginatedQuizParticipantSessionsToJSON;
+exports.AdminPaginatedQuizParticipantSessionsToJSONTyped = AdminPaginatedQuizParticipantSessionsToJSONTyped;
+const AdminQuizParticipantSessionListItem_1 = require("./AdminQuizParticipantSessionListItem");
+/**
+ * Check if a given object implements the AdminPaginatedQuizParticipantSessions interface.
+ */
+function instanceOfAdminPaginatedQuizParticipantSessions(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function AdminPaginatedQuizParticipantSessionsFromJSON(json) {
+    return AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, false);
+}
+function AdminPaginatedQuizParticipantSessionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminQuizParticipantSessionListItem_1.AdminQuizParticipantSessionListItemFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function AdminPaginatedQuizParticipantSessionsToJSON(json) {
+    return AdminPaginatedQuizParticipantSessionsToJSONTyped(json, false);
+}
+function AdminPaginatedQuizParticipantSessionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminQuizParticipantSessionListItem_1.AdminQuizParticipantSessionListItemToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/models/AdminQuizParticipantSessionListItem.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 { AdminQuizParticipantSessionScore } from './AdminQuizParticipantSessionScore';
+/**
+ *
+ * @export
+ * @interface AdminQuizParticipantSessionListItem
+ */
+export interface AdminQuizParticipantSessionListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    quizId: string;
+    /**
+     * External identifier of the learner who owns the session.
+     * @type {string}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    userId: string | null;
+    /**
+     * True for the quiz owner's own sessions, false for a learner who opened the quiz through its share link.
+     * @type {boolean}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    isOwner: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    status: AdminQuizParticipantSessionListItemStatusEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    completedAt: Date | null;
+    /**
+     *
+     * @type {AdminQuizParticipantSessionScore}
+     * @memberof AdminQuizParticipantSessionListItem
+     */
+    score: AdminQuizParticipantSessionScore;
+}
+/**
+ * @export
+ */
+export declare const AdminQuizParticipantSessionListItemStatusEnum: {
+    readonly Active: "active";
+    readonly Completed: "completed";
+    readonly Abandoned: "abandoned";
+};
+export type AdminQuizParticipantSessionListItemStatusEnum = typeof AdminQuizParticipantSessionListItemStatusEnum[keyof typeof AdminQuizParticipantSessionListItemStatusEnum];
+/**
+ * Check if a given object implements the AdminQuizParticipantSessionListItem interface.
+ */
+export declare function instanceOfAdminQuizParticipantSessionListItem(value: object): value is AdminQuizParticipantSessionListItem;
+export declare function AdminQuizParticipantSessionListItemFromJSON(json: any): AdminQuizParticipantSessionListItem;
+export declare function AdminQuizParticipantSessionListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminQuizParticipantSessionListItem;
+export declare function AdminQuizParticipantSessionListItemToJSON(json: any): AdminQuizParticipantSessionListItem;
+export declare function AdminQuizParticipantSessionListItemToJSONTyped(value?: AdminQuizParticipantSessionListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminQuizParticipantSessionListItem.js

@@ -0,0 +1,88 @@
+"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.AdminQuizParticipantSessionListItemStatusEnum = void 0;
+exports.instanceOfAdminQuizParticipantSessionListItem = instanceOfAdminQuizParticipantSessionListItem;
+exports.AdminQuizParticipantSessionListItemFromJSON = AdminQuizParticipantSessionListItemFromJSON;
+exports.AdminQuizParticipantSessionListItemFromJSONTyped = AdminQuizParticipantSessionListItemFromJSONTyped;
+exports.AdminQuizParticipantSessionListItemToJSON = AdminQuizParticipantSessionListItemToJSON;
+exports.AdminQuizParticipantSessionListItemToJSONTyped = AdminQuizParticipantSessionListItemToJSONTyped;
+const AdminQuizParticipantSessionScore_1 = require("./AdminQuizParticipantSessionScore");
+/**
+ * @export
+ */
+exports.AdminQuizParticipantSessionListItemStatusEnum = {
+    Active: 'active',
+    Completed: 'completed',
+    Abandoned: 'abandoned'
+};
+/**
+ * Check if a given object implements the AdminQuizParticipantSessionListItem interface.
+ */
+function instanceOfAdminQuizParticipantSessionListItem(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('isOwner' in value) || value['isOwner'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+function AdminQuizParticipantSessionListItemFromJSON(json) {
+    return AdminQuizParticipantSessionListItemFromJSONTyped(json, false);
+}
+function AdminQuizParticipantSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'quizId': json['quizId'],
+        'userId': json['userId'],
+        'isOwner': json['isOwner'],
+        'status': json['status'],
+        'startedAt': (new Date(json['startedAt'])),
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+        'score': (0, AdminQuizParticipantSessionScore_1.AdminQuizParticipantSessionScoreFromJSON)(json['score']),
+    };
+}
+function AdminQuizParticipantSessionListItemToJSON(json) {
+    return AdminQuizParticipantSessionListItemToJSONTyped(json, false);
+}
+function AdminQuizParticipantSessionListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'quizId': value['quizId'],
+        'userId': value['userId'],
+        'isOwner': value['isOwner'],
+        'status': value['status'],
+        'startedAt': value['startedAt'].toISOString(),
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'score': (0, AdminQuizParticipantSessionScore_1.AdminQuizParticipantSessionScoreToJSON)(value['score']),
+    };
+}

package/dist/models/AdminQuizParticipantSessionScore.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 AdminQuizParticipantSessionScore
+ */
+export interface AdminQuizParticipantSessionScore {
+    /**
+     *
+     * @type {number}
+     * @memberof AdminQuizParticipantSessionScore
+     */
+    totalCorrect: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminQuizParticipantSessionScore
+     */
+    totalQuestions: number;
+    /**
+     * Questions answered or rated in this session.
+     * @type {number}
+     * @memberof AdminQuizParticipantSessionScore
+     */
+    answeredCount: number;
+}
+/**
+ * Check if a given object implements the AdminQuizParticipantSessionScore interface.
+ */
+export declare function instanceOfAdminQuizParticipantSessionScore(value: object): value is AdminQuizParticipantSessionScore;
+export declare function AdminQuizParticipantSessionScoreFromJSON(json: any): AdminQuizParticipantSessionScore;
+export declare function AdminQuizParticipantSessionScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminQuizParticipantSessionScore;
+export declare function AdminQuizParticipantSessionScoreToJSON(json: any): AdminQuizParticipantSessionScore;
+export declare function AdminQuizParticipantSessionScoreToJSONTyped(value?: AdminQuizParticipantSessionScore | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminQuizParticipantSessionScore.js

@@ -0,0 +1,58 @@
+"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.instanceOfAdminQuizParticipantSessionScore = instanceOfAdminQuizParticipantSessionScore;
+exports.AdminQuizParticipantSessionScoreFromJSON = AdminQuizParticipantSessionScoreFromJSON;
+exports.AdminQuizParticipantSessionScoreFromJSONTyped = AdminQuizParticipantSessionScoreFromJSONTyped;
+exports.AdminQuizParticipantSessionScoreToJSON = AdminQuizParticipantSessionScoreToJSON;
+exports.AdminQuizParticipantSessionScoreToJSONTyped = AdminQuizParticipantSessionScoreToJSONTyped;
+/**
+ * Check if a given object implements the AdminQuizParticipantSessionScore interface.
+ */
+function instanceOfAdminQuizParticipantSessionScore(value) {
+    if (!('totalCorrect' in value) || value['totalCorrect'] === undefined)
+        return false;
+    if (!('totalQuestions' in value) || value['totalQuestions'] === undefined)
+        return false;
+    if (!('answeredCount' in value) || value['answeredCount'] === undefined)
+        return false;
+    return true;
+}
+function AdminQuizParticipantSessionScoreFromJSON(json) {
+    return AdminQuizParticipantSessionScoreFromJSONTyped(json, false);
+}
+function AdminQuizParticipantSessionScoreFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalCorrect': json['totalCorrect'],
+        'totalQuestions': json['totalQuestions'],
+        'answeredCount': json['answeredCount'],
+    };
+}
+function AdminQuizParticipantSessionScoreToJSON(json) {
+    return AdminQuizParticipantSessionScoreToJSONTyped(json, false);
+}
+function AdminQuizParticipantSessionScoreToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'totalCorrect': value['totalCorrect'],
+        'totalQuestions': value['totalQuestions'],
+        'answeredCount': value['answeredCount'],
+    };
+}

package/dist/models/AdminStudyObjectiveListItem.d.ts

@@ -34,7 +34,7 @@ export interface AdminStudyObjectiveListItem {
      */
     userId: string | null;
     /**
-     * Derived origin: 'canvas' if linked to a Canvas object, else 'syllabus' or 'custom' based on source
+     * Derived origin: 'canvas' if linked to a Canvas object, else 'syllabus' for syllabus-derived and 'custom' for learner-created or template-created objectives
      * @type {string}
      * @memberof AdminStudyObjectiveListItem
      */
@@ -157,6 +157,7 @@ export type AdminStudyObjectiveListItemOriginEnum = typeof AdminStudyObjectiveLi
 export declare const AdminStudyObjectiveListItemSourceEnum: {
     readonly User: "user";
     readonly Syllabus: "syllabus";
+    readonly Template: "template";
 };
 export type AdminStudyObjectiveListItemSourceEnum = typeof AdminStudyObjectiveListItemSourceEnum[keyof typeof AdminStudyObjectiveListItemSourceEnum];
 /**

package/dist/models/AdminStudyObjectiveListItem.js

@@ -32,7 +32,8 @@ exports.AdminStudyObjectiveListItemOriginEnum = {
  */
 exports.AdminStudyObjectiveListItemSourceEnum = {
     User: 'user',
-    Syllabus: 'syllabus'
+    Syllabus: 'syllabus',
+    Template: 'template'
 };
 /**
  * Check if a given object implements the AdminStudyObjectiveListItem interface.

package/dist/models/CreateStudySpaceFromTemplateDto.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 CreateStudySpaceFromTemplateDto
+ */
+export interface CreateStudySpaceFromTemplateDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudySpaceFromTemplateDto
+     */
+    name?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateStudySpaceFromTemplateDto
+     */
+    startIndex: number | null;
+}
+/**
+ * Check if a given object implements the CreateStudySpaceFromTemplateDto interface.
+ */
+export declare function instanceOfCreateStudySpaceFromTemplateDto(value: object): value is CreateStudySpaceFromTemplateDto;
+export declare function CreateStudySpaceFromTemplateDtoFromJSON(json: any): CreateStudySpaceFromTemplateDto;
+export declare function CreateStudySpaceFromTemplateDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudySpaceFromTemplateDto;
+export declare function CreateStudySpaceFromTemplateDtoToJSON(json: any): CreateStudySpaceFromTemplateDto;
+export declare function CreateStudySpaceFromTemplateDtoToJSONTyped(value?: CreateStudySpaceFromTemplateDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateStudySpaceFromTemplateDto.js

@@ -0,0 +1,52 @@
+"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.instanceOfCreateStudySpaceFromTemplateDto = instanceOfCreateStudySpaceFromTemplateDto;
+exports.CreateStudySpaceFromTemplateDtoFromJSON = CreateStudySpaceFromTemplateDtoFromJSON;
+exports.CreateStudySpaceFromTemplateDtoFromJSONTyped = CreateStudySpaceFromTemplateDtoFromJSONTyped;
+exports.CreateStudySpaceFromTemplateDtoToJSON = CreateStudySpaceFromTemplateDtoToJSON;
+exports.CreateStudySpaceFromTemplateDtoToJSONTyped = CreateStudySpaceFromTemplateDtoToJSONTyped;
+/**
+ * Check if a given object implements the CreateStudySpaceFromTemplateDto interface.
+ */
+function instanceOfCreateStudySpaceFromTemplateDto(value) {
+    if (!('startIndex' in value) || value['startIndex'] === undefined)
+        return false;
+    return true;
+}
+function CreateStudySpaceFromTemplateDtoFromJSON(json) {
+    return CreateStudySpaceFromTemplateDtoFromJSONTyped(json, false);
+}
+function CreateStudySpaceFromTemplateDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'startIndex': json['startIndex'],
+    };
+}
+function CreateStudySpaceFromTemplateDtoToJSON(json) {
+    return CreateStudySpaceFromTemplateDtoToJSONTyped(json, false);
+}
+function CreateStudySpaceFromTemplateDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'startIndex': value['startIndex'],
+    };
+}

package/dist/models/QuizSharing.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 QuizSharing
+ */
+export interface QuizSharing {
+    /**
+     *
+     * @type {string}
+     * @memberof QuizSharing
+     */
+    quizId: string;
+    /**
+     * Whether other learners can currently open this quiz by link.
+     * @type {boolean}
+     * @memberof QuizSharing
+     */
+    isShared: boolean;
+    /**
+     * The link token other learners redeem through the shared-quizzes endpoints. Null while sharing is off. Re-enabling after a disable issues a new token; the old one stays dead.
+     * @type {string}
+     * @memberof QuizSharing
+     */
+    shareToken: string | null;
+    /**
+     * When the current link was issued. Null while sharing is off.
+     * @type {Date}
+     * @memberof QuizSharing
+     */
+    sharedAt: Date | null;
+}
+/**
+ * Check if a given object implements the QuizSharing interface.
+ */
+export declare function instanceOfQuizSharing(value: object): value is QuizSharing;
+export declare function QuizSharingFromJSON(json: any): QuizSharing;
+export declare function QuizSharingFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuizSharing;
+export declare function QuizSharingToJSON(json: any): QuizSharing;
+export declare function QuizSharingToJSONTyped(value?: QuizSharing | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QuizSharing.js

@@ -0,0 +1,62 @@
+"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.instanceOfQuizSharing = instanceOfQuizSharing;
+exports.QuizSharingFromJSON = QuizSharingFromJSON;
+exports.QuizSharingFromJSONTyped = QuizSharingFromJSONTyped;
+exports.QuizSharingToJSON = QuizSharingToJSON;
+exports.QuizSharingToJSONTyped = QuizSharingToJSONTyped;
+/**
+ * Check if a given object implements the QuizSharing interface.
+ */
+function instanceOfQuizSharing(value) {
+    if (!('quizId' in value) || value['quizId'] === undefined)
+        return false;
+    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;
+}
+function QuizSharingFromJSON(json) {
+    return QuizSharingFromJSONTyped(json, false);
+}
+function QuizSharingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'quizId': json['quizId'],
+        'isShared': json['isShared'],
+        'shareToken': json['shareToken'],
+        'sharedAt': (json['sharedAt'] == null ? null : new Date(json['sharedAt'])),
+    };
+}
+function QuizSharingToJSON(json) {
+    return QuizSharingToJSONTyped(json, false);
+}
+function QuizSharingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'quizId': value['quizId'],
+        'isShared': value['isShared'],
+        'shareToken': value['shareToken'],
+        'sharedAt': value['sharedAt'] == null ? value['sharedAt'] : value['sharedAt'].toISOString(),
+    };
+}

package/dist/models/ResourceListItem.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ResourceSharing } from './ResourceSharing';
 import type { ResourceStudyObjective } from './ResourceStudyObjective';
 import type { ResourceChat } from './ResourceChat';
 import type { ResourceStudySpace } from './ResourceStudySpace';
@@ -61,6 +62,12 @@ export interface ResourceListItem {
      * @memberof ResourceListItem
      */
     createdAt: Date;
+    /**
+     * True when the caller generated this resource; false when they opened someone else's through a share link. Mirrors the `ownership` filter the list was requested with.
+     * @type {boolean}
+     * @memberof ResourceListItem
+     */
+    isOwner: boolean;
     /**
      * Questions (or cards) persisted so far.
      * @type {number}
@@ -94,19 +101,19 @@ export interface ResourceListItem {
      */
     courseId: string | null;
     /**
-     * The chat this resource was generated in. Null when that chat has been deleted.
+     * The chat this resource was generated in. Null when that chat has been deleted, and always null on a shared resource.
      * @type {ResourceChat}
      * @memberof ResourceListItem
      */
     chat: ResourceChat | null;
     /**
-     * The study objective the originating chat was filed under.
+     * The study objective the originating chat was filed under. Always null on a shared resource.
      * @type {ResourceStudyObjective}
      * @memberof ResourceListItem
      */
     studyObjective: ResourceStudyObjective | null;
     /**
-     * The study space this resource belongs to: the objective's space when it has one, else the learner's space for the attributed course.
+     * The study space this resource belongs to: the objective's space when it has one, else the learner's space for the attributed course. Always null on a shared resource.
      * @type {ResourceStudySpace}
      * @memberof ResourceListItem
      */
@@ -117,6 +124,12 @@ export interface ResourceListItem {
      * @memberof ResourceListItem
      */
     activity: ResourceActivity;
+    /**
+     * Link-sharing state and how many other learners have used the link.
+     * @type {ResourceSharing}
+     * @memberof ResourceListItem
+     */
+    sharing: ResourceSharing;
 }
 /**
  * @export

package/dist/models/ResourceListItem.js

@@ -19,6 +19,7 @@ exports.ResourceListItemFromJSON = ResourceListItemFromJSON;
 exports.ResourceListItemFromJSONTyped = ResourceListItemFromJSONTyped;
 exports.ResourceListItemToJSON = ResourceListItemToJSON;
 exports.ResourceListItemToJSONTyped = ResourceListItemToJSONTyped;
+const ResourceSharing_1 = require("./ResourceSharing");
 const ResourceStudyObjective_1 = require("./ResourceStudyObjective");
 const ResourceChat_1 = require("./ResourceChat");
 const ResourceStudySpace_1 = require("./ResourceStudySpace");
@@ -56,6 +57,8 @@ function instanceOfResourceListItem(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('isOwner' in value) || value['isOwner'] === undefined)
+        return false;
     if (!('questionCount' in value) || value['questionCount'] === undefined)
         return false;
     if (!('questionTypeCounts' in value) || value['questionTypeCounts'] === undefined)
@@ -74,6 +77,8 @@ function instanceOfResourceListItem(value) {
         return false;
     if (!('activity' in value) || value['activity'] === undefined)
         return false;
+    if (!('sharing' in value) || value['sharing'] === undefined)
+        return false;
     return true;
 }
 function ResourceListItemFromJSON(json) {
@@ -91,6 +96,7 @@ function ResourceListItemFromJSONTyped(json, ignoreDiscriminator) {
         'generationStatus': json['generationStatus'],
         'expectedQuestionCount': json['expectedQuestionCount'],
         'createdAt': (new Date(json['createdAt'])),
+        'isOwner': json['isOwner'],
         'questionCount': json['questionCount'],
         'questionTypeCounts': json['questionTypeCounts'],
         'topics': json['topics'],
@@ -100,6 +106,7 @@ function ResourceListItemFromJSONTyped(json, ignoreDiscriminator) {
         'studyObjective': (0, ResourceStudyObjective_1.ResourceStudyObjectiveFromJSON)(json['studyObjective']),
         'studySpace': (0, ResourceStudySpace_1.ResourceStudySpaceFromJSON)(json['studySpace']),
         'activity': (0, ResourceActivity_1.ResourceActivityFromJSON)(json['activity']),
+        'sharing': (0, ResourceSharing_1.ResourceSharingFromJSON)(json['sharing']),
     };
 }
 function ResourceListItemToJSON(json) {
@@ -117,6 +124,7 @@ function ResourceListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'generationStatus': value['generationStatus'],
         'expectedQuestionCount': value['expectedQuestionCount'],
         'createdAt': value['createdAt'].toISOString(),
+        'isOwner': value['isOwner'],
         'questionCount': value['questionCount'],
         'questionTypeCounts': value['questionTypeCounts'],
         'topics': value['topics'],
@@ -126,5 +134,6 @@ function ResourceListItemToJSONTyped(value, ignoreDiscriminator = false) {
         'studyObjective': (0, ResourceStudyObjective_1.ResourceStudyObjectiveToJSON)(value['studyObjective']),
         'studySpace': (0, ResourceStudySpace_1.ResourceStudySpaceToJSON)(value['studySpace']),
         'activity': (0, ResourceActivity_1.ResourceActivityToJSON)(value['activity']),
+        'sharing': (0, ResourceSharing_1.ResourceSharingToJSON)(value['sharing']),
     };
 }