@groton/canvas-api 0.3.0

package/dist/Resources/Accounts.d.ts

@@ -0,0 +1,138 @@
+export type Account = {
+    /**
+     * The ID of the Account object
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The display name of the account */
+    name: string;
+    /** The UUID of the account */
+    uuid: string;
+    /**
+     * The account's parent ID, or null if this is the root account
+     *
+     * Type: integer
+     */
+    parent_account_id: number | string;
+    /**
+     * The ID of the root account, or null if this is the root account
+     *
+     * Type: integer
+     */
+    root_account_id: number | string;
+    /**
+     * The storage quota for the account in megabytes, if not otherwise specified
+     *
+     * Type: integer
+     */
+    default_storage_quota_mb: number | string;
+    /**
+     * The storage quota for a user in the account in megabytes, if not otherwise
+     * specified
+     *
+     * Type: integer
+     */
+    default_user_storage_quota_mb: number | string;
+    /**
+     * The storage quota for a group in the account in megabytes, if not otherwise
+     * specified
+     *
+     * Type: integer
+     */
+    default_group_storage_quota_mb: number | string;
+    /**
+     * The default time zone of the account. Allowed time zones are
+     * {http://www.iana.org/time-zones IANA time zones} or friendlier
+     * {http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html Ruby on
+     * Rails time zones}.
+     */
+    default_time_zone: string;
+    /**
+     * The account's identifier in the Student Information System. Only included
+     * if the user has permission to view SIS information.
+     */
+    sis_account_id: string;
+    /**
+     * The account's identifier in the Student Information System. Only included
+     * if the user has permission to view SIS information.
+     */
+    integration_id: string;
+    /**
+     * The id of the SIS import if created through SIS. Only included if the user
+     * has permission to manage SIS information.
+     *
+     * Type: integer
+     */
+    sis_import_id: number | string;
+    /**
+     * The number of courses directly under the account (available via include)
+     *
+     * Type: integer
+     */
+    course_count: number | string;
+    /**
+     * The number of sub-accounts directly under the account (available via
+     * include)
+     *
+     * Type: integer
+     */
+    sub_account_count: number | string;
+    /** The account's identifier that is sent as context_id in LTI launches. */
+    lti_guid: string;
+    /** The state of the account. Can be 'active' or 'deleted'. */
+    workflow_state: string;
+};
+export type TermsOfService = {
+    /**
+     * Terms Of Service id
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The given type for the Terms of Service */
+    terms_type: string;
+    /**
+     * Boolean dictating if the user must accept Terms of Service
+     *
+     * Type: boolean
+     */
+    passive: boolean | string;
+    /**
+     * The id of the root account that owns the Terms of Service
+     *
+     * Type: integer
+     */
+    account_id: number | string;
+    /** Content of the Terms of Service */
+    content: string;
+    /** The type of self registration allowed */
+    self_registration_type: string;
+};
+export type HelpLink = {
+    /** The ID of the help link */
+    id: string;
+    /** The name of the help link */
+    text: string;
+    /** The description of the help link */
+    subtext: string;
+    /** The URL of the help link */
+    url: string;
+    /** The type of the help link */
+    type: string;
+    /** The roles that have access to this help link */
+    available_to: string[];
+};
+export type HelpLinks = {
+    /** Help link button title */
+    help_link_name: string;
+    /** Help link button icon */
+    help_link_icon: string;
+    /** Help links defined by the account. Could include default help links. */
+    custom_help_links: HelpLink[];
+    /**
+     * Default help links provided when account has not set help links of their
+     * own.
+     */
+    default_help_links: HelpLink[];
+};

package/dist/Resources/Accounts.js

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

package/dist/Resources/Admins.d.ts

@@ -0,0 +1,18 @@
+import { User } from './Users.js';
+export type Admin = {
+    /**
+     * The unique identifier for the account role/user assignment.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The account role assigned. This can be 'AccountAdmin' or a user-defined
+     * role created by the Roles API.
+     */
+    role: string;
+    /** The user the role is assigned to. See the Users API for details. */
+    user: User;
+    /** The status of the account role/user assignment. */
+    workflow_state: string;
+};

package/dist/Resources/Admins.js

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

package/dist/Resources/AnnouncementExternalFeeds.d.ts

@@ -0,0 +1,34 @@
+export type ExternalFeed = {
+    /**
+     * The ID of the feed
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * The title of the feed, pulled from the feed itself. If the feed hasn't yet
+     * been pulled, a temporary name will be synthesized based on the URL
+     */
+    display_name: string;
+    /** The HTTP/HTTPS URL to the feed */
+    url: string;
+    /**
+     * If not null, only feed entries whose title contains this string will
+     * trigger new posts in Canvas
+     */
+    header_match: string;
+    /**
+     * When this external feed was added to Canvas
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * The verbosity setting determines how much of the feed's content is imported
+     * into Canvas as part of the posting. 'link_only' means that only the title
+     * and a link to the item. 'truncate' means that a summary of the first
+     * portion of the item body will be used. 'full' means that the full item body
+     * will be used.
+     */
+    verbosity: string;
+};

package/dist/Resources/AnnouncementExternalFeeds.js

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

package/dist/Resources/ApiTokenScopes.d.ts

@@ -0,0 +1,14 @@
+export type Scope = {
+    /** The resource the scope is associated with */
+    resource: string;
+    /** The localized resource name */
+    resource_name: string;
+    /** The controller the scope is associated to */
+    controller: string;
+    /** The controller action the scope is associated to */
+    action: string;
+    /** The HTTP verb for the scope */
+    verb: string;
+    /** The identifier for the scope */
+    scope: string;
+};

package/dist/Resources/ApiTokenScopes.js

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

package/dist/Resources/AppointmentGroups.d.ts

@@ -0,0 +1,156 @@
+import { CalendarEvent } from './CalendarEvents.js';
+/** Date and time for an appointment */
+export type Appointment = {
+    /**
+     * The appointment identifier.
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /**
+     * Start time for the appointment
+     *
+     * Format: date-time
+     */
+    start_at: string;
+    /**
+     * End time for the appointment
+     *
+     * Format: date-time
+     */
+    end_at: string;
+};
+export type AppointmentGroup = {
+    /**
+     * The ID of the appointment group
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The title of the appointment group */
+    title: string;
+    /**
+     * The start of the first time slot in the appointment group
+     *
+     * Format: date-time
+     */
+    start_at: string;
+    /**
+     * The end of the last time slot in the appointment group
+     *
+     * Format: date-time
+     */
+    end_at: string;
+    /** The text description of the appointment group */
+    description: string;
+    /** The location name of the appointment group */
+    location_name: string;
+    /** The address of the appointment group's location */
+    location_address: string;
+    /**
+     * The number of participant who have reserved slots (see include[] argument)
+     *
+     * Type: integer
+     */
+    participant_count: number | string;
+    /**
+     * The start and end times of slots reserved by the current user as well as
+     * the id of the calendar event for the reservation (see include[] argument)
+     */
+    reserved_times: Appointment[];
+    /**
+     * Boolean indicating whether observer users should be able to sign-up for an
+     * appointment
+     *
+     * Type: boolean
+     */
+    allow_observer_signup: boolean | string;
+    /**
+     * The context codes (i.e. courses) this appointment group belongs to. Only
+     * people in these courses will be eligible to sign up.
+     */
+    context_codes: string[];
+    /**
+     * The sub-context codes (i.e. course sections and group categories) this
+     * appointment group is restricted to
+     */
+    sub_context_codes: number | string[];
+    /**
+     * Current state of the appointment group ('pending', 'active' or 'deleted').
+     * 'pending' indicates that it has not been published yet and is invisible to
+     * participants.
+     */
+    workflow_state: string;
+    /**
+     * Boolean indicating whether the current user needs to sign up for this
+     * appointment group (i.e. it's reservable and the
+     * min_appointments_per_participant limit has not been met by this user).
+     *
+     * Type: boolean
+     */
+    requiring_action: boolean | string;
+    /**
+     * Number of time slots in this appointment group
+     *
+     * Type: integer
+     */
+    appointments_count: number | string;
+    /**
+     * Calendar Events representing the time slots (see include[] argument) Refer
+     * to the Calendar Events API for more information
+     */
+    appointments: CalendarEvent[];
+    /**
+     * Newly created time slots (same format as appointments above). Only returned
+     * in Create/Update responses where new time slots have been added
+     */
+    new_appointments: CalendarEvent[];
+    /**
+     * Maximum number of time slots a user may register for, or null if no limit
+     *
+     * Type: integer
+     */
+    max_appointments_per_participant: number | string;
+    /**
+     * Minimum number of time slots a user must register for. If not set, users do
+     * not need to sign up for any time slots
+     *
+     * Type: integer
+     */
+    min_appointments_per_participant: number | string;
+    /**
+     * Maximum number of participants that may register for each time slot, or
+     * null if no limit
+     *
+     * Type: integer
+     */
+    participants_per_appointment: number | string;
+    /**
+     * 'private' means participants cannot see who has signed up for a particular
+     * time slot, 'protected' means that they can
+     */
+    participant_visibility: string;
+    /**
+     * Indicates how participants sign up for the appointment group, either as
+     * individuals ('User') or in student groups ('Group'). Related to
+     * sub_context_codes (i.e. 'Group' signups always have a single group
+     * category)
+     */
+    participant_type: string;
+    /** URL for this appointment group (to update, delete, etc.) */
+    url: string;
+    /** URL for a user to view this appointment group */
+    html_url: string;
+    /**
+     * When the appointment group was created
+     *
+     * Format: date-time
+     */
+    created_at: string;
+    /**
+     * When the appointment group was last updated
+     *
+     * Format: date-time
+     */
+    updated_at: string;
+};

package/dist/Resources/AppointmentGroups.js

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

package/dist/Resources/AssignmentExtensions.d.ts

@@ -0,0 +1,26 @@
+export type AssignmentExtension = {
+    /**
+     * The ID of the Assignment the extension belongs to.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    assignment_id: number | string;
+    /**
+     * The ID of the Student that needs the assignment extension.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    user_id: number | string;
+    /**
+     * Number of times the student is allowed to re-submit the assignment
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    extra_attempts: number | string;
+};

package/dist/Resources/AssignmentExtensions.js

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

package/dist/Resources/AssignmentGroups.d.ts

@@ -0,0 +1,54 @@
+import { JSONObject } from '@battis/typescript-tricks';
+export type GradingRules = {
+    /**
+     * Number of lowest scores to be dropped for each user.
+     *
+     * Type: integer
+     */
+    drop_lowest: number | string;
+    /**
+     * Number of highest scores to be dropped for each user.
+     *
+     * Type: integer
+     */
+    drop_highest: number | string;
+    /** Assignment IDs that should never be dropped. */
+    never_drop: number | string[];
+};
+export type AssignmentGroup = {
+    /**
+     * The id of the Assignment Group
+     *
+     * Type: integer
+     */
+    id: number | string;
+    /** The name of the Assignment Group */
+    name: string;
+    /**
+     * The position of the Assignment Group
+     *
+     * Type: integer
+     */
+    position: number | string;
+    /**
+     * The weight of the Assignment Group
+     *
+     * Type: integer
+     */
+    group_weight: number | string;
+    /** The sis source id of the Assignment Group */
+    sis_source_id: string;
+    /**
+     * The integration data of the Assignment Group
+     *
+     * Object
+     */
+    integration_data: JSONObject;
+    /**
+     * The assignments in this Assignment Group (see the Assignment API for a
+     * detailed list of fields)
+     */
+    assignments: number | string[];
+    /** The grading rules that this Assignment Group has */
+    rules: GradingRules;
+};

package/dist/Resources/AssignmentGroups.js

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