/** * 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 * as runtime from '../runtime'; import type { CreateStudyPlanDto, StudyPlan, StudyPlanActivity, UpdateActivityCompletionDto } from '../models/index'; export interface DeleteStudyPlanRequest { xUserId: string; planId: string; } export interface GetStudyObjectiveStudyPlanRequest { xUserId: string; studyObjectiveId: string; } export interface SaveStudyObjectiveStudyPlanRequest { xUserId: string; studyObjectiveId: string; createStudyPlanDto: CreateStudyPlanDto; } export interface UpdateStudyPlanActivityCompletionRequest { xUserId: string; activityId: string; updateActivityCompletionDto: UpdateActivityCompletionDto; } /** * */ export declare 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: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes the plan and its activities. The chats those activities started are not deleted. * Delete a study plan */ deleteStudyPlan(requestParameters: DeleteStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: GetStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: GetStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: SaveStudyObjectiveStudyPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: UpdateStudyPlanActivityCompletionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: UpdateStudyPlanActivityCompletionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }