lms-graphql-api 0.7.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (96) hide show
  1. checksums.yaml +4 -4
  2. data/lib/lms_graphql/canvas.rb +1 -0
  3. data/lib/lms_graphql/mutations/canvas/add_domain_to_account_whitelist.rb +22 -0
  4. data/lib/lms_graphql/mutations/canvas/create_assignment.rb +4 -2
  5. data/lib/lms_graphql/mutations/canvas/create_conversation.rb +3 -1
  6. data/lib/lms_graphql/mutations/canvas/create_planner_override.rb +3 -3
  7. data/lib/lms_graphql/mutations/canvas/edit_assignment.rb +4 -2
  8. data/lib/lms_graphql/mutations/canvas/enable_disable_or_clear_explicit_csp_setting_accounts.rb +22 -0
  9. data/lib/lms_graphql/mutations/canvas/enable_disable_or_clear_explicit_csp_setting_courses.rb +22 -0
  10. data/lib/lms_graphql/mutations/canvas/mutations.rb +6 -1
  11. data/lib/lms_graphql/mutations/canvas/remove_domain_from_account_whitelist.rb +22 -0
  12. data/lib/lms_graphql/mutations/canvas/set_extensions_for_student_assignment_submissions.rb +26 -0
  13. data/lib/lms_graphql/mutations/canvas/update_planner_note.rb +28 -0
  14. data/lib/lms_graphql/resolvers/canvas/get_current_settings_for_account_or_course_accounts.rb +20 -0
  15. data/lib/lms_graphql/resolvers/canvas/get_current_settings_for_account_or_course_courses.rb +20 -0
  16. data/lib/lms_graphql/resolvers/canvas/get_single_course_accounts.rb +4 -2
  17. data/lib/lms_graphql/resolvers/canvas/get_single_course_courses.rb +4 -2
  18. data/lib/lms_graphql/resolvers/canvas/get_sis_import_error_list_sis_import_errors.rb +4 -2
  19. data/lib/lms_graphql/resolvers/canvas/get_sis_import_error_list_sis_imports.rb +4 -2
  20. data/lib/lms_graphql/resolvers/canvas/get_sis_import_list.rb +4 -2
  21. data/lib/lms_graphql/resolvers/canvas/list_activity_stream_activity_stream.rb +3 -3
  22. data/lib/lms_graphql/resolvers/canvas/list_activity_stream_self.rb +3 -3
  23. data/lib/lms_graphql/resolvers/canvas/show_planner_note.rb +20 -0
  24. data/lib/lms_graphql/types/canvas/admin_input.rb +1 -1
  25. data/lib/lms_graphql/types/canvas/appointment_group_input.rb +3 -3
  26. data/lib/lms_graphql/types/canvas/assignment.rb +1 -0
  27. data/lib/lms_graphql/types/canvas/assignment_event_input.rb +2 -2
  28. data/lib/lms_graphql/types/canvas/assignment_extension.rb +16 -0
  29. data/lib/lms_graphql/types/canvas/assignment_extension_input.rb +16 -0
  30. data/lib/lms_graphql/types/canvas/assignment_group_input.rb +1 -1
  31. data/lib/lms_graphql/types/canvas/assignment_input.rb +10 -9
  32. data/lib/lms_graphql/types/canvas/authentication_provider_input.rb +1 -1
  33. data/lib/lms_graphql/types/canvas/conference_input.rb +1 -1
  34. data/lib/lms_graphql/types/canvas/content_detail_input.rb +1 -1
  35. data/lib/lms_graphql/types/canvas/content_export_input.rb +1 -1
  36. data/lib/lms_graphql/types/canvas/conversation_input.rb +1 -1
  37. data/lib/lms_graphql/types/canvas/course_epub_export_input.rb +1 -1
  38. data/lib/lms_graphql/types/canvas/course_event_input.rb +1 -1
  39. data/lib/lms_graphql/types/canvas/course_input.rb +4 -4
  40. data/lib/lms_graphql/types/canvas/discussion_topic_input.rb +2 -2
  41. data/lib/lms_graphql/types/canvas/enrollment.rb +12 -8
  42. data/lib/lms_graphql/types/canvas/enrollment_input.rb +14 -10
  43. data/lib/lms_graphql/types/canvas/epub_export_input.rb +1 -1
  44. data/lib/lms_graphql/types/canvas/feature_input.rb +1 -1
  45. data/lib/lms_graphql/types/canvas/grade_change_event_input.rb +1 -1
  46. data/lib/lms_graphql/types/canvas/grading_standard_input.rb +1 -1
  47. data/lib/lms_graphql/types/canvas/group_category_input.rb +1 -1
  48. data/lib/lms_graphql/types/canvas/help_link_input.rb +2 -2
  49. data/lib/lms_graphql/types/canvas/module_input.rb +1 -1
  50. data/lib/lms_graphql/types/canvas/module_item_input.rb +2 -2
  51. data/lib/lms_graphql/types/canvas/module_item_sequence_input.rb +2 -2
  52. data/lib/lms_graphql/types/canvas/module_item_sequence_node_input.rb +3 -3
  53. data/lib/lms_graphql/types/canvas/outcome_group_input.rb +1 -1
  54. data/lib/lms_graphql/types/canvas/outcome_import_input.rb +2 -2
  55. data/lib/lms_graphql/types/canvas/outcome_input.rb +1 -1
  56. data/lib/lms_graphql/types/canvas/outcome_link_input.rb +2 -2
  57. data/lib/lms_graphql/types/canvas/outcome_path_input.rb +1 -1
  58. data/lib/lms_graphql/types/canvas/outcome_rollup_input.rb +2 -2
  59. data/lib/lms_graphql/types/canvas/outcome_rollup_score_input.rb +1 -1
  60. data/lib/lms_graphql/types/canvas/page_input.rb +2 -2
  61. data/lib/lms_graphql/types/canvas/page_revision_input.rb +1 -1
  62. data/lib/lms_graphql/types/canvas/page_view_input.rb +1 -1
  63. data/lib/lms_graphql/types/canvas/poll_session_input.rb +1 -1
  64. data/lib/lms_graphql/types/canvas/profile_input.rb +1 -1
  65. data/lib/lms_graphql/types/canvas/query_type.rb +12 -4
  66. data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_container_input.rb +1 -1
  67. data/lib/lms_graphql/types/canvas/quiz_assignment_override_set_input.rb +2 -2
  68. data/lib/lms_graphql/types/canvas/quiz_input.rb +3 -3
  69. data/lib/lms_graphql/types/canvas/quiz_question_input.rb +1 -1
  70. data/lib/lms_graphql/types/canvas/quiz_report_input.rb +2 -2
  71. data/lib/lms_graphql/types/canvas/quiz_statistic_input.rb +3 -3
  72. data/lib/lms_graphql/types/canvas/quiz_statistics_question_statistic_input.rb +1 -1
  73. data/lib/lms_graphql/types/canvas/report_input.rb +2 -2
  74. data/lib/lms_graphql/types/canvas/result_input.rb +1 -1
  75. data/lib/lms_graphql/types/canvas/role_input.rb +1 -1
  76. data/lib/lms_graphql/types/canvas/rubric_criterium_input.rb +1 -1
  77. data/lib/lms_graphql/types/canvas/rubric_input.rb +1 -1
  78. data/lib/lms_graphql/types/canvas/section_attribute_input.rb +3 -3
  79. data/lib/lms_graphql/types/canvas/sis_assignment_input.rb +3 -3
  80. data/lib/lms_graphql/types/canvas/sis_import.rb +12 -2
  81. data/lib/lms_graphql/types/canvas/sis_import_datum_input.rb +1 -1
  82. data/lib/lms_graphql/types/canvas/sis_import_error.rb +1 -0
  83. data/lib/lms_graphql/types/canvas/sis_import_error_input.rb +1 -0
  84. data/lib/lms_graphql/types/canvas/sis_import_input.rb +15 -5
  85. data/lib/lms_graphql/types/canvas/sis_import_statistic.rb +39 -0
  86. data/lib/lms_graphql/types/canvas/sis_import_statistic_input.rb +39 -0
  87. data/lib/lms_graphql/types/canvas/submission.rb +1 -0
  88. data/lib/lms_graphql/types/canvas/submission_comment_input.rb +1 -1
  89. data/lib/lms_graphql/types/canvas/submission_history_input.rb +1 -1
  90. data/lib/lms_graphql/types/canvas/submission_input.rb +2 -1
  91. data/lib/lms_graphql/types/canvas/user_assignment_override_attribute_input.rb +1 -1
  92. data/lib/lms_graphql/types/canvas/user_input.rb +1 -1
  93. data/lib/lms_graphql/types/canvas_forward_declarations.rb +375 -16
  94. data/lib/lms_graphql/types/canvas_hacks.rb +15 -0
  95. data/lib/lms_graphql/version.rb +1 -1
  96. metadata +16 -2
@@ -7,8 +7,8 @@ module LMSGraphQL
7
7
  module Canvas
8
8
  class CanvasModuleItemSequenceInput < BaseInputObject
9
9
  description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
10
- argument :items, [LMSGraphQL::Types::Canvas::CanvasModuleItemSequenceNode], "an array containing one ModuleItemSequenceNode for each appearence of the asset in the module sequence (up to 10 total).Example: {'prev'=>nil, 'current'=>{'id'=>768, 'module_id'=>123, 'title'=>'A lonely page', 'type'=>'Page'}, 'next'=>{'id'=>769, 'module_id'=>127, 'title'=>'Project 1', 'type'=>'Assignment'}, 'mastery_path'=>{'locked'=>true, 'assignment_sets'=>[], 'selected_set_id'=>nil, 'awaiting_choice'=>false, 'still_processing'=>false, 'modules_url'=>'/courses/11/modules', 'choose_url'=>'/courses/11/modules/items/9/choose', 'modules_tab_disabled'=>false}}", required: false
11
- argument :modules, [LMSGraphQL::Types::Canvas::CanvasModule], "an array containing each Module referenced above.Example: {'id'=>123, 'name'=>'Overview'}, {'id'=>127, 'name'=>'Imaginary Numbers'}", required: false
10
+ argument :items, [LMSGraphQL::Types::Canvas::CanvasModuleItemSequenceNodeInput], "an array containing one ModuleItemSequenceNode for each appearence of the asset in the module sequence (up to 10 total).Example: {'prev'=>nil, 'current'=>{'id'=>768, 'module_id'=>123, 'title'=>'A lonely page', 'type'=>'Page'}, 'next'=>{'id'=>769, 'module_id'=>127, 'title'=>'Project 1', 'type'=>'Assignment'}, 'mastery_path'=>{'locked'=>true, 'assignment_sets'=>[], 'selected_set_id'=>nil, 'awaiting_choice'=>false, 'still_processing'=>false, 'modules_url'=>'/courses/11/modules', 'choose_url'=>'/courses/11/modules/items/9/choose', 'modules_tab_disabled'=>false}}", required: false
11
+ argument :modules, [LMSGraphQL::Types::Canvas::CanvasModuleInput], "an array containing each Module referenced above.Example: {'id'=>123, 'name'=>'Overview'}, {'id'=>127, 'name'=>'Imaginary Numbers'}", required: false
12
12
 
13
13
  end
14
14
  end
@@ -8,9 +8,9 @@ module LMSGraphQL
8
8
  module Canvas
9
9
  class CanvasModuleItemSequenceNodeInput < BaseInputObject
10
10
  description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
11
- argument :prev, LMSGraphQL::Types::Canvas::CanvasModuleItem, "The previous ModuleItem in the sequence.", required: false
12
- argument :current, LMSGraphQL::Types::Canvas::CanvasModuleItem, "The ModuleItem being queried.Example: 768, 123, A lonely page, Page", required: false
13
- argument :next, LMSGraphQL::Types::Canvas::CanvasModuleItem, "The next ModuleItem in the sequence.Example: 769, 127, Project 1, Assignment", required: false
11
+ argument :prev, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The previous ModuleItem in the sequence.", required: false
12
+ argument :current, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The ModuleItem being queried.Example: 768, 123, A lonely page, Page", required: false
13
+ argument :next, LMSGraphQL::Types::Canvas::CanvasModuleItemInput, "The next ModuleItem in the sequence.Example: 769, 127, Project 1, Assignment", required: false
14
14
  argument :mastery_path, String, "The conditional release rule for the module item, if applicable.Example: true, , , false, false, /courses/11/modules, /courses/11/modules/items/9/choose, false", required: false
15
15
 
16
16
  end
@@ -8,7 +8,7 @@ module LMSGraphQL
8
8
  description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
9
9
  argument :id, ID, "the ID of the outcome group.Example: 1", required: false
10
10
  argument :url, String, "the URL for fetching/updating the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1", required: false
11
- argument :parent_outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroup, "an abbreviated OutcomeGroup object representing the parent group of this outcome group, if any. omitted in the abbreviated form..", required: false
11
+ argument :parent_outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroupInput, "an abbreviated OutcomeGroup object representing the parent group of this outcome group, if any. omitted in the abbreviated form..", required: false
12
12
  argument :context_id, ID, "the context owning the outcome group. may be null for global outcome groups. omitted in the abbreviated form..Example: 1", required: false
13
13
  argument :context_type, String, "Example: Account", required: false
14
14
  argument :title, String, "title of the outcome group.Example: Outcome group title", required: false
@@ -22,9 +22,9 @@ module LMSGraphQL
22
22
  - 'importing': The outcome import is currently processing.
23
23
  - 'succeeded': The outcome import has completed successfully.
24
24
  - 'failed': The outcome import failed..Example: imported", required: false
25
- argument :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatum, "See the OutcomeImportData specification above..", required: false
25
+ argument :data, LMSGraphQL::Types::Canvas::CanvasOutcomeImportDatumInput, "See the OutcomeImportData specification above..", required: false
26
26
  argument :progress, String, "The progress of the outcome import..Example: 100", required: false
27
- argument :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user that initiated the outcome_import. See the Users API for details..", required: false
27
+ argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user that initiated the outcome_import. See the Users API for details..", required: false
28
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
29
 
30
30
  end
@@ -24,7 +24,7 @@ module LMSGraphQL
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
25
  argument :calculation_method, OutcomeCalculationMethodEnum, "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
- argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRating], "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..", required: false
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
29
29
  argument :can_unlink, Boolean, "whether the outcome can be unlinked.Example: true", required: false
30
30
  argument :assessed, Boolean, "whether this outcome has been used to assess a student.Example: true", required: false
@@ -10,8 +10,8 @@ module LMSGraphQL
10
10
  argument :url, String, "the URL for fetching/updating the outcome link. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes/1", required: false
11
11
  argument :context_id, ID, "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..Example: 1", required: false
12
12
  argument :context_type, String, "Example: Account", required: false
13
- argument :outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroup, "an abbreviated OutcomeGroup object representing the group containing the outcome link..", required: false
14
- argument :outcome, LMSGraphQL::Types::Canvas::CanvasOutcome, "an abbreviated Outcome object representing the outcome linked into the containing outcome group..", required: false
13
+ argument :outcome_group, LMSGraphQL::Types::Canvas::CanvasOutcomeGroupInput, "an abbreviated OutcomeGroup object representing the group containing the outcome link..", required: false
14
+ argument :outcome, LMSGraphQL::Types::Canvas::CanvasOutcomeInput, "an abbreviated Outcome object representing the outcome linked into the containing outcome group..", required: false
15
15
  argument :assessed, Boolean, "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..Example: true", required: false
16
16
  argument :can_unlink, Boolean, "whether this outcome link is manageable and is not the last link to an aligned outcome.", required: false
17
17
 
@@ -7,7 +7,7 @@ module LMSGraphQL
7
7
  class CanvasOutcomePathInput < BaseInputObject
8
8
  description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
9
9
  argument :id, ID, "A unique identifier for this outcome.Example: 42", required: false
10
- argument :parts, LMSGraphQL::Types::Canvas::CanvasOutcomePathPart, "an array of OutcomePathPart objects.", required: false
10
+ argument :parts, LMSGraphQL::Types::Canvas::CanvasOutcomePathPartInput, "an array of OutcomePathPart objects.", required: false
11
11
 
12
12
  end
13
13
  end
@@ -7,9 +7,9 @@ module LMSGraphQL
7
7
  module Canvas
8
8
  class CanvasOutcomeRollupInput < BaseInputObject
9
9
  description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
10
- argument :scores, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScore, "an array of OutcomeRollupScore objects.", required: false
10
+ argument :scores, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScoreInput, "an array of OutcomeRollupScore objects.", required: false
11
11
  argument :name, String, "The name of the resource for this rollup. For example, the user name..Example: John Doe", required: false
12
- argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupLink, "Example: 42, 42, 57", required: false
12
+ argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupLinkInput, "Example: 42, 42, 57", required: false
13
13
 
14
14
  end
15
15
  end
@@ -8,7 +8,7 @@ module LMSGraphQL
8
8
  description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
9
9
  argument :score, Int, "The rollup score for the outcome, based on the student alignment scores related to the outcome. This could be null if the student has no related scores..Example: 3", required: false
10
10
  argument :count, Int, "The number of alignment scores included in this rollup..Example: 6", required: false
11
- argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScoreLink, "Example: 42", required: false
11
+ argument :links, LMSGraphQL::Types::Canvas::CanvasOutcomeRollupScoreLinkInput, "Example: 42", required: false
12
12
 
13
13
  end
14
14
  end
@@ -13,12 +13,12 @@ module LMSGraphQL
13
13
  argument :updated_at, LMSGraphQL::Types::DateTimeType, "the date the page was last updated.Example: 2012-08-08T14:25:20-06:00", required: false
14
14
  argument :hide_from_students, Boolean, "(DEPRECATED) whether this page is hidden from students (note: this is always reflected as the inverse of the published value).", required: false
15
15
  argument :editing_roles, String, "roles allowed to edit the page; comma-separated list comprising a combination of 'teachers', 'students', 'members', and/or 'public' if not supplied, course defaults are used.Example: teachers,students", required: false
16
- argument :last_edited_by, LMSGraphQL::Types::Canvas::CanvasUser, "the User who last edited the page (this may not be present if the page was imported from another system).", required: false
16
+ argument :last_edited_by, LMSGraphQL::Types::Canvas::CanvasUserInput, "the User who last edited the page (this may not be present if the page was imported from another system).", required: false
17
17
  argument :body, String, "the page content, in HTML (present when requesting a single page; omitted when listing pages).Example: <p>Page Content</p>", required: false
18
18
  argument :published, Boolean, "whether the page is published (true) or draft state (false)..Example: true", required: false
19
19
  argument :front_page, Boolean, "whether this page is the front page for the wiki.", required: false
20
20
  argument :locked_for_user, Boolean, "Whether or not this is locked for the user..", required: false
21
- argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfo, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
21
+ argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
22
22
  argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This page is locked until September 1 at 12:00am", required: false
23
23
 
24
24
  end
@@ -9,7 +9,7 @@ module LMSGraphQL
9
9
  argument :revision_id, ID, "an identifier for this revision of the page.Example: 7", required: false
10
10
  argument :updated_at, LMSGraphQL::Types::DateTimeType, "the time when this revision was saved.Example: 2012-08-07T11:23:58-06:00", required: false
11
11
  argument :latest, Boolean, "whether this is the latest revision or not.Example: true", required: false
12
- argument :edited_by, LMSGraphQL::Types::Canvas::CanvasUser, "the User who saved this revision, if applicable (this may not be present if the page was imported from another system).", required: false
12
+ argument :edited_by, LMSGraphQL::Types::Canvas::CanvasUserInput, "the User who saved this revision, if applicable (this may not be present if the page was imported from another system).", required: false
13
13
  argument :url, String, "the following fields are not included in the index action and may be omitted from the show action via summary=1 the historic url of the page.Example: old-page-title", required: false
14
14
  argument :title, String, "the historic page title.Example: Old Page Title", required: false
15
15
  argument :body, String, "the historic page contents.Example: <p>Old Page Content</p>", required: false
@@ -22,7 +22,7 @@ module LMSGraphQL
22
22
  argument :participated, Boolean, "True if the request counted as participating, such as submitting homework.Example: false", required: false
23
23
  argument :http_method, String, "The HTTP method such as GET or POST.Example: GET", required: false
24
24
  argument :remote_ip, String, "The origin IP address of the request.Example: 173.194.46.71", required: false
25
- argument :links, LMSGraphQL::Types::Canvas::CanvasPageViewLink, "The page view links to define the relationships.Example: 1234, 1234", required: false
25
+ argument :links, LMSGraphQL::Types::Canvas::CanvasPageViewLinkInput, "The page view links to define the relationships.Example: 1234, 1234", required: false
26
26
 
27
27
  end
28
28
  end
@@ -14,7 +14,7 @@ module LMSGraphQL
14
14
  argument :has_public_results, Boolean, "Specifies whether the results are viewable by students..Example: true", required: false
15
15
  argument :created_at, String, "The time at which the poll session was created..Example: 2014-01-07T15:16:18Z", required: false
16
16
  argument :results, String, "The results of the submissions of the poll. Each key is the poll choice id, and the value is the count of submissions..Example: 10, 3, 27, 8", required: false
17
- argument :poll_submissions, LMSGraphQL::Types::Canvas::CanvasPollSubmission, "If the poll session has public results, this will return an array of all submissions, viewable by both students and teachers. If the results are not public, for students it will return their submission only..", required: false
17
+ argument :poll_submissions, LMSGraphQL::Types::Canvas::CanvasPollSubmissionInput, "If the poll session has public results, this will return an array of all submissions, viewable by both students and teachers. If the results are not public, for students it will return their submission only..", required: false
18
18
 
19
19
  end
20
20
  end
@@ -17,7 +17,7 @@ module LMSGraphQL
17
17
  argument :sis_user_id, ID, "sis1.Example: sis1", required: false
18
18
  argument :lti_user_id, ID, "", required: false
19
19
  argument :avatar_url, String, "The avatar_url can change over time, so we recommend not caching it for more than a few hours.Example: url", required: false
20
- argument :calendar, LMSGraphQL::Types::Canvas::CanvasCalendarLink, "", required: false
20
+ argument :calendar, LMSGraphQL::Types::Canvas::CanvasCalendarLinkInput, "", required: false
21
21
  argument :time_zone, String, "Optional: This field is only returned in certain API calls, and will return the IANA time zone name of the user's preferred timezone..Example: America/Denver", required: false
22
22
  argument :locale, String, "The users locale..", required: false
23
23
 
@@ -439,6 +439,14 @@ module LMSGraphQL
439
439
  resolver: LMSGraphQL::Resolvers::Canvas::ListMigrationSystemsUser,
440
440
  description: "List Migration Systems. Lists the currently available migration types. These values may change."
441
441
 
442
+ field :get_current_settings_for_account_or_course_courses,
443
+ resolver: LMSGraphQL::Resolvers::Canvas::GetCurrentSettingsForAccountOrCourseCourse,
444
+ description: "Get current settings for account or course. Update multiple modules in an account."
445
+
446
+ field :get_current_settings_for_account_or_course_accounts,
447
+ resolver: LMSGraphQL::Resolvers::Canvas::GetCurrentSettingsForAccountOrCourseAccount,
448
+ description: "Get current settings for account or course. Update multiple modules in an account."
449
+
442
450
  field :list_conversations,
443
451
  resolver: LMSGraphQL::Resolvers::Canvas::ListConversation,
444
452
  description: "List conversations. Returns the paginated list of conversations for the current user, most recent ones first."
@@ -1169,15 +1177,15 @@ module LMSGraphQL
1169
1177
 
1170
1178
  field :list_planner_items,
1171
1179
  resolver: LMSGraphQL::Resolvers::Canvas::ListPlannerItem,
1172
- description: "List planner items. Retrieve the paginated list of objects to be shown on the planner for the current user with the associated planner override to override an item's visibility if set. [ { 'context_type': 'Course', 'course_id': 1, 'visible_in_planner': true, Whether or not it is displayed on the student planner 'planner_override': { ... planner override object ... }, Associated PlannerOverride object if user has toggled visibility for the object on the planner 'submissions': false, The statuses of the user's submissions for this object 'plannable_id': '123', 'plannable_type': 'discussion_topic', 'plannable': { ... discussion topic object }, 'html_url': '/courses/1/discussion_topics/8' }, { 'context_type': 'Course', 'course_id': 1, 'visible_in_planner': true, 'planner_override': { 'id': 3, 'plannable_type': 'Assignment', 'plannable_id': 1, 'user_id': 2, 'workflow_state': 'active', 'marked_complete': true, A user-defined setting for marking items complete in the planner 'dismissed': false, A user-defined setting for hiding items from the opportunities list 'deleted_at': null, 'created_at': '2017-05-18T18:35:55Z', 'updated_at': '2017-05-18T18:35:55Z' }, 'submissions': { The status as it pertains to the current user 'excused': false, 'graded': false, 'late': false, 'missing': true, 'needs_grading': false, 'with_feedback': false }, 'plannable_id': '456', 'plannable_type': 'assignment', 'plannable': { ... assignment object ... }, 'html_url': 'http: canvas.instructure.com/courses/1/assignments/1#submit' }, { 'visible_in_planner': true, 'planner_override': null, 'submissions': false, false if no associated assignment exists for the plannable item 'plannable_id': '789', 'plannable_type': 'planner_note', 'plannable': { 'id': 1, 'todo_date': '2017-05-30T06:00:00Z', 'title': 'hello', 'details': 'world', 'user_id': 2, 'course_id': null, 'workflow_state': 'active', 'created_at': '2017-05-30T16:29:04Z', 'updated_at': '2017-05-30T16:29:15Z' }, 'html_url': 'http: canvas.instructure.com/api/v1/planner_notes.1' } ]"
1180
+ description: "List planner items. Retrieve the paginated list of objects to be shown on the planner for the current user with the associated planner override to override an item's visibility if set. [ { 'context_type': 'Course', 'course_id': 1, 'planner_override': { ... planner override object ... }, Associated PlannerOverride object if user has toggled visibility for the object on the planner 'submissions': false, The statuses of the user's submissions for this object 'plannable_id': '123', 'plannable_type': 'discussion_topic', 'plannable': { ... discussion topic object }, 'html_url': '/courses/1/discussion_topics/8' }, { 'context_type': 'Course', 'course_id': 1, 'planner_override': { 'id': 3, 'plannable_type': 'Assignment', 'plannable_id': 1, 'user_id': 2, 'workflow_state': 'active', 'marked_complete': true, A user-defined setting for marking items complete in the planner 'dismissed': false, A user-defined setting for hiding items from the opportunities list 'deleted_at': null, 'created_at': '2017-05-18T18:35:55Z', 'updated_at': '2017-05-18T18:35:55Z' }, 'submissions': { The status as it pertains to the current user 'excused': false, 'graded': false, 'late': false, 'missing': true, 'needs_grading': false, 'with_feedback': false }, 'plannable_id': '456', 'plannable_type': 'assignment', 'plannable': { ... assignment object ... }, 'html_url': 'http: canvas.instructure.com/courses/1/assignments/1#submit' }, { 'planner_override': null, 'submissions': false, false if no associated assignment exists for the plannable item 'plannable_id': '789', 'plannable_type': 'planner_note', 'plannable': { 'id': 1, 'todo_date': '2017-05-30T06:00:00Z', 'title': 'hello', 'details': 'world', 'user_id': 2, 'course_id': null, 'workflow_state': 'active', 'created_at': '2017-05-30T16:29:04Z', 'updated_at': '2017-05-30T16:29:15Z' }, 'html_url': 'http: canvas.instructure.com/api/v1/planner_notes.1' } ]"
1173
1181
 
1174
1182
  field :list_planner_notes,
1175
1183
  resolver: LMSGraphQL::Resolvers::Canvas::ListPlannerNote,
1176
1184
  description: "List planner notes. Retrieve the paginated list of planner notes Retrieve planner note for a user"
1177
1185
 
1178
- field :show_plannernote,
1179
- resolver: LMSGraphQL::Resolvers::Canvas::ShowPlannernote,
1180
- description: "Show a PlannerNote. Retrieve a planner note for the current user"
1186
+ field :show_planner_note,
1187
+ resolver: LMSGraphQL::Resolvers::Canvas::ShowPlannerNote,
1188
+ description: "Show a planner note. Retrieve a planner note for the current user"
1181
1189
 
1182
1190
  field :list_planner_overrides,
1183
1191
  resolver: LMSGraphQL::Resolvers::Canvas::ListPlannerOverride,
@@ -6,7 +6,7 @@ module LMSGraphQL
6
6
  module Canvas
7
7
  class CanvasQuizAssignmentOverrideSetContainerInput < BaseInputObject
8
8
  description "Quiz Assignment Overrides. API Docs: https://canvas.instructure.com/doc/api/quiz_assignment_overrides.html"
9
- argument :quiz_assignment_overrides, [LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideSet], "The QuizAssignmentOverrideSet.", required: false
9
+ argument :quiz_assignment_overrides, [LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideSetInput], "The QuizAssignmentOverrideSet.", required: false
10
10
 
11
11
  end
12
12
  end
@@ -8,8 +8,8 @@ module LMSGraphQL
8
8
  class CanvasQuizAssignmentOverrideSetInput < BaseInputObject
9
9
  description "Quiz Assignment Overrides. API Docs: https://canvas.instructure.com/doc/api/quiz_assignment_overrides.html"
10
10
  argument :quiz_id, ID, "ID of the quiz those dates are for..Example: 1", required: false
11
- argument :due_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverride, "An array of quiz assignment overrides. For students, this array will always contain a single item which is the set of dates that apply to that student. For teachers and staff, it may contain more..", required: false
12
- argument :all_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverride, "An array of all assignment overrides active for the quiz. This is visible only to teachers and staff..", required: false
11
+ argument :due_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideInput, "An array of quiz assignment overrides. For students, this array will always contain a single item which is the set of dates that apply to that student. For teachers and staff, it may contain more..", required: false
12
+ argument :all_dates, LMSGraphQL::Types::Canvas::CanvasQuizAssignmentOverrideInput, "An array of all assignment overrides active for the quiz. This is visible only to teachers and staff..", required: false
13
13
 
14
14
  end
15
15
  end
@@ -54,12 +54,12 @@ module LMSGraphQL
54
54
  argument :published, Boolean, "whether the quiz has a published or unpublished draft state..Example: true", required: false
55
55
  argument :unpublishable, Boolean, "Whether the assignment's 'published' state can be changed to false. Will be false if there are student submissions for the quiz..Example: true", required: false
56
56
  argument :locked_for_user, Boolean, "Whether or not this is locked for the user..", required: false
57
- argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfo, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
57
+ argument :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfoInput, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", required: false
58
58
  argument :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This quiz is locked until September 1 at 12:00am", required: false
59
59
  argument :speedgrader_url, String, "Link to Speed Grader for this quiz. Will not be present if quiz is unpublished.Example: http://canvas.instructure.com/courses/1/speed_grader?assignment_id=1", required: false
60
60
  argument :quiz_extensions_url, String, "Link to endpoint to send extensions for this quiz..Example: http://canvas.instructure.com/courses/1/quizzes/2/quiz_extensions", required: false
61
- argument :permissions, LMSGraphQL::Types::Canvas::CanvasQuizPermission, "Permissions the user has for the quiz.", required: false
62
- argument :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDate], "list of due dates for the quiz.", required: false
61
+ argument :permissions, LMSGraphQL::Types::Canvas::CanvasQuizPermissionInput, "Permissions the user has for the quiz.", required: false
62
+ argument :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDateInput], "list of due dates for the quiz.", required: false
63
63
  argument :version_number, Int, "Current version number of the quiz.Example: 3", required: false
64
64
  argument :question_types, String, "List of question types in the quiz.Example: multiple_choice, essay", required: false
65
65
  argument :anonymous_submissions, Boolean, "Whether survey submissions will be kept anonymous (only applicable to 'graded_survey', 'survey' quiz types).", required: false
@@ -16,7 +16,7 @@ module LMSGraphQL
16
16
  argument :correct_comments, String, "The comments to display if the student answers the question correctly..Example: That's correct!", required: false
17
17
  argument :incorrect_comments, String, "The comments to display if the student answers incorrectly..Example: Unfortunately, that IS a prime number.", required: false
18
18
  argument :neutral_comments, String, "The comments to display regardless of how the student answered..Example: Goldbach's conjecture proposes that every even integer greater than 2 can be expressed as the sum of two prime numbers.", required: false
19
- argument :answers, [LMSGraphQL::Types::Canvas::CanvasAnswer], "An array of available answers to display to the student..", required: false
19
+ argument :answers, [LMSGraphQL::Types::Canvas::CanvasAnswerInput], "An array of available answers to display to the student..", required: false
20
20
 
21
21
  end
22
22
  end
@@ -21,9 +21,9 @@ module LMSGraphQL
21
21
  argument :created_at, LMSGraphQL::Types::DateTimeType, "when the report was created.Example: 2013-05-01T12:34:56-07:00", required: false
22
22
  argument :updated_at, LMSGraphQL::Types::DateTimeType, "when the report was last updated.Example: 2013-05-01T12:34:56-07:00", required: false
23
23
  argument :url, String, "the API endpoint for this report.Example: http://canvas.example.com/api/v1/courses/1/quizzes/1/reports/1", required: false
24
- argument :file, LMSGraphQL::Types::Canvas::CanvasFile, "if the report has finished generating, a File object that represents it. refer to the Files API for more information about the format.", required: false
24
+ argument :file, LMSGraphQL::Types::Canvas::CanvasFileInput, "if the report has finished generating, a File object that represents it. refer to the Files API for more information about the format.", required: false
25
25
  argument :progress_url, String, "if the report has not yet finished generating, a URL where information about its progress can be retrieved. refer to the Progress API for more information (Note: not available in JSON-API format).", required: false
26
- argument :progress, LMSGraphQL::Types::Canvas::CanvasProgress, "if the report is being generated, a Progress object that represents the operation. Refer to the Progress API for more information about the format. (Note: available only in JSON-API format).", required: false
26
+ argument :progress, LMSGraphQL::Types::Canvas::CanvasProgressInput, "if the report is being generated, a Progress object that represents the operation. Refer to the Progress API for more information about the format. (Note: available only in JSON-API format).", required: false
27
27
 
28
28
  end
29
29
  end
@@ -16,9 +16,9 @@ NOTE: AVAILABLE ONLY IN NON-JSON-API REQUESTS..Example: 2", required: false
16
16
  argument :generated_at, LMSGraphQL::Types::DateTimeType, "The time at which the statistics were generated, which is usually after the occurrence of a quiz event, like a student submitting it..Example: 2013-01-23T23:59:00-07:00", required: false
17
17
  argument :url, String, "The API HTTP/HTTPS URL to this quiz statistics..Example: http://canvas.example.edu/api/v1/courses/1/quizzes/2/statistics", required: false
18
18
  argument :html_url, String, "The HTTP/HTTPS URL to the page where the statistics can be seen visually..Example: http://canvas.example.edu/courses/1/quizzes/2/statistics", required: false
19
- argument :question_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsQuestionStatistic, "Question-specific statistics for each question and its answers..", required: false
20
- argument :submission_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsSubmissionStatistic, "Question-specific statistics for each question and its answers..", required: false
21
- argument :links, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsLink, "JSON-API construct that contains links to media related to this quiz statistics object.
19
+ argument :question_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsQuestionStatisticInput, "Question-specific statistics for each question and its answers..", required: false
20
+ argument :submission_statistics, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsSubmissionStatisticInput, "Question-specific statistics for each question and its answers..", required: false
21
+ argument :links, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsLinkInput, "JSON-API construct that contains links to media related to this quiz statistics object.
22
22
  NOTE: AVAILABLE ONLY IN JSON-API REQUESTS..", required: false
23
23
 
24
24
  end
@@ -7,7 +7,7 @@ module LMSGraphQL
7
7
  class CanvasQuizStatisticsQuestionStatisticInput < BaseInputObject
8
8
  description "Quiz Statistics. API Docs: https://canvas.instructure.com/doc/api/quiz_statistics.html"
9
9
  argument :responses, Int, "Number of students who have provided an answer to this question. Blank or empty responses are not counted..Example: 3", required: false
10
- argument :answers, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsAnswerStatistic, "Statistics related to each individual pre-defined answer..", required: false
10
+ argument :answers, LMSGraphQL::Types::Canvas::CanvasQuizStatisticsAnswerStatisticInput, "Statistics related to each individual pre-defined answer..", required: false
11
11
 
12
12
  end
13
13
  end
@@ -10,12 +10,12 @@ module LMSGraphQL
10
10
  argument :id, ID, "The unique identifier for the report..Example: 1", required: false
11
11
  argument :report, String, "The type of report..Example: sis_export_csv", required: false
12
12
  argument :file_url, String, "The url to the report download..Example: https://example.com/some/path", required: false
13
- argument :attachment, LMSGraphQL::Types::Canvas::CanvasFile, "The attachment api object of the report. Only available after the report has completed..", required: false
13
+ argument :attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "The attachment api object of the report. Only available after the report has completed..", required: false
14
14
  argument :status, String, "The status of the report.Example: complete", required: false
15
15
  argument :created_at, LMSGraphQL::Types::DateTimeType, "The date and time the report was created..Example: 2013-12-01T23:59:00-06:00", required: false
16
16
  argument :started_at, LMSGraphQL::Types::DateTimeType, "The date and time the report started processing..Example: 2013-12-02T00:03:21-06:00", required: false
17
17
  argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date and time the report finished processing..Example: 2013-12-02T00:03:21-06:00", required: false
18
- argument :parameters, LMSGraphQL::Types::Canvas::CanvasReportParameter, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", required: false
18
+ argument :parameters, LMSGraphQL::Types::Canvas::CanvasReportParameterInput, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", required: false
19
19
  argument :progress, Int, "The progress of the report.Example: 100", required: false
20
20
  argument :current_line, Int, "This is the current line count being written to the report. It updates every 1000 records..Example: 12000", required: false
21
21
 
@@ -9,7 +9,7 @@ module LMSGraphQL
9
9
  argument :id, ID, "A unique identifier for this result.Example: 42", required: false
10
10
  argument :passed, Boolean, "Whether the user passed or not.Example: true", required: false
11
11
  argument :assessed_at, LMSGraphQL::Types::DateTimeType, "When this result was recorded.Example: 2014-05-13T00:01:57-06:00", required: false
12
- argument :links, LMSGraphQL::Types::Canvas::CanvasResultLink, "Unique identifiers of objects associated with this result.Example: 42, 23, 5", required: false
12
+ argument :links, LMSGraphQL::Types::Canvas::CanvasResultLinkInput, "Unique identifiers of objects associated with this result.Example: 42, 23, 5", required: false
13
13
 
14
14
  end
15
15
  end
@@ -9,7 +9,7 @@ module LMSGraphQL
9
9
  argument :label, String, "The label of the role..Example: New Role", required: false
10
10
  argument :role, String, "The label of the role. (Deprecated alias for 'label').Example: New Role", required: false
11
11
  argument :base_role_type, String, "The role type that is being used as a base for this role. For account-level roles, this is 'AccountMembership'. For course-level roles, it is an enrollment type..Example: AccountMembership", required: false
12
- argument :account, LMSGraphQL::Types::Canvas::CanvasAccount, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", required: false
12
+ argument :account, LMSGraphQL::Types::Canvas::CanvasAccountInput, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", required: false
13
13
  argument :workflow_state, String, "The state of the role: 'active', 'inactive', or 'built_in'.Example: active", required: false
14
14
  argument :permissions, String, "A dictionary of permissions keyed by name (see permissions input parameter in the 'Create a role' API)..Example: {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>true, 'readonly'=>true, 'explicit'=>false}, {'enabled'=>false, 'locked'=>true, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>false}", required: false
15
15
 
@@ -13,7 +13,7 @@ module LMSGraphQL
13
13
  argument :description, String, "Example: Criterion 1", required: false
14
14
  argument :long_description, String, "Example: Criterion 1 more details", required: false
15
15
  argument :criterion_use_range, Boolean, "Example: true", required: false
16
- argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRating], "", required: false
16
+ argument :ratings, [LMSGraphQL::Types::Canvas::CanvasRubricRatingInput], "", required: false
17
17
  argument :ignore_for_scoring, Boolean, "Example: true", required: false
18
18
 
19
19
  end
@@ -15,7 +15,7 @@ module LMSGraphQL
15
15
  argument :read_only, Boolean, "Example: true", required: false
16
16
  argument :free_form_criterion_comments, Boolean, "whether or not free-form comments are used.Example: true", required: false
17
17
  argument :hide_score_total, Boolean, "Example: true", required: false
18
- argument :assessments, [LMSGraphQL::Types::Canvas::CanvasRubricAssessment], "If an assessment type is included in the 'include' parameter, includes an array of rubric assessment objects for a given rubric, based on the assessment type requested. If the user does not request an assessment type this key will be absent..", required: false
18
+ argument :assessments, [LMSGraphQL::Types::Canvas::CanvasRubricAssessmentInput], "If an assessment type is included in the 'include' parameter, includes an array of rubric assessment objects for a given rubric, based on the assessment type requested. If the user does not request an assessment type this key will be absent..", required: false
19
19
 
20
20
  end
21
21
  end
@@ -12,9 +12,9 @@ module LMSGraphQL
12
12
  argument :name, String, "The name of the section..Example: Section A", required: false
13
13
  argument :sis_id, ID, "The sis id of the section..Example: s34643", required: false
14
14
  argument :integration_id, ID, "Optional: The integration ID of the section..Example: 3452342345", required: false
15
- argument :origin_course, LMSGraphQL::Types::Canvas::CanvasCourseAttribute, "The course to which the section belongs or the course from which the section was cross-listed.", required: false
16
- argument :xlist_course, LMSGraphQL::Types::Canvas::CanvasCourseAttribute, "Optional: Attributes of the xlist course. Only present when the section has been cross-listed. See Courses API for more details.", required: false
17
- argument :override, LMSGraphQL::Types::Canvas::CanvasSectionAssignmentOverrideAttribute, "Optional: Attributes of the assignment override that apply to the section. See Assignment API for more details.", required: false
15
+ argument :origin_course, LMSGraphQL::Types::Canvas::CanvasCourseAttributeInput, "The course to which the section belongs or the course from which the section was cross-listed.", required: false
16
+ argument :xlist_course, LMSGraphQL::Types::Canvas::CanvasCourseAttributeInput, "Optional: Attributes of the xlist course. Only present when the section has been cross-listed. See Courses API for more details.", required: false
17
+ argument :override, LMSGraphQL::Types::Canvas::CanvasSectionAssignmentOverrideAttributeInput, "Optional: Attributes of the assignment override that apply to the section. See Assignment API for more details.", required: false
18
18
 
19
19
  end
20
20
  end
@@ -32,9 +32,9 @@ module LMSGraphQL
32
32
  argument :integration_id, ID, "Third Party integration id for assignment.Example: 12341234", required: false
33
33
  argument :integration_data, String, "(optional, Third Party integration data for assignment).Example: other_data", required: false
34
34
  argument :include_in_final_grade, Boolean, "If false, the assignment will be omitted from the student's final grade.Example: true", required: false
35
- argument :assignment_group, [LMSGraphQL::Types::Canvas::CanvasAssignmentGroupAttribute], "Includes attributes of a assignment_group for convenience. For more details see Assignments API..", required: false
36
- argument :sections, [LMSGraphQL::Types::Canvas::CanvasSectionAttribute], "Includes attributes of a section for convenience. For more details see Sections API..", required: false
37
- argument :user_overrides, [LMSGraphQL::Types::Canvas::CanvasUserAssignmentOverrideAttribute], "Includes attributes of a user assignment overrides. For more details see Assignments API..", required: false
35
+ argument :assignment_group, [LMSGraphQL::Types::Canvas::CanvasAssignmentGroupAttributeInput], "Includes attributes of a assignment_group for convenience. For more details see Assignments API..", required: false
36
+ argument :sections, [LMSGraphQL::Types::Canvas::CanvasSectionAttributeInput], "Includes attributes of a section for convenience. For more details see Sections API..", required: false
37
+ argument :user_overrides, [LMSGraphQL::Types::Canvas::CanvasUserAssignmentOverrideAttributeInput], "Includes attributes of a user assignment overrides. For more details see Assignments API..", required: false
38
38
 
39
39
  end
40
40
  end
@@ -1,5 +1,6 @@
1
1
  require_relative "../canvas_base_type"
2
2
  require_relative "sis_import_datum"
3
+ require_relative "sis_import_statistic"
3
4
  require_relative "file"
4
5
  require_relative "user"
5
6
 
@@ -7,14 +8,18 @@ module LMSGraphQL
7
8
  module Types
8
9
  module Canvas
9
10
  class SisImportWorkflowStateEnum < ::GraphQL::Schema::Enum
11
+ value "initializing"
10
12
  value "created"
11
13
  value "importing"
12
14
  value "cleanup_batch"
13
15
  value "imported"
14
16
  value "imported_with_messages"
15
17
  value "aborted"
16
- value "failed_with_messages"
17
18
  value "failed"
19
+ value "failed_with_messages"
20
+ value "restoring"
21
+ value "partially_restored"
22
+ value "restored"
18
23
  end
19
24
  class CanvasSisImport < BaseType
20
25
  description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
@@ -23,6 +28,7 @@ module LMSGraphQL
23
28
  field :ended_at, LMSGraphQL::Types::DateTimeType, "The date the SIS import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", null: true
24
29
  field :updated_at, LMSGraphQL::Types::DateTimeType, "The date the SIS import was last updated..Example: 2013-12-02T00:03:21-06:00", null: true
25
30
  field :workflow_state, SisImportWorkflowStateEnum, "The current state of the SIS import.
31
+ - 'initializing': The SIS import is being created, if this gets stuck in initializing, it will not import and will continue on to next import.
26
32
  - 'created': The SIS import has been created.
27
33
  - 'importing': The SIS import is currently processing.
28
34
  - 'cleanup_batch': The SIS import is currently cleaning up courses, sections, and enrollments not included in the batch for batch_mode imports.
@@ -30,8 +36,12 @@ module LMSGraphQL
30
36
  - 'imported_with_messages': The SIS import completed with errors or warnings.
31
37
  - 'aborted': The SIS import was aborted.
32
38
  - 'failed_with_messages': The SIS import failed with errors.
33
- - 'failed': The SIS import failed..Example: imported", null: true
39
+ - 'failed': The SIS import failed.
40
+ - 'restoring': The SIS import is restoring states of imported items.
41
+ - 'partially_restored': The SIS import is restored some of the states of imported items. This is generally due to passing a param like undelete only.
42
+ - 'restored': The SIS import is restored all of the states of imported items..Example: imported", null: true
34
43
  field :data, LMSGraphQL::Types::Canvas::CanvasSisImportDatum, "data.", null: true
44
+ field :statistics, LMSGraphQL::Types::Canvas::CanvasSisImportStatistic, "statistics.", null: true
35
45
  field :progress, String, "The progress of the SIS import. The progress will reset when using batch_mode and have a different progress for the cleanup stage.Example: 100", null: true
36
46
  field :errors_attachment, LMSGraphQL::Types::Canvas::CanvasFile, "The errors_attachment api object of the SIS import. Only available if there are errors or warning and import has completed..", null: true
37
47
  field :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user that initiated the sis_batch. See the Users API for details..", null: true
@@ -8,7 +8,7 @@ module LMSGraphQL
8
8
  description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
9
9
  argument :import_type, String, "The type of SIS import.Example: instructure_csv", required: false
10
10
  argument :supplied_batches, String, "Which files were included in the SIS import.Example: term, course, section, user, enrollment", required: false
11
- argument :counts, LMSGraphQL::Types::Canvas::CanvasSisImportCount, "The number of rows processed for each type of import.", required: false
11
+ argument :counts, LMSGraphQL::Types::Canvas::CanvasSisImportCountInput, "The number of rows processed for each type of import.", required: false
12
12
 
13
13
  end
14
14
  end
@@ -9,6 +9,7 @@ module LMSGraphQL
9
9
  field :sis_import_id, ID, "The unique identifier for the SIS import..Example: 1", null: true
10
10
  field :file, String, "The file where the error message occurred..Example: courses.csv", null: true
11
11
  field :message, String, "The error message that from the record..Example: No short_name given for course C001", null: true
12
+ field :row_info, String, "The contents of the line that had the error..Example: account_1, Sub account 1,, active ", null: true
12
13
  field :row, Int, "The line number where the error occurred. Some Importers do not yet support this. This is a 1 based index starting with the header row..Example: 34", null: true
13
14
 
14
15
  end
@@ -9,6 +9,7 @@ module LMSGraphQL
9
9
  argument :sis_import_id, ID, "The unique identifier for the SIS import..Example: 1", required: false
10
10
  argument :file, String, "The file where the error message occurred..Example: courses.csv", required: false
11
11
  argument :message, String, "The error message that from the record..Example: No short_name given for course C001", required: false
12
+ argument :row_info, String, "The contents of the line that had the error..Example: account_1, Sub account 1,, active ", required: false
12
13
  argument :row, Int, "The line number where the error occurred. Some Importers do not yet support this. This is a 1 based index starting with the header row..Example: 34", required: false
13
14
 
14
15
  end