@groton/canvas-api 0.3.0

package/dist/Resources/NewQuizzes.d.ts

@@ -0,0 +1,261 @@
+import { JSONObject } from '@battis/typescript-tricks';
+export type NewQuiz = {
+    /** The ID of the quiz */
+    id: string;
+    /** The title of the quiz */
+    title: string;
+    /** The quiz's instructions */
+    instructions: string;
+    /** The ID of the quiz's assignment group */
+    assignment_group_id: string;
+    /**
+     * The total point value given to the quiz
+     *
+     * Type: integer
+     */
+    points_possible: number | string;
+    /**
+     * When the quiz is due
+     *
+     * Format: date-time
+     */
+    due_at: string;
+    /**
+     * When to lock the quiz
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+    /**
+     * When to unlock the quiz
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * Whether the quiz has a published or unpublished draft state
+     *
+     * Type: boolean
+     */
+    published: boolean | string;
+    /**
+     * The type of grading the assignment receives ('pass_fail', 'percent',
+     * 'letter_grade', 'gpa_scale', or 'points')
+     */
+    grading_type: string;
+    /** Additional quiz settings (see QuizSettings) */
+    quiz_settings: QuizSettings;
+};
+export type QuizSettings = {
+    /**
+     * Type of calculator the user will have access to during the quiz ('none',
+     * basic' or 'scientific')
+     */
+    calculator_type: string;
+    /**
+     * Whether access to the quiz should be restricted to the IP address ranges
+     * described in 'filters'
+     *
+     * Type: boolean
+     */
+    filter_ip_address: boolean | string;
+    /**
+     * IP address ranges from which users can take the quiz, if
+     * 'filter_ip_address' is true
+     *
+     * Object
+     */
+    filters: JSONObject;
+    /**
+     * Whether questions should be shown all at once ('none') or one-at-a-time
+     * ('question')
+     */
+    one_at_a_time_type: string;
+    /**
+     * Whether to allow user to return to previous questions when
+     * 'one_at_a_time_type' is set to 'question'
+     *
+     * Type: boolean
+     */
+    allow_backtracking: boolean | string;
+    /**
+     * Whether answers should be shuffled during quiz
+     *
+     * Type: boolean
+     */
+    shuffle_answers: boolean | string;
+    /**
+     * Whether questions should be shuffled during quiz
+     *
+     * Type: boolean
+     */
+    shuffle_questions: boolean | string;
+    /**
+     * Whether to require an access code to take the quiz (set as
+     * 'student_access_code')
+     *
+     * Type: boolean
+     */
+    require_student_access_code: boolean | string;
+    /**
+     * Access code that is required to take the quiz if
+     * 'require_student_access_code' is true
+     */
+    student_access_code: string;
+    /**
+     * Whether the quiz has a time limit (set as 'session_time_limit_in_seconds')
+     *
+     * Type: boolean
+     */
+    has_time_limit: boolean | string;
+    /**
+     * Time limit during the quiz (in seconds)
+     *
+     * Type: integer
+     */
+    session_time_limit_in_seconds: number | string;
+    /** Settings to configure multiple quiz attempts (see MultipleAttemptsSettings) */
+    multiple_attempts: MultipleAttemptsSettings;
+    /** Settings to restrict student result view (see ResultViewSettings) */
+    result_view_settings: ResultViewSettings;
+};
+export type MultipleAttemptsSettings = {
+    /**
+     * Whether to allow multiple attempts
+     *
+     * Type: boolean
+     */
+    multiple_attempts_enabled: boolean | string;
+    /**
+     * Whether to limit the number of attempts if 'multiple_attempts_enabled' is
+     * true. Unlimited attempts if false.
+     *
+     * Type: boolean
+     */
+    attempt_limit: boolean | string;
+    /**
+     * Number of attempts to allow if 'multiple_attempts_enabled' and
+     * 'attempt_limit' are true
+     *
+     * Type: integer
+     */
+    max_attempts: number | string;
+    /**
+     * Specifies which score to keep after attempts ('average', 'first',
+     * 'highest', or 'latest')
+     */
+    score_to_keep: string;
+    /**
+     * Whether to enforce a waiting period after an attempt (set as
+     * 'cooling_period_seconds')
+     *
+     * Type: boolean
+     */
+    cooling_period: boolean | string;
+    /**
+     * Required waiting period (in seconds) between attempts. Enforced if
+     * 'cooling_period' is true.
+     *
+     * Type: integer
+     */
+    cooling_period_seconds: number | string;
+};
+export type ResultViewSettings = {
+    /**
+     * Whether to restrict the student result view
+     *
+     * Type: boolean
+     */
+    result_view_restricted: boolean | string;
+    /**
+     * Whether to show points awarded (overall and per question), if
+     * 'result_view_restricted' is true
+     *
+     * Type: boolean
+     */
+    display_points_awarded: boolean | string;
+    /**
+     * Whether to show points possible (overall and per question), if
+     * 'result_view_restricted' is true
+     *
+     * Type: boolean
+     */
+    display_points_possible: boolean | string;
+    /**
+     * Whether to show questions in the result view, if 'result_view_restricted'
+     * is true
+     *
+     * Type: boolean
+     */
+    display_items: boolean | string;
+    /**
+     * Whether to show student's responses in the result view, if 'display_items'
+     * is true
+     *
+     * Type: boolean
+     */
+    display_item_response: boolean | string;
+    /**
+     * Whether student responses should be shown for all attempts ('always'), only
+     * once after each attempt ('once_per_attempt'), only after their last attempt
+     * ('after_last_attempt'), or only once after their last attempt
+     * ('once_after_last_attempt'). if 'display_item_response' is true
+     */
+    display_item_response_qualifier: string;
+    /**
+     * When student responses should be shown to them, if 'display_item_responses'
+     * is true
+     *
+     * Format: date-time
+     */
+    show_item_responses_at: string;
+    /**
+     * When student responses should be hidden from them, if
+     * 'display_item_responses' is true. must be later than
+     * 'show_item_responses_at'
+     *
+     * Format: date-time
+     */
+    hide_item_responses_at: string;
+    /**
+     * Whether to indicate whether the student's response is correct/incorrect, if
+     * 'display_item_response' is true
+     *
+     * Type: boolean
+     */
+    display_item_response_correctness: boolean | string;
+    /**
+     * Whether student response correctness should be shown for all attempts
+     * ('always') or only after their last attempt ('after_last_attempt'), if
+     * 'display_item_response_correctness' is true
+     */
+    display_item_response_correctness_qualifier: string;
+    /**
+     * When correctness of student responses should be shown to them, if
+     * 'display_item_response_correctness' is true
+     *
+     * Format: date-time
+     */
+    show_item_response_correctness_at: string;
+    /**
+     * When correctness of student responses should be hidden from them, if
+     * 'display_item_response_correctness' is true. must be later than
+     * 'show_item_response_correctness_at'
+     *
+     * Format: date-time
+     */
+    hide_item_response_correctness_at: string;
+    /**
+     * Whether to show the correct answer for each question, if
+     * 'display_item_response_correctness' is true
+     *
+     * Type: boolean
+     */
+    display_item_correct_answer: boolean | string;
+    /**
+     * Whether to show feedback for each item, if 'display_items' is true
+     *
+     * Type: boolean
+     */
+    display_item_feedback: boolean | string;
+};

package/dist/Resources/NewQuizzes.js

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

package/dist/Resources/NewQuizzesAccommodations.d.ts

@@ -0,0 +1,64 @@
+import { JSONObject } from '@battis/typescript-tricks';
+/** Response structure for processing accommodations */
+export type AccommodationResponse = {
+    /** Processing result message */
+    message: string;
+    /** List of successfully processed accommodations */
+    successful: JSONObject[];
+    /** List of accommodations that failed to process */
+    failed: JSONObject[];
+};
+/** Request format for setting course-level accommodations */
+export type CourseAccommodationRequest = {
+    /**
+     * Canvas user ID of the student receiving accommodations
+     *
+     * Type: integer
+     */
+    user_id: number | string;
+    /**
+     * Amount of extra time (in minutes) for quiz submission
+     *
+     * Type: integer
+     */
+    extra_time: number | string;
+    /**
+     * Apply accommodations to ongoing quiz sessions
+     *
+     * Type: boolean
+     */
+    apply_to_in_progress_quiz_sessions: boolean | string;
+    /**
+     * Removes one incorrect answer from multiple-choice questions with 4+ choices
+     *
+     * Type: boolean
+     */
+    reduce_choices_enabled: boolean | string;
+};
+/** Request format for setting quiz-level accommodations */
+export type QuizAccommodationRequest = {
+    /**
+     * Canvas user ID of the student receiving accommodations
+     *
+     * Type: integer
+     */
+    user_id: number | string;
+    /**
+     * Amount of extra time (in minutes) for quiz submission
+     *
+     * Type: integer
+     */
+    extra_time: number | string;
+    /**
+     * Number of additional attempts allowed beyond the quiz limit
+     *
+     * Type: integer
+     */
+    extra_attempts: number | string;
+    /**
+     * Removes one incorrect answer from multiple-choice questions with 4+ choices
+     *
+     * Type: boolean
+     */
+    reduce_choices_enabled: boolean | string;
+};

package/dist/Resources/NewQuizzesAccommodations.js

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

package/dist/Resources/NewQuizzesReports.d.ts

@@ -0,0 +1,51 @@
+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;
+    /**
+     * 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;
+    /**
+     * For successfully completed jobs, this is a JSON object containing url of
+     * the report and other details
+     *
+     * Object
+     */
+    results: JSONObject;
+    /** Url where a progress update can be retrieved */
+    url: string;
+};

package/dist/Resources/NewQuizzesReports.js

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

package/dist/Resources/NoticeHandlers.d.ts

@@ -0,0 +1,23 @@
+/** Set of notice handlers (one per notice type) for an LTI tool deployment. */
+export type NoticeCatalog = {
+    /** The LTI tool's client ID (global developer key ID) */
+    client_id: string;
+    /** String that identifies the Platform-Tool integration governing the notices */
+    deployment_id: string;
+    /** List of notice handlers for the tool */
+    notice_handlers: NoticeHandler[];
+};
+/** A notice handler for a particular tool deployment and notice type. */
+export type NoticeHandler = {
+    /** URL to receive the notice */
+    handler: string;
+    /** The type of notice */
+    notice_type: string;
+    /**
+     * The maximum number of notices to include in a single batch, or 'null' if
+     * not set.
+     *
+     * Type: integer
+     */
+    max_batch_size: number | string;
+};

package/dist/Resources/NoticeHandlers.js

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

package/dist/Resources/NotificationPreferences.d.ts

@@ -0,0 +1,13 @@
+export type NotificationPreference = {
+    href: string;
+    /** The notification this preference belongs to */
+    notification: string;
+    /** The category of that notification */
+    category: string;
+    /**
+     * How often to send notifications to this communication channel for the given
+     * notification. Possible values are 'immediately', 'daily', 'weekly', and
+     * 'never'
+     */
+    frequency: string;
+};

package/dist/Resources/NotificationPreferences.js

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

package/dist/Resources/OriginalityReports.d.ts

@@ -0,0 +1,63 @@
+export type ToolSetting = {
+    /**
+     * The resource type code of the resource handler to use to display
+     * originality reports
+     */
+    resource_type_code: string;
+    /**
+     * A URL that may be used to override the launch URL inferred by the specified
+     * resource_type_code. If used a 'resource_type_code' must also be specified.
+     */
+    resource_url: string;
+};
+export type OriginalityReport = {
+    /**
+     * The id of the OriginalityReport
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The id of the file receiving the originality score
+     *
+     * Type: integer
+     */
+    file_id: number | string;
+    /**
+     * A number between 0 and 100 representing the originality score
+     *
+     * Type: number
+     */
+    originality_score: number | string;
+    /**
+     * The ID of the file within Canvas containing the originality report document
+     * (if provided)
+     *
+     * Type: integer
+     */
+    originality_report_file_id: number | string;
+    /** A non-LTI launch URL where the originality score of the file may be found. */
+    originality_report_url: string;
+    /**
+     * A ToolSetting object containing optional 'resource_type_code' and
+     * 'resource_url'
+     */
+    tool_setting: ToolSetting;
+    /**
+     * A message describing the error. If set, the workflow_state will become
+     * 'error.'
+     */
+    error_report: string;
+    /**
+     * The submitted_at date time of the submission.
+     *
+     * Format: date-time
+     */
+    submission_time: string;
+    /**
+     * The id of the root Account associated with the OriginalityReport
+     *
+     * Type: integer
+     */
+    root_account_id: number | string;
+};

package/dist/Resources/OriginalityReports.js

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

package/dist/Resources/OutcomeGroups.d.ts

@@ -0,0 +1,93 @@
+import { Outcome } from './Outcomes.js';
+export type OutcomeGroup = {
+    /**
+     * The ID of the outcome group
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The URL for fetching/updating the outcome group. should be treated as
+     * opaque
+     */
+    url: string;
+    /**
+     * An abbreviated OutcomeGroup object representing the parent group of this
+     * outcome group, if any. omitted in the abbreviated form.
+     */
+    parent_outcome_group: OutcomeGroup;
+    /**
+     * The context owning the outcome group. may be null for global outcome
+     * groups. omitted in the abbreviated form.
+     *
+     * Type: integer
+     */
+    context_id: number | string;
+    context_type: string;
+    /** Title of the outcome group */
+    title: string;
+    /** Description of the outcome group. omitted in the abbreviated form. */
+    description: string;
+    /** A custom GUID for the learning standard. */
+    vendor_guid: string;
+    /**
+     * The URL for listing/creating subgroups under the outcome group. should be
+     * treated as opaque
+     */
+    subgroups_url: string;
+    /**
+     * The URL for listing/creating outcome links under the outcome group. should
+     * be treated as opaque
+     */
+    outcomes_url: string;
+    /**
+     * The URL for importing another group into this outcome group. should be
+     * treated as opaque. omitted in the abbreviated form.
+     */
+    import_url: string;
+    /**
+     * Whether the current user can update the outcome group
+     *
+     * Type: boolean
+     */
+    can_edit: boolean | string;
+};
+export type OutcomeLink = {
+    /** The URL for fetching/updating the outcome link. should be treated as opaque */
+    url: string;
+    /**
+     * The context owning the outcome link. will match the context owning the
+     * outcome group containing the outcome link; included for convenience. may be
+     * null for links in global outcome groups.
+     *
+     * Type: integer
+     */
+    context_id: number | string;
+    context_type: string;
+    /**
+     * An abbreviated OutcomeGroup object representing the group containing the
+     * outcome link.
+     */
+    outcome_group: OutcomeGroup;
+    /**
+     * An abbreviated Outcome object representing the outcome linked into the
+     * containing outcome group.
+     */
+    outcome: Outcome;
+    /**
+     * Whether this outcome has been used to assess a student in the context of
+     * this outcome link. In other words, this will be set to true if the context
+     * is a course, and a student has been assessed with this outcome in that
+     * course.
+     *
+     * Type: boolean
+     */
+    assessed: boolean | string;
+    /**
+     * Whether this outcome link is manageable and is not the last link to an
+     * aligned outcome
+     *
+     * Type: boolean
+     */
+    can_unlink: boolean | string;
+};

package/dist/Resources/OutcomeGroups.js

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

package/dist/Resources/OutcomeImports.d.ts

@@ -0,0 +1,56 @@
+import { JSONObject } from '@battis/typescript-tricks';
+import { User } from './Users.js';
+export type OutcomeImportData = {
+    /** The type of outcome import */
+    import_type: string;
+};
+export type OutcomeImport = {
+    /**
+     * The unique identifier for the outcome import.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The unique identifier for the group into which the outcomes will be
+     * imported to, or NULL.
+     *
+     * Type: integer
+     */
+    learning_outcome_group_id: number | string;
+    /**
+     * The date the outcome import was created.
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * The date the outcome import finished. Returns null if not finished.
+     *
+     * Format: date-time
+     */
+    ended_at: string;
+    /**
+     * The date the outcome import was last updated.
+     *
+     * Format: date-time
+     */
+    updated_at: string;
+    /**
+     * The current state of the outcome import.
+     *
+     * - 'created': The outcome import has been created.
+     * - 'importing': The outcome import is currently processing.
+     * - 'succeeded': The outcome import has completed successfully.
+     * - 'failed': The outcome import failed.
+     */
+    workflow_state: string;
+    /** See the OutcomeImportData specification above. */
+    data: OutcomeImportData;
+    /** The progress of the outcome import. */
+    progress: string;
+    /** The user that initiated the outcome_import. See the Users API for details. */
+    user: User;
+    /** An array of row number / error message pairs. Returns the first 25 errors. */
+    processing_errors: JSONObject[][];
+};

package/dist/Resources/OutcomeImports.js

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