lms-graphql-api 0.1.0

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

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class AssignmentOverride < BaseType
+          description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+          field :id, ID, "the ID of the assignment override.Example: 4", null: true
+          field :assignment_id, ID, "the ID of the assignment the override applies to.Example: 123", null: true
+          field :student_ids, [ID], "the IDs of the override's target students (present if the override targets an ad-hoc set of students).Example: 1, 2, 3", null: true
+          field :group_id, ID, "the ID of the override's target group (present if the override targets a group and the assignment is a group assignment).Example: 2", null: true
+          field :course_section_id, ID, "the ID of the overrides's target section (present if the override targets a section).Example: 1", null: true
+          field :title, String, "the title of the override.Example: an assignment override", null: true
+          field :due_at, LMS::GraphQL::Types::DateTimeType, "the overridden due at (present if due_at is overridden).Example: 2012-07-01T23:59:00-06:00", null: true
+          field :all_day, Int, "the overridden all day flag (present if due_at is overridden).Example: true", null: true
+          field :all_day_date, LMS::GraphQL::Types::DateTimeType, "the overridden all day date (present if due_at is overridden).Example: 2012-07-01", null: true
+          field :unlock_at, LMS::GraphQL::Types::DateTimeType, "the overridden unlock at (present if unlock_at is overridden).Example: 2012-07-01T23:59:00-06:00", null: true
+          field :lock_at, LMS::GraphQL::Types::DateTimeType, "the overridden lock at, if any (present if lock_at is overridden).Example: 2012-07-01T23:59:00-06:00", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class AuthenticationEventEventTypeEnum < ::GraphQL::Schema::Enum
+          value "login"
+          value "logout"
+        end
+        class AuthenticationEvent < BaseType
+          description "Authentications Log. API Docs: https://canvas.instructure.com/doc/api/authentications_log.html"
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "timestamp of the event.Example: 2012-07-19T15:00:00-06:00", null: true
+          field :event_type, AuthenticationEventEventTypeEnum, "authentication event type ('login' or 'logout').Example: login", null: true
+          field :pseudonym_id, ID, "ID of the pseudonym (login) associated with the event.Example: 9478", null: true
+          field :account_id, ID, "ID of the account associated with the event. will match the account_id in the associated pseudonym..Example: 2319", null: true
+          field :user_id, ID, "ID of the user associated with the event will match the user_id in the associated pseudonym..Example: 362", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative "../canvas_base_type"
+require_relative "federated_attributes_config"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class AuthenticationProvider < BaseType
+          description "Authentication Providers. API Docs: https://canvas.instructure.com/doc/api/authentication_providers.html"
+          field :identifier_format, String, "Valid for SAML providers..Example: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress", null: true
+          field :auth_type, String, "Valid for all providers..Example: saml", null: true
+          field :id, ID, "Valid for all providers..Example: 1649", null: true
+          field :log_out_url, String, "Valid for SAML providers..Example: http://example.com/saml1/slo", null: true
+          field :log_in_url, String, "Valid for SAML and CAS providers..Example: http://example.com/saml1/sli", null: true
+          field :certificate_fingerprint, String, "Valid for SAML providers..Example: 111222", null: true
+          field :requested_authn_context, String, "Valid for SAML providers..", null: true
+          field :auth_host, String, "Valid for LDAP providers..Example: 127.0.0.1", null: true
+          field :auth_filter, String, "Valid for LDAP providers..Example: filter1", null: true
+          field :auth_over_tls, Int, "Valid for LDAP providers..", null: true
+          field :auth_base, String, "Valid for LDAP and CAS providers..", null: true
+          field :auth_username, String, "Valid for LDAP providers..Example: username1", null: true
+          field :auth_port, Int, "Valid for LDAP providers..", null: true
+          field :position, Int, "Valid for all providers..Example: 1", null: true
+          field :idp_entity_id, ID, "Valid for SAML providers..Example: http://example.com/saml1", null: true
+          field :login_attribute, String, "Valid for SAML providers..Example: nameid", null: true
+          field :sig_alg, String, "Valid for SAML providers..Example: http://www.w3.org/2001/04/xmldsig-more#rsa-sha256", null: true
+          field :jit_provisioning, Boolean, "Just In Time provisioning. Valid for all providers except Canvas (which has the similar in concept self_registration setting)..", null: true
+          field :federated_attributes, LMS::GraphQL::Types::Canvas::FederatedAttributesConfig, "", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Avatar < BaseType
+          description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+          field :type, String, "['gravatar'|'attachment'|'no_pic'] The type of avatar record, for categorization purposes..Example: gravatar", null: true
+          field :url, String, "The url of the avatar.Example: https://secure.gravatar.com/avatar/2284.", null: true
+          field :token, String, "A unique representation of the avatar record which can be used to set the avatar with the user update endpoint. Note: this is an internal representation and is subject to change without notice. It should be consumed with this api endpoint and used in the user update endpoint, and should not be constructed by the client..Example: <opaque_token>", null: true
+          field :display_name, String, "A textual description of the avatar record..Example: user, sample", null: true
+          field :id, ID, "['attachment' type only] the internal id of the attachment.Example: 12", null: true
+          field :content_type, String, "['attachment' type only] the content-type of the attachment..Example: image/jpeg", null: true
+          field :filename, String, "['attachment' type only] the filename of the attachment.Example: profile.jpg", null: true
+          field :size, Int, "['attachment' type only] the size of the attachment.Example: 32649", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class BlueprintMigration < BaseType
+          description "Blueprint Courses. API Docs: https://canvas.instructure.com/doc/api/blueprint_courses.html"
+          field :id, ID, "The ID of the migration..Example: 1", null: true
+          field :template_id, ID, "The ID of the template the migration belongs to. Only present when querying a blueprint course..Example: 2", null: true
+          field :subscription_id, ID, "The ID of the associated course's blueprint subscription. Only present when querying a course associated with a blueprint..Example: 101", null: true
+          field :user_id, ID, "The ID of the user who queued the migration..Example: 3", null: true
+          field :workflow_state, String, "Current state of the content migration: queued, exporting, imports_queued, completed, exports_failed, imports_failed.Example: running", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "Time when the migration was queued.Example: 2013-08-28T23:59:00-06:00", null: true
+          field :exports_started_at, LMS::GraphQL::Types::DateTimeType, "Time when the exports begun.Example: 2013-08-28T23:59:00-06:00", null: true
+          field :imports_queued_at, LMS::GraphQL::Types::DateTimeType, "Time when the exports were completed and imports were queued.Example: 2013-08-28T23:59:00-06:00", null: true
+          field :imports_completed_at, LMS::GraphQL::Types::DateTimeType, "Time when the imports were completed.Example: 2013-08-28T23:59:00-06:00", null: true
+          field :comment, String, "User-specified comment describing changes made in this operation.Example: Fixed spelling in question 3 of midterm exam", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class BlueprintRestriction < BaseType
+          description "Blueprint Courses. API Docs: https://canvas.instructure.com/doc/api/blueprint_courses.html"
+          field :content, Boolean, "Restriction on main content (e.g. title, description)..Example: true", null: true
+          field :points, Boolean, "Restriction on points possible for assignments and graded learning objects.Example: true", null: true
+          field :due_dates, Boolean, "Restriction on due dates for assignments and graded learning objects.", null: true
+          field :availability_dates, Boolean, "Restriction on availability dates for an object.Example: true", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+require_relative "blueprint_migration"
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class BlueprintTemplate < BaseType
+          description "Blueprint Courses. API Docs: https://canvas.instructure.com/doc/api/blueprint_courses.html"
+          field :id, ID, "The ID of the template..Example: 1", null: true
+          field :course_id, ID, "The ID of the Course the template belongs to..Example: 2", null: true
+          field :last_export_completed_at, LMS::GraphQL::Types::DateTimeType, "Time when the last export was completed.Example: 2013-08-28T23:59:00-06:00", null: true
+          field :associated_course_count, Int, "Number of associated courses for the template.Example: 3", null: true
+          field :latest_migration, String, "Details of the latest migration.", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Bookmark < BaseType
+          description "Bookmarks. API Docs: https://canvas.instructure.com/doc/api/bookmarks.html"
+          field :id, ID, "Example: 1", null: true
+          field :name, String, "Example: Biology 101", null: true
+          field :url, String, "Example: /courses/1", null: true
+          field :position, Int, "Example: 1", null: true
+          field :data, String, "Example: 1", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CalendarEvent < BaseType
+          description "Calendar Events. API Docs: https://canvas.instructure.com/doc/api/calendar_events.html"
+          field :id, ID, "The ID of the calendar event.Example: 234", null: true
+          field :title, String, "The title of the calendar event.Example: Paintball Fight!", null: true
+          field :start_at, LMS::GraphQL::Types::DateTimeType, "The start timestamp of the event.Example: 2012-07-19T15:00:00-06:00", null: true
+          field :end_at, LMS::GraphQL::Types::DateTimeType, "The end timestamp of the event.Example: 2012-07-19T16:00:00-06:00", null: true
+          field :description, String, "The HTML description of the event.Example: <b>It's that time again!</b>", null: true
+          field :location_name, String, "The location name of the event.Example: Greendale Community College", null: true
+          field :location_address, String, "The address where the event is taking place.Example: Greendale, Colorado", null: true
+          field :context_code, String, "the context code of the calendar this event belongs to (course, user or group).Example: course_123", null: true
+          field :effective_context_code, String, "if specified, it indicates which calendar this event should be displayed on. for example, a section-level event would have the course's context code here, while the section's context code would be returned above).", null: true
+          field :all_context_codes, String, "a comma-separated list of all calendar contexts this event is part of.Example: course_123,course_456", null: true
+          field :workflow_state, String, "Current state of the event ('active', 'locked' or 'deleted') 'locked' indicates that start_at/end_at cannot be changed (though the event could be deleted). Normally only reservations or time slots with reservations are locked (see the Appointment Groups API).Example: active", null: true
+          field :hidden, Boolean, "Whether this event should be displayed on the calendar. Only true for course-level events with section-level child events..", null: true
+          field :parent_event_id, ID, "Normally null. If this is a reservation (see the Appointment Groups API), the id will indicate the time slot it is for. If this is a section-level event, this will be the course-level parent event..", null: true
+          field :child_events_count, Int, "The number of child_events. See child_events (and parent_event_id).Example: 0", null: true
+          field :child_events, Int, "Included by default, but may be excluded (see include[] option). If this is a time slot (see the Appointment Groups API) this will be a list of any reservations. If this is a course-level event, this will be a list of section-level events (if any).", null: true
+          field :url, String, "URL for this calendar event (to update, delete, etc.).Example: https://example.com/api/v1/calendar_events/234", null: true
+          field :html_url, String, "URL for a user to view this event.Example: https://example.com/calendar?event_id=234&include_contexts=course_123", null: true
+          field :all_day_date, LMS::GraphQL::Types::DateTimeType, "The date of this event.Example: 2012-07-19", null: true
+          field :all_day, Boolean, "Boolean indicating whether this is an all-day event (midnight to midnight).", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "When the calendar event was created.Example: 2012-07-12T10:55:20-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "When the calendar event was last updated.Example: 2012-07-12T10:55:20-06:00", null: true
+          field :appointment_group_id, ID, "Various Appointment-Group-related fields.These fields are only pertinent to time slots (appointments) and reservations of those time slots. See the Appointment Groups API. The id of the appointment group.", null: true
+          field :appointment_group_url, String, "The API URL of the appointment group.", null: true
+          field :own_reservation, Boolean, "If the event is a reservation, this a boolean indicating whether it is the current user's reservation, or someone else's.", null: true
+          field :reserve_url, String, "If the event is a time slot, the API URL for reserving it.", null: true
+          field :reserved, Boolean, "If the event is a time slot, a boolean indicating whether the user has already made a reservation for it.", null: true
+          field :participant_type, String, "The type of participant to sign up for a slot: 'User' or 'Group'.Example: User", null: true
+          field :participants_per_appointment, Int, "If the event is a time slot, this is the participant limit.", null: true
+          field :available_slots, Int, "If the event is a time slot and it has a participant limit, an integer indicating how many slots are available.", null: true
+          field :user, String, "If the event is a user-level reservation, this will contain the user participant JSON (refer to the Users API)..", null: true
+          field :group, String, "If the event is a group-level reservation, this will contain the group participant JSON (refer to the Groups API)..", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CalendarLink < BaseType
+          description "Courses. API Docs: https://canvas.instructure.com/doc/api/courses.html"
+          field :ics, String, "The URL of the calendar in ICS format.Example: https://canvas.instructure.com/feeds/calendars/course_abcdef.ics", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ChangeRecord < BaseType
+          description "Blueprint Courses. API Docs: https://canvas.instructure.com/doc/api/blueprint_courses.html"
+          field :asset_id, ID, "The ID of the learning object that was changed in the blueprint course..Example: 2", null: true
+          field :asset_type, String, "The type of the learning object that was changed in the blueprint course.  One of 'assignment', 'attachment', 'discussion_topic', 'external_tool', 'quiz', or 'wiki_page'..Example: assignment", null: true
+          field :asset_name, String, "The name of the learning object that was changed in the blueprint course..Example: Some Assignment", null: true
+          field :change_type, String, "The type of change; one of 'created', 'updated', 'deleted'.Example: created", null: true
+          field :html_url, String, "The URL of the changed object.Example: https://canvas.example.com/courses/101/assignments/2", null: true
+          field :locked, Boolean, "Whether the object is locked in the blueprint.", null: true
+          field :exceptions, String, "A list of ExceptionRecords for linked courses that did not receive this update..Example: {'course_id'=>101, 'conflicting_changes'=>['points']}", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class Collaboration < BaseType
+          description "Collaborations. API Docs: https://canvas.instructure.com/doc/api/collaborations.html"
+          field :id, ID, "The unique identifier for the collaboration.Example: 43", null: true
+          field :collaboration_type, String, "A name for the type of collaboration.Example: Microsoft Office", null: true
+          field :document_id, ID, "The collaboration document identifier for the collaboration provider.Example: oinwoenfe8w8ef_onweufe89fef", null: true
+          field :user_id, ID, "The canvas id of the user who created the collaboration.Example: 92", null: true
+          field :context_id, ID, "The canvas id of the course or group to which the collaboration belongs.Example: 77", null: true
+          field :context_type, String, "The canvas type of the course or group to which the collaboration belongs.Example: Course", null: true
+          field :url, String, "The LTI launch url to view collaboration..", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The timestamp when the collaboration was created.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :updated_at, LMS::GraphQL::Types::DateTimeType, "The timestamp when the collaboration was last modified.Example: 2012-06-01T00:00:00-06:00", null: true
+          field :description, String, "", null: true
+          field :title, String, "", null: true
+          field :type, String, "Another representation of the collaboration type.Example: ExternalToolCollaboration", null: true
+          field :update_url, String, "The LTI launch url to edit the collaboration.", null: true
+          field :user_name, String, "The name of the user who owns the collaboration.Example: John Danger", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CollaboratorTypeEnum < ::GraphQL::Schema::Enum
+          value "user"
+          value "group"
+        end
+        class Collaborator < BaseType
+          description "Collaborations. API Docs: https://canvas.instructure.com/doc/api/collaborations.html"
+          field :id, ID, "The unique user or group identifier for the collaborator..Example: 12345", null: true
+          field :type, CollaboratorTypeEnum, "The type of collaborator (e.g. 'user' or 'group')..Example: user", null: true
+          field :name, String, "The name of the collaborator..Example: Don Draper", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class ColumnDatum < BaseType
+          description "Custom Gradebook Columns. API Docs: https://canvas.instructure.com/doc/api/custom_gradebook_columns.html"
+          field :content, String, "Example: Nut allergy", null: true
+          field :user_id, ID, "Example: 2", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CommMessageWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "created"
+          value "staged"
+          value "sending"
+          value "sent"
+          value "bounced"
+          value "dashboard"
+          value "cancelled"
+          value "closed"
+        end
+        class CommMessage < BaseType
+          description "CommMessages. API Docs: https://canvas.instructure.com/doc/api/comm_messages.html"
+          field :id, ID, "The ID of the CommMessage..Example: 42", null: true
+          field :created_at, LMS::GraphQL::Types::DateTimeType, "The date and time this message was created.Example: 2013-03-19T21:00:00Z", null: true
+          field :sent_at, LMS::GraphQL::Types::DateTimeType, "The date and time this message was sent.Example: 2013-03-20T22:42:00Z", null: true
+          field :workflow_state, CommMessageWorkflowStateEnum, "The workflow state of the message. One of 'created', 'staged', 'sending', 'sent', 'bounced', 'dashboard', 'cancelled', or 'closed'.Example: sent", null: true
+          field :from, String, "The address that was put in the 'from' field of the message.Example: notifications@example.com", null: true
+          field :from_name, String, "The display name for the from address.Example: Instructure Canvas", null: true
+          field :to, String, "The address the message was sent to:.Example: someone@example.com", null: true
+          field :reply_to, String, "The reply_to header of the message.Example: notifications+specialdata@example.com", null: true
+          field :subject, String, "The message subject.Example: example subject line", null: true
+          field :body, String, "The plain text body of the message.Example: This is the body of the message", null: true
+          field :html_body, String, "The HTML body of the message..Example: <html><body>This is the body of the message</body></html>", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CommunicationChannelTypeEnum < ::GraphQL::Schema::Enum
+          value "email"
+          value "push"
+          value "sms"
+          value "twitter"
+        end
+
+                class CommunicationChannelWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "unconfirmed"
+          value "active"
+        end
+        class CommunicationChannel < BaseType
+          description "Communication Channels. API Docs: https://canvas.instructure.com/doc/api/communication_channels.html"
+          field :id, ID, "The ID of the communication channel..Example: 16", null: true
+          field :address, String, "The address, or path, of the communication channel..Example: sheldon@caltech.example.com", null: true
+          field :type, CommunicationChannelTypeEnum, "The type of communcation channel being described. Possible values are: 'email', 'push', 'sms', or 'twitter'. This field determines the type of value seen in 'address'..Example: email", null: true
+          field :position, Int, "The position of this communication channel relative to the user's other channels when they are ordered..Example: 1", null: true
+          field :user_id, ID, "The ID of the user that owns this communication channel..Example: 1", null: true
+          field :workflow_state, CommunicationChannelWorkflowStateEnum, "The current state of the communication channel. Possible values are: 'unconfirmed' or 'active'..Example: active", null: true
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+
+
+module LMS
+  module GraphQL
+    module Types
+      module Canvas
+        class CompletionRequirementTypeEnum < ::GraphQL::Schema::Enum
+          value "must_view"
+          value "must_submit"
+          value "must_contribute"
+          value "min_score"
+        end
+        class CompletionRequirement < BaseType
+          description "Modules. API Docs: https://canvas.instructure.com/doc/api/modules.html"
+          field :type, CompletionRequirementTypeEnum, "one of 'must_view', 'must_submit', 'must_contribute', 'min_score'.Example: min_score", null: true
+          field :min_score, Int, "minimum score required to complete (only present when type == 'min_score').Example: 10", null: true
+          field :completed, Boolean, "whether the calling user has met this requirement (Optional; present only if the caller is a student or if the optional parameter 'student_id' is included).Example: true", null: true
+
+        end
+      end
+    end
+  end
+end