/** * 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 { CreateStudyObjectiveDtoCanvasDocumentsInner } from './CreateStudyObjectiveDtoCanvasDocumentsInner'; import type { CreateStudyObjectiveDtoCanvasObject } from './CreateStudyObjectiveDtoCanvasObject'; /** * * @export * @interface CreateStudyObjectiveDto */ export interface CreateStudyObjectiveDto { /** * * @type {string} * @memberof CreateStudyObjectiveDto */ title: string; /** * * @type {string} * @memberof CreateStudyObjectiveDto */ notes?: string | null; /** * * @type {Array} * @memberof CreateStudyObjectiveDto */ canvasDocuments?: Array; /** * * @type {Date} * @memberof CreateStudyObjectiveDto */ dueAt?: Date | null; /** * Canvas course the objective belongs to. The learner's study space for this course is resolved (created on first use) and the objective is linked to it. Mutually exclusive with `studySpaceId`; exactly one of the two is required. * @type {string} * @memberof CreateStudyObjectiveDto */ courseId?: string; /** * Existing study space to file the objective in, addressed directly rather than through a Canvas course. Use this for a space with no Canvas course; the objective is created with no course id. Mutually exclusive with `courseId`; exactly one of the two is required. * @type {string} * @memberof CreateStudyObjectiveDto */ studySpaceId?: string; /** * Display name of the Canvas course. Used to name the learner's study space for this course when it has no name yet; an existing name is never overwritten. Only meaningful alongside `courseId` — a space addressed by `studySpaceId` already exists and is renamed through the study-spaces endpoint. * @type {string} * @memberof CreateStudyObjectiveDto */ courseName?: string; /** * * @type {CreateStudyObjectiveDtoCanvasObject} * @memberof CreateStudyObjectiveDto */ canvasObject?: CreateStudyObjectiveDtoCanvasObject; } /** * Check if a given object implements the CreateStudyObjectiveDto interface. */ export declare function instanceOfCreateStudyObjectiveDto(value: object): value is CreateStudyObjectiveDto; export declare function CreateStudyObjectiveDtoFromJSON(json: any): CreateStudyObjectiveDto; export declare function CreateStudyObjectiveDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateStudyObjectiveDto; export declare function CreateStudyObjectiveDtoToJSON(json: any): CreateStudyObjectiveDto; export declare function CreateStudyObjectiveDtoToJSONTyped(value?: CreateStudyObjectiveDto | null, ignoreDiscriminator?: boolean): any;