lms-graphql-api 0.1.0

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class QuizSubmissionEvent < BaseType
+          description "Quiz Submission Events. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_events.html"
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "a timestamp record of creation time.Example: 2014-10-08T19:29:58Z", null: true
+          field :event_type, String, "the type of event being sent.Example: question_answered", null: true
+          field :event_data, String, "custom contextual data for the specific event type.Example: 42", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class QuizSubmissionQuestion < BaseType
+          description "Quiz Submission Questions. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_questions.html"
+          field :id, ID, "The ID of the QuizQuestion this answer is for..Example: 1", null: true
+          field :flagged, Boolean, "Whether this question is flagged..Example: true", null: true
+          field :answer, String, "The provided answer (if any) for this question. The format of this parameter depends on the type of the question, see the Appendix for more information..", null: true
+          field :answers, String, "The possible answers for this question when those possible answers are necessary.  The presence of this parameter is dependent on permissions..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class QuizSubmissionUserList < 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/quiz_submission_user_list_metum.rb

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class QuizSubmissionUserListMetum < 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/report.rb

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+require_relative "file"
+require_relative "report_parameter"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Report < BaseType
+          description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+          field :id, ID, "The unique identifier for the report..Example: 1", null: true
+          field :report, String, "The type of report..Example: sis_export_csv", null: true
+          field :file_url, String, "The url to the report download..Example: https://example.com/some/path", null: true
+          field :attachment, LMS::GraphQL::Types::Canvas::File, "The attachment api object of the report. Only available after the report has completed..", null: true
+          field :status, String, "The status of the report.Example: complete", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The date and time the report was created..Example: 2013-12-01T23:59:00-06:00", null: true
+          field :started_at, LMS::GraphQL::Types::DateTimeType, "The date and time the report started processing..Example: 2013-12-02T00:03:21-06:00", null: true
+          field :ended_at, LMS::GraphQL::Types::DateTimeType, "The date and time the report finished processing..Example: 2013-12-02T00:03:21-06:00", null: true
+          field :parameters, LMS::GraphQL::Types::Canvas::ReportParameter, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", null: true
+          field :progress, Int, "The progress of the report.Example: 100", null: true
+          field :current_line, Int, "This is the current line count being written to the report. It updates every 1000 records..Example: 12000", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ReportParameterOrderEnum < ::GraphQL::Schema::Enum
+          value "users"
+          value "courses"
+          value "outcomes"
+        end
+        class ReportParameter < BaseType
+          description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+          field :enrollment_term_id, ID, "The canvas id of the term to get grades from.Example: 2", null: true
+          field :include_deleted, Boolean, "If true, deleted objects will be included. If false, deleted objects will be omitted..", null: true
+          field :course_id, ID, "The id of the course to report on.Example: 2", null: true
+          field :order, ReportParameterOrderEnum, "The sort order for the csv, Options: 'users', 'courses', 'outcomes'..Example: users", null: true
+          field :users, Boolean, "If true, user data will be included. If false, user data will be omitted..", null: true
+          field :accounts, Boolean, "If true, account data will be included. If false, account data will be omitted..", null: true
+          field :terms, Boolean, "If true, term data will be included. If false, term data will be omitted..", null: true
+          field :courses, Boolean, "If true, course data will be included. If false, course data will be omitted..", null: true
+          field :sections, Boolean, "If true, section data will be included. If false, section data will be omitted..", null: true
+          field :enrollments, Boolean, "If true, enrollment data will be included. If false, enrollment data will be omitted..", null: true
+          field :groups, Boolean, "If true, group data will be included. If false, group data will be omitted..", null: true
+          field :xlist, Boolean, "If true, data for crosslisted courses will be included. If false, data for crosslisted courses will be omitted..", null: true
+          field :sis_terms_csv, Int, "Example: 1", null: true
+          field :sis_accounts_csv, Int, "Example: 1", null: true
+          field :include_enrollment_state, Boolean, "If true, enrollment state will be included. If false, enrollment state will be omitted. Defaults to false..", null: true
+          field :enrollment_state, String, "Include enrollment state. Defaults to 'all' Options: ['active'| 'invited'| 'creation_pending'| 'deleted'| 'rejected'| 'completed'| 'inactive'| 'all'].Example: all", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "The beginning date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", null: true
+          field :end_at, LMS::GraphQL::Types::DateTimeType, "The end date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+require_relative "result_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Result < BaseType
+          description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+          field :id, ID, "A unique identifier for this result.Example: 42", null: true
+          field :passed, Boolean, "Whether the user passed or not.Example: true", null: true
+          field :assessed_at, LMS::GraphQL::Types::DateTimeType, "When this result was recorded.Example: 2014-05-13T00:01:57-06:00", null: true
+          field :links, LMS::GraphQL::Types::Canvas::ResultLink, "Unique identifiers of objects associated with this result.Example: 42, 23, 5", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ResultLink < BaseType
+          description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+          field :user, String, "A unique identifier for the user to whom this result applies.Example: 42", null: true
+          field :assessor, String, "A unique identifier for the user who created this result.Example: 23", null: true
+          field :assessment, String, "A unique identifier for the assessment that this result is for.Example: 5", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+require_relative "account"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Role < BaseType
+          description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+          field :label, String, "The label of the role..Example: New Role", null: true
+          field :role, String, "The label of the role. (Deprecated alias for 'label').Example: New Role", null: true
+          field :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", null: true
+          field :account, LMS::GraphQL::Types::Canvas::Account, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", null: true
+          field :workflow_state, String, "The state of the role: 'active', 'inactive', or 'built_in'.Example: active", null: true
+          field :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}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class RolePermission < BaseType
+          description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+          field :enabled, Boolean, "Whether the role has the permission.Example: true", null: true
+          field :locked, Boolean, "Whether the permission is locked by this role.", null: true
+          field :applies_to_self, Boolean, "Whether the permission applies to the account this role is in. Only present if enabled is true.Example: true", null: true
+          field :applies_to_descendants, Boolean, "Whether the permission cascades down to sub accounts of the account this role is in. Only present if enabled is true.", null: true
+          field :readonly, Boolean, "Whether the permission can be modified in this role (i.e. whether the permission is locked by an upstream role)..", null: true
+          field :explicit, Boolean, "Whether the value of enabled is specified explicitly by this role, or inherited from an upstream role..Example: true", null: true
+          field :prior_default, Boolean, "The value that would have been inherited from upstream if the role had not explicitly set a value. Only present if explicit is true..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+require_relative "rubric_assessment"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Rubric < BaseType
+          description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+          field :id, ID, "the ID of the rubric.Example: 1", null: true
+          field :title, String, "title of the rubric.Example: some title", null: true
+          field :context_id, ID, "the context owning the rubric.Example: 1", null: true
+          field :context_type, String, "Example: Course", null: true
+          field :points_possible, Int, "Example: 10.0", null: true
+          field :reusable, Boolean, "Example: false", null: true
+          field :read_only, Boolean, "Example: true", null: true
+          field :free_form_criterion_comments, Boolean, "whether or not free-form comments are used.Example: true", null: true
+          field :hide_score_total, Boolean, "Example: true", null: true
+          field :assessments, [LMS::GraphQL::Types::Canvas::RubricAssessment], "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..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class RubricAssessment < BaseType
+          description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+          field :id, ID, "the ID of the rubric.Example: 1", null: true
+          field :rubric_id, ID, "the rubric the assessment belongs to.Example: 1", null: true
+          field :rubric_association_id, ID, "Example: 2", null: true
+          field :score, Int, "Example: 5.0", null: true
+          field :artifact_type, String, "the object of the assessment.Example: Submission", null: true
+          field :artifact_id, ID, "the id of the object of the assessment.Example: 3", null: true
+          field :artifact_attempt, Int, "the current number of attempts made on the object of the assessment.Example: 2", null: true
+          field :assessment_type, String, "the type of assessment. values will be either 'grading', 'peer_review', or 'provisional_grade'.Example: grading", null: true
+          field :assessor_id, ID, "user id of the person who made the assessment.Example: 6", null: true
+          field :data, String, "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", null: true
+          field :comments, String, "(Optional) If 'comments_only' is included in the 'style' parameter, returned assessments will include only the comments portion of their data hash. If the user does not request a style, this key will be absent..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+require_relative "rubric_rating"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class RubricCriterium < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :points, Int, "Example: 10", null: true
+          field :id, ID, "The id of rubric criteria..Example: crit1", null: true
+          field :learning_outcome_id, ID, "(Optional) The id of the learning outcome this criteria uses, if any..Example: 1234", null: true
+          field :vendor_guid, String, "(Optional) The 3rd party vendor's GUID for the outcome this criteria references, if any..Example: abdsfjasdfne3jsdfn2", null: true
+          field :description, String, "Example: Criterion 1", null: true
+          field :long_description, String, "Example: Criterion 1 more details", null: true
+          field :criterion_use_range, Boolean, "Example: true", null: true
+          field :ratings, [LMS::GraphQL::Types::Canvas::RubricRating], "", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class RubricRating < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :points, Int, "Example: 10", null: true
+          field :id, ID, "Example: rat1", null: true
+          field :description, String, "Example: Full marks", null: true
+          field :long_description, String, "Example: Student completed the assignment flawlessly.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Scope < BaseType
+          description "Scopes. API Docs: https://canvas.instructure.com/doc/api/scopes.html"
+          field :resource, String, "The resource the scope is associated with.Example: courses", null: true
+          field :verb, String, "The HTTP verb for the scope.Example: GET", null: true
+          field :scope, String, "The identifier for the scope.Example: url:GET|/api/v1/courses", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Section < BaseType
+          description "Sections. API Docs: https://canvas.instructure.com/doc/api/sections.html"
+          field :id, ID, "The unique identifier for the section..Example: 1", null: true
+          field :name, String, "The name of the section..Example: Section A", null: true
+          field :sis_section_id, ID, "The sis id of the section. This field is only included if the user has permission to view SIS information..Example: s34643", null: true
+          field :integration_id, ID, "Optional: The integration ID of the section. This field is only included if the user has permission to view SIS information..Example: 3452342345", null: true
+          field :sis_import_id, ID, "The unique identifier for the SIS import if created through SIS. This field is only included if the user has permission to manage SIS information..Example: 47", null: true
+          field :course_id, ID, "The unique Canvas identifier for the course in which the section belongs.Example: 7", null: true
+          field :sis_course_id, ID, "The unique SIS identifier for the course in which the section belongs. This field is only included if the user has permission to view SIS information..Example: 7", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "the start date for the section, if applicable.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :end_at, LMS::GraphQL::Types::DateTimeType, "the end date for the section, if applicable.", null: true
+          field :restrict_enrollments_to_section_dates, Boolean, "Restrict user enrollments to the start and end dates of the section.", null: true
+          field :nonxlist_course_id, ID, "The unique identifier of the original course of a cross-listed section.", null: true
+          field :total_students, Int, "optional: the total number of active and invited students in the section.Example: 13", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SectionAssignmentOverrideAttribute < BaseType
+          description "SIS Integration. API Docs: https://canvas.instructure.com/doc/api/sis_integration.html"
+          field :override_title, String, "The title for the assignment override.Example: some section override", 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
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+require_relative "course_attribute"
+require_relative "course_attribute"
+require_relative "section_assignment_override_attribute"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SectionAttribute < BaseType
+          description "SIS Integration. API Docs: https://canvas.instructure.com/doc/api/sis_integration.html"
+          field :id, ID, "The unique identifier for the section..Example: 1", null: true
+          field :name, String, "The name of the section..Example: Section A", null: true
+          field :sis_id, ID, "The sis id of the section..Example: s34643", null: true
+          field :integration_id, ID, "Optional: The integration ID of the section..Example: 3452342345", null: true
+          field :origin_course, LMS::GraphQL::Types::Canvas::CourseAttribute, "The course to which the section belongs or the course from which the section was cross-listed.", null: true
+          field :xlist_course, LMS::GraphQL::Types::Canvas::CourseAttribute, "Optional: Attributes of the xlist course. Only present when the section has been cross-listed. See Courses API for more details.", null: true
+          field :override, LMS::GraphQL::Types::Canvas::SectionAssignmentOverrideAttribute, "Optional: Attributes of the assignment override that apply to the section. See Assignment API for more details.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class SharedBrandConfig < BaseType
+          description "Shared Brand Configs. API Docs: https://canvas.instructure.com/doc/api/shared_brand_configs.html"
+          field :id, ID, "The shared_brand_config identifier..Example: 987", null: true
+          field :account_id, ID, "The id of the account it should be shared within..", null: true
+          field :brand_config_md5, String, "The md5 (since BrandConfigs are identified by MD5 and not numeric id) of the BrandConfig to share..Example: 1d31002c95842f8fe16da7dfcc0d1f39", null: true
+          field :name, String, "The name to share this theme as.Example: Crimson and Gold Verson 1", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "When this was created.Example: 2012-07-13T10:55:20-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "When this was last updated.Example: 2012-07-13T10:55:20-06:00", null: true
+
+        end
+      end
+    end
+  end
+end