@instructure/athena-api-client 3.20.3 → 3.21.0

package/dist/esm/apis/StudyPlansApi.js

@@ -0,0 +1,202 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateStudyPlanDtoToJSON, StudyPlanFromJSON, StudyPlanActivityFromJSON, UpdateActivityCompletionDtoToJSON, } from '../models/index';
+/**
+ *
+ */
+export class StudyPlansApi extends runtime.BaseAPI {
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlanRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteStudyPlan().');
+            }
+            if (requestParameters['planId'] == null) {
+                throw new runtime.RequiredError('planId', 'Required parameter "planId" was null or undefined when calling deleteStudyPlan().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-plans/{planId}`;
+            urlPath = urlPath.replace(`{${"planId"}}`, encodeURIComponent(String(requestParameters['planId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes the plan and its activities. The chats those activities started are not deleted.
+     * Delete a study plan
+     */
+    deleteStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteStudyPlanRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlanRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling getStudyObjectiveStudyPlan().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}/study-plan`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyPlanFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the objective\'s saved plan with its activities ordered by `position`, or 404 when the objective has no plan.
+     * Get a study objective\'s plan
+     */
+    getStudyObjectiveStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStudyObjectiveStudyPlanRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlanRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling saveStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling saveStudyObjectiveStudyPlan().');
+            }
+            if (requestParameters['createStudyPlanDto'] == null) {
+                throw new runtime.RequiredError('createStudyPlanDto', 'Required parameter "createStudyPlanDto" was null or undefined when calling saveStudyObjectiveStudyPlan().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}/study-plan`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateStudyPlanDtoToJSON(requestParameters['createStudyPlanDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyPlanFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Persists an ordered list of activities as the objective\'s plan. An objective has at most one plan, so this replaces any existing plan — the previous activities and their completion state are deleted in the same transaction. A payload over the 20-activity cap is rejected, never truncated.
+     * Save (or replace) a study objective\'s plan
+     */
+    saveStudyObjectiveStudyPlan(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.saveStudyObjectiveStudyPlanRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling updateStudyPlanActivityCompletion().');
+            }
+            if (requestParameters['activityId'] == null) {
+                throw new runtime.RequiredError('activityId', 'Required parameter "activityId" was null or undefined when calling updateStudyPlanActivityCompletion().');
+            }
+            if (requestParameters['updateActivityCompletionDto'] == null) {
+                throw new runtime.RequiredError('updateActivityCompletionDto', 'Required parameter "updateActivityCompletionDto" was null or undefined when calling updateStudyPlanActivityCompletion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-plan-activities/{activityId}`;
+            urlPath = urlPath.replace(`{${"activityId"}}`, encodeURIComponent(String(requestParameters['activityId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateActivityCompletionDtoToJSON(requestParameters['updateActivityCompletionDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => StudyPlanActivityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Toggles one activity\'s completion. This is the only write a saved plan accepts — a plan\'s content is immutable, so changing it means saving a new plan over it. Completing an already-complete activity keeps the original timestamp.
+     * Mark a plan activity complete or incomplete
+     */
+    updateStudyPlanActivityCompletion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateStudyPlanActivityCompletionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/index.d.ts

@@ -20,6 +20,7 @@ export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
+export * from './StudyPlansApi';
 export * from './StudyPrepApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';

package/dist/esm/apis/index.js

@@ -22,6 +22,7 @@ export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './StudyObjectiveConceptsApi';
 export * from './StudyObjectivesApi';
+export * from './StudyPlansApi';
 export * from './StudyPrepApi';
 export * from './SyllabusAnalysisApi';
 export * from './TagsApi';

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { CreateStudyPlanDtoActivitiesInner } from './CreateStudyPlanDtoActivitiesInner';
+/**
+ *
+ * @export
+ * @interface CreateStudyPlanDto
+ */
+export interface CreateStudyPlanDto {
+    /**
+     *
+     * @type {Array<CreateStudyPlanDtoActivitiesInner>}
+     * @memberof CreateStudyPlanDto
+     */
+    activities: Array<CreateStudyPlanDtoActivitiesInner>;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDto
+     */
+    sourceToolCallId?: string | null;
+}
+/**
+ * Check if a given object implements the CreateStudyPlanDto interface.
+ */
+export declare function instanceOfCreateStudyPlanDto(value: object): value is CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoFromJSON(json: any): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoToJSON(json: any): CreateStudyPlanDto;
+export declare function CreateStudyPlanDtoToJSONTyped(value?: CreateStudyPlanDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyPlanDto.js

@@ -0,0 +1,46 @@
+/* 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 { CreateStudyPlanDtoActivitiesInnerFromJSON, CreateStudyPlanDtoActivitiesInnerToJSON, } from './CreateStudyPlanDtoActivitiesInner';
+/**
+ * Check if a given object implements the CreateStudyPlanDto interface.
+ */
+export function instanceOfCreateStudyPlanDto(value) {
+    if (!('activities' in value) || value['activities'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyPlanDtoFromJSON(json) {
+    return CreateStudyPlanDtoFromJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'activities': (json['activities'].map(CreateStudyPlanDtoActivitiesInnerFromJSON)),
+        'sourceToolCallId': json['sourceToolCallId'] == null ? undefined : json['sourceToolCallId'],
+    };
+}
+export function CreateStudyPlanDtoToJSON(json) {
+    return CreateStudyPlanDtoToJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'activities': (value['activities'].map(CreateStudyPlanDtoActivitiesInnerToJSON)),
+        'sourceToolCallId': value['sourceToolCallId'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 CreateStudyPlanDtoActivitiesInner
+ */
+export interface CreateStudyPlanDtoActivitiesInner {
+    /**
+     *
+     * @type {number}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    position: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    label?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    duration?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateStudyPlanDtoActivitiesInner
+     */
+    description?: string;
+}
+/**
+ * Check if a given object implements the CreateStudyPlanDtoActivitiesInner interface.
+ */
+export declare function instanceOfCreateStudyPlanDtoActivitiesInner(value: object): value is CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerFromJSON(json: any): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerToJSON(json: any): CreateStudyPlanDtoActivitiesInner;
+export declare function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value?: CreateStudyPlanDtoActivitiesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateStudyPlanDtoActivitiesInner.js

@@ -0,0 +1,53 @@
+/* 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 CreateStudyPlanDtoActivitiesInner interface.
+ */
+export function instanceOfCreateStudyPlanDtoActivitiesInner(value) {
+    if (!('position' in value) || value['position'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyPlanDtoActivitiesInnerFromJSON(json) {
+    return CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoActivitiesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'position': json['position'],
+        'label': json['label'] == null ? undefined : json['label'],
+        'duration': json['duration'] == null ? undefined : json['duration'],
+        'title': json['title'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+export function CreateStudyPlanDtoActivitiesInnerToJSON(json) {
+    return CreateStudyPlanDtoActivitiesInnerToJSONTyped(json, false);
+}
+export function CreateStudyPlanDtoActivitiesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'position': value['position'],
+        'label': value['label'],
+        'duration': value['duration'],
+        'title': value['title'],
+        'description': value['description'],
+    };
+}

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { StudyPlanActivity } from './StudyPlanActivity';
+/**
+ *
+ * @export
+ * @interface StudyPlan
+ */
+export interface StudyPlan {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlan
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlan
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlan
+     */
+    ownerType: StudyPlanOwnerTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyPlan
+     */
+    ownerId: string;
+    /**
+     * Tool call id of the proposal this plan was saved from, when it came from one.
+     * @type {string}
+     * @memberof StudyPlan
+     */
+    sourceToolCallId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyPlan
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyPlan
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {Array<StudyPlanActivity>}
+     * @memberof StudyPlan
+     */
+    activities: Array<StudyPlanActivity>;
+}
+/**
+ * @export
+ */
+export declare const StudyPlanOwnerTypeEnum: {
+    readonly StudyObjective: "study_objective";
+};
+export type StudyPlanOwnerTypeEnum = typeof StudyPlanOwnerTypeEnum[keyof typeof StudyPlanOwnerTypeEnum];
+/**
+ * Check if a given object implements the StudyPlan interface.
+ */
+export declare function instanceOfStudyPlan(value: object): value is StudyPlan;
+export declare function StudyPlanFromJSON(json: any): StudyPlan;
+export declare function StudyPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyPlan;
+export declare function StudyPlanToJSON(json: any): StudyPlan;
+export declare function StudyPlanToJSONTyped(value?: StudyPlan | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyPlan.js

@@ -0,0 +1,78 @@
+/* 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 { StudyPlanActivityFromJSON, StudyPlanActivityToJSON, } from './StudyPlanActivity';
+/**
+ * @export
+ */
+export const StudyPlanOwnerTypeEnum = {
+    StudyObjective: 'study_objective'
+};
+/**
+ * Check if a given object implements the StudyPlan interface.
+ */
+export function instanceOfStudyPlan(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('ownerType' in value) || value['ownerType'] === undefined)
+        return false;
+    if (!('ownerId' in value) || value['ownerId'] === undefined)
+        return false;
+    if (!('sourceToolCallId' in value) || value['sourceToolCallId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if (!('activities' in value) || value['activities'] === undefined)
+        return false;
+    return true;
+}
+export function StudyPlanFromJSON(json) {
+    return StudyPlanFromJSONTyped(json, false);
+}
+export function StudyPlanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'ownerType': json['ownerType'],
+        'ownerId': json['ownerId'],
+        'sourceToolCallId': json['sourceToolCallId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'activities': (json['activities'].map(StudyPlanActivityFromJSON)),
+    };
+}
+export function StudyPlanToJSON(json) {
+    return StudyPlanToJSONTyped(json, false);
+}
+export function StudyPlanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'ownerType': value['ownerType'],
+        'ownerId': value['ownerId'],
+        'sourceToolCallId': value['sourceToolCallId'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+        'activities': (value['activities'].map(StudyPlanActivityToJSON)),
+    };
+}

package/dist/esm/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;