lms-graphql-api 0.1.0

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

@@ -0,0 +1,30 @@
+require_relative "../canvas_base_type"
+require_relative "conference_recording"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Conference < BaseType
+          description "Conferences. API Docs: https://canvas.instructure.com/doc/api/conferences.html"
+          field :id, ID, "The id of the conference.Example: 170", null: true
+          field :conference_type, String, "The type of conference.Example: AdobeConnect", null: true
+          field :conference_key, String, "The 3rd party's ID for the conference.Example: abcdjoelisgreatxyz", null: true
+          field :description, String, "The description for the conference.Example: Conference Description", null: true
+          field :duration, Int, "The expected duration the conference is supposed to last.Example: 60", null: true
+          field :ended_at, LMS::GraphQL::Types::DateTimeType, "The date that the conference ended at, null if it hasn't ended.Example: 2013-12-13T17:23:26Z", null: true
+          field :started_at, LMS::GraphQL::Types::DateTimeType, "The date the conference started at, null if it hasn't started.Example: 2013-12-12T23:02:17Z", null: true
+          field :title, String, "The title of the conference.Example: Test conference", null: true
+          field :users, Int, "Array of user ids that are participants in the conference.Example: 1, 7, 8, 9, 10", null: true
+          field :has_advanced_settings, Boolean, "True if the conference type has advanced settings..", null: true
+          field :long_running, Boolean, "If true the conference is long running and has no expected end time.", null: true
+          field :user_settings, String, "A collection of settings specific to the conference type.Example: true", null: true
+          field :recordings, [LMS::GraphQL::Types::Canvas::ConferenceRecording], "A List of recordings for the conference.", null: true
+          field :url, String, "URL for the conference, may be null if the conference type doesn't set it.", null: true
+          field :join_url, String, "URL to join the conference, may be null if the conference type doesn't set it.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ConferenceRecording < BaseType
+          description "Conferences. API Docs: https://canvas.instructure.com/doc/api/conferences.html"
+          field :duration_minutes, Int, "Example: 0", null: true
+          field :title, String, "Example: course2: Test conference 3 [170]_0", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "Example: 2013-12-12T16:09:33.903-07:00", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "Example: 2013-12-12T16:09:09.960-07:00", null: true
+          field :playback_url, String, "Example: http://example.com/recording_url", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+require_relative "lock_info"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ContentDetail < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :points_possible, Int, "Example: 20", null: true
+          field :due_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-12-31T06:00:00-06:00", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-12-31T06:00:00-06:00", null: true
+          field :lock_at, LMS::GraphQL::Types::DateTimeType, "Example: 2012-12-31T06:00:00-06:00", null: true
+          field :locked_for_user, Boolean, "Example: true", null: true
+          field :lock_explanation, String, "Example: This quiz is part of an unpublished module and is not available yet.", null: true
+          field :lock_info, LMS::GraphQL::Types::Canvas::LockInfo, "Example: assignment_4, 2012-12-31T06:00:00-06:00, 2012-12-31T06:00:00-06:00, {}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative "../canvas_base_type"
+require_relative "file"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ContentExportExportTypeEnum < ::GraphQL::Schema::Enum
+          value "common_cartridge"
+          value "qti"
+        end
+
+                class ContentExportWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "exporting"
+          value "exported"
+          value "failed"
+        end
+        class ContentExport < BaseType
+          description "Content Exports. API Docs: https://canvas.instructure.com/doc/api/content_exports.html"
+          field :id, ID, "the unique identifier for the export.Example: 101", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "the date and time this export was requested.Example: 2014-01-01T00:00:00Z", null: true
+          field :export_type, ContentExportExportTypeEnum, "the type of content migration: 'common_cartridge' or 'qti'.Example: common_cartridge", null: true
+          field :attachment, LMS::GraphQL::Types::Canvas::File, "attachment api object for the export package (not present before the export completes or after it becomes unavailable for download.).Example: https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh", null: true
+          field :progress_url, String, "The api endpoint for polling the current progress.Example: https://example.com/api/v1/progress/4", null: true
+          field :user_id, ID, "The ID of the user who started the export.Example: 4", null: true
+          field :workflow_state, ContentExportWorkflowStateEnum, "Current state of the content migration: created exporting exported failed.Example: exported", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ContentMigrationWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "pre_processing"
+          value "pre_processed"
+          value "running"
+          value "waiting_for_select"
+          value "completed"
+          value "failed"
+        end
+        class ContentMigration < BaseType
+          description "Content Migrations. API Docs: https://canvas.instructure.com/doc/api/content_migrations.html"
+          field :id, ID, "the unique identifier for the migration.Example: 370663", null: true
+          field :migration_type, String, "the type of content migration.Example: common_cartridge_importer", null: true
+          field :migration_type_title, String, "the name of the content migration type.Example: Canvas Cartridge Importer", null: true
+          field :migration_issues_url, String, "API url to the content migration's issues.Example: https://example.com/api/v1/courses/1/content_migrations/1/migration_issues", null: true
+          field :attachment, String, "attachment api object for the uploaded file may not be present for all migrations.Example: {'url'=>'https://example.com/api/v1/courses/1/content_migrations/1/download_archive'}", null: true
+          field :progress_url, String, "The api endpoint for polling the current progress.Example: https://example.com/api/v1/progress/4", null: true
+          field :user_id, ID, "The user who started the migration.Example: 4", null: true
+          field :workflow_state, ContentMigrationWorkflowStateEnum, "Current state of the content migration: pre_processing, pre_processed, running, waiting_for_select, completed, failed.Example: running", null: true
+          field :started_at, LMS::GraphQL::Types::DateTimeType, "timestamp.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :finished_at, LMS::GraphQL::Types::DateTimeType, "timestamp.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :pre_attachment, String, "file uploading data, see {file:file_uploads.html File Upload Documentation} for file upload workflow This works a little differently in that all the file data is in the pre_attachment hash if there is no upload_url then there was an attachment pre-processing error, the error message will be in the message key This data will only be here after a create or update call.Example: {'upload_url'=>'', 'message'=>'file exceeded quota', 'upload_params'=>{}}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require_relative "../canvas_base_type"
+require_relative "conversation_participant"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Conversation < BaseType
+          description "Conversations. API Docs: https://canvas.instructure.com/doc/api/conversations.html"
+          field :id, ID, "the unique identifier for the conversation..Example: 2", null: true
+          field :subject, String, "the subject of the conversation..Example: 2", null: true
+          field :workflow_state, String, "The current state of the conversation (read, unread or archived)..Example: unread", null: true
+          field :last_message, String, "A <=100 character preview from the most recent message..Example: sure thing, here's the file", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "the date and time at which the last message was sent..Example: 2011-09-02T12:00:00Z", null: true
+          field :message_count, Int, "the number of messages in the conversation..Example: 2", null: true
+          field :subscribed, Boolean, "whether the current user is subscribed to the conversation..Example: true", null: true
+          field :private, Boolean, "whether the conversation is private..Example: true", null: true
+          field :starred, Boolean, "whether the conversation is starred..Example: true", null: true
+          field :properties, String, "Additional conversation flags (last_author, attachments, media_objects). Each listed property means the flag is set to true (i.e. the current user is the most recent author, there are attachments, or there are media objects).", null: true
+          field :audience, Int, "Array of user ids who are involved in the conversation, ordered by participation level, then alphabetical. Excludes current user, unless this is a monologue..", null: true
+          field :audience_contexts, String, "Most relevant shared contexts (courses and groups) between current user and other participants. If there is only one participant, it will also include that user's enrollment(s)/ membership type(s) in each course/group..", null: true
+          field :avatar_url, String, "URL to appropriate icon for this conversation (custom, individual or group avatar, depending on audience)..Example: https://canvas.instructure.com/images/messages/avatar-group-50.png", null: true
+          field :participants, [LMS::GraphQL::Types::Canvas::ConversationParticipant], "Array of users participating in the conversation. Includes current user..", null: true
+          field :visible, Boolean, "indicates whether the conversation is visible under the current scope and filter. This attribute is always true in the index API response, and is primarily useful in create/update responses so that you can know if the record should be displayed in the UI. The default scope is assumed, unless a scope or filter is passed to the create/update API call..Example: true", null: true
+          field :context_name, String, "Name of the course or group in which the conversation is occurring..Example: Canvas 101", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ConversationParticipant < BaseType
+          description "Conversations. API Docs: https://canvas.instructure.com/doc/api/conversations.html"
+          field :id, ID, "The user ID for the participant..Example: 2", null: true
+          field :name, String, "A short name the user has selected, for use in conversations or other less formal places through the site..Example: Shelly", null: true
+          field :full_name, String, "The full name of the user..Example: Sheldon Cooper", null: true
+          field :avatar_url, String, "If requested, this field will be included and contain a url to retrieve the user's avatar..Example: https://canvas.instructure.com/images/messages/avatar-50.png", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require_relative "../canvas_base_type"
+require_relative "enrollment"
+require_relative "calendar_link"
+require_relative "term"
+require_relative "course_progress"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "unpublished"
+          value "available"
+          value "completed"
+          value "deleted"
+        end
+
+                class CourseDefaultViewEnum < ::GraphQL::Schema::Enum
+          value "feed"
+          value "wiki"
+          value "modules"
+          value "syllabus"
+          value "assignments"
+        end
+        class Course < BaseType
+          description "Courses. API Docs: https://canvas.instructure.com/doc/api/courses.html"
+          field :id, ID, "the unique identifier for the course.Example: 370663", null: true
+          field :sis_course_id, ID, "the SIS identifier for the course, if defined. This field is only included if the user has permission to view SIS information..", null: true
+          field :uuid, String, "the UUID of the course.Example: WvAHhY5FINzq5IyRIJybGeiXyFkG3SqHUPb7jZY5", null: true
+          field :integration_id, ID, "the integration identifier for the course, if defined. This field is only included if the user has permission to 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..Example: 34", null: true
+          field :name, String, "the full name of the course.Example: InstructureCon 2012", null: true
+          field :course_code, String, "the course code.Example: INSTCON12", null: true
+          field :workflow_state, CourseWorkflowStateEnum, "the current state of the course one of 'unpublished', 'available', 'completed', or 'deleted'.Example: available", null: true
+          field :account_id, ID, "the account associated with the course.Example: 81259", null: true
+          field :root_account_id, ID, "the root account associated with the course.Example: 81259", null: true
+          field :enrollment_term_id, ID, "the enrollment term associated with the course.Example: 34", null: true
+          field :grading_standard_id, ID, "the grading standard associated with the course.Example: 25", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "the start date for the course, if applicable.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :end_at, LMS::GraphQL::Types::DateTimeType, "the end date for the course, if applicable.Example: 2012-09-01T00:00:00-06:00", null: true
+          field :locale, String, "the course-set locale, if applicable.Example: en", null: true
+          field :enrollments, [LMS::GraphQL::Types::Canvas::Enrollment], "A list of enrollments linking the current user to the course. for student enrollments, grading information may be included if include[]=total_scores.", null: true
+          field :total_students, Int, "optional: the total number of active and invited students in the course.Example: 32", null: true
+          field :calendar, LMS::GraphQL::Types::Canvas::CalendarLink, "course calendar.", null: true
+          field :default_view, CourseDefaultViewEnum, "the type of page that users will see when they first visit the course - 'feed': Recent Activity Dashboard - 'wiki': Wiki Front Page - 'modules': Course Modules/Sections Page - 'assignments': Course Assignments List - 'syllabus': Course Syllabus Page other types may be added in the future.Example: feed", null: true
+          field :syllabus_body, String, "optional: user-generated HTML for the course syllabus.Example: <p>syllabus html goes here</p>", null: true
+          field :needs_grading_count, Int, "optional: the number of submissions needing grading returned only if the current user has grading rights and include[]=needs_grading_count.Example: 17", null: true
+          field :term, LMS::GraphQL::Types::Canvas::Term, "optional: the enrollment term object for the course returned only if include[]=term.", null: true
+          field :course_progress, LMS::GraphQL::Types::Canvas::CourseProgress, "optional (beta): information on progress through the course returned only if include[]=course_progress.", null: true
+          field :apply_assignment_group_weights, Boolean, "weight final grade based on assignment group percentages.Example: true", null: true
+          field :permissions, String, "optional: the permissions the user has for the course. returned only for a single course and include[]=permissions.Example: true, true", null: true
+          field :is_public, Boolean, "Example: true", null: true
+          field :is_public_to_auth_users, Boolean, "Example: true", null: true
+          field :public_syllabus, Boolean, "Example: true", null: true
+          field :public_syllabus_to_auth, Boolean, "Example: true", null: true
+          field :public_description, String, "optional: the public description of the course.Example: Come one, come all to InstructureCon 2012!", null: true
+          field :storage_quota_mb, Int, "Example: 5", null: true
+          field :storage_quota_used_mb, Float, "Example: 5", null: true
+          field :hide_final_grades, Boolean, "", null: true
+          field :license, String, "Example: Creative Commons", null: true
+          field :allow_student_assignment_edits, Boolean, "", null: true
+          field :allow_wiki_comments, Boolean, "", null: true
+          field :allow_student_forum_attachments, Boolean, "", null: true
+          field :open_enrollment, Boolean, "Example: true", null: true
+          field :self_enrollment, Boolean, "", null: true
+          field :restrict_enrollments_to_course_dates, Boolean, "", null: true
+          field :course_format, String, "Example: online", null: true
+          field :access_restricted_by_date, Boolean, "optional: this will be true if this user is currently prevented from viewing the course because of date restriction settings.", null: true
+          field :time_zone, String, "The course's IANA time zone name..Example: America/Denver", null: true
+          field :blueprint, Boolean, "optional: whether the course is set as a Blueprint Course (blueprint fields require the Blueprint Courses feature).Example: true", null: true
+          field :blueprint_restrictions, String, "optional: Set of restrictions applied to all locked course objects.Example: true, true, false, false", null: true
+          field :blueprint_restrictions_by_object_type, String, "optional: Sets of restrictions differentiated by object type applied to locked course objects.Example: {'content'=>true, 'points'=>true}, {'content'=>true}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseAttribute < BaseType
+          description "SIS Integration. API Docs: https://canvas.instructure.com/doc/api/sis_integration.html"
+          field :id, ID, "The unique Canvas identifier for the origin course.Example: 7", null: true
+          field :name, String, "The name of the origin course..Example: Section A", null: true
+          field :sis_id, ID, "The sis id of the origin_course..Example: c34643", null: true
+          field :integration_id, ID, "The integration ID of the origin_course..Example: I-2", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+require_relative "epub_export"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseEpubExport < BaseType
+          description "ePub Exports. API Docs: https://canvas.instructure.com/doc/api/e_pub_exports.html"
+          field :id, ID, "the unique identifier for the course.Example: 101", null: true
+          field :name, String, "the name for the course.Example: Maths 101", null: true
+          field :epub_export, LMS::GraphQL::Types::Canvas::EpubExport, "ePub export API object.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+require_relative "course_event_link"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseEvent < BaseType
+          description "Course Audit log. API Docs: https://canvas.instructure.com/doc/api/course_audit_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, "Course event type The event type defines the type and schema of the event_data object..Example: updated", null: true
+          field :event_data, String, "Course event data depending on the event type.  This will return an object containing the relevant event data.  An updated event type will return an UpdatedEventData object..Example: {}", null: true
+          field :event_source, String, "Course event source depending on the event type.  This will return a string containing the source of the event..Example: manual|sis|api", null: true
+          field :links, LMS::GraphQL::Types::Canvas::CourseEventLink, "Jsonapi.org links.Example: 12345, 12345, e2b76430-27a5-0131-3ca1-48e0eb13f29b", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseEventLink < BaseType
+          description "Course Audit log. API Docs: https://canvas.instructure.com/doc/api/course_audit_log.html"
+          field :course, Int, "ID of the course for the event..Example: 12345", null: true
+          field :user, Int, "ID of the user for the event (who made the change)..Example: 12345", 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
+          field :copied_from, Int, "ID of the course that this course was copied from. This is only included if the event_type is copied_from..Example: 12345", null: true
+          field :copied_to, Int, "ID of the course that this course was copied to. This is only included if the event_type is copied_to..Example: 12345", null: true
+          field :sis_batch, Int, "ID of the SIS batch that triggered the event..Example: 12345", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseNickname < BaseType
+          description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+          field :course_id, ID, "the ID of the course.Example: 88", null: true
+          field :name, String, "the actual name of the course.Example: S1048576 DPMS1200 Intro to Newtonian Mechanics", null: true
+          field :nickname, String, "the calling user's nickname for the course.Example: Physics", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseProgress < BaseType
+          description "Courses. API Docs: https://canvas.instructure.com/doc/api/courses.html"
+          field :requirement_count, Int, "total number of requirements from all modules.Example: 10", null: true
+          field :requirement_completed_count, Int, "total number of requirements the user has completed from all modules.Example: 1", null: true
+          field :next_requirement_url, String, "url to next module item that has an unmet requirement. null if the user has completed the course or the current module does not require sequential progress.Example: http://localhost/courses/1/modules/items/2", null: true
+          field :completed_at, LMS::GraphQL::Types::DateTimeType, "date the course was completed. null if the course has not been completed by this user.Example: 2013-06-01T00:00:00-06:00", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CourseQuizExtension < BaseType
+          description "Course Quiz Extensions. API Docs: https://canvas.instructure.com/doc/api/course_quiz_extensions.html"
+          field :user_id, ID, "The ID of the Student that needs the quiz extension..Example: 3", null: true
+          field :extra_attempts, Int, "Number of times the student is allowed to re-take the quiz over the multiple-attempt limit..Example: 1", null: true
+          field :extra_time, Int, "Amount of extra time allowed for the quiz submission, in minutes..Example: 60", null: true
+          field :manually_unlocked, Boolean, "The student can take the quiz even if it's locked for everyone else.Example: true", null: true
+          field :end_at, String, "The time at which the quiz submission will be overdue, and be flagged as a late submission..Example: 2013-11-07T13:16:18Z", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CreatedEventDatum < BaseType
+          description "Course Audit log. API Docs: https://canvas.instructure.com/doc/api/course_audit_log.html"
+          field :name, String, "Example: , Course 1", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "Example: , 2012-01-19T15:00:00-06:00", null: true
+          field :conclude_at, LMS::GraphQL::Types::DateTimeType, "Example: , 2012-01-19T15:00:00-08:00", null: true
+          field :is_public, Boolean, "Example: , false", null: true
+          field :created_source, String, "The type of action that triggered the creation of the course..Example: manual|sis|api", null: true
+
+        end
+      end
+    end
+  end
+end