/**
 * 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 { CreateStudySpaceDto, StudySpace, UpdateStudySpaceDto } from '../models/index';
export interface CreateStudySpaceRequest {
    xUserId: string;
    createStudySpaceDto: CreateStudySpaceDto;
}
export interface DeleteStudySpaceRequest {
    xUserId: string;
    studySpaceId: string;
}
export interface ListStudySpacesRequest {
    xUserId: string;
}
export interface UpdateStudySpaceRequest {
    xUserId: string;
    studySpaceId: string;
    updateStudySpaceDto: UpdateStudySpaceDto;
}
/**
 *
 */
export declare class StudySpacesApi extends runtime.BaseAPI {
    /**
     * Creates an empty study space for the authenticated user with no Canvas course behind it, so a learner can organize study work that isn\'t tied to a course. Titles are trimmed and must be non-empty; several spaces may share a title, since a learner\'s own labels are not required to be unique. `courseId` is not accepted and is rejected if sent: a Canvas-backed space is resolved (and created on first use) from the course when an objective is filed into it, so it is never created directly.
     * Create a study space the learner names
     */
    createStudySpaceRaw(requestParameters: CreateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudySpace>>;
    /**
     * Creates an empty study space for the authenticated user with no Canvas course behind it, so a learner can organize study work that isn\'t tied to a course. Titles are trimmed and must be non-empty; several spaces may share a title, since a learner\'s own labels are not required to be unique. `courseId` is not accepted and is rejected if sent: a Canvas-backed space is resolved (and created on first use) from the course when an objective is filed into it, so it is never created directly.
     * Create a study space the learner names
     */
    createStudySpace(requestParameters: CreateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudySpace>;
    /**
     * Deletes one of the authenticated user\'s study spaces along with every study objective in it, including archived ones. Restricted to a space with no Canvas course: a Canvas-backed space is recreated the next time an objective is filed into its course, so deleting one is rejected rather than silently undone. This destroys study work — `activeObjectiveCount` on the space says how much, so a client can confirm with the learner before calling.
     * Delete a study space the learner created
     */
    deleteStudySpaceRaw(requestParameters: DeleteStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Deletes one of the authenticated user\'s study spaces along with every study objective in it, including archived ones. Restricted to a space with no Canvas course: a Canvas-backed space is recreated the next time an objective is filed into its course, so deleting one is rejected rather than silently undone. This destroys study work — `activeObjectiveCount` on the space says how much, so a client can confirm with the learner before calling.
     * Delete a study space the learner created
     */
    deleteStudySpace(requestParameters: DeleteStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per Canvas course, plus however many they have created themselves — a set they organize by hand either way, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
     * List the authenticated user\'s study spaces
     */
    listStudySpacesRaw(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StudySpace>>>;
    /**
     * Returns the persisted study spaces of the authenticated user, oldest first, each with its count of non-archived objectives. Spaces with no objectives are included. Unpaginated: a learner holds at most one space per Canvas course, plus however many they have created themselves — a set they organize by hand either way, so the list is returned in full. A client that also renders live Canvas enrollments can merge these in, so a learner still sees the courses they have study history for when their Canvas connection is unavailable.
     * List the authenticated user\'s study spaces
     */
    listStudySpaces(requestParameters: ListStudySpacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StudySpace>>;
    /**
     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
     * Update a study space title
     */
    updateStudySpaceRaw(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StudySpace>>;
    /**
     * Sets the title of one of the authenticated user\'s study spaces. Titles are trimmed and must be non-empty.
     * Update a study space title
     */
    updateStudySpace(requestParameters: UpdateStudySpaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StudySpace>;
}