lms-graphql-api 1.3.0

data/lib/lms_graphql/types/canvas/account_input.rb

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAccountInput < BaseInputObject
+        description "Accounts (LTI). API Docs: https://canvas.instructure.com/doc/api/accounts_(lti).html"
+        argument :id, ID, "the ID of the Account object.Example: 2", required: false
+        argument :name, String, "The display name of the account.Example: Canvas Account", required: false
+        argument :uuid, String, "The UUID of the account.Example: WvAHhY5FINzq5IyRIJybGeiXyFkG3SqHUPb7jZY5", required: false
+        argument :parent_account_id, ID, "The account's parent ID, or null if this is the root account.Example: 1", required: false
+        argument :root_account_id, ID, "The ID of the root account, or null if this is the root account.Example: 1", required: false
+        argument :workflow_state, String, "The state of the account. Can be 'active' or 'deleted'..Example: active", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/account_notification.rb

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class AccountNotificationIconEnum < ::GraphQL::Schema::Enum
+          value "warning"
+          value "information"
+          value "question"
+          value "error"
+          value "calendar"
+        end
+      class CanvasAccountNotification < BaseType
+        description "Account Notifications. API Docs: https://canvas.instructure.com/doc/api/account_notifications.html"
+        field :subject, String, "The subject of the notifications.Example: Attention Students", null: true
+        field :message, String, "The message to be sent in the notification..Example: This is a test of the notification system.", null: true
+        field :start_at, LMSGraphQL::Types::DateTimeType, "When to send out the notification..Example: 2013-08-28T23:59:00-06:00", null: true
+        field :end_at, LMSGraphQL::Types::DateTimeType, "When to expire the notification..Example: 2013-08-29T23:59:00-06:00", null: true
+        field :icon, AccountNotificationIconEnum, "The icon to display with the message.  Defaults to warning..Example: information", null: true
+        field :roles, String, "(Deprecated) The roles to send the notification to.  If roles is not passed it defaults to all roles.Example: StudentEnrollment", null: true
+        field :role_ids, [ID], "The roles to send the notification to.  If roles is not passed it defaults to all roles.Example: 1", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/account_notification_input.rb

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class AccountNotificationIconEnum < ::GraphQL::Schema::Enum
+          value "warning"
+          value "information"
+          value "question"
+          value "error"
+          value "calendar"
+        end
+      class CanvasAccountNotificationInput < BaseInputObject
+        description "Account Notifications. API Docs: https://canvas.instructure.com/doc/api/account_notifications.html"
+        argument :subject, String, "The subject of the notifications.Example: Attention Students", required: false
+        argument :message, String, "The message to be sent in the notification..Example: This is a test of the notification system.", required: false
+        argument :start_at, LMSGraphQL::Types::DateTimeType, "When to send out the notification..Example: 2013-08-28T23:59:00-06:00", required: false
+        argument :end_at, LMSGraphQL::Types::DateTimeType, "When to expire the notification..Example: 2013-08-29T23:59:00-06:00", required: false
+        argument :icon, AccountNotificationIconEnum, "The icon to display with the message.  Defaults to warning..Example: information", required: false
+        argument :roles, String, "(Deprecated) The roles to send the notification to.  If roles is not passed it defaults to all roles.Example: StudentEnrollment", required: false
+        argument :role_ids, [ID], "The roles to send the notification to.  If roles is not passed it defaults to all roles.Example: 1", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/admin.rb

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_type"
+require_relative "user"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAdmin < BaseType
+        description "Admins. API Docs: https://canvas.instructure.com/doc/api/admins.html"
+        field :id, ID, "The unique identifier for the account role/user assignment..Example: 1023", null: true
+        field :role, String, "The account role assigned. This can be 'AccountAdmin' or a user-defined role created by the Roles API..Example: AccountAdmin", null: true
+        field :user, LMSGraphQL::Types::Canvas::CanvasUser, "The user the role is assigned to. See the Users API for details..", null: true
+        field :workflow_state, String, "The status of the account role/user assignment..Example: deleted", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/admin_input.rb

@@ -0,0 +1,17 @@
+require_relative "../canvas_base_input_type"
+require_relative "user"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAdminInput < BaseInputObject
+        description "Admins. API Docs: https://canvas.instructure.com/doc/api/admins.html"
+        argument :id, ID, "The unique identifier for the account role/user assignment..Example: 1023", required: false
+        argument :role, String, "The account role assigned. This can be 'AccountAdmin' or a user-defined role created by the Roles API..Example: AccountAdmin", required: false
+        argument :user, LMSGraphQL::Types::Canvas::CanvasUserInput, "The user the role is assigned to. See the Users API for details..", required: false
+        argument :workflow_state, String, "The status of the account role/user assignment..Example: deleted", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/anonymous_user_display.rb

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAnonymousUserDisplay < BaseType
+        description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+        field :anonymous_id, ID, "A unique short ID identifying this user within the scope of a particular assignment..Example: xn29Q", null: true
+        field :avatar_image_url, String, "A URL to retrieve a generic avatar..Example: https://en.gravatar.com/avatar/d8cb8c8cd40ddf0cd05241443a591868?s=80&r=g", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/anonymous_user_display_input.rb

@@ -0,0 +1,15 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAnonymousUserDisplayInput < BaseInputObject
+        description "Users. API Docs: https://canvas.instructure.com/doc/api/users.html"
+        argument :anonymous_id, ID, "A unique short ID identifying this user within the scope of a particular assignment..Example: xn29Q", required: false
+        argument :avatar_image_url, String, "A URL to retrieve a generic avatar..Example: https://en.gravatar.com/avatar/d8cb8c8cd40ddf0cd05241443a591868?s=80&r=g", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/answer.rb

@@ -0,0 +1,30 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAnswer < BaseType
+        description "Quiz Questions. API Docs: https://canvas.instructure.com/doc/api/quiz_questions.html"
+        field :id, ID, "The unique identifier for the answer.  Do not supply if this answer is part of a new question.Example: 6656", null: true
+        field :answer_text, String, "The text of the answer..Example: Constantinople", null: true
+        field :answer_weight, Int, "An integer to determine correctness of the answer. Incorrect answers should be 0, correct answers should be non-negative..Example: 100", null: true
+        field :answer_comments, String, "Specific contextual comments for a particular answer..Example: Remember to check your spelling prior to submitting this answer.", null: true
+        field :text_after_answers, String, "Used in missing word questions.  The text to follow the missing word.Example:  is the capital of Utah.", null: true
+        field :answer_match_left, String, "Used in matching questions.  The static value of the answer that will be displayed on the left for students to match for..Example: Salt Lake City", null: true
+        field :answer_match_right, String, "Used in matching questions. The correct match for the value given in answer_match_left.  Will be displayed in a dropdown with the other answer_match_right values...Example: Utah", null: true
+        field :matching_answer_incorrect_matches, String, "Used in matching questions. A list of distractors, delimited by new lines (
+) that will be seeded with all the answer_match_right values..Example: Nevada California Washington", null: true
+        field :numerical_answer_type, String, "Used in numerical questions.  Values can be 'exact_answer', 'range_answer', or 'precision_answer'..Example: exact_answer", null: true
+        field :exact, Int, "Used in numerical questions of type 'exact_answer'.  The value the answer should equal..Example: 42", null: true
+        field :margin, Int, "Used in numerical questions of type 'exact_answer'. The margin of error allowed for the student's answer..Example: 4", null: true
+        field :approximate, Float, "Used in numerical questions of type 'precision_answer'.  The value the answer should equal..Example: 1234600000.0", null: true
+        field :precision, Int, "Used in numerical questions of type 'precision_answer'. The numerical precision that will be used when comparing the student's answer..Example: 4", null: true
+        field :start, Int, "Used in numerical questions of type 'range_answer'. The start of the allowed range (inclusive)..Example: 1", null: true
+        field :end, Int, "Used in numerical questions of type 'range_answer'. The end of the allowed range (inclusive)..Example: 10", null: true
+        field :blank_id, ID, "Used in fill in multiple blank and multiple dropdowns questions..Example: 1170", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/answer_input.rb

@@ -0,0 +1,30 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAnswerInput < BaseInputObject
+        description "Quiz Questions. API Docs: https://canvas.instructure.com/doc/api/quiz_questions.html"
+        argument :id, ID, "The unique identifier for the answer.  Do not supply if this answer is part of a new question.Example: 6656", required: false
+        argument :answer_text, String, "The text of the answer..Example: Constantinople", required: false
+        argument :answer_weight, Int, "An integer to determine correctness of the answer. Incorrect answers should be 0, correct answers should be non-negative..Example: 100", required: false
+        argument :answer_comments, String, "Specific contextual comments for a particular answer..Example: Remember to check your spelling prior to submitting this answer.", required: false
+        argument :text_after_answers, String, "Used in missing word questions.  The text to follow the missing word.Example:  is the capital of Utah.", required: false
+        argument :answer_match_left, String, "Used in matching questions.  The static value of the answer that will be displayed on the left for students to match for..Example: Salt Lake City", required: false
+        argument :answer_match_right, String, "Used in matching questions. The correct match for the value given in answer_match_left.  Will be displayed in a dropdown with the other answer_match_right values...Example: Utah", required: false
+        argument :matching_answer_incorrect_matches, String, "Used in matching questions. A list of distractors, delimited by new lines (
+) that will be seeded with all the answer_match_right values..Example: Nevada California Washington", required: false
+        argument :numerical_answer_type, String, "Used in numerical questions.  Values can be 'exact_answer', 'range_answer', or 'precision_answer'..Example: exact_answer", required: false
+        argument :exact, Int, "Used in numerical questions of type 'exact_answer'.  The value the answer should equal..Example: 42", required: false
+        argument :margin, Int, "Used in numerical questions of type 'exact_answer'. The margin of error allowed for the student's answer..Example: 4", required: false
+        argument :approximate, Float, "Used in numerical questions of type 'precision_answer'.  The value the answer should equal..Example: 1234600000.0", required: false
+        argument :precision, Int, "Used in numerical questions of type 'precision_answer'. The numerical precision that will be used when comparing the student's answer..Example: 4", required: false
+        argument :start, Int, "Used in numerical questions of type 'range_answer'. The start of the allowed range (inclusive)..Example: 1", required: false
+        argument :end, Int, "Used in numerical questions of type 'range_answer'. The end of the allowed range (inclusive)..Example: 10", required: false
+        argument :blank_id, ID, "Used in fill in multiple blank and multiple dropdowns questions..Example: 1170", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/appointment.rb

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAppointment < BaseType
+        description "Appointment Groups. API Docs: https://canvas.instructure.com/doc/api/appointment_groups.html"
+        field :id, ID, "The appointment identifier..Example: 987", null: true
+        field :start_at, LMSGraphQL::Types::DateTimeType, "Start time for the appointment.Example: 2012-07-20T15:00:00-06:00", null: true
+        field :end_at, LMSGraphQL::Types::DateTimeType, "End time for the appointment.Example: 2012-07-20T15:00:00-06:00", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/appointment_group.rb

@@ -0,0 +1,55 @@
+require_relative "../canvas_base_type"
+require_relative "appointment"
+require_relative "calendar_event"
+require_relative "calendar_event"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class AppointmentGroupWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "pending"
+          value "active"
+          value "deleted"
+        end
+
+                class AppointmentGroupParticipantVisibilityEnum < ::GraphQL::Schema::Enum
+          value "private"
+          value "protected"
+        end
+
+                class AppointmentGroupParticipantTypeEnum < ::GraphQL::Schema::Enum
+          value "User"
+          value "Group"
+        end
+      class CanvasAppointmentGroup < BaseType
+        description "Appointment Groups. API Docs: https://canvas.instructure.com/doc/api/appointment_groups.html"
+        field :id, ID, "The ID of the appointment group.Example: 543", null: true
+        field :title, String, "The title of the appointment group.Example: Final Presentation", null: true
+        field :start_at, LMSGraphQL::Types::DateTimeType, "The start of the first time slot in the appointment group.Example: 2012-07-20T15:00:00-06:00", null: true
+        field :end_at, LMSGraphQL::Types::DateTimeType, "The end of the last time slot in the appointment group.Example: 2012-07-20T17:00:00-06:00", null: true
+        field :description, String, "The text description of the appointment group.Example: Es muy importante", null: true
+        field :location_name, String, "The location name of the appointment group.Example: El Tigre Chino's office", null: true
+        field :location_address, String, "The address of the appointment group's location.Example: Room 234", null: true
+        field :participant_count, Int, "The number of participant who have reserved slots (see include[] argument).Example: 2", null: true
+        field :reserved_times, [LMSGraphQL::Types::Canvas::CanvasAppointment], "The start and end times of slots reserved by the current user as well as the id of the calendar event for the reservation (see include[] argument).Example: {'id'=>987, 'start_at'=>'2012-07-20T15:00:00-06:00', 'end_at'=>'2012-07-20T15:00:00-06:00'}", null: true
+        field :context_codes, String, "The context codes (i.e. courses) this appointment group belongs to. Only people in these courses will be eligible to sign up..Example: course_123", null: true
+        field :sub_context_codes, Int, "The sub-context codes (i.e. course sections and group categories) this appointment group is restricted to.Example: course_section_234", null: true
+        field :workflow_state, AppointmentGroupWorkflowStateEnum, "Current state of the appointment group ('pending', 'active' or 'deleted'). 'pending' indicates that it has not been published yet and is invisible to participants..Example: active", null: true
+        field :requiring_action, Boolean, "Boolean indicating whether the current user needs to sign up for this appointment group (i.e. it's reservable and the min_appointments_per_participant limit has not been met by this user)..Example: true", null: true
+        field :appointments_count, Int, "Number of time slots in this appointment group.Example: 2", null: true
+        field :appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEvent], "Calendar Events representing the time slots (see include[] argument) Refer to the Calendar Events API for more information.", null: true
+        field :new_appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEvent], "Newly created time slots (same format as appointments above). Only returned in Create/Update responses where new time slots have been added.", null: true
+        field :max_appointments_per_participant, Int, "Maximum number of time slots a user may register for, or null if no limit.Example: 1", null: true
+        field :min_appointments_per_participant, Int, "Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots.Example: 1", null: true
+        field :participants_per_appointment, Int, "Maximum number of participants that may register for each time slot, or null if no limit.Example: 1", null: true
+        field :participant_visibility, AppointmentGroupParticipantVisibilityEnum, "'private' means participants cannot see who has signed up for a particular time slot, 'protected' means that they can.Example: private", null: true
+        field :participant_type, AppointmentGroupParticipantTypeEnum, "Indicates how participants sign up for the appointment group, either as individuals ('User') or in student groups ('Group'). Related to sub_context_codes (i.e. 'Group' signups always have a single group category).Example: User", null: true
+        field :url, String, "URL for this appointment group (to update, delete, etc.).Example: https://example.com/api/v1/appointment_groups/543", null: true
+        field :html_url, String, "URL for a user to view this appointment group.Example: http://example.com/appointment_groups/1", null: true
+        field :created_at, LMSGraphQL::Types::DateTimeType, "When the appointment group was created.Example: 2012-07-13T10:55:20-06:00", null: true
+        field :updated_at, LMSGraphQL::Types::DateTimeType, "When the appointment group was last updated.Example: 2012-07-13T10:55:20-06:00", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/appointment_group_input.rb

@@ -0,0 +1,55 @@
+require_relative "../canvas_base_input_type"
+require_relative "appointment"
+require_relative "calendar_event"
+require_relative "calendar_event"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class AppointmentGroupWorkflowStateEnum < ::GraphQL::Schema::Enum
+          value "pending"
+          value "active"
+          value "deleted"
+        end
+
+                class AppointmentGroupParticipantVisibilityEnum < ::GraphQL::Schema::Enum
+          value "private"
+          value "protected"
+        end
+
+                class AppointmentGroupParticipantTypeEnum < ::GraphQL::Schema::Enum
+          value "User"
+          value "Group"
+        end
+      class CanvasAppointmentGroupInput < BaseInputObject
+        description "Appointment Groups. API Docs: https://canvas.instructure.com/doc/api/appointment_groups.html"
+        argument :id, ID, "The ID of the appointment group.Example: 543", required: false
+        argument :title, String, "The title of the appointment group.Example: Final Presentation", required: false
+        argument :start_at, LMSGraphQL::Types::DateTimeType, "The start of the first time slot in the appointment group.Example: 2012-07-20T15:00:00-06:00", required: false
+        argument :end_at, LMSGraphQL::Types::DateTimeType, "The end of the last time slot in the appointment group.Example: 2012-07-20T17:00:00-06:00", required: false
+        argument :description, String, "The text description of the appointment group.Example: Es muy importante", required: false
+        argument :location_name, String, "The location name of the appointment group.Example: El Tigre Chino's office", required: false
+        argument :location_address, String, "The address of the appointment group's location.Example: Room 234", required: false
+        argument :participant_count, Int, "The number of participant who have reserved slots (see include[] argument).Example: 2", required: false
+        argument :reserved_times, [LMSGraphQL::Types::Canvas::CanvasAppointmentInput], "The start and end times of slots reserved by the current user as well as the id of the calendar event for the reservation (see include[] argument).Example: {'id'=>987, 'start_at'=>'2012-07-20T15:00:00-06:00', 'end_at'=>'2012-07-20T15:00:00-06:00'}", required: false
+        argument :context_codes, String, "The context codes (i.e. courses) this appointment group belongs to. Only people in these courses will be eligible to sign up..Example: course_123", required: false
+        argument :sub_context_codes, Int, "The sub-context codes (i.e. course sections and group categories) this appointment group is restricted to.Example: course_section_234", required: false
+        argument :workflow_state, AppointmentGroupWorkflowStateEnum, "Current state of the appointment group ('pending', 'active' or 'deleted'). 'pending' indicates that it has not been published yet and is invisible to participants..Example: active", required: false
+        argument :requiring_action, Boolean, "Boolean indicating whether the current user needs to sign up for this appointment group (i.e. it's reservable and the min_appointments_per_participant limit has not been met by this user)..Example: true", required: false
+        argument :appointments_count, Int, "Number of time slots in this appointment group.Example: 2", required: false
+        argument :appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEventInput], "Calendar Events representing the time slots (see include[] argument) Refer to the Calendar Events API for more information.", required: false
+        argument :new_appointments, [LMSGraphQL::Types::Canvas::CanvasCalendarEventInput], "Newly created time slots (same format as appointments above). Only returned in Create/Update responses where new time slots have been added.", required: false
+        argument :max_appointments_per_participant, Int, "Maximum number of time slots a user may register for, or null if no limit.Example: 1", required: false
+        argument :min_appointments_per_participant, Int, "Minimum number of time slots a user must register for. If not set, users do not need to sign up for any time slots.Example: 1", required: false
+        argument :participants_per_appointment, Int, "Maximum number of participants that may register for each time slot, or null if no limit.Example: 1", required: false
+        argument :participant_visibility, AppointmentGroupParticipantVisibilityEnum, "'private' means participants cannot see who has signed up for a particular time slot, 'protected' means that they can.Example: private", required: false
+        argument :participant_type, AppointmentGroupParticipantTypeEnum, "Indicates how participants sign up for the appointment group, either as individuals ('User') or in student groups ('Group'). Related to sub_context_codes (i.e. 'Group' signups always have a single group category).Example: User", required: false
+        argument :url, String, "URL for this appointment group (to update, delete, etc.).Example: https://example.com/api/v1/appointment_groups/543", required: false
+        argument :html_url, String, "URL for a user to view this appointment group.Example: http://example.com/appointment_groups/1", required: false
+        argument :created_at, LMSGraphQL::Types::DateTimeType, "When the appointment group was created.Example: 2012-07-13T10:55:20-06:00", required: false
+        argument :updated_at, LMSGraphQL::Types::DateTimeType, "When the appointment group was last updated.Example: 2012-07-13T10:55:20-06:00", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/appointment_input.rb

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAppointmentInput < BaseInputObject
+        description "Appointment Groups. API Docs: https://canvas.instructure.com/doc/api/appointment_groups.html"
+        argument :id, ID, "The appointment identifier..Example: 987", required: false
+        argument :start_at, LMSGraphQL::Types::DateTimeType, "Start time for the appointment.Example: 2012-07-20T15:00:00-06:00", required: false
+        argument :end_at, LMSGraphQL::Types::DateTimeType, "End time for the appointment.Example: 2012-07-20T15:00:00-06:00", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/assessment.rb

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAssessment < BaseType
+        description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+        field :id, ID, "A unique identifier for this live assessment.Example: 42", null: true
+        field :key, String, "A client specified unique identifier for the assessment.Example: 2014-05-27,outcome_52", null: true
+        field :title, String, "A human readable title for the assessment.Example: May 27th Reading Assessment", null: true
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/assessment_input.rb

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasAssessmentInput < BaseInputObject
+        description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+        argument :id, ID, "A unique identifier for this live assessment.Example: 42", required: false
+        argument :key, String, "A client specified unique identifier for the assessment.Example: 2014-05-27,outcome_52", required: false
+        argument :title, String, "A human readable title for the assessment.Example: May 27th Reading Assessment", required: false
+
+      end
+    end
+  end
+end

data/lib/lms_graphql/types/canvas/assignment.rb

@@ -0,0 +1,109 @@
+require_relative "../canvas_base_type"
+require_relative "assignment_date"
+require_relative "turnitin_setting"
+require_relative "external_tool_tag_attribute"
+require_relative "needs_grading_count"
+require_relative "lock_info"
+require_relative "discussion_topic"
+require_relative "submission"
+require_relative "rubric_criterium"
+require_relative "assignment_override"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class AssignmentSubmissionTypeEnum < ::GraphQL::Schema::Enum
+          value "discussion_topic"
+          value "online_quiz"
+          value "on_paper"
+          value "not_graded"
+          value "none"
+          value "external_tool"
+          value "online_text_entry"
+          value "online_url"
+          value "online_upload"
+          value "media_recording"
+        end
+
+                class AssignmentGradingTypeEnum < ::GraphQL::Schema::Enum
+          value "pass_fail"
+          value "percent"
+          value "letter_grade"
+          value "gpa_scale"
+          value "points"
+        end
+      class CanvasAssignment < BaseType
+        description "Assignments. API Docs: https://canvas.instructure.com/doc/api/assignments.html"
+        field :id, ID, "the ID of the assignment.Example: 4", null: true
+        field :name, String, "the name of the assignment.Example: some assignment", null: true
+        field :description, String, "the assignment description, in an HTML fragment.Example: <p>Do the following:</p>.", null: true
+        field :created_at, LMSGraphQL::Types::DateTimeType, "The time at which this assignment was originally created.Example: 2012-07-01T23:59:00-06:00", null: true
+        field :updated_at, LMSGraphQL::Types::DateTimeType, "The time at which this assignment was last modified in any way.Example: 2012-07-01T23:59:00-06:00", null: true
+        field :due_at, LMSGraphQL::Types::DateTimeType, "the due date for the assignment. returns null if not present. NOTE: If this assignment has assignment overrides, this field will be the due date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", null: true
+        field :lock_at, LMSGraphQL::Types::DateTimeType, "the lock date (assignment is locked after this date). returns null if not present. NOTE: If this assignment has assignment overrides, this field will be the lock date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", null: true
+        field :unlock_at, LMSGraphQL::Types::DateTimeType, "the unlock date (assignment is unlocked after this date) returns null if not present NOTE: If this assignment has assignment overrides, this field will be the unlock date as it applies to the user requesting information from the API..Example: 2012-07-01T23:59:00-06:00", null: true
+        field :has_overrides, Boolean, "whether this assignment has overrides.Example: true", null: true
+        field :all_dates, [LMSGraphQL::Types::Canvas::CanvasAssignmentDate], "(Optional) all dates associated with the assignment, if applicable.", null: true
+        field :course_id, ID, "the ID of the course the assignment belongs to.Example: 123", null: true
+        field :html_url, String, "the URL to the assignment's web page.Example: https://.", null: true
+        field :submissions_download_url, String, "the URL to download all submissions as a zip.Example: https://example.com/courses/:course_id/assignments/:id/submissions?zip=1", null: true
+        field :assignment_group_id, ID, "the ID of the assignment's group.Example: 2", null: true
+        field :due_date_required, Boolean, "Boolean flag indicating whether the assignment requires a due date based on the account level setting.Example: true", null: true
+        field :allowed_extensions, String, "Allowed file extensions, which take effect if submission_types includes 'online_upload'..Example: docx, ppt", null: true
+        field :max_name_length, Int, "An integer indicating the maximum length an assignment's name may be.Example: 15", null: true
+        field :turnitin_enabled, Boolean, "Boolean flag indicating whether or not Turnitin has been enabled for the assignment. NOTE: This flag will not appear unless your account has the Turnitin plugin available.Example: true", null: true
+        field :vericite_enabled, Boolean, "Boolean flag indicating whether or not VeriCite has been enabled for the assignment. NOTE: This flag will not appear unless your account has the VeriCite plugin available.Example: true", null: true
+        field :turnitin_settings, LMSGraphQL::Types::Canvas::CanvasTurnitinSetting, "Settings to pass along to turnitin to control what kinds of matches should be considered. originality_report_visibility can be 'immediate', 'after_grading', 'after_due_date', or 'never' exclude_small_matches_type can be null, 'percent', 'words' exclude_small_matches_value: - if type is null, this will be null also - if type is 'percent', this will be a number between 0 and 100 representing match size to exclude as a percentage of the document size. - if type is 'words', this will be number > 0 representing how many words a match must contain for it to be considered NOTE: This flag will not appear unless your account has the Turnitin plugin available.", null: true
+        field :grade_group_students_individually, Boolean, "If this is a group assignment, boolean flag indicating whether or not students will be graded individually..", null: true
+        field :external_tool_tag_attributes, LMSGraphQL::Types::Canvas::CanvasExternalToolTagAttribute, "(Optional) assignment's settings for external tools if submission_types include 'external_tool'. Only url and new_tab are included (new_tab defaults to false).  Use the 'External Tools' API if you need more information about an external tool..", null: true
+        field :peer_reviews, Boolean, "Boolean indicating if peer reviews are required for this assignment.", null: true
+        field :automatic_peer_reviews, Boolean, "Boolean indicating peer reviews are assigned automatically. If false, the teacher is expected to manually assign peer reviews..", null: true
+        field :peer_review_count, Int, "Integer representing the amount of reviews each user is assigned. NOTE: This key is NOT present unless you have automatic_peer_reviews set to true..Example: 0", null: true
+        field :peer_reviews_assign_at, LMSGraphQL::Types::DateTimeType, "String representing a date the reviews are due by. Must be a date that occurs after the default due date. If blank, or date is not after the assignment's due date, the assignment's due date will be used. NOTE: This key is NOT present unless you have automatic_peer_reviews set to true..Example: 2012-07-01T23:59:00-06:00", null: true
+        field :intra_group_peer_reviews, Boolean, "Boolean representing whether or not members from within the same group on a group assignment can be assigned to peer review their own group's work.Example: false", null: true
+        field :group_category_id, ID, "The ID of the assignment’s group set, if this is a group assignment. For group discussions, set group_category_id on the discussion topic, not the linked assignment..Example: 1", null: true
+        field :needs_grading_count, Int, "if the requesting user has grading rights, the number of submissions that need grading..Example: 17", null: true
+        field :needs_grading_count_by_section, [LMSGraphQL::Types::Canvas::CanvasNeedsGradingCount], "if the requesting user has grading rights and the 'needs_grading_count_by_section' flag is specified, the number of submissions that need grading split out by section. NOTE: This key is NOT present unless you pass the 'needs_grading_count_by_section' argument as true.  ANOTHER NOTE: it's possible to be enrolled in multiple sections, and if a student is setup that way they will show an assignment that needs grading in multiple sections (effectively the count will be duplicated between sections).Example: {'section_id'=>'123456', 'needs_grading_count'=>5}, {'section_id'=>'654321', 'needs_grading_count'=>0}", null: true
+        field :position, Int, "the sorting order of the assignment in the group.Example: 1", null: true
+        field :post_to_sis, Boolean, "(optional, present if Sync Grades to SIS feature is enabled).Example: true", null: true
+        field :integration_id, ID, "(optional, Third Party unique identifier for Assignment).Example: 12341234", null: true
+        field :integration_data, String, "(optional, Third Party integration data for assignment).Example: 0954", null: true
+        field :muted, Boolean, "For courses using Old Gradebook, indicates whether the assignment is muted. For courses using New Gradebook, true if the assignment has any unposted submissions, otherwise false. To see the posted status of submissions, check the 'posted_attribute' on Submission..", null: true
+        field :points_possible, Float, "the maximum points possible for the assignment.Example: 12.0", null: true
+        field :submission_types, AssignmentSubmissionTypeEnum, "the types of submissions allowed for this assignment list containing one or more of the following: 'discussion_topic', 'online_quiz', 'on_paper', 'none', 'external_tool', 'online_text_entry', 'online_url', 'online_upload' 'media_recording'.Example: online_text_entry", null: true
+        field :has_submitted_submissions, Boolean, "If true, the assignment has been submitted to by at least one student.Example: true", null: true
+        field :grading_type, AssignmentGradingTypeEnum, "The type of grading the assignment receives; one of 'pass_fail', 'percent', 'letter_grade', 'gpa_scale', 'points'.Example: points", null: true
+        field :grading_standard_id, ID, "The id of the grading standard being applied to this assignment. Valid if grading_type is 'letter_grade' or 'gpa_scale'..", null: true
+        field :published, Boolean, "Whether the assignment is published.Example: true", null: true
+        field :unpublishable, Boolean, "Whether the assignment's 'published' state can be changed to false. Will be false if there are student submissions for the assignment..", null: true
+        field :only_visible_to_overrides, Boolean, "Whether the assignment is only visible to overrides..", null: true
+        field :locked_for_user, Boolean, "Whether or not this is locked for the user..", null: true
+        field :lock_info, LMSGraphQL::Types::Canvas::CanvasLockInfo, "(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 assignment is locked until September 1 at 12:00am", null: true
+        field :quiz_id, ID, "(Optional) id of the associated quiz (applies only when submission_types is ['online_quiz']).Example: 620", null: true
+        field :anonymous_submissions, Boolean, "(Optional) whether anonymous submissions are accepted (applies only to quiz assignments).", null: true
+        field :discussion_topic, LMSGraphQL::Types::Canvas::CanvasDiscussionTopic, "(Optional) the DiscussionTopic associated with the assignment, if applicable.", null: true
+        field :freeze_on_copy, Boolean, "(Optional) Boolean indicating if assignment will be frozen when it is copied. NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..", null: true
+        field :frozen, Boolean, "(Optional) Boolean indicating if assignment is frozen for the calling user. NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..", null: true
+        field :frozen_attributes, String, "(Optional) Array of frozen attributes for the assignment. Only account administrators currently have permission to change an attribute in this list. Will be empty if no attributes are frozen for this assignment. Possible frozen attributes are: title, description, lock_at, points_possible, grading_type, submission_types, assignment_group_id, allowed_extensions, group_category_id, notify_of_update, peer_reviews NOTE: This field will only be present if the AssignmentFreezer plugin is available for your account..Example: title", null: true
+        field :submission, LMSGraphQL::Types::Canvas::CanvasSubmission, "(Optional) If 'submission' is included in the 'include' parameter, includes a Submission object that represents the current user's (user who is requesting information from the api) current submission for the assignment. See the Submissions API for an example response. If the user does not have a submission, this key will be absent..", null: true
+        field :use_rubric_for_grading, Boolean, "(Optional) If true, the rubric is directly tied to grading the assignment. Otherwise, it is only advisory. Included if there is an associated rubric..Example: true", null: true
+        field :rubric_settings, String, "(Optional) An object describing the basic attributes of the rubric, including the point total. Included if there is an associated rubric..Example: {'points_possible'=>12}", null: true
+        field :rubric, [LMSGraphQL::Types::Canvas::CanvasRubricCriterium], "(Optional) A list of scoring criteria and ratings for each rubric criterion. Included if there is an associated rubric..", null: true
+        field :assignment_visibility, Int, "(Optional) If 'assignment_visibility' is included in the 'include' parameter, includes an array of student IDs who can see this assignment..Example: 137, 381, 572", null: true
+        field :overrides, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverride], "(Optional) If 'overrides' is included in the 'include' parameter, includes an array of assignment override objects..", null: true
+        field :omit_from_final_grade, Boolean, "(Optional) If true, the assignment will be omitted from the student's final grade.Example: true", null: true
+        field :moderated_grading, Boolean, "Boolean indicating if the assignment is moderated..Example: true", null: true
+        field :grader_count, Int, "The maximum number of provisional graders who may issue grades for this assignment. Only relevant for moderated assignments. Must be a positive value, and must be set to 1 if the course has fewer than two active instructors. Otherwise, the maximum value is the number of active instructors in the course minus one, or 10 if the course has more than 11 active instructors..Example: 3", null: true
+        field :final_grader_id, ID, "The user ID of the grader responsible for choosing final grades for this assignment. Only relevant for moderated assignments..Example: 3", null: true
+        field :grader_comments_visible_to_graders, Boolean, "Boolean indicating if provisional graders' comments are visible to other provisional graders. Only relevant for moderated assignments..Example: true", null: true
+        field :graders_anonymous_to_graders, Boolean, "Boolean indicating if provisional graders' identities are hidden from other provisional graders. Only relevant for moderated assignments with grader_comments_visible_to_graders set to true..Example: true", null: true
+        field :grader_names_visible_to_final_grader, Boolean, "Boolean indicating if provisional grader identities are visible to the final grader. Only relevant for moderated assignments..Example: true", null: true
+        field :anonymous_grading, Boolean, "Boolean indicating if the assignment is graded anonymously. If true, graders cannot see student identities..Example: true", null: true
+        field :allowed_attempts, Int, "The number of submission attempts a student can make for this assignment. -1 is considered unlimited..Example: 2", null: true
+        field :post_manually, Boolean, "Whether the assignment has manual posting enabled. Only relevant for courses using New Gradebook..Example: true", null: true
+
+      end
+    end
+  end
+end