lms-graphql-api 1.3.0

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

@@ -0,0 +1,13 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasQuizSubmissionUserList < BaseType
+        description "Quiz Submission User List. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html"
+      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasQuizSubmissionUserListInput < BaseInputObject
+        description "Quiz Submission User List. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html"
+      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasQuizSubmissionUserListMetum < BaseType
+        description "Quiz Submission User List. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html"
+      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasQuizSubmissionUserListMetumInput < BaseInputObject
+        description "Quiz Submission User List. API Docs: https://canvas.instructure.com/doc/api/quiz_submission_user_list.html"
+      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_type"
+require_relative "file"
+require_relative "report_parameter"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasReport < BaseType
+        description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+        field :id, ID, "The unique identifier for the report..Example: 1", null: true
+        field :report, String, "The type of report..Example: sis_export_csv", null: true
+        field :file_url, String, "The url to the report download..Example: https://example.com/some/path", null: true
+        field :attachment, LMSGraphQL::Types::Canvas::CanvasFile, "The attachment api object of the report. Only available after the report has completed..", null: true
+        field :status, String, "The status of the report.Example: complete", null: true
+        field :created_at, LMSGraphQL::Types::DateTimeType, "The date and time the report was created..Example: 2013-12-01T23:59:00-06:00", null: true
+        field :started_at, LMSGraphQL::Types::DateTimeType, "The date and time the report started processing..Example: 2013-12-02T00:03:21-06:00", null: true
+        field :ended_at, LMSGraphQL::Types::DateTimeType, "The date and time the report finished processing..Example: 2013-12-02T00:03:21-06:00", null: true
+        field :parameters, LMSGraphQL::Types::Canvas::CanvasReportParameter, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", null: true
+        field :progress, Int, "The progress of the report.Example: 100", null: true
+        field :current_line, Int, "This is the current line count being written to the report. It updates every 1000 records..Example: 12000", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require_relative "../canvas_base_input_type"
+require_relative "file"
+require_relative "report_parameter"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasReportInput < BaseInputObject
+        description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+        argument :id, ID, "The unique identifier for the report..Example: 1", required: false
+        argument :report, String, "The type of report..Example: sis_export_csv", required: false
+        argument :file_url, String, "The url to the report download..Example: https://example.com/some/path", required: false
+        argument :attachment, LMSGraphQL::Types::Canvas::CanvasFileInput, "The attachment api object of the report. Only available after the report has completed..", required: false
+        argument :status, String, "The status of the report.Example: complete", required: false
+        argument :created_at, LMSGraphQL::Types::DateTimeType, "The date and time the report was created..Example: 2013-12-01T23:59:00-06:00", required: false
+        argument :started_at, LMSGraphQL::Types::DateTimeType, "The date and time the report started processing..Example: 2013-12-02T00:03:21-06:00", required: false
+        argument :ended_at, LMSGraphQL::Types::DateTimeType, "The date and time the report finished processing..Example: 2013-12-02T00:03:21-06:00", required: false
+        argument :parameters, LMSGraphQL::Types::Canvas::CanvasReportParameterInput, "The report parameters.Example: 2, 2012-07-13T10:55:20-06:00, 2012-07-13T10:55:20-06:00", required: false
+        argument :progress, Int, "The progress of the report.Example: 100", required: false
+        argument :current_line, Int, "This is the current line count being written to the report. It updates every 1000 records..Example: 12000", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class ReportParameterOrderEnum < ::GraphQL::Schema::Enum
+          value "users"
+          value "courses"
+          value "outcomes"
+        end
+      class CanvasReportParameter < BaseType
+        description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+        field :enrollment_term_id, ID, "The canvas id of the term to get grades from.Example: 2", null: true
+        field :include_deleted, Boolean, "If true, deleted objects will be included. If false, deleted objects will be omitted..", null: true
+        field :course_id, ID, "The id of the course to report on.Example: 2", null: true
+        field :order, ReportParameterOrderEnum, "The sort order for the csv, Options: 'users', 'courses', 'outcomes'..Example: users", null: true
+        field :users, Boolean, "If true, user data will be included. If false, user data will be omitted..", null: true
+        field :accounts, Boolean, "If true, account data will be included. If false, account data will be omitted..", null: true
+        field :terms, Boolean, "If true, term data will be included. If false, term data will be omitted..", null: true
+        field :courses, Boolean, "If true, course data will be included. If false, course data will be omitted..", null: true
+        field :sections, Boolean, "If true, section data will be included. If false, section data will be omitted..", null: true
+        field :enrollments, Boolean, "If true, enrollment data will be included. If false, enrollment data will be omitted..", null: true
+        field :groups, Boolean, "If true, group data will be included. If false, group data will be omitted..", null: true
+        field :xlist, Boolean, "If true, data for crosslisted courses will be included. If false, data for crosslisted courses will be omitted..", null: true
+        field :sis_terms_csv, Int, "Example: 1", null: true
+        field :sis_accounts_csv, Int, "Example: 1", null: true
+        field :include_enrollment_state, Boolean, "If true, enrollment state will be included. If false, enrollment state will be omitted. Defaults to false..", null: true
+        field :enrollment_state, String, "Include enrollment state. Defaults to 'all' Options: ['active'| 'invited'| 'creation_pending'| 'deleted'| 'rejected'| 'completed'| 'inactive'| 'all'].Example: all", null: true
+        field :start_at, LMSGraphQL::Types::DateTimeType, "The beginning date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", null: true
+        field :end_at, LMSGraphQL::Types::DateTimeType, "The end date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+        class ReportParameterOrderEnum < ::GraphQL::Schema::Enum
+          value "users"
+          value "courses"
+          value "outcomes"
+        end
+      class CanvasReportParameterInput < BaseInputObject
+        description "Account Reports. API Docs: https://canvas.instructure.com/doc/api/account_reports.html"
+        argument :enrollment_term_id, ID, "The canvas id of the term to get grades from.Example: 2", required: false
+        argument :include_deleted, Boolean, "If true, deleted objects will be included. If false, deleted objects will be omitted..", required: false
+        argument :course_id, ID, "The id of the course to report on.Example: 2", required: false
+        argument :order, ReportParameterOrderEnum, "The sort order for the csv, Options: 'users', 'courses', 'outcomes'..Example: users", required: false
+        argument :users, Boolean, "If true, user data will be included. If false, user data will be omitted..", required: false
+        argument :accounts, Boolean, "If true, account data will be included. If false, account data will be omitted..", required: false
+        argument :terms, Boolean, "If true, term data will be included. If false, term data will be omitted..", required: false
+        argument :courses, Boolean, "If true, course data will be included. If false, course data will be omitted..", required: false
+        argument :sections, Boolean, "If true, section data will be included. If false, section data will be omitted..", required: false
+        argument :enrollments, Boolean, "If true, enrollment data will be included. If false, enrollment data will be omitted..", required: false
+        argument :groups, Boolean, "If true, group data will be included. If false, group data will be omitted..", required: false
+        argument :xlist, Boolean, "If true, data for crosslisted courses will be included. If false, data for crosslisted courses will be omitted..", required: false
+        argument :sis_terms_csv, Int, "Example: 1", required: false
+        argument :sis_accounts_csv, Int, "Example: 1", required: false
+        argument :include_enrollment_state, Boolean, "If true, enrollment state will be included. If false, enrollment state will be omitted. Defaults to false..", required: false
+        argument :enrollment_state, String, "Include enrollment state. Defaults to 'all' Options: ['active'| 'invited'| 'creation_pending'| 'deleted'| 'rejected'| 'completed'| 'inactive'| 'all'].Example: all", required: false
+        argument :start_at, LMSGraphQL::Types::DateTimeType, "The beginning date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", required: false
+        argument :end_at, LMSGraphQL::Types::DateTimeType, "The end date for submissions. Max time range is 2 weeks..Example: 2012-07-13T10:55:20-06:00", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasResult < BaseType
+        description "Result. API Docs: https://canvas.instructure.com/doc/api/result.html"
+        field :id, ID, "The fully qualified URL for showing the Result.Example: http://institution.canvas.com/api/lti/courses/5/line_items/2/results/1", null: true
+        field :user_id, String, "The lti_user_id or the Canvas user_id.Example: 50 | 'abcasdf'", null: true
+        field :result_score, Float, "The score of the result as defined by Canvas, scaled to the resultMaximum.Example: 50", null: true
+        field :result_maximum, Float, "Maximum possible score for this result; 1 is the default value and will be assumed if not specified otherwise. Minimum value of 0 required..Example: 50", null: true
+        field :comment, String, "Comment visible to the student about the result..", null: true
+        field :score_of, String, "URL of the line item this belongs to.Example: http://institution.canvas.com/api/lti/courses/5/line_items/2", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasResultInput < BaseInputObject
+        description "Result. API Docs: https://canvas.instructure.com/doc/api/result.html"
+        argument :id, ID, "The fully qualified URL for showing the Result.Example: http://institution.canvas.com/api/lti/courses/5/line_items/2/results/1", required: false
+        argument :user_id, String, "The lti_user_id or the Canvas user_id.Example: 50 | 'abcasdf'", required: false
+        argument :result_score, Float, "The score of the result as defined by Canvas, scaled to the resultMaximum.Example: 50", required: false
+        argument :result_maximum, Float, "Maximum possible score for this result; 1 is the default value and will be assumed if not specified otherwise. Minimum value of 0 required..Example: 50", required: false
+        argument :comment, String, "Comment visible to the student about the result..", required: false
+        argument :score_of, String, "URL of the line item this belongs to.Example: http://institution.canvas.com/api/lti/courses/5/line_items/2", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasResultLink < BaseType
+        description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+        field :user, String, "A unique identifier for the user to whom this result applies.Example: 42", null: true
+        field :assessor, String, "A unique identifier for the user who created this result.Example: 23", null: true
+        field :assessment, String, "A unique identifier for the assessment that this result is for.Example: 5", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasResultLinkInput < BaseInputObject
+        description "LiveAssessments. API Docs: https://canvas.instructure.com/doc/api/live_assessments.html"
+        argument :user, String, "A unique identifier for the user to whom this result applies.Example: 42", required: false
+        argument :assessor, String, "A unique identifier for the user who created this result.Example: 23", required: false
+        argument :assessment, String, "A unique identifier for the assessment that this result is for.Example: 5", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_type"
+require_relative "account"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRole < BaseType
+        description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+        field :label, String, "The label of the role..Example: New Role", null: true
+        field :role, String, "The label of the role. (Deprecated alias for 'label').Example: New Role", null: true
+        field :base_role_type, String, "The role type that is being used as a base for this role. For account-level roles, this is 'AccountMembership'. For course-level roles, it is an enrollment type..Example: AccountMembership", null: true
+        field :account, LMSGraphQL::Types::Canvas::CanvasAccount, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", null: true
+        field :workflow_state, String, "The state of the role: 'active', 'inactive', or 'built_in'.Example: active", null: true
+        field :permissions, String, "A dictionary of permissions keyed by name (see permissions input parameter in the 'Create a role' API)..Example: {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>true, 'readonly'=>true, 'explicit'=>false}, {'enabled'=>false, 'locked'=>true, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>false}", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative "../canvas_base_input_type"
+require_relative "account"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRoleInput < BaseInputObject
+        description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+        argument :label, String, "The label of the role..Example: New Role", required: false
+        argument :role, String, "The label of the role. (Deprecated alias for 'label').Example: New Role", required: false
+        argument :base_role_type, String, "The role type that is being used as a base for this role. For account-level roles, this is 'AccountMembership'. For course-level roles, it is an enrollment type..Example: AccountMembership", required: false
+        argument :account, LMSGraphQL::Types::Canvas::CanvasAccountInput, "JSON representation of the account the role is in..Example: 1019, CGNU, 73, 1, cgnu", required: false
+        argument :workflow_state, String, "The state of the role: 'active', 'inactive', or 'built_in'.Example: active", required: false
+        argument :permissions, String, "A dictionary of permissions keyed by name (see permissions input parameter in the 'Create a role' API)..Example: {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>true, 'readonly'=>true, 'explicit'=>false}, {'enabled'=>false, 'locked'=>true, 'readonly'=>false, 'explicit'=>true, 'prior_default'=>false}, {'enabled'=>true, 'locked'=>false, 'readonly'=>false, 'explicit'=>false}", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRolePermission < BaseType
+        description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+        field :enabled, Boolean, "Whether the role has the permission.Example: true", null: true
+        field :locked, Boolean, "Whether the permission is locked by this role.", null: true
+        field :applies_to_self, Boolean, "Whether the permission applies to the account this role is in. Only present if enabled is true.Example: true", null: true
+        field :applies_to_descendants, Boolean, "Whether the permission cascades down to sub accounts of the account this role is in. Only present if enabled is true.", null: true
+        field :readonly, Boolean, "Whether the permission can be modified in this role (i.e. whether the permission is locked by an upstream role)..", null: true
+        field :explicit, Boolean, "Whether the value of enabled is specified explicitly by this role, or inherited from an upstream role..Example: true", null: true
+        field :prior_default, Boolean, "The value that would have been inherited from upstream if the role had not explicitly set a value. Only present if explicit is true..", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRolePermissionInput < BaseInputObject
+        description "Roles. API Docs: https://canvas.instructure.com/doc/api/roles.html"
+        argument :enabled, Boolean, "Whether the role has the permission.Example: true", required: false
+        argument :locked, Boolean, "Whether the permission is locked by this role.", required: false
+        argument :applies_to_self, Boolean, "Whether the permission applies to the account this role is in. Only present if enabled is true.Example: true", required: false
+        argument :applies_to_descendants, Boolean, "Whether the permission cascades down to sub accounts of the account this role is in. Only present if enabled is true.", required: false
+        argument :readonly, Boolean, "Whether the permission can be modified in this role (i.e. whether the permission is locked by an upstream role)..", required: false
+        argument :explicit, Boolean, "Whether the value of enabled is specified explicitly by this role, or inherited from an upstream role..Example: true", required: false
+        argument :prior_default, Boolean, "The value that would have been inherited from upstream if the role had not explicitly set a value. Only present if explicit is true..", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require_relative "../canvas_base_type"
+require_relative "rubric_criterion"
+require_relative "rubric_assessment"
+require_relative "rubric_association"
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRubric < BaseType
+        description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+        field :id, ID, "the ID of the rubric.Example: 1", null: true
+        field :title, String, "title of the rubric.Example: some title", null: true
+        field :context_id, ID, "the context owning the rubric.Example: 1", null: true
+        field :context_type, String, "Example: Course", null: true
+        field :points_possible, Int, "Example: 10.0", null: true
+        field :reusable, Boolean, "Example: false", null: true
+        field :read_only, Boolean, "Example: true", null: true
+        field :free_form_criterion_comments, Boolean, "whether or not free-form comments are used.Example: true", null: true
+        field :hide_score_total, Boolean, "Example: true", null: true
+        field :data, [LMSGraphQL::Types::Canvas::CanvasRubricCriterion], "An array with all of this Rubric's grading Criteria.", null: true
+        field :assessments, [LMSGraphQL::Types::Canvas::CanvasRubricAssessment], "If an assessment type is included in the 'include' parameter, includes an array of rubric assessment objects for a given rubric, based on the assessment type requested. If the user does not request an assessment type this key will be absent..", null: true
+        field :associations, [LMSGraphQL::Types::Canvas::CanvasRubricAssociation], "If an association type is included in the 'include' parameter, includes an array of rubric association objects for a given rubric, based on the association type requested. If the user does not request an association type this key will be absent..", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRubricAssessment < BaseType
+        description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+        field :id, ID, "the ID of the rubric.Example: 1", null: true
+        field :rubric_id, ID, "the rubric the assessment belongs to.Example: 1", null: true
+        field :rubric_association_id, ID, "Example: 2", null: true
+        field :score, Int, "Example: 5.0", null: true
+        field :artifact_type, String, "the object of the assessment.Example: Submission", null: true
+        field :artifact_id, ID, "the id of the object of the assessment.Example: 3", null: true
+        field :artifact_attempt, Int, "the current number of attempts made on the object of the assessment.Example: 2", null: true
+        field :assessment_type, String, "the type of assessment. values will be either 'grading', 'peer_review', or 'provisional_grade'.Example: grading", null: true
+        field :assessor_id, ID, "user id of the person who made the assessment.Example: 6", null: true
+        field :data, String, "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", null: true
+        field :comments, String, "(Optional) If 'comments_only' is included in the 'style' parameter, returned assessments will include only the comments portion of their data hash. If the user does not request a style, this key will be absent..", null: true
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../canvas_base_input_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRubricAssessmentInput < BaseInputObject
+        description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+        argument :id, ID, "the ID of the rubric.Example: 1", required: false
+        argument :rubric_id, ID, "the rubric the assessment belongs to.Example: 1", required: false
+        argument :rubric_association_id, ID, "Example: 2", required: false
+        argument :score, Int, "Example: 5.0", required: false
+        argument :artifact_type, String, "the object of the assessment.Example: Submission", required: false
+        argument :artifact_id, ID, "the id of the object of the assessment.Example: 3", required: false
+        argument :artifact_attempt, Int, "the current number of attempts made on the object of the assessment.Example: 2", required: false
+        argument :assessment_type, String, "the type of assessment. values will be either 'grading', 'peer_review', or 'provisional_grade'.Example: grading", required: false
+        argument :assessor_id, ID, "user id of the person who made the assessment.Example: 6", required: false
+        argument :data, String, "(Optional) If 'full' is included in the 'style' parameter, returned assessments will have their full details contained in their data hash. If the user does not request a style, this key will be absent..", required: false
+        argument :comments, String, "(Optional) If 'comments_only' is included in the 'style' parameter, returned assessments will include only the comments portion of their data hash. If the user does not request a style, this key will be absent..", required: false
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative "../canvas_base_type"
+
+
+module LMSGraphQL
+  module Types
+    module Canvas
+      class CanvasRubricAssociation < BaseType
+        description "Rubrics. API Docs: https://canvas.instructure.com/doc/api/rubrics.html"
+        field :id, ID, "the ID of the association.Example: 1", null: true
+        field :rubric_id, ID, "the ID of the rubric.Example: 1", null: true
+        field :association_id, ID, "the ID of the object this association links to.Example: 1", null: true
+        field :association_type, String, "the type of object this association links to.Example: Course", null: true
+        field :use_for_grading, Boolean, "Whether or not the associated rubric is used for grade calculation.Example: true", null: true
+        field :summary_data, String, "", null: true
+        field :purpose, String, "Whether or not the association is for grading (and thus linked to an assignment) or if it's to indicate the rubric should appear in its context. Values will be grading or bookmark..Example: grading", null: true
+        field :hide_score_total, Boolean, "Whether or not the score total is displayed within the rubric. This option is only available if the rubric is not used for grading..Example: true", null: true
+        field :hide_points, Boolean, "Example: true", null: true
+        field :hide_outcome_results, Boolean, "Example: true", null: true
+
+      end
+    end
+  end
+end