@instructure/athena-api-client 3.20.3 → 3.21.0

package/dist/models/StudyPlanActivity.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 StudyPlanActivity
+ */
+export interface StudyPlanActivity {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    studyPlanId: string;
+    /**
+     * Sort key within the plan. Activities are returned in ascending order.
+     * @type {number}
+     * @memberof StudyPlanActivity
+     */
+    position: number;
+    /**
+     * Display-only label such as "Day 1" or "Aug 1". May be empty; it is never parsed for ordering.
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    label: string;
+    /**
+     * Free-form duration such as "30 min".
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    duration: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlanActivity
+     */
+    description: string;
+    /**
+     * When the activity was completed, or null if it is not done.
+     * @type {Date}
+     * @memberof StudyPlanActivity
+     */
+    completedAt: Date | null;
+}
+/**
+ * Check if a given object implements the StudyPlanActivity interface.
+ */
+export declare function instanceOfStudyPlanActivity(value: object): value is StudyPlanActivity;
+export declare function StudyPlanActivityFromJSON(json: any): StudyPlanActivity;
+export declare function StudyPlanActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyPlanActivity;
+export declare function StudyPlanActivityToJSON(json: any): StudyPlanActivity;
+export declare function StudyPlanActivityToJSONTyped(value?: StudyPlanActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/models/StudyPlanActivity.js

@@ -0,0 +1,78 @@
+"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.instanceOfStudyPlanActivity = instanceOfStudyPlanActivity;
+exports.StudyPlanActivityFromJSON = StudyPlanActivityFromJSON;
+exports.StudyPlanActivityFromJSONTyped = StudyPlanActivityFromJSONTyped;
+exports.StudyPlanActivityToJSON = StudyPlanActivityToJSON;
+exports.StudyPlanActivityToJSONTyped = StudyPlanActivityToJSONTyped;
+/**
+ * Check if a given object implements the StudyPlanActivity interface.
+ */
+function instanceOfStudyPlanActivity(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('studyPlanId' in value) || value['studyPlanId'] === undefined)
+        return false;
+    if (!('position' in value) || value['position'] === undefined)
+        return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('duration' in value) || value['duration'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    return true;
+}
+function StudyPlanActivityFromJSON(json) {
+    return StudyPlanActivityFromJSONTyped(json, false);
+}
+function StudyPlanActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'studyPlanId': json['studyPlanId'],
+        'position': json['position'],
+        'label': json['label'],
+        'duration': json['duration'],
+        'title': json['title'],
+        'description': json['description'],
+        'completedAt': (json['completedAt'] == null ? null : new Date(json['completedAt'])),
+    };
+}
+function StudyPlanActivityToJSON(json) {
+    return StudyPlanActivityToJSONTyped(json, false);
+}
+function StudyPlanActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'studyPlanId': value['studyPlanId'],
+        'position': value['position'],
+        'label': value['label'],
+        'duration': value['duration'],
+        'title': value['title'],
+        'description': value['description'],
+        'completedAt': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+    };
+}

package/dist/models/UpdateActivityCompletionDto.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 UpdateActivityCompletionDto
+ */
+export interface UpdateActivityCompletionDto {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateActivityCompletionDto
+     */
+    completed: boolean;
+}
+/**
+ * Check if a given object implements the UpdateActivityCompletionDto interface.
+ */
+export declare function instanceOfUpdateActivityCompletionDto(value: object): value is UpdateActivityCompletionDto;
+export declare function UpdateActivityCompletionDtoFromJSON(json: any): UpdateActivityCompletionDto;
+export declare function UpdateActivityCompletionDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateActivityCompletionDto;
+export declare function UpdateActivityCompletionDtoToJSON(json: any): UpdateActivityCompletionDto;
+export declare function UpdateActivityCompletionDtoToJSONTyped(value?: UpdateActivityCompletionDto | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UpdateActivityCompletionDto.js

@@ -0,0 +1,50 @@
+"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.instanceOfUpdateActivityCompletionDto = instanceOfUpdateActivityCompletionDto;
+exports.UpdateActivityCompletionDtoFromJSON = UpdateActivityCompletionDtoFromJSON;
+exports.UpdateActivityCompletionDtoFromJSONTyped = UpdateActivityCompletionDtoFromJSONTyped;
+exports.UpdateActivityCompletionDtoToJSON = UpdateActivityCompletionDtoToJSON;
+exports.UpdateActivityCompletionDtoToJSONTyped = UpdateActivityCompletionDtoToJSONTyped;
+/**
+ * Check if a given object implements the UpdateActivityCompletionDto interface.
+ */
+function instanceOfUpdateActivityCompletionDto(value) {
+    if (!('completed' in value) || value['completed'] === undefined)
+        return false;
+    return true;
+}
+function UpdateActivityCompletionDtoFromJSON(json) {
+    return UpdateActivityCompletionDtoFromJSONTyped(json, false);
+}
+function UpdateActivityCompletionDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'completed': json['completed'],
+    };
+}
+function UpdateActivityCompletionDtoToJSON(json) {
+    return UpdateActivityCompletionDtoToJSONTyped(json, false);
+}
+function UpdateActivityCompletionDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'completed': value['completed'],
+    };
+}

package/dist/models/UserFeatures.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 UserFeatures
+ */
+export interface UserFeatures {
+    /**
+     * Names of the features the calling user is entitled to, sorted alphabetically.
+     * @type {Array<string>}
+     * @memberof UserFeatures
+     */
+    features: Array<string>;
+}
+/**
+ * Check if a given object implements the UserFeatures interface.
+ */
+export declare function instanceOfUserFeatures(value: object): value is UserFeatures;
+export declare function UserFeaturesFromJSON(json: any): UserFeatures;
+export declare function UserFeaturesFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserFeatures;
+export declare function UserFeaturesToJSON(json: any): UserFeatures;
+export declare function UserFeaturesToJSONTyped(value?: UserFeatures | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UserFeatures.js

@@ -0,0 +1,50 @@
+"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.instanceOfUserFeatures = instanceOfUserFeatures;
+exports.UserFeaturesFromJSON = UserFeaturesFromJSON;
+exports.UserFeaturesFromJSONTyped = UserFeaturesFromJSONTyped;
+exports.UserFeaturesToJSON = UserFeaturesToJSON;
+exports.UserFeaturesToJSONTyped = UserFeaturesToJSONTyped;
+/**
+ * Check if a given object implements the UserFeatures interface.
+ */
+function instanceOfUserFeatures(value) {
+    if (!('features' in value) || value['features'] === undefined)
+        return false;
+    return true;
+}
+function UserFeaturesFromJSON(json) {
+    return UserFeaturesFromJSONTyped(json, false);
+}
+function UserFeaturesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'features': json['features'],
+    };
+}
+function UserFeaturesToJSON(json) {
+    return UserFeaturesToJSONTyped(json, false);
+}
+function UserFeaturesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'features': value['features'],
+    };
+}

package/dist/models/index.d.ts

@@ -53,6 +53,8 @@ export * from './CreatePracticeQuizRequest';
 export * from './CreateStudyObjectiveDto';
 export * from './CreateStudyObjectiveDtoCanvasDocumentsInner';
 export * from './CreateStudyObjectiveDtoCanvasObject';
+export * from './CreateStudyPlanDto';
+export * from './CreateStudyPlanDtoActivitiesInner';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
@@ -105,6 +107,8 @@ export * from './StudyObjectiveConceptAttachment';
 export * from './StudyObjectiveConceptAttachmentList';
 export * from './StudyObjectiveConceptSummary';
 export * from './StudyObjectiveFileAttachment';
+export * from './StudyPlan';
+export * from './StudyPlanActivity';
 export * from './SubmitQuizResponseRequest';
 export * from './SyllabusAnalysisObjective';
 export * from './SyllabusAnalysisStatus';
@@ -124,6 +128,7 @@ export * from './TriggerStudyObjectiveConceptExtractionResponse';
 export * from './TriggerSyllabusAnalysisRequest';
 export * from './TriggerSyllabusAnalysisRequestFile';
 export * from './UpdateAccountDto';
+export * from './UpdateActivityCompletionDto';
 export * from './UpdateChatRequest';
 export * from './UpdateFeatureDto';
 export * from './UpdatePlanDto';
@@ -142,6 +147,7 @@ export * from './UpsertVoteRequest';
 export * from './UserConcept';
 export * from './UserConceptConcept';
 export * from './UserContext';
+export * from './UserFeatures';
 export * from './UserFile';
 export * from './UserFileAssociation';
 export * from './UserFileUploadUrlFile';

package/dist/models/index.js

@@ -71,6 +71,8 @@ __exportStar(require("./CreatePracticeQuizRequest"), exports);
 __exportStar(require("./CreateStudyObjectiveDto"), exports);
 __exportStar(require("./CreateStudyObjectiveDtoCanvasDocumentsInner"), exports);
 __exportStar(require("./CreateStudyObjectiveDtoCanvasObject"), exports);
+__exportStar(require("./CreateStudyPlanDto"), exports);
+__exportStar(require("./CreateStudyPlanDtoActivitiesInner"), exports);
 __exportStar(require("./CreateTokenRequest"), exports);
 __exportStar(require("./CreateTokenResponse"), exports);
 __exportStar(require("./DailyQuizStatus"), exports);
@@ -123,6 +125,8 @@ __exportStar(require("./StudyObjectiveConceptAttachment"), exports);
 __exportStar(require("./StudyObjectiveConceptAttachmentList"), exports);
 __exportStar(require("./StudyObjectiveConceptSummary"), exports);
 __exportStar(require("./StudyObjectiveFileAttachment"), exports);
+__exportStar(require("./StudyPlan"), exports);
+__exportStar(require("./StudyPlanActivity"), exports);
 __exportStar(require("./SubmitQuizResponseRequest"), exports);
 __exportStar(require("./SyllabusAnalysisObjective"), exports);
 __exportStar(require("./SyllabusAnalysisStatus"), exports);
@@ -142,6 +146,7 @@ __exportStar(require("./TriggerStudyObjectiveConceptExtractionResponse"), export
 __exportStar(require("./TriggerSyllabusAnalysisRequest"), exports);
 __exportStar(require("./TriggerSyllabusAnalysisRequestFile"), exports);
 __exportStar(require("./UpdateAccountDto"), exports);
+__exportStar(require("./UpdateActivityCompletionDto"), exports);
 __exportStar(require("./UpdateChatRequest"), exports);
 __exportStar(require("./UpdateFeatureDto"), exports);
 __exportStar(require("./UpdatePlanDto"), exports);
@@ -160,6 +165,7 @@ __exportStar(require("./UpsertVoteRequest"), exports);
 __exportStar(require("./UserConcept"), exports);
 __exportStar(require("./UserConceptConcept"), exports);
 __exportStar(require("./UserContext"), exports);
+__exportStar(require("./UserFeatures"), exports);
 __exportStar(require("./UserFile"), exports);
 __exportStar(require("./UserFileAssociation"), exports);
 __exportStar(require("./UserFileUploadUrlFile"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.20.3",
+  "version": "3.21.0",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {