@groton/canvas-api 0.3.0

package/dist/Resources/PollSessions.d.ts

@@ -0,0 +1,60 @@
+import { JSONObject } from '@battis/typescript-tricks';
+import { PollSubmission } from './PollSubmissions.js';
+export type PollSession = {
+    /**
+     * The unique identifier for the poll session.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The id of the Poll this poll session is associated with
+     *
+     * Type: integer
+     */
+    poll_id: number | string;
+    /**
+     * The id of the Course this poll session is associated with
+     *
+     * Type: integer
+     */
+    course_id: number | string;
+    /**
+     * The id of the Course Section this poll session is associated with
+     *
+     * Type: integer
+     */
+    course_section_id: number | string;
+    /**
+     * Specifies whether or not this poll session has been published for students
+     * to participate in.
+     *
+     * Type: boolean
+     */
+    is_published: boolean | string;
+    /**
+     * Specifies whether the results are viewable by students.
+     *
+     * Type: boolean
+     */
+    has_public_results: boolean | string;
+    /**
+     * The time at which the poll session was created.
+     *
+     * Format: 'date-time'
+     */
+    created_at: string;
+    /**
+     * The results of the submissions of the poll. Each key is the poll choice id,
+     * and the value is the count of submissions.
+     *
+     * Object
+     */
+    results: JSONObject;
+    /**
+     * If the poll session has public results, this will return an array of all
+     * submissions, viewable by both students and teachers. If the results are not
+     * public, for students it will return their submission only.
+     */
+    poll_submissions: PollSubmission;
+};

package/dist/Resources/PollSessions.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/PollSubmissions.d.ts

@@ -0,0 +1,26 @@
+export type PollSubmission = {
+    /**
+     * The unique identifier for the poll submission.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The unique identifier of the poll choice chosen for this submission.
+     *
+     * Type: integer
+     */
+    poll_choice_id: number | string;
+    /**
+     * The unique identifier of the user who submitted this poll submission.
+     *
+     * Type: integer
+     */
+    user_id: number | string;
+    /**
+     * The date and time the poll submission was submitted.
+     *
+     * Format: 'date-time'
+     */
+    created_at: string;
+};

package/dist/Resources/PollSubmissions.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/Polls.d.ts

@@ -0,0 +1,32 @@
+import { JSONObject } from '@battis/typescript-tricks';
+export type Poll = {
+    /**
+     * The unique identifier for the poll.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The question/title of the poll. */
+    question: string;
+    /** A short description of the poll. */
+    description: string;
+    /**
+     * The time at which the poll was created.
+     *
+     * Format: 'date-time'
+     */
+    created_at: string;
+    /**
+     * The unique identifier for the user that created the poll.
+     *
+     * Type: integer
+     */
+    user_id: number | string;
+    /**
+     * An aggregate of the results of all associated poll sessions, with the poll
+     * choice id as the key, and the aggregated submission count as the value.
+     *
+     * Object
+     */
+    total_results: JSONObject;
+};

package/dist/Resources/Polls.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/ProficiencyRatings.d.ts

@@ -0,0 +1,25 @@
+export type ProficiencyRating = {
+    /** The description of the rating */
+    description: string;
+    /**
+     * A non-negative number of points for the rating
+     *
+     * Type: number
+     */
+    points: number | string;
+    /**
+     * Indicates the rating where mastery is first achieved
+     *
+     * Type: boolean
+     */
+    mastery: boolean | string;
+    /** The hex color code of the rating */
+    color: string;
+};
+export type Proficiency = {
+    /**
+     * An array of proficiency ratings. See the ProficiencyRating specification
+     * above.
+     */
+    ratings: unknown;
+};

package/dist/Resources/ProficiencyRatings.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/Progress.d.ts

@@ -0,0 +1,54 @@
+import { JSONObject } from '@battis/typescript-tricks';
+export type Progress = {
+    /**
+     * The ID of the Progress object
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The context owning the job.
+     *
+     * Type: integer
+     */
+    context_id: number | string;
+    context_type: string;
+    /**
+     * The id of the user who started the job
+     *
+     * Type: integer
+     */
+    user_id: number | string;
+    /** The type of operation */
+    tag: string;
+    /**
+     * Percent completed
+     *
+     * Type: integer
+     */
+    completion: number | string;
+    /** The state of the job one of 'queued', 'running', 'completed', 'failed' */
+    workflow_state: string;
+    /**
+     * The time the job was created
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * The time the job was last updated
+     *
+     * Format: date-time
+     */
+    updated_at: string;
+    /** Optional details about the job */
+    message: string;
+    /**
+     * Optional results of the job. omitted when job is still pending
+     *
+     * Object
+     */
+    results: JSONObject;
+    /** Url where a progress update can be retrieved with an LTI access token */
+    url: string;
+};

package/dist/Resources/Progress.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizAssignmentOverrides.d.ts

@@ -0,0 +1,59 @@
+/** Set of assignment-overridden dates for a quiz. */
+export type QuizAssignmentOverrideSet = {
+    /** ID of the quiz those dates are for. */
+    quiz_id: string;
+    /**
+     * An array of quiz assignment overrides. For students, this array will always
+     * contain a single item which is the set of dates that apply to that student.
+     * For teachers and staff, it may contain more.
+     */
+    due_dates: QuizAssignmentOverride;
+    /**
+     * An array of all assignment overrides active for the quiz. This is visible
+     * only to teachers and staff.
+     */
+    all_dates: QuizAssignmentOverride;
+};
+/** Container for set of assignment-overridden dates for a quiz. */
+export type QuizAssignmentOverrideSetContainer = {
+    /** The QuizAssignmentOverrideSet */
+    quiz_assignment_overrides: QuizAssignmentOverrideSet[];
+};
+/** Set of assignment-overridden dates for a quiz. */
+export type QuizAssignmentOverride = {
+    /**
+     * ID of the assignment override, unless this is the base construct, in which
+     * case the 'id' field is omitted.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The date after which any quiz submission is considered late.
+     *
+     * Format: date-time
+     */
+    due_at: string;
+    /**
+     * Date when the quiz becomes available for taking.
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * When the quiz will stop being available for taking. A value of null means
+     * it can always be taken.
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+    /** Title of the section this assignment override is for, if any. */
+    title: string;
+    /**
+     * If this property is present, it means that dates in this structure are not
+     * based on an assignment override, but are instead for all students.
+     *
+     * Type: boolean
+     */
+    base: boolean | string;
+};

package/dist/Resources/QuizAssignmentOverrides.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizExtensions.d.ts

@@ -0,0 +1,48 @@
+export type QuizExtension = {
+    /**
+     * The ID of the Quiz the quiz extension belongs to.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    quiz_id: number | string;
+    /**
+     * The ID of the Student that needs the quiz extension.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    user_id: number | string;
+    /**
+     * Number of times the student is allowed to re-take the quiz over the
+     * multiple-attempt limit.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    extra_attempts: number | string;
+    /**
+     * Amount of extra time allowed for the quiz submission, in minutes.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    extra_time: number | string;
+    /**
+     * The student can take the quiz even if it's locked for everyone else
+     *
+     * Type: boolean
+     */
+    manually_unlocked: boolean | string;
+    /**
+     * The time at which the quiz submission will be overdue, and be flagged as a
+     * late submission.
+     *
+     * Format: 'date-time'
+     */
+    end_at: string;
+};

package/dist/Resources/QuizExtensions.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizIpFilters.d.ts

@@ -0,0 +1,8 @@
+export type QuizIPFilter = {
+    /** A unique name for the filter. */
+    name: string;
+    /** Name of the Account (or Quiz) the IP filter is defined in. */
+    account: string;
+    /** An IP address (or range mask) this filter embodies. */
+    filter: string;
+};

package/dist/Resources/QuizIpFilters.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizQuestionGroups.d.ts

@@ -0,0 +1,52 @@
+export type QuizGroup = {
+    /**
+     * The ID of the question group.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    id: number | string;
+    /**
+     * The ID of the Quiz the question group belongs to.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    quiz_id: number | string;
+    /** The name of the question group. */
+    name: string;
+    /**
+     * The number of questions to pick from the group to display to the student.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    pick_count: number | string;
+    /**
+     * The amount of points allotted to each question in the group.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    question_points: number | string;
+    /**
+     * The ID of the Assessment question bank to pull questions from.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    assessment_question_bank_id: number | string;
+    /**
+     * The order in which the question group will be retrieved and displayed.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    position: number | string;
+};

package/dist/Resources/QuizQuestionGroups.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizQuestions.d.ts

@@ -0,0 +1,158 @@
+export type QuizQuestion = {
+    /**
+     * The ID of the quiz question.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    id: number | string;
+    /**
+     * The ID of the Quiz the question belongs to.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    quiz_id: number | string;
+    /**
+     * The order in which the question will be retrieved and displayed.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    position: number | string;
+    /** The name of the question. */
+    question_name: string;
+    /** The type of the question. */
+    question_type: string;
+    /** The text of the question. */
+    question_text: string;
+    /**
+     * The maximum amount of points possible received for getting this question
+     * correct.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    points_possible: number | string;
+    /** The comments to display if the student answers the question correctly. */
+    correct_comments: string;
+    /** The comments to display if the student answers incorrectly. */
+    incorrect_comments: string;
+    /** The comments to display regardless of how the student answered. */
+    neutral_comments: string;
+    /** An array of available answers to display to the student. */
+    answers: Answer[];
+};
+export type Answer = {
+    /**
+     * The unique identifier for the answer. Do not supply if this answer is part
+     * of a new question
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    id: number | string;
+    /** The text of the answer. */
+    answer_text: string;
+    /**
+     * An integer to determine correctness of the answer. Incorrect answers should
+     * be 0, correct answers should be 100.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    answer_weight: number | string;
+    /** Specific contextual comments for a particular answer. */
+    answer_comments: string;
+    /** Used in missing word questions. The text to follow the missing word */
+    text_after_answers: string;
+    /**
+     * Used in matching questions. The static value of the answer that will be
+     * displayed on the left for students to match for.
+     */
+    answer_match_left: string;
+    /**
+     * Used in matching questions. The correct match for the value given in
+     * answer_match_left. Will be displayed in a dropdown with the other
+     * answer_match_right values..
+     */
+    answer_match_right: string;
+    /**
+     * Used in matching questions. A list of distractors, delimited by new lines (
+     * ) that will be seeded with all the answer_match_right values.
+     */
+    matching_answer_incorrect_matches: string;
+    /**
+     * Used in numerical questions. Values can be 'exact_answer', 'range_answer',
+     * or 'precision_answer'.
+     */
+    numerical_answer_type: string;
+    /**
+     * Used in numerical questions of type 'exact_answer'. The value the answer
+     * should equal.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    exact: number | string;
+    /**
+     * Used in numerical questions of type 'exact_answer'. The margin of error
+     * allowed for the student's answer.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    margin: number | string;
+    /**
+     * Used in numerical questions of type 'precision_answer'. The value the
+     * answer should equal.
+     *
+     * Type: number
+     *
+     * Format: 'float64'
+     */
+    approximate: number | string;
+    /**
+     * Used in numerical questions of type 'precision_answer'. The numerical
+     * precision that will be used when comparing the student's answer.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    precision: number | string;
+    /**
+     * Used in numerical questions of type 'range_answer'. The start of the
+     * allowed range (inclusive).
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    start: number | string;
+    /**
+     * Used in numerical questions of type 'range_answer'. The end of the allowed
+     * range (inclusive).
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    end: number | string;
+    /**
+     * Used in fill in multiple blank and multiple dropdowns questions.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    blank_id: number | string;
+};

package/dist/Resources/QuizQuestions.js

@@ -0,0 +1 @@
+export {};

package/dist/Resources/QuizReports.d.ts

@@ -0,0 +1,75 @@
+import { Progress } from './CoursePace.js';
+import { File } from './Files.js';
+export type QuizReport = {
+    /**
+     * The ID of the quiz report
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The ID of the quiz
+     *
+     * Type: integer
+     */
+    quiz_id: number | string;
+    /**
+     * Which type of report this is possible values: 'student_analysis',
+     * 'item_analysis'
+     */
+    report_type: string;
+    /** A human-readable (and localized) version of the report_type */
+    readable_type: string;
+    /**
+     * Boolean indicating whether the report represents all submissions or only
+     * the most recent ones for each student
+     *
+     * Type: boolean
+     */
+    includes_all_versions: boolean | string;
+    /**
+     * Boolean indicating whether the report is for an anonymous survey. if true,
+     * no student names will be included in the csv
+     *
+     * Type: boolean
+     */
+    anonymous: boolean | string;
+    /**
+     * Boolean indicating whether the report can be generated, which is true
+     * unless the quiz is a survey one
+     *
+     * Type: boolean
+     */
+    generatable: boolean | string;
+    /**
+     * When the report was created
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * When the report was last updated
+     *
+     * Format: date-time
+     */
+    updated_at: string;
+    /** The API endpoint for this report */
+    url: string;
+    /**
+     * If the report has finished generating, a File object that represents it.
+     * refer to the Files API for more information about the format
+     */
+    file: File;
+    /**
+     * If the report has not yet finished generating, a URL where information
+     * about its progress can be retrieved. refer to the Progress API for more
+     * information (Note: not available in JSON-API format)
+     */
+    progress_url: string;
+    /**
+     * If the report is being generated, a Progress object that represents the
+     * operation. Refer to the Progress API for more information about the format.
+     * (Note: available only in JSON-API format)
+     */
+    progress: Progress;
+};

package/dist/Resources/QuizReports.js

@@ -0,0 +1 @@
+export {};