@groton/canvas-api 0.3.0

package/dist/Resources/Assignments.d.ts

@@ -0,0 +1,847 @@
+import { JSONObject } from '@battis/typescript-tricks';
+import { DiscussionTopic } from './DiscussionTopics.js';
+import { Submission } from './Submissions.js';
+export type ExternalToolTagAttributes = {
+    /** URL to the external tool */
+    url: string;
+    /**
+     * Whether or not there is a new tab for the external tool
+     *
+     * Type: boolean
+     */
+    new_tab: boolean | string;
+    /** The identifier for this tool_tag */
+    resource_link_id: string;
+};
+export type LockInfo = {
+    /** Asset string for the object causing the lock */
+    asset_string: string;
+    /**
+     * (Optional) Time at which this was/will be unlocked. Must be before the due
+     * date.
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * (Optional) Time at which this was/will be locked. Must be after the due
+     * date.
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+    /** (Optional) Context module causing the lock. */
+    context_module: string;
+    /** Type: boolean */
+    manually_locked: boolean | string;
+};
+export type RubricRating = {
+    /** Type: integer */
+    points: number | string;
+    id: string;
+    description: string;
+    long_description: string;
+};
+export type RubricCriteria = {
+    /** Type: integer */
+    points: number | string;
+    /** The id of rubric criteria. */
+    id: string;
+    /** (Optional) The id of the learning outcome this criteria uses, if any. */
+    learning_outcome_id: string;
+    /**
+     * (Optional) The 3rd party vendor's GUID for the outcome this criteria
+     * references, if any.
+     */
+    vendor_guid: string;
+    description: string;
+    long_description: string;
+    /** Type: boolean */
+    criterion_use_range: boolean | string;
+    ratings: RubricRating[];
+    /** Type: boolean */
+    ignore_for_scoring: boolean | string;
+};
+/**
+ * Object representing a due date for an assignment or quiz. If the due date
+ * came from an assignment override, it will have an 'id' field.
+ */
+export type AssignmentDate = {
+    /**
+     * (Optional, missing if 'base' is present) id of the assignment override this
+     * date represents
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * (Optional, present if 'id' is missing) whether this date represents the
+     * assignment's or quiz's default due date
+     *
+     * Type: boolean
+     */
+    base: boolean | string;
+    title: string;
+    /**
+     * The due date for the assignment. Must be between the unlock date and the
+     * lock date if there are lock dates
+     *
+     * Format: date-time
+     */
+    due_at: string;
+    /**
+     * The unlock date for the assignment. Must be before the due date if there is
+     * a due date.
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * The lock date for the assignment. Must be after the due date if there is a
+     * due date.
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+};
+export type TurnitinSettings = {
+    originality_report_visibility: string;
+    /** Type: boolean */
+    s_paper_check: boolean | string;
+    /** Type: boolean */
+    internet_check: boolean | string;
+    /** Type: boolean */
+    journal_check: boolean | string;
+    /** Type: boolean */
+    exclude_biblio: boolean | string;
+    /** Type: boolean */
+    exclude_quoted: boolean | string;
+    exclude_small_matches_type: string;
+    /** Type: integer */
+    exclude_small_matches_value: number | string;
+};
+/** Used by Assignment model */
+export type NeedsGradingCount = {
+    /** The section ID */
+    section_id: string;
+    /**
+     * Number of submissions that need grading
+     *
+     * Type: integer
+     */
+    needs_grading_count: number | string;
+};
+/** Used by Assignment model */
+export type ScoreStatistic = {
+    /**
+     * Min score
+     *
+     * Type: integer
+     */
+    min: number | string;
+    /**
+     * Max score
+     *
+     * Type: integer
+     */
+    max: number | string;
+    /**
+     * Mean score
+     *
+     * Type: integer
+     */
+    mean: number | string;
+    /**
+     * Upper quartile score
+     *
+     * Type: integer
+     */
+    upper_q: number | string;
+    /**
+     * Median score
+     *
+     * Type: integer
+     */
+    median: number | string;
+    /**
+     * Lower quartile score
+     *
+     * Type: integer
+     */
+    lower_q: number | string;
+};
+export type Assignment = {
+    /**
+     * The ID of the assignment
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The name of the assignment */
+    name: string;
+    /** The assignment description, in an HTML fragment */
+    description: string;
+    /**
+     * The time at which this assignment was originally created
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * The time at which this assignment was last modified in any way
+     *
+     * Format: date-time
+     */
+    updated_at: string;
+    /**
+     * The due date for the assignment. returns null if not present. NOTE: If this
+     * assignment has assignment overrides, this field will be the due date as it
+     * applies to the user requesting information from the API.
+     *
+     * Format: date-time
+     */
+    due_at: string;
+    /**
+     * The lock date (assignment is locked after this date). returns null if not
+     * present. NOTE: If this assignment has assignment overrides, this field will
+     * be the lock date as it applies to the user requesting information from the
+     * API.
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+    /**
+     * The unlock date (assignment is unlocked after this date) returns null if
+     * not present NOTE: If this assignment has assignment overrides, this field
+     * will be the unlock date as it applies to the user requesting information
+     * from the API.
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * Whether this assignment has overrides
+     *
+     * Type: boolean
+     */
+    has_overrides: boolean | string;
+    /** (Optional) all dates associated with the assignment, if applicable */
+    all_dates: AssignmentDate[];
+    /**
+     * The ID of the course the assignment belongs to
+     *
+     * Type: integer
+     */
+    course_id: number | string;
+    /** The URL to the assignment's web page */
+    html_url: string;
+    /** The URL to download all submissions as a zip */
+    submissions_download_url: string;
+    /**
+     * The ID of the assignment's group
+     *
+     * Type: integer
+     */
+    assignment_group_id: number | string;
+    /**
+     * Boolean flag indicating whether the assignment requires a due date based on
+     * the account level setting
+     *
+     * Type: boolean
+     */
+    due_date_required: boolean | string;
+    /**
+     * Allowed file extensions, which take effect if submission_types includes
+     * 'online_upload'.
+     */
+    allowed_extensions: string[];
+    /**
+     * An integer indicating the maximum length an assignment's name may be
+     *
+     * Type: integer
+     */
+    max_name_length: number | string;
+    /**
+     * Boolean flag indicating whether or not Turnitin has been enabled for the
+     * assignment. NOTE: This flag will not appear unless your account has the
+     * Turnitin plugin available
+     *
+     * Type: boolean
+     */
+    turnitin_enabled: boolean | string;
+    /**
+     * Boolean flag indicating whether or not VeriCite has been enabled for the
+     * assignment. NOTE: This flag will not appear unless your account has the
+     * VeriCite plugin available
+     *
+     * Type: boolean
+     */
+    vericite_enabled: boolean | string;
+    /**
+     * Settings to pass along to turnitin to control what kinds of matches should
+     * be considered. originality_report_visibility can be 'immediate',
+     * 'after_grading', 'after_due_date', or 'never' exclude_small_matches_type
+     * can be null, 'percent', 'words' exclude_small_matches_value: - if type is
+     * null, this will be null also - if type is 'percent', this will be a number
+     * between 0 and 100 representing match size to exclude as a percentage of the
+     * document size. - if type is 'words', this will be number > 0 representing
+     * how many words a match must contain for it to be considered NOTE: This flag
+     * will not appear unless your account has the Turnitin plugin available
+     */
+    turnitin_settings: TurnitinSettings;
+    /**
+     * If this is a group assignment, boolean flag indicating whether or not
+     * students will be graded individually.
+     *
+     * Type: boolean
+     */
+    grade_group_students_individually: boolean | string;
+    /**
+     * (Optional) assignment's settings for external tools if submission_types
+     * include 'external_tool'. Only url and new_tab are included (new_tab
+     * defaults to false). Use the 'External Tools' API if you need more
+     * information about an external tool.
+     */
+    external_tool_tag_attributes: ExternalToolTagAttributes;
+    /**
+     * Boolean indicating if peer reviews are required for this assignment
+     *
+     * Type: boolean
+     */
+    peer_reviews: boolean | string;
+    /**
+     * Boolean indicating peer reviews are assigned automatically. If false, the
+     * teacher is expected to manually assign peer reviews.
+     *
+     * Type: boolean
+     */
+    automatic_peer_reviews: boolean | string;
+    /**
+     * Integer representing the amount of reviews each user is assigned. NOTE:
+     * This key is NOT present unless you have automatic_peer_reviews set to
+     * true.
+     *
+     * Type: integer
+     */
+    peer_review_count: number | string;
+    /**
+     * String representing a date the reviews are due by. Must be a date that
+     * occurs after the default due date. If blank, or date is not after the
+     * assignment's due date, the assignment's due date will be used. NOTE: This
+     * key is NOT present unless you have automatic_peer_reviews set to true.
+     *
+     * Format: date-time
+     */
+    peer_reviews_assign_at: string;
+    /**
+     * Boolean representing whether or not members from within the same group on a
+     * group assignment can be assigned to peer review their own group's work
+     *
+     * Type: boolean
+     */
+    intra_group_peer_reviews: boolean | string;
+    /**
+     * The ID of the assignment’s group set, if this is a group assignment. For
+     * group discussions, set group_category_id on the discussion topic, not the
+     * linked assignment.
+     *
+     * Type: integer
+     */
+    group_category_id: number | string;
+    /**
+     * If the requesting user has grading rights, the number of submissions that
+     * need grading.
+     *
+     * Type: integer
+     */
+    needs_grading_count: number | string;
+    /**
+     * If the requesting user has grading rights and the
+     * 'needs_grading_count_by_section' flag is specified, the number of
+     * submissions that need grading split out by section. NOTE: This key is NOT
+     * present unless you pass the 'needs_grading_count_by_section' argument as
+     * true. ANOTHER NOTE: it's possible to be enrolled in multiple sections, and
+     * if a student is setup that way they will show an assignment that needs
+     * grading in multiple sections (effectively the count will be duplicated
+     * between sections)
+     */
+    needs_grading_count_by_section: NeedsGradingCount[];
+    /**
+     * The sorting order of the assignment in the group
+     *
+     * Type: integer
+     */
+    position: number | string;
+    /**
+     * (optional, present if Sync Grades to SIS feature is enabled)
+     *
+     * Type: boolean
+     */
+    post_to_sis: boolean | string;
+    /** (optional, Third Party unique identifier for Assignment) */
+    integration_id: string;
+    /**
+     * (optional, Third Party integration data for assignment)
+     *
+     * Object
+     */
+    integration_data: JSONObject;
+    /**
+     * The maximum points possible for the assignment
+     *
+     * Type: number
+     */
+    points_possible: number | string;
+    /**
+     * The types of submissions allowed for this assignment list containing one or
+     * more of the following: 'discussion_topic', 'online_quiz', 'on_paper',
+     * 'none', 'external_tool', 'online_text_entry', 'online_url',
+     * 'online_upload', 'media_recording', 'student_annotation'
+     */
+    submission_types: string[];
+    /**
+     * If true, the assignment has been submitted to by at least one student
+     *
+     * Type: boolean
+     */
+    has_submitted_submissions: boolean | string;
+    /**
+     * The type of grading the assignment receives; one of 'pass_fail', 'percent',
+     * 'letter_grade', 'gpa_scale', 'points'
+     */
+    grading_type: string;
+    /**
+     * The id of the grading standard being applied to this assignment. Valid if
+     * grading_type is 'letter_grade' or 'gpa_scale'.
+     *
+     * Type: integer
+     */
+    grading_standard_id: number | string;
+    /**
+     * Whether the assignment is published
+     *
+     * Type: boolean
+     */
+    published: boolean | string;
+    /**
+     * Whether the assignment's 'published' state can be changed to false. Will be
+     * false if there are student submissions for the assignment.
+     *
+     * Type: boolean
+     */
+    unpublishable: boolean | string;
+    /**
+     * Whether the assignment is only visible to overrides.
+     *
+     * Type: boolean
+     */
+    only_visible_to_overrides: boolean | string;
+    /**
+     * Whether or not this is locked for the user.
+     *
+     * Type: boolean
+     */
+    locked_for_user: boolean | string;
+    /**
+     * (Optional) Information for the user about the lock. Present when
+     * locked_for_user is true.
+     */
+    lock_info: LockInfo;
+    /**
+     * (Optional) An explanation of why this is locked for the user. Present when
+     * locked_for_user is true.
+     */
+    lock_explanation: string;
+    /**
+     * (Optional) id of the associated quiz (applies only when submission_types is
+     * ['online_quiz'])
+     *
+     * Type: integer
+     */
+    quiz_id: number | string;
+    /**
+     * (Optional) whether anonymous submissions are accepted (applies only to quiz
+     * assignments)
+     *
+     * Type: boolean
+     */
+    anonymous_submissions: boolean | string;
+    /**
+     * (Optional) the DiscussionTopic associated with the assignment, if
+     * applicable
+     */
+    discussion_topic: DiscussionTopic;
+    /**
+     * (Optional) Boolean indicating if assignment will be frozen when it is
+     * copied. NOTE: This field will only be present if the AssignmentFreezer
+     * plugin is available for your account.
+     *
+     * Type: boolean
+     */
+    freeze_on_copy: boolean | string;
+    /**
+     * (Optional) Boolean indicating if assignment is frozen for the calling user.
+     * NOTE: This field will only be present if the AssignmentFreezer plugin is
+     * available for your account.
+     *
+     * Type: boolean
+     */
+    frozen: boolean | string;
+    /**
+     * (Optional) Array of frozen attributes for the assignment. Only account
+     * administrators currently have permission to change an attribute in this
+     * list. Will be empty if no attributes are frozen for this assignment.
+     * Possible frozen attributes are: title, description, lock_at,
+     * points_possible, grading_type, submission_types, assignment_group_id,
+     * allowed_extensions, group_category_id, notify_of_update, peer_reviews NOTE:
+     * This field will only be present if the AssignmentFreezer plugin is
+     * available for your account.
+     */
+    frozen_attributes: string[];
+    /**
+     * (Optional) If 'submission' is included in the 'include' parameter, includes
+     * a Submission object that represents the current user's (user who is
+     * requesting information from the api) current submission for the assignment.
+     * See the Submissions API for an example response. If the user does not have
+     * a submission, this key will be absent.
+     */
+    submission: Submission;
+    /**
+     * (Optional) If true, the rubric is directly tied to grading the assignment.
+     * Otherwise, it is only advisory. Included if there is an associated rubric.
+     *
+     * Type: boolean
+     */
+    use_rubric_for_grading: boolean | string;
+    /**
+     * (Optional) An object describing the basic attributes of the rubric,
+     * including the point total. Included if there is an associated rubric.
+     *
+     * Object
+     */
+    rubric_settings: JSONObject;
+    /**
+     * (Optional) A list of scoring criteria and ratings for each rubric
+     * criterion. Included if there is an associated rubric.
+     */
+    rubric: RubricCriteria[];
+    /**
+     * (Optional) If 'assignment_visibility' is included in the 'include'
+     * parameter, includes an array of student IDs who can see this assignment.
+     */
+    assignment_visibility: number | string[];
+    /**
+     * (Optional) If 'overrides' is included in the 'include' parameter, includes
+     * an array of assignment override objects.
+     */
+    overrides: AssignmentOverride[];
+    /**
+     * (Optional) If true, the assignment will be omitted from the student's final
+     * grade
+     *
+     * Type: boolean
+     */
+    omit_from_final_grade: boolean | string;
+    /**
+     * (Optional) If true, the assignment will not be shown in any gradebooks
+     *
+     * Type: boolean
+     */
+    hide_in_gradebook: boolean | string;
+    /**
+     * Boolean indicating if the assignment is moderated.
+     *
+     * Type: boolean
+     */
+    moderated_grading: boolean | string;
+    /**
+     * The maximum number of provisional graders who may issue grades for this
+     * assignment. Only relevant for moderated assignments. Must be a positive
+     * value, and must be set to 1 if the course has fewer than two active
+     * instructors. Otherwise, the maximum value is the number of active
+     * instructors in the course minus one, or 10 if the course has more than 11
+     * active instructors.
+     *
+     * Type: integer
+     */
+    grader_count: number | string;
+    /**
+     * The user ID of the grader responsible for choosing final grades for this
+     * assignment. Only relevant for moderated assignments.
+     *
+     * Type: integer
+     */
+    final_grader_id: number | string;
+    /**
+     * Boolean indicating if provisional graders' comments are visible to other
+     * provisional graders. Only relevant for moderated assignments.
+     *
+     * Type: boolean
+     */
+    grader_comments_visible_to_graders: boolean | string;
+    /**
+     * Boolean indicating if provisional graders' identities are hidden from other
+     * provisional graders. Only relevant for moderated assignments with
+     * grader_comments_visible_to_graders set to true.
+     *
+     * Type: boolean
+     */
+    graders_anonymous_to_graders: boolean | string;
+    /**
+     * Boolean indicating if provisional grader identities are visible to the
+     * final grader. Only relevant for moderated assignments.
+     *
+     * Type: boolean
+     */
+    grader_names_visible_to_final_grader: boolean | string;
+    /**
+     * Boolean indicating if the assignment is graded anonymously. If true,
+     * graders cannot see student identities.
+     *
+     * Type: boolean
+     */
+    anonymous_grading: boolean | string;
+    /**
+     * The number of submission attempts a student can make for this assignment.
+     * -1 is considered unlimited.
+     *
+     * Type: integer
+     */
+    allowed_attempts: number | string;
+    /**
+     * Whether the assignment has manual posting enabled. Only relevant for
+     * courses using New Gradebook.
+     *
+     * Type: boolean
+     */
+    post_manually: boolean | string;
+    /**
+     * (Optional) If 'score_statistics' and 'submission' are included in the
+     * 'include' parameter and statistics are available, includes the min, max,
+     * and mode for this assignment
+     */
+    score_statistics: ScoreStatistic;
+    /**
+     * (Optional) If retrieving a single assignment and 'can_submit' is included
+     * in the 'include' parameter, flags whether user has the right to submit the
+     * assignment (i.e. checks enrollment dates, submission types, locked status,
+     * attempts remaining, etc...). Including 'can submit' automatically includes
+     * 'submission' in the include parameter. Not available when observed_users
+     * are included.
+     *
+     * Type: boolean
+     */
+    can_submit: boolean | string;
+    /**
+     * (Optional) The academic benchmark(s) associated with the assignment or the
+     * assignment's rubric. Only included if 'ab_guid' is included in the
+     * 'include' parameter.
+     */
+    ab_guid: string[];
+    /**
+     * The id of the attachment to be annotated by students. Relevant only if
+     * submission_types includes 'student_annotation'.
+     *
+     * Type: integer
+     */
+    annotatable_attachment_id: number | string;
+    /**
+     * (Optional) Boolean indicating whether student names are anonymized
+     *
+     * Type: boolean
+     */
+    anonymize_students: boolean | string;
+    /**
+     * (Optional) Boolean indicating whether the Respondus LockDown Browser® is
+     * required for this assignment.
+     *
+     * Type: boolean
+     */
+    require_lockdown_browser: boolean | string;
+    /**
+     * (Optional) Boolean indicating whether this assignment has important dates.
+     *
+     * Type: boolean
+     */
+    important_dates: boolean | string;
+    /**
+     * (Optional, Deprecated) Boolean indicating whether notifications are muted
+     * for this assignment.
+     *
+     * Type: boolean
+     */
+    muted: boolean | string;
+    /**
+     * Boolean indicating whether peer reviews are anonymous.
+     *
+     * Type: boolean
+     */
+    anonymous_peer_reviews: boolean | string;
+    /**
+     * Boolean indicating whether instructor anotations are anonymous.
+     *
+     * Type: boolean
+     */
+    anonymous_instructor_annotations: boolean | string;
+    /**
+     * Boolean indicating whether this assignment has graded submissions.
+     *
+     * Type: boolean
+     */
+    graded_submissions_exist: boolean | string;
+    /**
+     * Boolean indicating whether this is a quiz lti assignment.
+     *
+     * Type: boolean
+     */
+    is_quiz_assignment: boolean | string;
+    /**
+     * Boolean indicating whether this assignment is in a closed grading period.
+     *
+     * Type: boolean
+     */
+    in_closed_grading_period: boolean | string;
+    /**
+     * Boolean indicating whether this assignment can be duplicated.
+     *
+     * Type: boolean
+     */
+    can_duplicate: boolean | string;
+    /**
+     * If this assignment is a duplicate, it is the original assignment's
+     * course_id
+     *
+     * Type: integer
+     */
+    original_course_id: number | string;
+    /**
+     * If this assignment is a duplicate, it is the original assignment's id
+     *
+     * Type: integer
+     */
+    original_assignment_id: number | string;
+    /**
+     * If this assignment is a duplicate, it is the original assignment's
+     * lti_resource_link_id
+     *
+     * Type: integer
+     */
+    original_lti_resource_link_id: number | string;
+    /** If this assignment is a duplicate, it is the original assignment's name */
+    original_assignment_name: string;
+    /**
+     * If this assignment is a duplicate, it is the original assignment's quiz_id
+     *
+     * Type: integer
+     */
+    original_quiz_id: number | string;
+    /** String indicating what state this assignment is in. */
+    workflow_state: string;
+};
+export type BasicUser = {
+    /** The user's ID */
+    id: string;
+    /** The user's name */
+    name: string;
+};
+export type AssignmentOverride = {
+    /**
+     * The ID of the assignment override
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The ID of the assignment the override applies to (present if the override
+     * applies to an assignment)
+     *
+     * Type: integer
+     */
+    assignment_id: number | string;
+    /**
+     * The ID of the quiz the override applies to (present if the override applies
+     * to a quiz)
+     *
+     * Type: integer
+     */
+    quiz_id: number | string;
+    /**
+     * The ID of the module the override applies to (present if the override
+     * applies to a module)
+     *
+     * Type: integer
+     */
+    context_module_id: number | string;
+    /**
+     * The ID of the discussion the override applies to (present if the override
+     * applies to an ungraded discussion)
+     *
+     * Type: integer
+     */
+    discussion_topic_id: number | string;
+    /**
+     * The ID of the page the override applies to (present if the override applies
+     * to a page)
+     *
+     * Type: integer
+     */
+    wiki_page_id: number | string;
+    /**
+     * The ID of the file the override applies to (present if the override applies
+     * to a file)
+     *
+     * Type: integer
+     */
+    attachment_id: number | string;
+    /**
+     * The IDs of the override's target students (present if the override targets
+     * an ad-hoc set of students)
+     */
+    student_ids: number | string[];
+    /**
+     * The ID of the override's target group (present if the override targets a
+     * group and the assignment is a group assignment)
+     *
+     * Type: integer
+     */
+    group_id: number | string;
+    /**
+     * The ID of the overrides's target section (present if the override targets a
+     * section)
+     *
+     * Type: integer
+     */
+    course_section_id: number | string;
+    /** The title of the override */
+    title: string;
+    /**
+     * The overridden due at (present if due_at is overridden)
+     *
+     * Format: date-time
+     */
+    due_at: string;
+    /**
+     * The overridden all day flag (present if due_at is overridden)
+     *
+     * Type: boolean
+     */
+    all_day: boolean | string;
+    /**
+     * The overridden all day date (present if due_at is overridden)
+     *
+     * Format: date-time
+     */
+    all_day_date: string;
+    /**
+     * The overridden unlock at (present if unlock_at is overridden)
+     *
+     * Format: date-time
+     */
+    unlock_at: string;
+    /**
+     * The overridden lock at, if any (present if lock_at is overridden)
+     *
+     * Format: date-time
+     */
+    lock_at: string;
+};