lms-graphql-api 1.9.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lms_graphql/mutations/canvas/add_multiple_allowed_domains_to_account.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/add_users_to_content_share.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/create_content_share.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/create_instaccess_token.rb +22 -0
- data/lib/lms_graphql/mutations/canvas/create_jwt.rb +5 -3
- data/lib/lms_graphql/mutations/canvas/create_user_login.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/create_webhook_subscription.rb +1 -1
- data/lib/lms_graphql/mutations/canvas/delete_eportfolio.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/edit_user.rb +4 -2
- data/lib/lms_graphql/mutations/canvas/edit_user_login.rb +6 -2
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_courses_assignments.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_courses_submissions.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_sections_assignments.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_multiple_submissions_sections_submissions.rb +3 -3
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_submission_by_anonymous_id_courses.rb +51 -0
- data/lib/lms_graphql/mutations/canvas/grade_or_comment_on_submission_by_anonymous_id_sections.rb +51 -0
- data/lib/lms_graphql/mutations/canvas/mark_document_annotations_as_read_courses.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_document_annotations_as_read_sections.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_rubric_comments_as_read_courses.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/mark_rubric_comments_as_read_sections.rb +28 -0
- data/lib/lms_graphql/mutations/canvas/moderate_all_eportfolios_for_user.rb +27 -0
- data/lib/lms_graphql/mutations/canvas/moderate_eportfolio.rb +27 -0
- data/lib/lms_graphql/mutations/canvas/mutations.rb +19 -8
- data/lib/lms_graphql/mutations/canvas/restore_deleted_eportfolio.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/terminate_all_user_sessions.rb +24 -0
- data/lib/lms_graphql/mutations/canvas/update_associated_courses.rb +2 -2
- data/lib/lms_graphql/mutations/canvas/update_course.rb +8 -2
- data/lib/lms_graphql/mutations/canvas/update_course_settings.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/get_all_eportfolios_for_user.rb +25 -0
- data/lib/lms_graphql/resolvers/canvas/get_bulk_user_progress.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_custom_colors.rb +1 -1
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_completed.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_current.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_department_level_statistics_broken_down_by_subaccount_terms.rb +24 -0
- data/lib/lms_graphql/resolvers/canvas/get_document_annotations_read_state_courses.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_document_annotations_read_state_sections.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_eportfolio.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_eportfolio_pages.rb +23 -0
- data/lib/lms_graphql/resolvers/canvas/get_manually_created_courses_sub_account_for_domain_root_account.rb +22 -0
- data/lib/lms_graphql/resolvers/canvas/get_rubric_comments_read_state_courses.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_rubric_comments_read_state_sections.rb +26 -0
- data/lib/lms_graphql/resolvers/canvas/get_single_submission_by_anonymous_id_courses.rb +28 -0
- data/lib/lms_graphql/resolvers/canvas/get_single_submission_by_anonymous_id_sections.rb +28 -0
- data/lib/lms_graphql/resolvers/canvas/list_announcements.rb +1 -1
- data/lib/lms_graphql/resolvers/canvas/list_missing_submissions.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/list_planner_items_planner.rb +3 -1
- data/lib/lms_graphql/resolvers/canvas/list_planner_items_users.rb +3 -1
- data/lib/lms_graphql/types/canvas/account_notification_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/appointment_group_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/assignment.rb +1 -0
- data/lib/lms_graphql/types/canvas/assignment_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/assignment_input.rb +5 -4
- data/lib/lms_graphql/types/canvas/authentication_event_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/change_record.rb +1 -1
- data/lib/lms_graphql/types/canvas/change_record_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/collaborator_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/comm_message_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/communication_channel_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/completion_requirement_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_export_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/content_migration_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/content_share.rb +1 -1
- data/lib/lms_graphql/types/canvas/content_share_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/course_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/discussion_topic.rb +1 -1
- data/lib/lms_graphql/types/canvas/discussion_topic_input.rb +7 -7
- data/lib/lms_graphql/types/canvas/e_portfolio.rb +24 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_input.rb +24 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_page.rb +20 -0
- data/lib/lms_graphql/types/canvas/e_portfolio_page_input.rb +20 -0
- data/lib/lms_graphql/types/canvas/epub_export_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/exception_record.rb +1 -1
- data/lib/lms_graphql/types/canvas/exception_record_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/external_feed_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/favorite_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/feature.rb +1 -1
- data/lib/lms_graphql/types/canvas/feature_flag_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/feature_input.rb +3 -3
- data/lib/lms_graphql/types/canvas/group_category_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/group_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/group_membership_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/inst_access_token.rb +14 -0
- data/lib/lms_graphql/types/canvas/inst_access_token_input.rb +14 -0
- data/lib/lms_graphql/types/canvas/migration_issue_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_input.rb +4 -4
- data/lib/lms_graphql/types/canvas/module_item_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/notification_preference_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/outcome_import.rb +2 -1
- data/lib/lms_graphql/types/canvas/outcome_import_input.rb +4 -3
- data/lib/lms_graphql/types/canvas/outcome_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/proficiency.rb +1 -1
- data/lib/lms_graphql/types/canvas/proficiency_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/progress_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/query_type.rb +107 -51
- data/lib/lms_graphql/types/canvas/quiz_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/quiz_report_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/report_parameter_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/rubric_assessment.rb +1 -1
- data/lib/lms_graphql/types/canvas/rubric_assessment_input.rb +1 -1
- data/lib/lms_graphql/types/canvas/sis_assignment_input.rb +2 -2
- data/lib/lms_graphql/types/canvas/sis_import.rb +3 -3
- data/lib/lms_graphql/types/canvas/sis_import_input.rb +5 -5
- data/lib/lms_graphql/types/canvas/submission_input.rb +6 -6
- data/lib/lms_graphql/types/canvas/user.rb +2 -0
- data/lib/lms_graphql/types/canvas/user_input.rb +2 -0
- data/lib/lms_graphql/types/canvas_forward_declarations.rb +20 -16
- data/lib/lms_graphql/types/date_time_type.rb +4 -0
- data/lib/lms_graphql/version.rb +1 -1
- metadata +38 -6
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasExternalFeedInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class ExternalFeedInputVerbosityEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "link_only"
|
10
10
|
value "truncate"
|
11
11
|
value "full"
|
@@ -16,7 +16,7 @@ module LMSGraphQL
|
|
16
16
|
argument :url, String, "The HTTP/HTTPS URL to the feed.Example: http://example.com/myblog.rss", required: false
|
17
17
|
argument :header_match, String, "If not null, only feed entries whose title contains this string will trigger new posts in Canvas.Example: pattern", required: false
|
18
18
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "When this external feed was added to Canvas.Example: 2012-06-01T00:00:00-06:00", required: false
|
19
|
-
argument :verbosity,
|
19
|
+
argument :verbosity, ExternalFeedInputVerbosityEnum, "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..Example: truncate", required: false
|
20
20
|
|
21
21
|
end
|
22
22
|
end
|
@@ -5,12 +5,12 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasFavoriteInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class FavoriteInputContextTypeEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "Course"
|
10
10
|
end
|
11
11
|
description "Favorites. API Docs: https://canvas.instructure.com/doc/api/favorites.html"
|
12
12
|
argument :context_id, ID, "The ID of the object the Favorite refers to.Example: 1170", required: false
|
13
|
-
argument :context_type,
|
13
|
+
argument :context_type, FavoriteInputContextTypeEnum, "The type of the object the Favorite refers to (currently, only 'Course' is supported).Example: Course", required: false
|
14
14
|
|
15
15
|
end
|
16
16
|
end
|
@@ -23,8 +23,8 @@ module LMSGraphQL
|
|
23
23
|
field :feature_flag, LMSGraphQL::Types::Canvas::CanvasFeatureFlag, "The FeatureFlag that applies to the caller.Example: fancy_wickets, allowed", null: true
|
24
24
|
field :root_opt_in, Boolean, "If true, a feature that is 'allowed' globally will be 'off' by default in root accounts. Otherwise, root accounts inherit the global 'allowed' setting, which allows sub-accounts and courses to turn features on with no root account action..Example: true", null: true
|
25
25
|
field :beta, Boolean, "Whether the feature is a beta feature. If true, the feature may not be fully polished and may be subject to change in the future..Example: true", null: true
|
26
|
+
field :pending_enforcement, Boolean, "Whether the feature is nearing completion and will be finalized at an upcoming date..Example: true", null: true
|
26
27
|
field :autoexpand, Boolean, "Whether the details of the feature are autoexpanded on page load vs. the user clicking to expand..Example: true", null: true
|
27
|
-
field :development, Boolean, "Whether the feature is in active development. Features in this state are only visible in test and beta instances and are not yet available for production use..", null: true
|
28
28
|
field :release_notes_url, String, "A URL to the release notes describing the feature.Example: http://canvas.example.com/release_notes#fancy_wickets", null: true
|
29
29
|
|
30
30
|
end
|
@@ -5,23 +5,23 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasFeatureFlagInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class FeatureFlagInputContextTypeEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "Course"
|
10
10
|
value "Account"
|
11
11
|
value "User"
|
12
12
|
end
|
13
13
|
|
14
|
-
class
|
14
|
+
class FeatureFlagInputStateEnum < ::GraphQL::Schema::Enum
|
15
15
|
value "off"
|
16
16
|
value "allowed"
|
17
17
|
value "allowed_on"
|
18
18
|
value "on"
|
19
19
|
end
|
20
20
|
description "Feature Flags. API Docs: https://canvas.instructure.com/doc/api/feature_flags.html"
|
21
|
-
argument :context_type,
|
21
|
+
argument :context_type, FeatureFlagInputContextTypeEnum, "The type of object to which this flag applies (Account, Course, or User). (This field is not present if this FeatureFlag represents the global Canvas default).Example: Account", required: false
|
22
22
|
argument :context_id, ID, "The id of the object to which this flag applies (This field is not present if this FeatureFlag represents the global Canvas default).Example: 1038", required: false
|
23
23
|
argument :feature, String, "The feature this flag controls.Example: fancy_wickets", required: false
|
24
|
-
argument :state,
|
24
|
+
argument :state, FeatureFlagInputStateEnum, "The policy for the feature at this context. can be 'off', 'allowed', 'allowed_on', or 'on'..Example: allowed", required: false
|
25
25
|
argument :locked, Boolean, "If set, this feature flag cannot be changed in the caller's context because the flag is set 'off' or 'on' in a higher context.", required: false
|
26
26
|
|
27
27
|
end
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasFeatureInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class FeatureInputAppliesToEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "Course"
|
10
10
|
value "RootAccount"
|
11
11
|
value "Account"
|
@@ -14,7 +14,7 @@ module LMSGraphQL
|
|
14
14
|
description "Feature Flags. API Docs: https://canvas.instructure.com/doc/api/feature_flags.html"
|
15
15
|
argument :feature, String, "The symbolic name of the feature, used in FeatureFlags.Example: fancy_wickets", required: false
|
16
16
|
argument :display_name, String, "The user-visible name of the feature.Example: Fancy Wickets", required: false
|
17
|
-
argument :applies_to,
|
17
|
+
argument :applies_to, FeatureInputAppliesToEnum, "The type of object the feature applies to (RootAccount, Account, Course, or User):
|
18
18
|
* RootAccount features may only be controlled by flags on root accounts.
|
19
19
|
* Account features may be controlled by flags on accounts and their parent accounts.
|
20
20
|
* Course features may be controlled by flags on courses and their parent accounts.
|
@@ -23,8 +23,8 @@ module LMSGraphQL
|
|
23
23
|
argument :feature_flag, LMSGraphQL::Types::Canvas::CanvasFeatureFlagInput, "The FeatureFlag that applies to the caller.Example: fancy_wickets, allowed", required: false
|
24
24
|
argument :root_opt_in, Boolean, "If true, a feature that is 'allowed' globally will be 'off' by default in root accounts. Otherwise, root accounts inherit the global 'allowed' setting, which allows sub-accounts and courses to turn features on with no root account action..Example: true", required: false
|
25
25
|
argument :beta, Boolean, "Whether the feature is a beta feature. If true, the feature may not be fully polished and may be subject to change in the future..Example: true", required: false
|
26
|
+
argument :pending_enforcement, Boolean, "Whether the feature is nearing completion and will be finalized at an upcoming date..Example: true", required: false
|
26
27
|
argument :autoexpand, Boolean, "Whether the details of the feature are autoexpanded on page load vs. the user clicking to expand..Example: true", required: false
|
27
|
-
argument :development, Boolean, "Whether the feature is in active development. Features in this state are only visible in test and beta instances and are not yet available for production use..", required: false
|
28
28
|
argument :release_notes_url, String, "A URL to the release notes describing the feature.Example: http://canvas.example.com/release_notes#fancy_wickets", required: false
|
29
29
|
|
30
30
|
end
|
@@ -5,12 +5,12 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasGroupCategoryInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class GroupCategoryInputSelfSignupEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "restricted"
|
10
10
|
value "enabled"
|
11
11
|
end
|
12
12
|
|
13
|
-
class
|
13
|
+
class GroupCategoryInputAutoLeaderEnum < ::GraphQL::Schema::Enum
|
14
14
|
value "first"
|
15
15
|
value "random"
|
16
16
|
end
|
@@ -18,8 +18,8 @@ module LMSGraphQL
|
|
18
18
|
argument :id, ID, "The ID of the group category..Example: 17", required: false
|
19
19
|
argument :name, String, "The display name of the group category..Example: Math Groups", required: false
|
20
20
|
argument :role, String, "Certain types of group categories have special role designations. Currently, these include: 'communities', 'student_organized', and 'imported'. Regular course/account group categories have a role of null..Example: communities", required: false
|
21
|
-
argument :self_signup,
|
22
|
-
argument :auto_leader,
|
21
|
+
argument :self_signup, GroupCategoryInputSelfSignupEnum, "If the group category allows users to join a group themselves, thought they may only be a member of one group per group category at a time. Values include 'restricted', 'enabled', and null 'enabled' allows students to assign themselves to a group 'restricted' restricts them to only joining a group in their section null disallows students from joining groups.", required: false
|
22
|
+
argument :auto_leader, GroupCategoryInputAutoLeaderEnum, "Gives instructors the ability to automatically have group leaders assigned. Values include 'random', 'first', and null; 'random' picks a student from the group at random as the leader, 'first' sets the first student to be assigned to the group as the leader.", required: false
|
23
23
|
argument :context_type, String, "The course or account that the category group belongs to. The pattern here is that whatever the context_type is, there will be an _id field named after that type. So if instead context_type was 'Course', the course_id field would be replaced by an course_id field..Example: Account", required: false
|
24
24
|
argument :account_id, ID, "Example: 3", required: false
|
25
25
|
argument :group_limit, Int, "If self-signup is enabled, group_limit can be set to cap the number of users in each group. If null, there is no limit..", required: false
|
@@ -5,13 +5,13 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasGroupInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class GroupInputJoinLevelEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "parent_context_auto_join"
|
10
10
|
value "parent_context_request"
|
11
11
|
value "invitation_only"
|
12
12
|
end
|
13
13
|
|
14
|
-
class
|
14
|
+
class GroupInputRoleEnum < ::GraphQL::Schema::Enum
|
15
15
|
value "communities"
|
16
16
|
value "student_organized"
|
17
17
|
value "imported"
|
@@ -22,12 +22,12 @@ module LMSGraphQL
|
|
22
22
|
argument :description, String, "A description of the group. This is plain text..", required: false
|
23
23
|
argument :is_public, Boolean, "Whether or not the group is public. Currently only community groups can be made public. Also, once a group has been set to public, it cannot be changed back to private..", required: false
|
24
24
|
argument :followed_by_user, Boolean, "Whether or not the current user is following this group..", required: false
|
25
|
-
argument :join_level,
|
25
|
+
argument :join_level, GroupInputJoinLevelEnum, "How people are allowed to join the group. For all groups except for community groups, the user must share the group's parent course or account. For student organized or community groups, where a user can be a member of as many or few as they want, the applicable levels are 'parent_context_auto_join', 'parent_context_request', and 'invitation_only'. For class groups, where students are divided up and should only be part of one group of the category, this value will always be 'invitation_only', and is not relevant. * If 'parent_context_auto_join', anyone can join and will be automatically accepted. * If 'parent_context_request', anyone can request to join, which must be approved by a group moderator. * If 'invitation_only', only those how have received an invitation my join the group, by accepting that invitation..Example: invitation_only", required: false
|
26
26
|
argument :members_count, Int, "The number of members currently in the group.Example: 0", required: false
|
27
27
|
argument :avatar_url, String, "The url of the group's avatar.Example: https://<canvas>/files/avatar_image.png", required: false
|
28
28
|
argument :context_type, String, "The course or account that the group belongs to. The pattern here is that whatever the context_type is, there will be an _id field named after that type. So if instead context_type was 'account', the course_id field would be replaced by an account_id field..Example: Course", required: false
|
29
29
|
argument :course_id, ID, "Example: 3", required: false
|
30
|
-
argument :role,
|
30
|
+
argument :role, GroupInputRoleEnum, "Certain types of groups have special role designations. Currently, these include: 'communities', 'student_organized', and 'imported'. Regular course/account groups have a role of null..", required: false
|
31
31
|
argument :group_category_id, ID, "The ID of the group's category..Example: 4", required: false
|
32
32
|
argument :sis_group_id, ID, "The SIS ID of the group. Only included if the user has permission to view SIS information..Example: group4a", required: false
|
33
33
|
argument :sis_import_id, ID, "The id of the SIS import if created through SIS. Only included if the user has permission to manage SIS information..Example: 14", required: false
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasGroupMembershipInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class GroupMembershipInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "accepted"
|
10
10
|
value "invited"
|
11
11
|
value "requested"
|
@@ -14,7 +14,7 @@ module LMSGraphQL
|
|
14
14
|
argument :id, ID, "The id of the membership object.Example: 92", required: false
|
15
15
|
argument :group_id, ID, "The id of the group object to which the membership belongs.Example: 17", required: false
|
16
16
|
argument :user_id, ID, "The id of the user object to which the membership belongs.Example: 3", required: false
|
17
|
-
argument :workflow_state,
|
17
|
+
argument :workflow_state, GroupMembershipInputWorkflowStateEnum, "The current state of the membership. Current possible values are 'accepted', 'invited', and 'requested'.Example: accepted", required: false
|
18
18
|
argument :moderator, Boolean, "Whether or not the user is a moderator of the group (the must also be an active member of the group to moderate).Example: true", required: false
|
19
19
|
argument :just_created, Boolean, "optional: whether or not the record was just created on a create call (POST), i.e. was the user just added to the group, or was the user already a member.Example: true", required: false
|
20
20
|
argument :sis_import_id, ID, "The id of the SIS import if created through SIS. Only included if the user has permission to manage SIS information..Example: 4", required: false
|
@@ -0,0 +1,14 @@
|
|
1
|
+
require_relative "../canvas_base_type"
|
2
|
+
|
3
|
+
|
4
|
+
module LMSGraphQL
|
5
|
+
module Types
|
6
|
+
module Canvas
|
7
|
+
class CanvasInstAccessToken < BaseType
|
8
|
+
description "InstAccess tokens. API Docs: https://canvas.instructure.com/doc/api/inst_access_tokens.html"
|
9
|
+
field :token, String, "The InstAccess token itself -- a signed, encrypted JWT.Example: eyJhbGciOiJSU0ExXzUiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.EstatUwzltksvZn4wbjHYiwleM986vzryrv4R9jqvYDGEY4rt6KPG4Q6lJ3oI0piYbH7h17i8vIWv35cqrgRbb7fzmGQ0Ptj74OEjx-1gGBMZCbZTE4W206XxPHRm9TS4qOAvIq0hsvJroE4xZsVWJFiUIKl_Wd2udbvqwF8bvnMKPAx_ooa-9mWaG1N9kd4EWC3Oxu9wi7j8ZG_TbkLSXAg1KxLaO2zXBcU5_HWrKFRxOjHmWpaOMKWkjUInt-DA6fLRszBZp9BFGoop8S9KDs6f1JebLgyM5gGrP-Gz7kSEAPO9eVXtjpd6N29wMClNI0X-Ppp_40Fp4Z3vocTKQ.c_tcevWI68RuZ0s04fDSEQ.wV8KIPHGfYwxm19MWt3K7VVGm4qqZJruPwAZ8rdUANTzJoqwafqOnYZLCyky8lV7J-m64SMVUmR-BOha_CmJEKVVw7T5x70MTP6-nv4RMVPpcViHsNgE2f1GE9HUauVePw7CrnV0PyVaNq2EZasDgdHdye4iG_-hXXQZRnGYzxl8UceTLBVkpEYHlXKdD7DyQ0IT2BYOcZSpXyW7kEIvAHpNaNbvTPCR2t0SeGbuNf8PpYVjohKDpXhNgQ-Pyl9pxs05TrdjTq1fIctzTLqIN58nfqzoqQld6rSkjcAZZXgr8bOsg8EDFMov5gTv2_Uf-YOm52yD1SbL0lJ-VdpKgXu7XtQ4UmEOj40W4uXF-KmLTjEwQmdbmtKrruhakIeth7EZa3w0Xg6RRyHLqKUheAdTgxAIer8MST8tamZlqW1b9wjMw371zSSjeksF_UjTS9p9i7eTtRPuAbf9geDhKb5e-y29MJaL1eKkhTMiEOPY3O4XGGuqRdRMrbjkNmla_RxiQhFJ3T8Dem-yDRan8gqaJLfRRrvGViz-lty96bQT-Z0hVer1uJhAtkM6RT_DgrnAUP_66LfaupZr6bLCKwnYocF1ICcAzkcYw7l5jHa4DTc2ZLgLi-yfbv2wGXpybAvLfZcO424TxHOuQykCSvbfPPuf06kkjPbYmMg6_GdM3JcQ_50VUXQFZkjH45BH5zX7y-2u0ReM8zxt65RpJAvlivrc8j2_E-u0LhlzCwEgsnd61lG4baaI86IVl4wNXkMDui4CgGvAUAf4AXW7Imw_cF0zI69z0SLfahjaYkdREGIYKStBtPAR04sfsR7o.LHBODYub4W4Vq-SXfdbk1Q", null: true
|
10
|
+
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
require_relative "../canvas_base_input_type"
|
2
|
+
|
3
|
+
|
4
|
+
module LMSGraphQL
|
5
|
+
module Types
|
6
|
+
module Canvas
|
7
|
+
class CanvasInstAccessTokenInput < BaseInputObject
|
8
|
+
description "InstAccess tokens. API Docs: https://canvas.instructure.com/doc/api/inst_access_tokens.html"
|
9
|
+
argument :token, String, "The InstAccess token itself -- a signed, encrypted JWT.Example: eyJhbGciOiJSU0ExXzUiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.EstatUwzltksvZn4wbjHYiwleM986vzryrv4R9jqvYDGEY4rt6KPG4Q6lJ3oI0piYbH7h17i8vIWv35cqrgRbb7fzmGQ0Ptj74OEjx-1gGBMZCbZTE4W206XxPHRm9TS4qOAvIq0hsvJroE4xZsVWJFiUIKl_Wd2udbvqwF8bvnMKPAx_ooa-9mWaG1N9kd4EWC3Oxu9wi7j8ZG_TbkLSXAg1KxLaO2zXBcU5_HWrKFRxOjHmWpaOMKWkjUInt-DA6fLRszBZp9BFGoop8S9KDs6f1JebLgyM5gGrP-Gz7kSEAPO9eVXtjpd6N29wMClNI0X-Ppp_40Fp4Z3vocTKQ.c_tcevWI68RuZ0s04fDSEQ.wV8KIPHGfYwxm19MWt3K7VVGm4qqZJruPwAZ8rdUANTzJoqwafqOnYZLCyky8lV7J-m64SMVUmR-BOha_CmJEKVVw7T5x70MTP6-nv4RMVPpcViHsNgE2f1GE9HUauVePw7CrnV0PyVaNq2EZasDgdHdye4iG_-hXXQZRnGYzxl8UceTLBVkpEYHlXKdD7DyQ0IT2BYOcZSpXyW7kEIvAHpNaNbvTPCR2t0SeGbuNf8PpYVjohKDpXhNgQ-Pyl9pxs05TrdjTq1fIctzTLqIN58nfqzoqQld6rSkjcAZZXgr8bOsg8EDFMov5gTv2_Uf-YOm52yD1SbL0lJ-VdpKgXu7XtQ4UmEOj40W4uXF-KmLTjEwQmdbmtKrruhakIeth7EZa3w0Xg6RRyHLqKUheAdTgxAIer8MST8tamZlqW1b9wjMw371zSSjeksF_UjTS9p9i7eTtRPuAbf9geDhKb5e-y29MJaL1eKkhTMiEOPY3O4XGGuqRdRMrbjkNmla_RxiQhFJ3T8Dem-yDRan8gqaJLfRRrvGViz-lty96bQT-Z0hVer1uJhAtkM6RT_DgrnAUP_66LfaupZr6bLCKwnYocF1ICcAzkcYw7l5jHa4DTc2ZLgLi-yfbv2wGXpybAvLfZcO424TxHOuQykCSvbfPPuf06kkjPbYmMg6_GdM3JcQ_50VUXQFZkjH45BH5zX7y-2u0ReM8zxt65RpJAvlivrc8j2_E-u0LhlzCwEgsnd61lG4baaI86IVl4wNXkMDui4CgGvAUAf4AXW7Imw_cF0zI69z0SLfahjaYkdREGIYKStBtPAR04sfsR7o.LHBODYub4W4Vq-SXfdbk1Q", required: false
|
10
|
+
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -5,12 +5,12 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasMigrationIssueInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class MigrationIssueInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "active"
|
10
10
|
value "resolved"
|
11
11
|
end
|
12
12
|
|
13
|
-
class
|
13
|
+
class MigrationIssueInputIssueTypeEnum < ::GraphQL::Schema::Enum
|
14
14
|
value "todo"
|
15
15
|
value "warning"
|
16
16
|
value "error"
|
@@ -19,9 +19,9 @@ module LMSGraphQL
|
|
19
19
|
argument :id, ID, "the unique identifier for the issue.Example: 370663", required: false
|
20
20
|
argument :content_migration_url, String, "API url to the content migration.Example: https://example.com/api/v1/courses/1/content_migrations/1", required: false
|
21
21
|
argument :description, String, "Description of the issue for the end-user.Example: Questions in this quiz couldn't be converted", required: false
|
22
|
-
argument :workflow_state,
|
22
|
+
argument :workflow_state, MigrationIssueInputWorkflowStateEnum, "Current state of the issue: active, resolved.Example: active", required: false
|
23
23
|
argument :fix_issue_html_url, String, "HTML Url to the Canvas page to investigate the issue.Example: https://example.com/courses/1/quizzes/2", required: false
|
24
|
-
argument :issue_type,
|
24
|
+
argument :issue_type, MigrationIssueInputIssueTypeEnum, "Severity of the issue: todo, warning, error.Example: warning", required: false
|
25
25
|
argument :error_report_html_url, String, "Link to a Canvas error report if present (If the requesting user has permissions).Example: https://example.com/error_reports/3", required: false
|
26
26
|
argument :error_message, String, "Site administrator error message (If the requesting user has permissions).Example: admin only message", required: false
|
27
27
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "timestamp.Example: 2012-06-01T00:00:00-06:00", required: false
|
@@ -5,12 +5,12 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasModuleInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class ModuleInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "active"
|
10
10
|
value "deleted"
|
11
11
|
end
|
12
12
|
|
13
|
-
class
|
13
|
+
class ModuleInputStateEnum < ::GraphQL::Schema::Enum
|
14
14
|
value "locked"
|
15
15
|
value "unlocked"
|
16
16
|
value "started"
|
@@ -18,7 +18,7 @@ module LMSGraphQL
|
|
18
18
|
end
|
19
19
|
description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
|
20
20
|
argument :id, ID, "the unique identifier for the module.Example: 123", required: false
|
21
|
-
argument :workflow_state,
|
21
|
+
argument :workflow_state, ModuleInputWorkflowStateEnum, "the state of the module: 'active', 'deleted'.Example: active", required: false
|
22
22
|
argument :position, Int, "the position of this module in the course (1-based).Example: 2", required: false
|
23
23
|
argument :name, String, "the name of this module.Example: Imaginary Numbers and You", required: false
|
24
24
|
argument :unlock_at, LMSGraphQL::Types::DateTimeType, "(Optional) the date this module will unlock.Example: 2012-12-31T06:00:00-06:00", required: false
|
@@ -27,7 +27,7 @@ module LMSGraphQL
|
|
27
27
|
argument :items_count, Int, "The number of items in the module.Example: 10", required: false
|
28
28
|
argument :items_url, String, "The API URL to retrive this module's items.Example: https://canvas.example.com/api/v1/modules/123/items", required: false
|
29
29
|
argument :items, [LMSGraphQL::Types::Canvas::CanvasModuleItemInput], "The contents of this module, as an array of Module Items. (Present only if requested via include[]=items AND the module is not deemed too large by Canvas.).", required: false
|
30
|
-
argument :state,
|
30
|
+
argument :state, ModuleInputStateEnum, "The state of this Module for the calling user one of 'locked', 'unlocked', 'started', 'completed' (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).Example: started", required: false
|
31
31
|
argument :completed_at, LMSGraphQL::Types::DateTimeType, "the date the calling user completed the module (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).", required: false
|
32
32
|
argument :publish_final_grade, Boolean, "if the student's final grade for the course should be published to the SIS upon completion of this module.", required: false
|
33
33
|
argument :published, Boolean, "(Optional) Whether this module is published. This field is present only if the caller has permission to view unpublished modules..Example: true", required: false
|
@@ -6,7 +6,7 @@ module LMSGraphQL
|
|
6
6
|
module Types
|
7
7
|
module Canvas
|
8
8
|
class CanvasModuleItemInput < BaseInputObject
|
9
|
-
class
|
9
|
+
class ModuleItemInputTypeEnum < ::GraphQL::Schema::Enum
|
10
10
|
value "File"
|
11
11
|
value "Page"
|
12
12
|
value "Discussion"
|
@@ -22,7 +22,7 @@ module LMSGraphQL
|
|
22
22
|
argument :position, Int, "the position of this item in the module (1-based).Example: 1", required: false
|
23
23
|
argument :title, String, "the title of this item.Example: Square Roots: Irrational numbers or boxy vegetables?", required: false
|
24
24
|
argument :indent, Int, "0-based indent level; module items may be indented to show a hierarchy.Example: 0", required: false
|
25
|
-
argument :type,
|
25
|
+
argument :type, ModuleItemInputTypeEnum, "the type of object referred to one of 'File', 'Page', 'Discussion', 'Assignment', 'Quiz', 'SubHeader', 'ExternalUrl', 'ExternalTool'.Example: Assignment", required: false
|
26
26
|
argument :content_id, ID, "the id of the object referred to applies to 'File', 'Discussion', 'Assignment', 'Quiz', 'ExternalTool' types.Example: 1337", required: false
|
27
27
|
argument :html_url, String, "link to the item in Canvas.Example: https://canvas.example.edu/courses/222/modules/items/768", required: false
|
28
28
|
argument :url, String, "(Optional) link to the Canvas API object, if applicable.Example: https://canvas.example.edu/api/v1/courses/222/assignments/987", required: false
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasNotificationPreferenceInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class NotificationPreferenceInputFrequencyEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "immediately"
|
10
10
|
value "daily"
|
11
11
|
value "weekly"
|
@@ -15,7 +15,7 @@ module LMSGraphQL
|
|
15
15
|
argument :href, String, "Example: https://canvas.instructure.com/users/1/communication_channels/email/student@example.edu/notification_preferences/new_announcement", required: false
|
16
16
|
argument :notification, String, "The notification this preference belongs to.Example: new_announcement", required: false
|
17
17
|
argument :category, String, "The category of that notification.Example: announcement", required: false
|
18
|
-
argument :frequency,
|
18
|
+
argument :frequency, NotificationPreferenceInputFrequencyEnum, "How often to send notifications to this communication channel for the given notification. Possible values are 'immediately', 'daily', 'weekly', and 'never'.Example: daily", required: false
|
19
19
|
|
20
20
|
end
|
21
21
|
end
|
@@ -14,6 +14,7 @@ module LMSGraphQL
|
|
14
14
|
end
|
15
15
|
description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
|
16
16
|
field :id, ID, "The unique identifier for the outcome import..Example: 1", null: true
|
17
|
+
field :learning_outcome_group_id, ID, "The unique identifier for the group into which the outcomes will be imported to, or NULL..Example: 1", null: true
|
17
18
|
field :created_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was created..Example: 2013-12-01T23:59:00-06:00", null: true
|
18
19
|
field :ended_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", null: true
|
19
20
|
field :updated_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was last updated..Example: 2013-12-02T00:03:21-06:00", null: true
|
@@ -25,7 +26,7 @@ module LMSGraphQL
|
|
25
26
|
field :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatum, "See the OutcomeImportData specification above..", null: true
|
26
27
|
field :progress, String, "The progress of the outcome import..Example: 100", null: true
|
27
28
|
field :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user that initiated the outcome_import. See the Users API for details..", null: true
|
28
|
-
field :processing_errors, String, "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", null: true
|
29
|
+
field :processing_errors, [String], "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", null: true
|
29
30
|
|
30
31
|
end
|
31
32
|
end
|
@@ -6,7 +6,7 @@ module LMSGraphQL
|
|
6
6
|
module Types
|
7
7
|
module Canvas
|
8
8
|
class CanvasOutcomeImportInput < BaseInputObject
|
9
|
-
class
|
9
|
+
class OutcomeImportInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
10
10
|
value "created"
|
11
11
|
value "importing"
|
12
12
|
value "succeeded"
|
@@ -14,10 +14,11 @@ module LMSGraphQL
|
|
14
14
|
end
|
15
15
|
description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
|
16
16
|
argument :id, ID, "The unique identifier for the outcome import..Example: 1", required: false
|
17
|
+
argument :learning_outcome_group_id, ID, "The unique identifier for the group into which the outcomes will be imported to, or NULL..Example: 1", required: false
|
17
18
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was created..Example: 2013-12-01T23:59:00-06:00", required: false
|
18
19
|
argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", required: false
|
19
20
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "The date the outcome import was last updated..Example: 2013-12-02T00:03:21-06:00", required: false
|
20
|
-
argument :workflow_state,
|
21
|
+
argument :workflow_state, OutcomeImportInputWorkflowStateEnum, "The current state of the outcome import.
|
21
22
|
- 'created': The outcome import has been created.
|
22
23
|
- 'importing': The outcome import is currently processing.
|
23
24
|
- 'succeeded': The outcome import has completed successfully.
|
@@ -25,7 +26,7 @@ module LMSGraphQL
|
|
25
26
|
argument :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatumInput, "See the OutcomeImportData specification above..", required: false
|
26
27
|
argument :progress, String, "The progress of the outcome import..Example: 100", required: false
|
27
28
|
argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the outcome_import. See the Users API for details..", required: false
|
28
|
-
argument :processing_errors, String, "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", required: false
|
29
|
+
argument :processing_errors, [String], "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", required: false
|
29
30
|
|
30
31
|
end
|
31
32
|
end
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasOutcomeInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class OutcomeInputCalculationMethodEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "decaying_average"
|
10
10
|
value "n_mastery"
|
11
11
|
value "latest"
|
@@ -22,7 +22,7 @@ module LMSGraphQL
|
|
22
22
|
argument :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", required: false
|
23
23
|
argument :points_possible, Int, "maximum points possible. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 5", required: false
|
24
24
|
argument :mastery_points, Int, "points necessary to demonstrate mastery outcomes. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 3", required: false
|
25
|
-
argument :calculation_method,
|
25
|
+
argument :calculation_method, OutcomeInputCalculationMethodEnum, "the method used to calculate a students score.Example: decaying_average", required: false
|
26
26
|
argument :calculation_int, Int, "this defines the variable value used by the calculation_method. included only if calculation_method uses it.Example: 65", required: false
|
27
27
|
argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRatingInput], "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..", required: false
|
28
28
|
argument :can_edit, Boolean, "whether the current user can update the outcome.Example: true", required: false
|
@@ -6,7 +6,7 @@ module LMSGraphQL
|
|
6
6
|
module Canvas
|
7
7
|
class CanvasProficiency < BaseType
|
8
8
|
description "Proficiency Ratings. API Docs: https://canvas.instructure.com/doc/api/proficiency_ratings.html"
|
9
|
-
field :ratings, String, "An array of proficiency ratings. See the ProficiencyRating specification above..", null: true
|
9
|
+
field :ratings, [String], "An array of proficiency ratings. See the ProficiencyRating specification above..", null: true
|
10
10
|
|
11
11
|
end
|
12
12
|
end
|
@@ -6,7 +6,7 @@ module LMSGraphQL
|
|
6
6
|
module Canvas
|
7
7
|
class CanvasProficiencyInput < BaseInputObject
|
8
8
|
description "Proficiency Ratings. API Docs: https://canvas.instructure.com/doc/api/proficiency_ratings.html"
|
9
|
-
argument :ratings, String, "An array of proficiency ratings. See the ProficiencyRating specification above..", required: false
|
9
|
+
argument :ratings, [String], "An array of proficiency ratings. See the ProficiencyRating specification above..", required: false
|
10
10
|
|
11
11
|
end
|
12
12
|
end
|
@@ -5,7 +5,7 @@ module LMSGraphQL
|
|
5
5
|
module Types
|
6
6
|
module Canvas
|
7
7
|
class CanvasProgressInput < BaseInputObject
|
8
|
-
class
|
8
|
+
class ProgressInputWorkflowStateEnum < ::GraphQL::Schema::Enum
|
9
9
|
value "queued"
|
10
10
|
value "running"
|
11
11
|
value "completed"
|
@@ -18,7 +18,7 @@ module LMSGraphQL
|
|
18
18
|
argument :user_id, ID, "the id of the user who started the job.Example: 123", required: false
|
19
19
|
argument :tag, String, "the type of operation.Example: course_batch_update", required: false
|
20
20
|
argument :completion, Int, "percent completed.Example: 100", required: false
|
21
|
-
argument :workflow_state,
|
21
|
+
argument :workflow_state, ProgressInputWorkflowStateEnum, "the state of the job one of 'queued', 'running', 'completed', 'failed'.Example: completed", required: false
|
22
22
|
argument :created_at, LMSGraphQL::Types::DateTimeType, "the time the job was created.Example: 2013-01-15T15:00:00Z", required: false
|
23
23
|
argument :updated_at, LMSGraphQL::Types::DateTimeType, "the time the job was last updated.Example: 2013-01-15T15:04:00Z", required: false
|
24
24
|
argument :message, String, "optional details about the job.Example: 17 courses processed", required: false
|