lms-graphql-api 0.1.0

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class LockInfo < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :asset_string, String, "Asset string for the object causing the lock.Example: assignment_4", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "(Optional) Time at which this was/will be unlocked. Must be before the due date..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. Must be after the due date..Example: 2013-02-01T00:00:00-06:00", null: true
+          field :context_module, String, "(Optional) Context module causing the lock..Example: {}", null: true
+          field :manually_locked, Boolean, "Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class LtiAssignment < BaseType
+          description "Plagiarism Detection Platform Assignments. API Docs: https://canvas.instructure.com/doc/api/plagiarism_detection_platform_assignments.html"
+          field :id, ID, "Example: 4", null: true
+          field :name, String, "Example: Midterm Review", null: true
+          field :description, String, "Example: <p>Do the following:</p>.", null: true
+          field :points_possible, Int, "Example: 10", null: true
+          field :due_at, LMS::GraphQL::Types::DateTimeType, "The due date for the assignment. If a user id is supplied and an assignment override is in place this field will reflect the due date as it applies to the user..Example: 2012-07-01T23:59:00-06:00", null: true
+          field :lti_id, ID, "Example: 86157096483e6b3a50bfedc6bac902c0b20a824f", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class MediaComment < BaseType
+          description "Submissions. API Docs: https://canvas.instructure.com/doc/api/submissions.html"
+          field :content_type, String, "Example: audio/mp4", null: true
+          field :display_name, String, "Example: something", null: true
+          field :media_id, ID, "Example: 3232", null: true
+          field :media_type, String, "Example: audio", null: true
+          field :url, String, "Example: http://example.com/media_url", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class MigrationIssueWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "active"
+          value "resolved"
+        end
+
+                class MigrationIssueIssueTypeEnum < ::GraphQL::Schema::Enum
+          value "todo"
+          value "warning"
+          value "error"
+        end
+        class MigrationIssue < BaseType
+          description "Content Migrations. API Docs: https://canvas.instructure.com/doc/api/content_migrations.html"
+          field :id, ID, "the unique identifier for the issue.Example: 370663", null: true
+          field :content_migration_url, String, "API url to the content migration.Example: https://example.com/api/v1/courses/1/content_migrations/1", null: true
+          field :description, String, "Description of the issue for the end-user.Example: Questions in this quiz couldn't be converted", null: true
+          field :workflow_state, MigrationIssueWorkflowStateEnum, "Current state of the issue: active, resolved.Example: active", null: true
+          field :fix_issue_html_url, String, "HTML Url to the Canvas page to investigate the issue.Example: https://example.com/courses/1/quizzes/2", null: true
+          field :issue_type, MigrationIssueIssueTypeEnum, "Severity of the issue: todo, warning, error.Example: warning", null: true
+          field :error_report_html_url, String, "Link to a Canvas error report if present (If the requesting user has permissions).Example: https://example.com/error_reports/3", null: true
+          field :error_message, String, "Site administrator error message (If the requesting user has permissions).Example: admin only message", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "timestamp.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "timestamp.Example: 2012-06-01T00:00:00-06:00", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Migrator < BaseType
+          description "Content Migrations. API Docs: https://canvas.instructure.com/doc/api/content_migrations.html"
+          field :type, String, "The value to pass to the create endpoint.Example: common_cartridge_importer", null: true
+          field :requires_file_upload, Boolean, "Whether this endpoint requires a file upload.Example: true", null: true
+          field :name, String, "Description of the package type expected.Example: Common Cartridge 1.0/1.1/1.2 Package", null: true
+          field :required_settings, String, "A list of fields this system requires.Example: source_course_id", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require_relative "../canvas_base_type"
+require_relative "module_item"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ModuleWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "active"
+          value "deleted"
+        end
+
+                class ModuleStateEnum < ::GraphQL::Schema::Enum
+          value "locked"
+          value "unlocked"
+          value "started"
+          value "completed"
+        end
+        class Module < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :id, ID, "the unique identifier for the module.Example: 123", null: true
+          field :workflow_state, ModuleWorkflowStateEnum, "the state of the module: 'active', 'deleted'.Example: active", null: true
+          field :position, Int, "the position of this module in the course (1-based).Example: 2", null: true
+          field :name, String, "the name of this module.Example: Imaginary Numbers and You", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "(Optional) the date this module will unlock.Example: 2012-12-31T06:00:00-06:00", null: true
+          field :require_sequential_progress, Boolean, "Whether module items must be unlocked in order.Example: true", null: true
+          field :prerequisite_module_ids, [ID], "IDs of Modules that must be completed before this one is unlocked.Example: 121, 122", null: true
+          field :items_count, Int, "The number of items in the module.Example: 10", null: true
+          field :items_url, String, "The API URL to retrive this module's items.Example: https://canvas.example.com/api/v1/modules/123/items", null: true
+          field :items, [LMS::GraphQL::Types::Canvas::ModuleItem], "The contents of this module, as an array of Module Items. (Present only if requested via include[]=items AND the module is not deemed too large by Canvas.).", null: true
+          field :state, ModuleStateEnum, "The state of this Module for the calling user one of 'locked', 'unlocked', 'started', 'completed' (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).Example: started", null: true
+          field :completed_at, LMS::GraphQL::Types::DateTimeType, "the date the calling user completed the module (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).", null: true
+          field :publish_final_grade, Boolean, "if the student's final grade for the course should be published to the SIS upon completion of this module.", null: true
+          field :published, Boolean, "(Optional) Whether this module is published. This field is present only if the caller has permission to view unpublished modules..Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require_relative "../canvas_base_type"
+require_relative "completion_requirement"
+require_relative "content_detail"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ModuleItemTypeEnum < ::GraphQL::Schema::Enum
+          value "File"
+          value "Page"
+          value "Discussion"
+          value "Assignment"
+          value "Quiz"
+          value "SubHeader"
+          value "ExternalUrl"
+          value "ExternalTool"
+        end
+        class ModuleItem < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :id, ID, "the unique identifier for the module item.Example: 768", null: true
+          field :module_id, ID, "the id of the Module this item appears in.Example: 123", null: true
+          field :position, Int, "the position of this item in the module (1-based).Example: 1", null: true
+          field :title, String, "the title of this item.Example: Square Roots: Irrational numbers or boxy vegetables?", null: true
+          field :indent, Int, "0-based indent level; module items may be indented to show a hierarchy.Example: 0", null: true
+          field :type, ModuleItemTypeEnum, "the type of object referred to one of 'File', 'Page', 'Discussion', 'Assignment', 'Quiz', 'SubHeader', 'ExternalUrl', 'ExternalTool'.Example: Assignment", null: true
+          field :content_id, ID, "the id of the object referred to applies to 'File', 'Discussion', 'Assignment', 'Quiz', 'ExternalTool' types.Example: 1337", null: true
+          field :html_url, String, "link to the item in Canvas.Example: https://canvas.example.edu/courses/222/modules/items/768", null: true
+          field :url, String, "(Optional) link to the Canvas API object, if applicable.Example: https://canvas.example.edu/api/v1/courses/222/assignments/987", null: true
+          field :page_url, String, "(only for 'Page' type) unique locator for the linked wiki page.Example: my-page-title", null: true
+          field :external_url, String, "(only for 'ExternalUrl' and 'ExternalTool' types) external url that the item points to.Example: https://www.example.com/externalurl", null: true
+          field :new_tab, Boolean, "(only for 'ExternalTool' type) whether the external tool opens in a new tab.", null: true
+          field :completion_requirement, LMS::GraphQL::Types::Canvas::CompletionRequirement, "Completion requirement for this module item.Example: min_score, 10, true", null: true
+          field :content_details, LMS::GraphQL::Types::Canvas::ContentDetail, "(Present only if requested through include[]=content_details) If applicable, returns additional details specific to the associated object.Example: 20, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00", null: true
+          field :published, Boolean, "(Optional) Whether this module item is published. This field is present only if the caller has permission to view unpublished items..Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+require_relative "module_item_sequence_node"
+require_relative "module"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ModuleItemSequence < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :items, [LMS::GraphQL::Types::Canvas::ModuleItemSequenceNode], "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}}", null: true
+          field :modules, [LMS::GraphQL::Types::Canvas::Module], "an array containing each Module referenced above.Example: {'id'=>123, 'name'=>'Overview'}, {'id'=>127, 'name'=>'Imaginary Numbers'}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+require_relative "module_item"
+require_relative "module_item"
+require_relative "module_item"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ModuleItemSequenceNode < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :prev, LMS::GraphQL::Types::Canvas::ModuleItem, "The previous ModuleItem in the sequence.", null: true
+          field :current, LMS::GraphQL::Types::Canvas::ModuleItem, "The ModuleItem being queried.Example: 768, 123, A lonely page, Page", null: true
+          field :next, LMS::GraphQL::Types::Canvas::ModuleItem, "The next ModuleItem in the sequence.Example: 769, 127, Project 1, Assignment", null: true
+          field :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", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class NeedsGradingCount < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :section_id, ID, "The section ID.Example: 123456", null: true
+          field :needs_grading_count, Int, "Number of submissions that need grading.Example: 5", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class NotificationPreferenceFrequencyEnum < ::GraphQL::Schema::Enum
+          value "immediately"
+          value "daily"
+          value "weekly"
+          value "never"
+        end
+        class NotificationPreference < BaseType
+          description "Notification Preferences. API Docs: https://canvas.instructure.com/doc/api/notification_preferences.html"
+          field :href, String, "Example: https://canvas.instructure.com/users/1/communication_channels/email/student@example.edu/notification_preferences/new_announcement", null: true
+          field :notification, String, "The notification this preference belongs to.Example: new_announcement", null: true
+          field :category, String, "The category of that notification.Example: announcement", null: true
+          field :frequency, NotificationPreferenceFrequencyEnum, "How often to send notifications to this communication channel for the given notification. Possible values are 'immediately', 'daily', 'weekly', and 'never'.Example: daily", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+require_relative "tool_setting"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OriginalityReport < BaseType
+          description "Originality Reports. API Docs: https://canvas.instructure.com/doc/api/originality_reports.html"
+          field :id, ID, "The id of the OriginalityReport.Example: 4", null: true
+          field :file_id, ID, "The id of the file receiving the originality score.Example: 8", null: true
+          field :originality_score, Float, "A number between 0 and 100 representing the originality score.Example: 0.16", null: true
+          field :originality_report_file_id, ID, "The ID of the file within Canvas containing the originality report document (if provided).Example: 23", null: true
+          field :originality_report_url, String, "A non-LTI launch URL where the originality score of the file may be found..Example: http://www.example.com/report", null: true
+          field :tool_setting, String, "A ToolSetting object containing optional 'resource_type_code' and 'resource_url'.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require_relative "../canvas_base_type"
+require_relative "rubric_rating"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeCalculationMethodEnum < ::GraphQL::Schema::Enum
+          value "decaying_average"
+          value "n_mastery"
+          value "latest"
+          value "highest"
+        end
+        class Outcome < BaseType
+          description "Outcomes. API Docs: https://canvas.instructure.com/doc/api/outcomes.html"
+          field :id, ID, "the ID of the outcome.Example: 1", null: true
+          field :url, String, "the URL for fetching/updating the outcome. should be treated as opaque.Example: /api/v1/outcomes/1", null: true
+          field :context_id, ID, "the context owning the outcome. may be null for global outcomes.Example: 1", null: true
+          field :context_type, String, "Example: Account", null: true
+          field :title, String, "title of the outcome.Example: Outcome title", null: true
+          field :display_name, String, "Optional friendly name for reporting.Example: My Favorite Outcome", null: true
+          field :description, String, "description of the outcome. omitted in the abbreviated form..Example: Outcome description", null: true
+          field :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", null: true
+          field :points_possible, Int, "maximum points possible. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..Example: 5", null: true
+          field :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", null: true
+          field :calculation_method, OutcomeCalculationMethodEnum, "the method used to calculate a students score.Example: decaying_average", null: true
+          field :calculation_int, Int, "this defines the variable value used by the calculation_method. included only if calculation_method uses it.Example: 75", null: true
+          field :ratings, [LMS::GraphQL::Types::Canvas::RubricRating], "possible ratings for this outcome. included only if the outcome embeds a rubric criterion. omitted in the abbreviated form..", null: true
+          field :can_edit, Boolean, "whether the current user can update the outcome.Example: true", null: true
+          field :can_unlink, Boolean, "whether the outcome can be unlinked.Example: true", null: true
+          field :assessed, Boolean, "whether this outcome has been used to assess a student.Example: true", null: true
+          field :has_updateable_rubrics, Boolean, "whether updates to this outcome will propagate to unassessed rubrics that have imported it.Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeAlignment < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :id, ID, "A unique identifier for this alignment.Example: quiz_3", null: true
+          field :name, String, "The name of this alignment.Example: Big mid-term test", null: true
+          field :html_url, String, "(Optional) A URL for details about this alignment.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_group"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeGroup < BaseType
+          description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
+          field :id, ID, "the ID of the outcome group.Example: 1", null: true
+          field :url, String, "the URL for fetching/updating the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1", null: true
+          field :parent_outcome_group, LMS::GraphQL::Types::Canvas::OutcomeGroup, "an abbreviated OutcomeGroup object representing the parent group of this outcome group, if any. omitted in the abbreviated form..", null: true
+          field :context_id, ID, "the context owning the outcome group. may be null for global outcome groups. omitted in the abbreviated form..Example: 1", null: true
+          field :context_type, String, "Example: Account", null: true
+          field :title, String, "title of the outcome group.Example: Outcome group title", null: true
+          field :description, String, "description of the outcome group. omitted in the abbreviated form..Example: Outcome group description", null: true
+          field :vendor_guid, String, "A custom GUID for the learning standard..Example: customid9000", null: true
+          field :subgroups_url, String, "the URL for listing/creating subgroups under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/subgroups", null: true
+          field :outcomes_url, String, "the URL for listing/creating outcome links under the outcome group. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes", null: true
+          field :import_url, String, "the URL for importing another group into this outcome group. should be treated as opaque. omitted in the abbreviated form..Example: /api/v1/accounts/1/outcome_groups/1/import", null: true
+          field :can_edit, Boolean, "whether the current user can update the outcome group.Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_import_datum"
+require_relative "user"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeImportWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "importing"
+          value "succeeded"
+          value "failed"
+        end
+        class OutcomeImport < BaseType
+          description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+          field :id, ID, "The unique identifier for the outcome import..Example: 1", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The date the outcome import was created..Example: 2013-12-01T23:59:00-06:00", null: true
+          field :ended_at, LMS::GraphQL::Types::DateTimeType, "The date the outcome 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 outcome import was last updated..Example: 2013-12-02T00:03:21-06:00", null: true
+          field :workflow_state, OutcomeImportWorkflowStateEnum, "The current state of the outcome import.
+ - 'created': The outcome import has been created.
+ - 'importing': The outcome import is currently processing.
+ - 'succeeded': The outcome import has completed successfully.
+ - 'failed': The outcome import failed..Example: imported", null: true
+          field :data, LMS::GraphQL::Types::Canvas::OutcomeImportDatum, "See the OutcomeImportData specification above..", null: true
+          field :progress, String, "The progress of the outcome import..Example: 100", null: true
+          field :user, LMS::GraphQL::Types::Canvas::User, "The user that initiated the outcome_import. See the Users API for details..", null: true
+          field :processing_errors, String, "An array of row number / error message pairs. Returns the first 25 errors..Example: 1, Missing required fields: title", null: true
+
+        end
+      end
+    end
+  end
+end