lms-graphql-api 0.1.0

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeImportDatum < BaseType
+          description "Outcome Imports. API Docs: https://canvas.instructure.com/doc/api/outcome_imports.html"
+          field :import_type, String, "The type of outcome import.Example: instructure_csv", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_group"
+require_relative "outcome"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeLink < BaseType
+          description "Outcome Groups. API Docs: https://canvas.instructure.com/doc/api/outcome_groups.html"
+          field :url, String, "the URL for fetching/updating the outcome link. should be treated as opaque.Example: /api/v1/accounts/1/outcome_groups/1/outcomes/1", null: true
+          field :context_id, ID, "the context owning the outcome link. will match the context owning the outcome group containing the outcome link; included for convenience. may be null for links in global outcome groups..Example: 1", null: true
+          field :context_type, String, "Example: Account", null: true
+          field :outcome_group, LMS::GraphQL::Types::Canvas::OutcomeGroup, "an abbreviated OutcomeGroup object representing the group containing the outcome link..", null: true
+          field :outcome, LMS::GraphQL::Types::Canvas::Outcome, "an abbreviated Outcome object representing the outcome linked into the containing outcome group..", null: true
+          field :assessed, Boolean, "whether this outcome has been used to assess a student in the context of this outcome link.  In other words, this will be set to true if the context is a course, and a student has been assessed with this outcome in that course..Example: true", null: true
+          field :can_unlink, Boolean, "whether this outcome link is manageable and is not the last link to an aligned outcome.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_path_part"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomePath < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :id, ID, "A unique identifier for this outcome.Example: 42", null: true
+          field :parts, LMS::GraphQL::Types::Canvas::OutcomePathPart, "an array of OutcomePathPart objects.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomePathPart < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :name, String, "The title of the outcome or outcome group.Example: Spelling out numbers", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeResult < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :id, ID, "A unique identifier for this result.Example: 42", null: true
+          field :score, Int, "The student's score.Example: 6", null: true
+          field :submitted_or_assessed_at, LMS::GraphQL::Types::DateTimeType, "The datetime the resulting OutcomeResult was submitted at, or absent that, when it was assessed..Example: 2013-02-01T00:00:00-06:00", null: true
+          field :links, String, "Unique identifiers of objects associated with this result.Example: 3, 97, 53", null: true
+          field :percent, Float, "score's percent of maximum points possible for outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.Example: 0.65", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_rollup_score"
+require_relative "outcome_rollup_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeRollup < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :scores, LMS::GraphQL::Types::Canvas::OutcomeRollupScore, "an array of OutcomeRollupScore objects.", null: true
+          field :name, String, "The name of the resource for this rollup. For example, the user name..Example: John Doe", null: true
+          field :links, LMS::GraphQL::Types::Canvas::OutcomeRollupLink, "Example: 42, 42, 57", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeRollupLink < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :course, Int, "If an aggregate result was requested, the course field will be present. Otherwise, the user and section field will be present (Optional) The id of the course that this rollup applies to.Example: 42", null: true
+          field :user, Int, "(Optional) The id of the user that this rollup applies to.Example: 42", null: true
+          field :section, Int, "(Optional) The id of the section the user is in.Example: 57", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+require_relative "outcome_rollup_score_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeRollupScore < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :score, Int, "The rollup score for the outcome, based on the student alignment scores related to the outcome. This could be null if the student has no related scores..Example: 3", null: true
+          field :count, Int, "The number of alignment scores included in this rollup..Example: 6", null: true
+          field :links, LMS::GraphQL::Types::Canvas::OutcomeRollupScoreLink, "Example: 42", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class OutcomeRollupScoreLink < BaseType
+          description "Outcome Results. API Docs: https://canvas.instructure.com/doc/api/outcome_results.html"
+          field :outcome, Int, "The id of the related outcome.Example: 42", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative "../canvas_base_type"
+require_relative "user"
+require_relative "lock_info"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Page < BaseType
+          description "Pages. API Docs: https://canvas.instructure.com/doc/api/pages.html"
+          field :url, String, "the unique locator for the page.Example: my-page-title", null: true
+          field :title, String, "the title of the page.Example: My Page Title", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "the creation date for the page.Example: 2012-08-06T16:46:33-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "the date the page was last updated.Example: 2012-08-08T14:25:20-06:00", null: true
+          field :hide_from_students, Boolean, "(DEPRECATED) whether this page is hidden from students (note: this is always reflected as the inverse of the published value).", null: true
+          field :editing_roles, String, "roles allowed to edit the page; comma-separated list comprising a combination of 'teachers', 'students', 'members', and/or 'public' if not supplied, course defaults are used.Example: teachers,students", null: true
+          field :last_edited_by, LMS::GraphQL::Types::Canvas::User, "the User who last edited the page (this may not be present if the page was imported from another system).", null: true
+          field :body, String, "the page content, in HTML (present when requesting a single page; omitted when listing pages).Example: <p>Page Content</p>", null: true
+          field :published, Boolean, "whether the page is published (true) or draft state (false)..Example: true", null: true
+          field :front_page, Boolean, "whether this page is the front page for the wiki.", null: true
+          field :locked_for_user, Boolean, "Whether or not this is locked for the user..", null: true
+          field :lock_info, LMS::GraphQL::Types::Canvas::LockInfo, "(Optional) Information for the user about the lock. Present when locked_for_user is true..", null: true
+          field :lock_explanation, String, "(Optional) An explanation of why this is locked for the user. Present when locked_for_user is true..Example: This page is locked until September 1 at 12:00am", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+require_relative "user"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PageRevision < BaseType
+          description "Pages. API Docs: https://canvas.instructure.com/doc/api/pages.html"
+          field :revision_id, ID, "an identifier for this revision of the page.Example: 7", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "the time when this revision was saved.Example: 2012-08-07T11:23:58-06:00", null: true
+          field :latest, Boolean, "whether this is the latest revision or not.Example: true", null: true
+          field :edited_by, LMS::GraphQL::Types::Canvas::User, "the User who saved this revision, if applicable (this may not be present if the page was imported from another system).", null: true
+          field :url, String, "the following fields are not included in the index action and may be omitted from the show action via summary=1 the historic url of the page.Example: old-page-title", null: true
+          field :title, String, "the historic page title.Example: Old Page Title", null: true
+          field :body, String, "the historic page contents.Example: <p>Old Page Content</p>", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative "../canvas_base_type"
+require_relative "page_view_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PageView < BaseType
+          description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+          field :id, ID, "A UUID representing the page view.  This is also the unique request id.Example: 3e246700-e305-0130-51de-02e33aa501ef", null: true
+          field :app_name, String, "If the request is from an API request, the app that generated the access token.Example: Canvas for iOS", null: true
+          field :url, String, "The URL requested.Example: https://canvas.instructure.com/conversations", null: true
+          field :context_type, String, "The type of context for the request.Example: Course", null: true
+          field :asset_type, String, "The type of asset in the context for the request, if any.Example: Discussion", null: true
+          field :controller, String, "The rails controller that handled the request.Example: discussions", null: true
+          field :action, String, "The rails action that handled the request.Example: index", null: true
+          field :contributed, Boolean, "This field is deprecated, and will always be false.Example: false", null: true
+          field :interaction_seconds, Float, "An approximation of how long the user spent on the page, in seconds.Example: 7.21", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "When the request was made.Example: 2013-10-01T19:49:47Z", null: true
+          field :user_request, Boolean, "A flag indicating whether the request was user-initiated, or automatic (such as an AJAX call).Example: true", null: true
+          field :render_time, Float, "How long the response took to render, in seconds.Example: 0.369", null: true
+          field :user_agent, String, "The user-agent of the browser or program that made the request.Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/536.30.1 (KHTML, like Gecko) Version/6.0.5 Safari/536.30.1", null: true
+          field :participated, Boolean, "True if the request counted as participating, such as submitting homework.Example: false", null: true
+          field :http_method, String, "The HTTP method such as GET or POST.Example: GET", null: true
+          field :remote_ip, String, "The origin IP address of the request.Example: 173.194.46.71", null: true
+          field :links, LMS::GraphQL::Types::Canvas::PageViewLink, "The page view links to define the relationships.Example: 1234, 1234", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PageViewLink < BaseType
+          description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+          field :user, Int, "The ID of the user for this page view.Example: 1234", null: true
+          field :context, Int, "The ID of the context for the request (course id if context_type is Course, etc).Example: 1234", null: true
+          field :asset, Int, "The ID of the asset for the request, if any.Example: 1234", null: true
+          field :real_user, Int, "The ID of the actual user who made this request, if the request was made by a user who was masquerading.Example: 1234", null: true
+          field :account, Int, "The ID of the account context for this page view.Example: 1234", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PeerReview < BaseType
+          description "Peer Reviews. API Docs: https://canvas.instructure.com/doc/api/peer_reviews.html"
+          field :assessor_id, ID, "The assessors user id.Example: 23", null: true
+          field :asset_id, ID, "The id for the asset associated with this Peer Review.Example: 13", null: true
+          field :asset_type, String, "The type of the asset.Example: Submission", null: true
+          field :id, ID, "The id of the Peer Review.Example: 1", null: true
+          field :user_id, ID, "The user id for the owner of the asset.Example: 7", null: true
+          field :workflow_state, String, "The state of the Peer Review, either 'assigned' or 'completed'.Example: assigned", null: true
+          field :user, String, "the User object for the owner of the asset if the user include parameter is provided (see user API) (optional).Example: User", null: true
+          field :assessor, String, "The User object for the assessor if the user include parameter is provided (see user API) (optional).Example: User", null: true
+          field :submission_comments, String, "The submission comments associated with this Peer Review if the submission_comment include parameter is provided (see submissions API) (optional).Example: SubmissionComment", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PlannerNote < BaseType
+          description "Planner Note. API Docs: https://canvas.instructure.com/doc/api/planner_note.html"
+          field :id, ID, "The ID of the planner note.Example: 234", null: true
+          field :title, String, "The title for a planner note.Example: Bring books tomorrow", null: true
+          field :description, String, "The description of the planner note.Example: I need to bring books tomorrow for my course on biology", null: true
+          field :user_id, ID, "The id of the associated user creating the planner note.Example: 1578941", null: true
+          field :workflow_state, String, "The current published state of the planner note.Example: active", null: true
+          field :course_id, ID, "The course that the note is in relation too, if applicable.Example: 1578941", null: true
+          field :todo_date, LMS::GraphQL::Types::DateTimeType, "The datetime of when the planner note should show up on their planner.Example: 2017-05-09T10:12:00Z", null: true
+          field :linked_object_type, String, "the type of the linked learning object.Example: assignment", null: true
+          field :linked_object_id, ID, "the id of the linked learning object.Example: 131072", null: true
+          field :linked_object_html_url, String, "the Canvas web URL of the linked learning object.Example: https://canvas.example.com/courses/1578941/assignments/131072", null: true
+          field :linked_object_url, String, "the API URL of the linked learning object.Example: https://canvas.example.com/api/v1/courses/1578941/assignments/131072", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PlannerOverride < BaseType
+          description "Planner override. API Docs: https://canvas.instructure.com/doc/api/planner_override.html"
+          field :id, ID, "The ID of the planner override.Example: 234", null: true
+          field :plannable_type, String, "The type of the associated object for the planner override.Example: Assignment", null: true
+          field :plannable_id, ID, "The id of the associated object for the planner override.Example: 1578941", null: true
+          field :user_id, ID, "The id of the associated user for the planner override.Example: 1578941", null: true
+          field :workflow_state, String, "The current published state of the item, synced with the associated object.Example: published", null: true
+          field :marked_complete, Boolean, "Controls whether or not the associated plannable item is marked complete on the planner.", null: true
+          field :dismissed, Boolean, "Controls whether or not the associated plannable item shows up in the opportunities list.", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The datetime of when the planner override was created.Example: 2017-05-09T10:12:00Z", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "The datetime of when the planner override was updated.Example: 2017-05-09T10:12:00Z", null: true
+          field :deleted_at, LMS::GraphQL::Types::DateTimeType, "The datetime of when the planner override was deleted, if applicable.Example: 2017-05-15T12:12:00Z", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Poll < BaseType
+          description "Polls. API Docs: https://canvas.instructure.com/doc/api/polls.html"
+          field :id, ID, "The unique identifier for the poll..Example: 1023", null: true
+          field :question, String, "The question/title of the poll..Example: What do you consider most important to your learning in this course?", null: true
+          field :description, String, "A short description of the poll..Example: This poll is to determine what priorities the students in the course have.", null: true
+          field :created_at, String, "The time at which the poll was created..Example: 2014-01-07T15:16:18Z", null: true
+          field :user_id, ID, "The unique identifier for the user that created the poll..Example: 105", null: true
+          field :total_results, String, "An aggregate of the results of all associated poll sessions, with the poll choice id as the key, and the aggregated submission count as the value..Example: 20, 5, 17", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PollChoice < BaseType
+          description "PollChoices. API Docs: https://canvas.instructure.com/doc/api/poll_choices.html"
+          field :id, ID, "The unique identifier for the poll choice..Example: 1023", null: true
+          field :poll_id, ID, "The id of the poll this poll choice belongs to..Example: 1779", null: true
+          field :is_correct, Boolean, "Specifies whether or not this poll choice is a 'correct' choice..Example: true", null: true
+          field :text, String, "The text of the poll choice..Example: Choice A", null: true
+          field :position, Int, "The order of the poll choice in relation to it's sibling poll choices..Example: 1", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+require_relative "poll_submission"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PollSession < BaseType
+          description "Poll Sessions. API Docs: https://canvas.instructure.com/doc/api/poll_sessions.html"
+          field :id, ID, "The unique identifier for the poll session..Example: 1023", null: true
+          field :poll_id, ID, "The id of the Poll this poll session is associated with.Example: 55", null: true
+          field :course_id, ID, "The id of the Course this poll session is associated with.Example: 1111", null: true
+          field :course_section_id, ID, "The id of the Course Section this poll session is associated with.Example: 444", null: true
+          field :is_published, Boolean, "Specifies whether or not this poll session has been published for students to participate in..Example: true", null: true
+          field :has_public_results, Boolean, "Specifies whether the results are viewable by students..Example: true", null: true
+          field :created_at, String, "The time at which the poll session was created..Example: 2014-01-07T15:16:18Z", null: true
+          field :results, String, "The results of the submissions of the poll. Each key is the poll choice id, and the value is the count of submissions..Example: 10, 3, 27, 8", null: true
+          field :poll_submissions, LMS::GraphQL::Types::Canvas::PollSubmission, "If the poll session has public results, this will return an array of all submissions, viewable by both students and teachers. If the results are not public, for students it will return their submission only..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class PollSubmission < BaseType
+          description "PollSubmissions. API Docs: https://canvas.instructure.com/doc/api/poll_submissions.html"
+          field :id, ID, "The unique identifier for the poll submission..Example: 1023", null: true
+          field :poll_choice_id, ID, "The unique identifier of the poll choice chosen for this submission..Example: 155", null: true
+          field :user_id, ID, "the unique identifier of the user who submitted this poll submission..Example: 4555", null: true
+          field :created_at, String, "The date and time the poll submission was submitted..Example: 2013-11-07T13:16:18Z", null: true
+
+        end
+      end
+    end
+  end
+end