lms-graphql-api 0.1.0

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class File < BaseType
+          description "Plagiarism Detection Submissions. API Docs: https://canvas.instructure.com/doc/api/plagiarism_detection_submissions.html"
+          field :size, Int, "Example: 4", null: true
+          field :content_type, String, "Example: text/plain", null: true
+          field :url, String, "Example: http://www.example.com/files/569/download?download_frd=1&verifier=c6HdZmxOZa0Fiin2cbvZeI8I5ry7yqD7RChQzb6P", null: true
+          field :id, ID, "Example: 569", null: true
+          field :display_name, String, "Example: file.txt", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-07-06T14:58:50Z", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-07-06T14:58:50Z", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class FileAttachment < BaseType
+          description "Discussion Topics. API Docs: https://canvas.instructure.com/doc/api/discussion_topics.html"
+          field :content_type, String, "Example: unknown/unknown", null: true
+          field :url, String, "Example: http://www.example.com/courses/1/files/1/download", null: true
+          field :filename, String, "Example: content.txt", null: true
+          field :display_name, String, "Example: content.txt", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Folder < BaseType
+          description "Files. API Docs: https://canvas.instructure.com/doc/api/files.html"
+          field :context_type, String, "Example: Course", null: true
+          field :context_id, ID, "Example: 1401", null: true
+          field :files_count, Int, "Example: 0", null: true
+          field :position, Int, "Example: 3", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-07-06T14:58:50Z", null: true
+          field :folders_url, String, "Example: https://www.example.com/api/v1/folders/2937/folders", null: true
+          field :files_url, String, "Example: https://www.example.com/api/v1/folders/2937/files", null: true
+          field :full_name, String, "Example: course files/11folder", null: true
+          field :lock_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-07-06T14:58:50Z", null: true
+          field :id, ID, "Example: 2937", null: true
+          field :folders_count, Int, "Example: 0", null: true
+          field :name, String, "Example: 11folder", null: true
+          field :parent_folder_id, ID, "Example: 2934", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-07-06T14:58:50Z", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "", null: true
+          field :hidden, Boolean, "", null: true
+          field :hidden_for_user, Boolean, "", null: true
+          field :locked, Boolean, "Example: true", null: true
+          field :locked_for_user, Boolean, "", null: true
+          field :for_submissions, Boolean, "If true, indicates this is a read-only folder containing files submitted to assignments.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Grade < BaseType
+          description "Enrollments. API Docs: https://canvas.instructure.com/doc/api/enrollments.html"
+          field :html_url, String, "The URL to the Canvas web UI page for the user's grades, if this is a student enrollment..", null: true
+          field :current_grade, String, "The user's current grade in the class. Only included if user has permissions to view this grade..", null: true
+          field :final_grade, String, "The user's final grade for the class. Only included if user has permissions to view this grade..", null: true
+          field :current_score, String, "The user's current score in the class. Only included if user has permissions to view this score..", null: true
+          field :final_score, String, "The user's final score for the class. Only included if user has permissions to view this score..", null: true
+          field :unposted_current_grade, String, "The user's current grade in the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins..", null: true
+          field :unposted_final_grade, String, "The user's final grade for the class including muted/unposted assignments. Only included if user has permissions to view this grade, typically teachers, TAs, and admins...", null: true
+          field :unposted_current_score, String, "The user's current score in the class including muted/unposted assignments. Only included if user has permissions to view this score, typically teachers, TAs, and admins...", null: true
+          field :unposted_final_score, String, "The user's final score for the class including muted/unposted assignments. Only included if user has permissions to view this score, typically teachers, TAs, and admins...", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_type"
+require_relative "grade_change_event_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradeChangeEvent < BaseType
+          description "Grade Change Log. API Docs: https://canvas.instructure.com/doc/api/grade_change_log.html"
+          field :id, ID, "ID of the event..Example: e2b76430-27a5-0131-3ca1-48e0eb13f29b", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "timestamp of the event.Example: 2012-07-19T15:00:00-06:00", null: true
+          field :event_type, String, "GradeChange event type.Example: grade_change", null: true
+          field :excused_after, Boolean, "Boolean indicating whether the submission was excused after the change..Example: true", null: true
+          field :excused_before, Boolean, "Boolean indicating whether the submission was excused before the change..", null: true
+          field :grade_after, String, "The grade after the change..Example: 8", null: true
+          field :grade_before, String, "The grade before the change..Example: 8", null: true
+          field :graded_anonymously, Boolean, "Boolean indicating whether the student name was visible when the grade was given. Could be null if the grade change record was created before this feature existed..Example: true", null: true
+          field :version_number, String, "Version Number of the grade change submission..Example: 1", null: true
+          field :request_id, ID, "The unique request id of the request during the grade change..Example: e2b76430-27a5-0131-3ca1-48e0eb13f29b", null: true
+          field :links, LMS::GraphQL::Types::Canvas::GradeChangeEventLink, "", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradeChangeEventLink < BaseType
+          description "Grade Change Log. API Docs: https://canvas.instructure.com/doc/api/grade_change_log.html"
+          field :assignment, Int, "ID of the assignment associated with the event.Example: 2319", null: true
+          field :course, Int, "ID of the course associated with the event. will match the context_id in the associated assignment if the context type for the assignment is a course.Example: 2319", null: true
+          field :student, Int, "ID of the student associated with the event. will match the user_id in the associated submission..Example: 2319", null: true
+          field :grader, Int, "ID of the grader associated with the event. will match the grader_id in the associated submission..Example: 2319", null: true
+          field :page_view, String, "ID of the page view during the event if it exists..Example: e2b76430-27a5-0131-3ca1-48e0eb13f29b", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Grader < BaseType
+          description "Gradebook History. API Docs: https://canvas.instructure.com/doc/api/gradebook_history.html"
+          field :id, ID, "the user_id of the user who graded the contained submissions.Example: 27", null: true
+          field :name, String, "the name of the user who graded the contained submissions.Example: Some User", null: true
+          field :assignments, Int, "the assignment groups for all submissions in this response that were graded by this user.  The details are not nested inside here, but the fact that an assignment is present here means that the grader did grade submissions for this assignment on the contextual date. You can use the id of a grader and of an assignment to make another API call to find all submissions for a grader/assignment combination on a given date..Example: 1, 2, 3", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradingPeriod < BaseType
+          description "Grading Periods. API Docs: https://canvas.instructure.com/doc/api/grading_periods.html"
+          field :id, ID, "The unique identifier for the grading period..Example: 1023", null: true
+          field :title, String, "The title for the grading period..Example: First Block", null: true
+          field :start_date, String, "The start date of the grading period..Example: 2014-01-07T15:04:00Z", null: true
+          field :end_date, String, "The end date of the grading period..Example: 2014-05-07T17:07:00Z", null: true
+          field :close_date, String, "Grades can only be changed before the close date of the grading period..Example: 2014-06-07T17:07:00Z", null: true
+          field :weight, Int, "A weight value that contributes to the overall weight of a grading period set which is used to calculate how much assignments in this period contribute to the total grade.Example: 33.33", null: true
+          field :is_closed, Boolean, "If true, the grading period's close_date has passed..Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradingRule < BaseType
+          description "Assignment Groups. API Docs: https://canvas.instructure.com/doc/api/assignment_groups.html"
+          field :drop_lowest, Int, "Number of lowest scores to be dropped for each user..Example: 1", null: true
+          field :drop_highest, Int, "Number of highest scores to be dropped for each user..Example: 1", null: true
+          field :never_drop, Int, "Assignment IDs that should never be dropped..Example: 33, 17, 24", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradingSchemeEntry < BaseType
+          description "Grading Standards. API Docs: https://canvas.instructure.com/doc/api/grading_standards.html"
+          field :name, String, "The name for an entry value within a GradingStandard that describes the range of the value.Example: A", null: true
+          field :value, Int, "The value for the name of the entry within a GradingStandard.  The entry represents the lower bound of the range for the entry. This range includes the value up to the next entry in the GradingStandard, or 100 if there is no upper bound. The lowest value will have a lower bound range of 0..Example: 0.9", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+require_relative "grading_scheme_entry"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GradingStandard < BaseType
+          description "Grading Standards. API Docs: https://canvas.instructure.com/doc/api/grading_standards.html"
+          field :title, String, "the title of the grading standard.Example: Account Standard", null: true
+          field :id, ID, "the id of the grading standard.Example: 1", null: true
+          field :context_type, String, "the context this standard is associated with, either 'Account' or 'Course'.Example: Account", null: true
+          field :context_id, ID, "the id for the context either the Account or Course id.Example: 1", null: true
+          field :grading_scheme, [LMS::GraphQL::Types::Canvas::GradingSchemeEntry], "A list of GradingSchemeEntry that make up the Grading Standard as an array of values with the scheme name and value.Example: {'name'=>'A', 'value'=>0.9}, {'name'=>'B', 'value'=>0.8}, {'name'=>'C', 'value'=>0.7}, {'name'=>'D', 'value'=>0.6}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GroupJoinLevelEnum < ::GraphQL::Schema::Enum
+          value "parent_context_auto_join"
+          value "parent_context_request"
+          value "invitation_only"
+        end
+
+                class GroupRoleEnum < ::GraphQL::Schema::Enum
+          value "communities"
+          value "student_organized"
+          value "imported"
+        end
+        class Group < BaseType
+          description "Groups. API Docs: https://canvas.instructure.com/doc/api/groups.html"
+          field :id, ID, "The ID of the group..Example: 17", null: true
+          field :name, String, "The display name of the group..Example: Math Group 1", null: true
+          field :description, String, "A description of the group. This is plain text..", null: true
+          field :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..", null: true
+          field :followed_by_user, Boolean, "Whether or not the current user is following this group..", null: true
+          field :join_level, GroupJoinLevelEnum, "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", null: true
+          field :members_count, Int, "The number of members currently in the group.Example: 0", null: true
+          field :avatar_url, String, "The url of the group's avatar.Example: https://<canvas>/files/avatar_image.png", null: true
+          field :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", null: true
+          field :course_id, ID, "Example: 3", null: true
+          field :role, GroupRoleEnum, "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..", null: true
+          field :group_category_id, ID, "The ID of the group's category..Example: 4", null: true
+          field :sis_group_id, ID, "The SIS ID of the group. Only included if the user has permission to view SIS information..Example: group4a", null: true
+          field :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", null: true
+          field :storage_quota_mb, Int, "the storage quota for the group, in megabytes.Example: 50", null: true
+          field :permissions, String, "optional: the permissions the user has for the group. returned only for a single group and include[]=permissions.Example: true, true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "../canvas_base_type"
+require_relative "progress"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GroupCategorySelfSignupEnum < ::GraphQL::Schema::Enum
+          value "restricted"
+          value "enabled"
+        end
+
+                class GroupCategoryAutoLeaderEnum < ::GraphQL::Schema::Enum
+          value "first"
+          value "random"
+        end
+        class GroupCategory < BaseType
+          description "Group Categories. API Docs: https://canvas.instructure.com/doc/api/group_categories.html"
+          field :id, ID, "The ID of the group category..Example: 17", null: true
+          field :name, String, "The display name of the group category..Example: Math Groups", null: true
+          field :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", null: true
+          field :self_signup, GroupCategorySelfSignupEnum, "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.", null: true
+          field :auto_leader, GroupCategoryAutoLeaderEnum, "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.", null: true
+          field :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", null: true
+          field :account_id, ID, "Example: 3", null: true
+          field :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..", null: true
+          field :sis_group_category_id, ID, "The SIS identifier for the group category. This field is only included if the user has permission to manage or view SIS information..", null: true
+          field :sis_import_id, ID, "The unique identifier for the SIS import. This field is only included if the user has permission to manage SIS information..", null: true
+          field :progress, LMS::GraphQL::Types::Canvas::Progress, "If the group category has not yet finished a randomly student assignment request, a progress object will be attached, which will contain information related to the progress of the assignment request. Refer to the Progress API for more information.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class GroupMembershipWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "accepted"
+          value "invited"
+          value "requested"
+        end
+        class GroupMembership < BaseType
+          description "Groups. API Docs: https://canvas.instructure.com/doc/api/groups.html"
+          field :id, ID, "The id of the membership object.Example: 92", null: true
+          field :group_id, ID, "The id of the group object to which the membership belongs.Example: 17", null: true
+          field :user_id, ID, "The id of the user object to which the membership belongs.Example: 3", null: true
+          field :workflow_state, GroupMembershipWorkflowStateEnum, "The current state of the membership. Current possible values are 'accepted', 'invited', and 'requested'.Example: accepted", null: true
+          field :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", null: true
+          field :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", null: true
+          field :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", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class JSONAPIPagination < BaseType
+          description "Quiz Submission User List. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html"
+        
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class JWT < BaseType
+          description "JWTs. API Docs: https://canvas.instructure.com/doc/api/jw_ts.html"
+          field :token, String, "The signed, encrypted, base64 encoded JWT.Example: ZXlKaGJHY2lPaUprYVhJaUxDSmxibU1pT2lKQk1qVTJSME5OSW4wLi5QbnAzS1QzLUJkZ3lQZHgtLm5JT0pOV01iZmdtQ0g3WWtybjhLeHlMbW13cl9yZExXTXF3Y0IwbXkzZDd3V1NDd0JYQkV0UTRtTVNJSVRrX0FJcG0zSU1DeThMcW5NdzA0ckdHVTkweDB3MmNJbjdHeWxOUXdveU5ZZ3UwOEN4TkZteUpCeW5FVktrdU05QlRyZXZ3Y1ZTN2hvaC1WZHRqM19PR3duRm5yUVgwSFhFVFc4R28tUGxoQVUtUnhKT0pNakx1OUxYd2NDUzZsaW9ZMno5NVU3T0hLSGNpaDBmSGVjN2FzekVJT3g4NExUeHlReGxYU3BtbFZ5LVNuYWdfbVJUeU5yNHNsMmlDWFcwSzZCNDhpWHJ1clJVVm1LUkVlVTl4ZVVJcTJPaWNpSHpfemJ0X3FrMjhkdzRyajZXRnBHSlZPNWcwTlUzVHlSWk5qdHg1S2NrTjVSQjZ1X2FzWTBScjhTY2VhNFk3Y2JFX01wcm54cFZTNDFIekVVSVRNdzVMTk1GLVpQZy52LVVDTkVJYk8zQ09EVEhPRnFXLUFR", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class LatePolicy < BaseType
+          description "Late Policy. API Docs: https://canvas.instructure.com/doc/api/late_policy.html"
+          field :id, ID, "the unique identifier for the late policy.Example: 123", null: true
+          field :course_id, ID, "the unique identifier for the course.Example: 123", null: true
+          field :missing_submission_deduction_enabled, Boolean, "whether to enable missing submission deductions.Example: true", null: true
+          field :missing_submission_deduction, Float, "amount of percentage points to deduct.Example: 12.34", null: true
+          field :late_submission_deduction_enabled, Boolean, "whether to enable late submission deductions.Example: true", null: true
+          field :late_submission_deduction, Float, "amount of percentage points to deduct per late_submission_interval.Example: 12.34", null: true
+          field :late_submission_interval, String, "time interval for late submission deduction.Example: hour", null: true
+          field :late_submission_minimum_percent_enabled, Boolean, "whether to enable late submission minimum percent.Example: true", null: true
+          field :late_submission_minimum_percent, Float, "the minimum score a submission can receive in percentage points.Example: 12.34", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "the time at which this late policy was originally created.Example: 2012-07-01T23:59:00-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "the time at which this late policy was last modified in any way.Example: 2012-07-01T23:59:00-06:00", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class License < BaseType
+          description "Files. API Docs: https://canvas.instructure.com/doc/api/files.html"
+          field :id, ID, "a short string identifying the license.Example: cc_by_sa", null: true
+          field :name, String, "the name of the license.Example: CC Attribution ShareAlike", null: true
+          field :url, String, "a link to the license text.Example: http://creativecommons.org/licenses/by-sa/4.0", null: true
+
+        end
+      end
+    end
+  end
+end