lms-graphql-api 0.1.0

data/lib/lms/graphql/types/canvas/sis_assignment.rb

@@ -0,0 +1,44 @@
+require_relative "../canvas_base_type"
+require_relative "assignment_group_attribute"
+require_relative "section_attribute"
+require_relative "user_assignment_override_attribute"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SisAssignmentSubmissionTypeEnum < ::GraphQL::Schema::Enum
+          value "discussion_topic"
+          value "online_quiz"
+          value "on_paper"
+          value "not_graded"
+          value "none"
+          value "external_tool"
+          value "online_text_entry"
+          value "online_url"
+          value "online_upload"
+          value "media_recording"
+        end
+        class SisAssignment < BaseType
+          description "SIS Integration. API Docs: https://canvas.instructure.com/doc/api/sis_integration.html"
+          field :id, ID, "The unique identifier for the assignment..Example: 4", null: true
+          field :course_id, ID, "The unique identifier for the course..Example: 6", null: true
+          field :name, String, "the name of the assignment.Example: some assignment", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The time at which this assignment was originally created.Example: 2012-07-01T23:59:00-06:00", null: true
+          field :due_at, LMS::GraphQL::Types::DateTimeType, "the due date for the assignment. returns null if not present. NOTE: If this assignment has assignment overrides, this field will be the due date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be unlocked..Example: 2013-01-01T00:00:00-06:00", null: true
+          field :lock_at, LMS::GraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be locked..Example: 2013-02-01T00:00:00-06:00", null: true
+          field :points_possible, Int, "The maximum points possible for the assignment.Example: 12", null: true
+          field :submission_types, SisAssignmentSubmissionTypeEnum, "the types of submissions allowed for this assignment list containing one or more of the following: 'discussion_topic', 'online_quiz', 'on_paper', 'none', 'external_tool', 'online_text_entry', 'online_url', 'online_upload' 'media_recording'.Example: online_text_entry", null: true
+          field :integration_id, ID, "Third Party integration id for assignment.Example: 12341234", null: true
+          field :integration_data, String, "(optional, Third Party integration data for assignment).Example: other_data", null: true
+          field :include_in_final_grade, Boolean, "If false, the assignment will be omitted from the student's final grade.Example: true", null: true
+          field :assignment_group, [LMS::GraphQL::Types::Canvas::AssignmentGroupAttribute], "Includes attributes of a assignment_group for convenience. For more details see Assignments API..", null: true
+          field :sections, [LMS::GraphQL::Types::Canvas::SectionAttribute], "Includes attributes of a section for convenience. For more details see Sections API..", null: true
+          field :user_overrides, [LMS::GraphQL::Types::Canvas::UserAssignmentOverrideAttribute], "Includes attributes of a user assignment overrides. For more details see Assignments API..", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/sis_import.rb

@@ -0,0 +1,55 @@
+require_relative "../canvas_base_type"
+require_relative "sis_import_datum"
+require_relative "file"
+require_relative "user"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SisImportWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "importing"
+          value "cleanup_batch"
+          value "imported"
+          value "imported_with_messages"
+          value "aborted"
+          value "failed_with_messages"
+          value "failed"
+        end
+        class SisImport < BaseType
+          description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
+          field :id, ID, "The unique identifier for the SIS import..Example: 1", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The date the SIS import was created..Example: 2013-12-01T23:59:00-06:00", null: true
+          field :ended_at, LMS::GraphQL::Types::DateTimeType, "The date the SIS import finished. Returns null if not finished..Example: 2013-12-02T00:03:21-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "The date the SIS import was last updated..Example: 2013-12-02T00:03:21-06:00", null: true
+          field :workflow_state, SisImportWorkflowStateEnum, "The current state of the SIS import.
+ - 'created': The SIS import has been created.
+ - 'importing': The SIS import is currently processing.
+ - 'cleanup_batch': The SIS import is currently cleaning up courses, sections, and enrollments not included in the batch for batch_mode imports.
+ - 'imported': The SIS import has completed successfully.
+ - 'imported_with_messages': The SIS import completed with errors or warnings.
+ - 'aborted': The SIS import was aborted.
+ - 'failed_with_messages': The SIS import failed with errors.
+ - 'failed': The SIS import failed..Example: imported", null: true
+          field :data, LMS::GraphQL::Types::Canvas::SisImportDatum, "data.", null: true
+          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
+          field :errors_attachment, LMS::GraphQL::Types::Canvas::File, "The errors_attachment api object of the SIS import. Only available if there are errors or warning and import has completed..", null: true
+          field :user, LMS::GraphQL::Types::Canvas::User, "The user that initiated the sis_batch. See the Users API for details..", null: true
+          field :processing_warnings, String, "Only imports that are complete will get this data. An array of CSV_file/warning_message pairs..Example: students.csv, user John Doe has already claimed john_doe's requested login information, skipping", null: true
+          field :processing_errors, String, "An array of CSV_file/error_message pairs..Example: students.csv, Error while importing CSV. Please contact support.", null: true
+          field :batch_mode, Boolean, "Whether the import was run in batch mode..Example: true", null: true
+          field :batch_mode_term_id, ID, "The term the batch was limited to..Example: 1234", null: true
+          field :multi_term_batch_mode, Boolean, "Enables batch mode against all terms in term file. Requires change_threshold to be set..Example: false", null: true
+          field :skip_deletes, Boolean, "When set the import will skip any deletes..Example: false", null: true
+          field :override_sis_stickiness, Boolean, "Whether UI changes were overridden..Example: false", null: true
+          field :add_sis_stickiness, Boolean, "Whether stickiness was added to the batch changes..Example: false", null: true
+          field :clear_sis_stickiness, Boolean, "Whether stickiness was cleared..Example: false", null: true
+          field :diffing_data_set_identifier, String, "The identifier of the data set that this SIS batch diffs against.Example: account-5-enrollments", null: true
+          field :diffed_against_import_id, ID, "The ID of the SIS Import that this import was diffed against.Example: 1", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/sis_import_count.rb

@@ -0,0 +1,31 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SisImportCount < BaseType
+          description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
+          field :accounts, Int, "Example: 0", null: true
+          field :terms, Int, "Example: 3", null: true
+          field :abstract_courses, Int, "Example: 0", null: true
+          field :courses, Int, "Example: 121", null: true
+          field :sections, Int, "Example: 278", null: true
+          field :xlists, Int, "Example: 0", null: true
+          field :users, Int, "Example: 346", null: true
+          field :enrollments, Int, "Example: 1542", null: true
+          field :groups, Int, "Example: 0", null: true
+          field :group_memberships, Int, "Example: 0", null: true
+          field :grade_publishing_results, Int, "Example: 0", null: true
+          field :batch_courses_deleted, Int, "the number of courses that were removed because they were not included in the batch for batch_mode imports. Only included if courses were deleted.Example: 11", null: true
+          field :batch_sections_deleted, Int, "the number of sections that were removed because they were not included in the batch for batch_mode imports. Only included if sections were deleted.Example: 0", null: true
+          field :batch_enrollments_deleted, Int, "the number of enrollments that were removed because they were not included in the batch for batch_mode imports. Only included if enrollments were deleted.Example: 150", null: true
+          field :error_count, Int, "Example: 0", null: true
+          field :warning_count, Int, "Example: 0", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/sis_import_datum.rb

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+require_relative "sis_import_count"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SisImportDatum < BaseType
+          description "SIS Imports. API Docs: https://canvas.instructure.com/doc/api/sis_imports.html"
+          field :import_type, String, "The type of SIS import.Example: instructure_csv", null: true
+          field :supplied_batches, String, "Which files were included in the SIS import.Example: term, course, section, user, enrollment", null: true
+          field :counts, LMS::GraphQL::Types::Canvas::SisImportCount, "The number of rows processed for each type of import.", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/sis_import_error.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SisImportError < BaseType
+          description "SIS Import Errors. API Docs: https://canvas.instructure.com/doc/api/sis_import_errors.html"
+          field :sis_import_id, ID, "The unique identifier for the SIS import..Example: 1", null: true
+          field :file, String, "The file where the error message occurred..Example: courses.csv", null: true
+          field :message, String, "The error message that from the record..Example: No short_name given for course C001", null: true
+          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
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/sso_setting.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SSOSetting < BaseType
+          description "Authentication Providers. API Docs: https://canvas.instructure.com/doc/api/authentication_providers.html"
+          field :login_handle_name, String, "The label used for unique login identifiers..Example: Username", null: true
+          field :change_password_url, String, "The url to redirect users to for password resets. Leave blank for default Canvas behavior.Example: https://example.com/reset_password", null: true
+          field :auth_discovery_url, String, "If a discovery url is set, canvas will forward all users to that URL when they need to be authenticated. That page will need to then help the user figure out where they need to go to log in. If no discovery url is configured, the first configuration will be used to attempt to authenticate the user..Example: https://example.com/which_account", null: true
+          field :unknown_user_url, String, "If an unknown user url is set, Canvas will forward to that url when a service authenticates a user, but that user does not exist in Canvas. The default behavior is to present an error..Example: https://example.com/register_for_canvas", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/student_attribute.rb

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class StudentAttribute < BaseType
+          description "SIS Integration. API Docs: https://canvas.instructure.com/doc/api/sis_integration.html"
+          field :user_id, ID, "The unique Canvas identifier for the user.Example: 511", null: true
+          field :sis_user_id, ID, "The SIS ID associated with the user.  This field is only included if the user came from a SIS import and has permissions to view SIS information..Example: SHEL93921", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/submission.rb

@@ -0,0 +1,54 @@
+require_relative "../canvas_base_type"
+require_relative "submission_comment"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SubmissionSubmissionTypeEnum < ::GraphQL::Schema::Enum
+          value "online_text_entry"
+          value "online_url"
+          value "online_upload"
+          value "media_recording"
+        end
+
+                class SubmissionWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "graded"
+          value "submitted"
+          value "unsubmitted"
+          value "pending_review"
+        end
+        class Submission < BaseType
+          description "Submissions. API Docs: https://canvas.instructure.com/doc/api/submissions.html"
+          field :assignment_id, ID, "The submission's assignment id.Example: 23", null: true
+          field :assignment, String, "The submission's assignment (see the assignments API) (optional).Example: Assignment", null: true
+          field :course, String, "The submission's course (see the course API) (optional).Example: Course", null: true
+          field :attempt, Int, "This is the submission attempt number..Example: 1", null: true
+          field :body, String, "The content of the submission, if it was submitted directly in a text field..Example: There are three factors too.", null: true
+          field :grade, String, "The grade for the submission, translated into the assignment grading scheme (so a letter grade, for example)..Example: A-", null: true
+          field :grade_matches_current_submission, Boolean, "A boolean flag which is false if the student has re-submitted since the submission was last graded..Example: true", null: true
+          field :html_url, String, "URL to the submission. This will require the user to log in..Example: http://example.com/courses/255/assignments/543/submissions/134", null: true
+          field :preview_url, String, "URL to the submission preview. This will require the user to log in..Example: http://example.com/courses/255/assignments/543/submissions/134?preview=1", null: true
+          field :score, Float, "The raw score.Example: 13.5", null: true
+          field :submission_comments, [LMS::GraphQL::Types::Canvas::SubmissionComment], "Associated comments for a submission (optional).", null: true
+          field :submission_type, SubmissionSubmissionTypeEnum, "The types of submission ex: ('online_text_entry'|'online_url'|'online_upload'|'media_recording').Example: online_text_entry", null: true
+          field :submitted_at, LMS::GraphQL::Types::DateTimeType, "The timestamp when the assignment was submitted.Example: 2012-01-01T01:00:00Z", null: true
+          field :url, String, "The URL of the submission (for 'online_url' submissions)..", null: true
+          field :user_id, ID, "The id of the user who created the submission.Example: 134", null: true
+          field :grader_id, ID, "The id of the user who graded the submission. This will be null for submissions that haven't been graded yet. It will be a positive number if a real user has graded the submission and a negative number if the submission was graded by a process (e.g. Quiz autograder and autograding LTI tools).  Specifically autograded quizzes set grader_id to the negative of the quiz id.  Submissions autograded by LTI tools set grader_id to the negative of the tool id..Example: 86", null: true
+          field :graded_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-01-02T03:05:34Z", null: true
+          field :user, String, "The submissions user (see user API) (optional).Example: User", null: true
+          field :late, Boolean, "Whether the submission was made after the applicable due date.", null: true
+          field :assignment_visible, Boolean, "Whether the assignment is visible to the user who submitted the assignment. Submissions where `assignment_visible` is false no longer count towards the student's grade and the assignment can no longer be accessed by the student. `assignment_visible` becomes false for submissions that do not have a grade and whose assignment is no longer assigned to the student's section..Example: true", null: true
+          field :excused, Boolean, "Whether the assignment is excused.  Excused assignments have no impact on a user's grade..Example: true", null: true
+          field :missing, Boolean, "Whether the assignment is missing..Example: true", null: true
+          field :late_policy_status, String, "The status of the submission in relation to the late policy. Can be late, missing, none, or null..Example: missing", null: true
+          field :points_deducted, Float, "The amount of points automatically deducted from the score by the missing/late policy for a late or missing assignment..Example: 12.3", null: true
+          field :seconds_late, Float, "The amount of time, in seconds, that an submission is late by..Example: 300", null: true
+          field :workflow_state, SubmissionWorkflowStateEnum, "The current state of the submission.Example: submitted", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/submission_comment.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+require_relative "media_comment"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SubmissionComment < BaseType
+          description "Submissions. API Docs: https://canvas.instructure.com/doc/api/submissions.html"
+          field :id, ID, "Example: 37", null: true
+          field :author_id, ID, "Example: 134", null: true
+          field :author_name, String, "Example: Toph Beifong", null: true
+          field :author, String, "Abbreviated user object UserDisplay (see users API)..Example: {}", null: true
+          field :comment, String, "Example: Well here's the thing.", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-01-01T01:00:00Z", null: true
+          field :edited_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-01-02T01:00:00Z", null: true
+          field :media_comment, LMS::GraphQL::Types::Canvas::MediaComment, "", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/submission_history.rb

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+require_relative "submission_version"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SubmissionHistory < BaseType
+          description "Gradebook History. API Docs: https://canvas.instructure.com/doc/api/gradebook_history.html"
+          field :submission_id, ID, "the id of the submission.Example: 4", null: true
+          field :versions, [LMS::GraphQL::Types::Canvas::SubmissionVersion], "an array of all the versions of this submission.", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/submission_version.rb

@@ -0,0 +1,38 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SubmissionVersion < BaseType
+          description "Gradebook History. API Docs: https://canvas.instructure.com/doc/api/gradebook_history.html"
+          field :assignment_id, ID, "the id of the assignment this submissions is for.Example: 22604", null: true
+          field :assignment_name, String, "the name of the assignment this submission is for.Example: some assignment", null: true
+          field :body, String, "the body text of the submission.Example: text from the submission", null: true
+          field :current_grade, String, "the most up to date grade for the current version of this submission.Example: 100", null: true
+          field :current_graded_at, LMS::GraphQL::Types::DateTimeType, "the latest time stamp for the grading of this submission.Example: 2013-01-31T18:16:31Z", null: true
+          field :current_grader, String, "the name of the most recent grader for this submission.Example: Grader Name", null: true
+          field :grade_matches_current_submission, Boolean, "boolean indicating whether the grade is equal to the current submission grade.Example: true", null: true
+          field :graded_at, LMS::GraphQL::Types::DateTimeType, "time stamp for the grading of this version of the submission.Example: 2013-01-31T18:16:31Z", null: true
+          field :grader, String, "the name of the user who graded this version of the submission.Example: Grader Name", null: true
+          field :grader_id, ID, "the user id of the user who graded this version of the submission.Example: 67379", null: true
+          field :id, ID, "the id of the submission of which this is a version.Example: 11607", null: true
+          field :new_grade, String, "the updated grade provided in this version of the submission.Example: 100", null: true
+          field :new_graded_at, LMS::GraphQL::Types::DateTimeType, "the timestamp for the grading of this version of the submission (alias for graded_at).Example: 2013-01-31T18:16:31Z", null: true
+          field :new_grader, String, "alias for 'grader'.Example: Grader Name", null: true
+          field :previous_grade, String, "the grade for the submission version immediately preceding this one.Example: 90", null: true
+          field :previous_graded_at, LMS::GraphQL::Types::DateTimeType, "the timestamp for the grading of the submission version immediately preceding this one.Example: 2013-01-29T12:12:12Z", null: true
+          field :previous_grader, String, "the name of the grader who graded the version of this submission immediately preceding this one.Example: Graded on submission", null: true
+          field :score, Int, "the score for this version of the submission.Example: 100", null: true
+          field :user_name, String, "the name of the student who created this submission.Example: student@example.com", null: true
+          field :submission_type, String, "the type of submission.Example: online", null: true
+          field :url, String, "the url of the submission, if there is one.", null: true
+          field :user_id, ID, "the user ID of the student who created this submission.Example: 67376", null: true
+          field :workflow_state, String, "the state of the submission at this version.Example: unsubmitted", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/tab.rb

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Tab < BaseType
+          description "Tabs. API Docs: https://canvas.instructure.com/doc/api/tabs.html"
+          field :html_url, String, "Example: /courses/1/external_tools/4", null: true
+          field :id, ID, "Example: context_external_tool_4", null: true
+          field :label, String, "Example: WordPress", null: true
+          field :type, String, "Example: external", null: true
+          field :hidden, Boolean, "only included if true.Example: true", null: true
+          field :visibility, String, "possible values are: public, members, admins, and none.Example: public", null: true
+          field :position, Int, "1 based.Example: 2", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/term.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Term < BaseType
+          description "Courses. API Docs: https://canvas.instructure.com/doc/api/courses.html"
+          field :id, ID, "Example: 1", null: true
+          field :name, String, "Example: Default Term", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-06-01T00:00:00-06:00", null: true
+          field :end_at, LMS::GraphQL::Types::DateTimeType, "", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/tool_setting.rb

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ToolSetting < BaseType
+          description "Originality Reports. API Docs: https://canvas.instructure.com/doc/api/originality_reports.html"
+          field :resource_type_code, String, "the resource type code of the resource handler to use to display originality reports.Example: originality_reports", null: true
+          field :resource_url, String, "a URL that may be used to override the launch URL inferred by the specified resource_type_code. If used a 'resource_type_code' must also be specified..Example: http://www.test.com/originality_report", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/turnitin_setting.rb

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class TurnitinSetting < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :originality_report_visibility, String, "Example: after_grading", null: true
+          field :s_paper_check, Boolean, "", null: true
+          field :internet_check, Boolean, "", null: true
+          field :journal_check, Boolean, "", null: true
+          field :exclude_biblio, Boolean, "", null: true
+          field :exclude_quoted, Boolean, "", null: true
+          field :exclude_small_matches_type, String, "Example: percent", null: true
+          field :exclude_small_matches_value, Int, "Example: 50", null: true
+
+        end
+      end
+    end
+  end
+end

data/lib/lms/graphql/types/canvas/updated_event_datum.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class UpdatedEventDatum < BaseType
+          description "Course Audit log. API Docs: https://canvas.instructure.com/doc/api/course_audit_log.html"
+          field :name, String, "Example: Course 1, Course 2", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-01-19T15:00:00-06:00, 2012-07-19T15:00:00-06:00", null: true
+          field :conclude_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-01-19T15:00:00-08:00, 2012-07-19T15:00:00-08:00", null: true
+          field :is_public, Boolean, "Example: true, false", null: true
+
+        end
+      end
+    end
+  end
+end