lms-graphql-api 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 358fa627a924534a860031a908602ea74777b16fabf1265cb830fc57ea37c71e
-  data.tar.gz: 2730860baf62f49c92ea1dfe38224814dd6f97d686d174ade80362850e69555d
+  metadata.gz: 1553540f1503fbadf467c724f34948954a62af8944523fa61830c7f7c60adcf9
+  data.tar.gz: 25eb3a5e81880b693c34efba5322ea99bde1ca0f03ad7482aa72e3a8e6725881
 SHA512:
-  metadata.gz: 9a6a89db9a705c54b67607b8cf45e165ed9264a24381c32ade27cb1104ad8d7f8f018c80a48f665fe4151bd711b36d771aa3d626424bc1a83180dbc2c4aca1e3
-  data.tar.gz: c795e70c13d93188d5d6bae5f8175340fb419364ddead2ac0fd9f332ce358e5961ed3e191e4a806a290fefb47c338fc3bb678cc2d347eacfb4815d4d0c912df2
+  metadata.gz: d421e976ce50d52b71eb9831b5e6883e4e7da6b365eab376dc631116837226e0d8ceced07d6c950a58f2ea2e4e9340ef8f88b8ce6812008e59c1ae40410c3cd5
+  data.tar.gz: 7996c100441fbc9a65e8ae421e810ac4a72854f8028029aeec0ecfa1462301029686770014cfd987971e33e9648e272eea73e216df38975929e7e6c8a1ded448

data/lib/lms_graphql/mutations/canvas/abort_all_pending_sis_imports.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class AbortAllPendingSisImport < BaseMutation
         argument :account_id, ID, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(account_id:)
           context[:canvas_api].call("ABORT_ALL_PENDING_SIS_IMPORTS").proxy(
             "ABORT_ALL_PENDING_SIS_IMPORTS",

data/lib/lms_graphql/mutations/canvas/abort_generation_of_report_or_remove_previously_generated_one.rb

@@ -7,7 +7,10 @@ module LMSGraphQL
         argument :course_id, ID, required: true
         argument :quiz_id, ID, required: true
         argument :id, ID, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, quiz_id:, id:)
           context[:canvas_api].call("ABORT_GENERATION_OF_REPORT_OR_REMOVE_PREVIOUSLY_GENERATED_ONE").proxy(
             "ABORT_GENERATION_OF_REPORT_OR_REMOVE_PREVIOUSLY_GENERATED_ONE",

data/lib/lms_graphql/mutations/canvas/abort_sis_import.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AbortSisImport < BaseMutation
         argument :account_id, ID, required: true
         argument :id, ID, required: true
+        
+        
         field :sis_import, LMSGraphQL::Types::Canvas::CanvasSisImport, null: false
+        
         def resolve(account_id:, id:)
           context[:canvas_api].call("ABORT_SIS_IMPORT").proxy(
             "ABORT_SIS_IMPORT",

data/lib/lms_graphql/mutations/canvas/accept_course_invitation.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AcceptCourseInvitation < BaseMutation
         argument :course_id, ID, required: true
         argument :id, ID, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, id:)
           context[:canvas_api].call("ACCEPT_COURSE_INVITATION").proxy(
             "ACCEPT_COURSE_INVITATION",

data/lib/lms_graphql/mutations/canvas/activate_role.rb

@@ -8,7 +8,10 @@ module LMSGraphQL
         argument :id, ID, required: true
         argument :role_id, ID, required: true
         argument :role, String, required: false
+        
+        
         field :role, LMSGraphQL::Types::Canvas::CanvasRole, null: false
+        
         def resolve(account_id:, id:, role_id:, role: nil)
           context[:canvas_api].call("ACTIVATE_ROLE").proxy(
             "ACTIVATE_ROLE",

data/lib/lms_graphql/mutations/canvas/add_allowed_domain_to_account.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AddAllowedDomainToAccount < BaseMutation
         argument :account_id, ID, required: true
         argument :domain, String, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(account_id:, domain:)
           context[:canvas_api].call("ADD_ALLOWED_DOMAIN_TO_ACCOUNT").proxy(
             "ADD_ALLOWED_DOMAIN_TO_ACCOUNT",

data/lib/lms_graphql/mutations/canvas/add_authentication_provider.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class AddAuthenticationProvider < BaseMutation
         argument :account_id, ID, required: true
+        
+        
         field :authentication_provider, LMSGraphQL::Types::Canvas::CanvasAuthenticationProvider, null: false
+        
         def resolve(account_id:)
           context[:canvas_api].call("ADD_AUTHENTICATION_PROVIDER").proxy(
             "ADD_AUTHENTICATION_PROVIDER",

data/lib/lms_graphql/mutations/canvas/add_course_to_favorites.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class AddCourseToFavorite < BaseMutation
         argument :id, ID, required: true
+        
+        
         field :favorite, LMSGraphQL::Types::Canvas::CanvasFavorite, null: false
+        
         def resolve(id:)
           context[:canvas_api].call("ADD_COURSE_TO_FAVORITES").proxy(
             "ADD_COURSE_TO_FAVORITES",

data/lib/lms_graphql/mutations/canvas/add_group_to_favorites.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class AddGroupToFavorite < BaseMutation
         argument :id, ID, required: true
+        
+        
         field :favorite, LMSGraphQL::Types::Canvas::CanvasFavorite, null: false
+        
         def resolve(id:)
           context[:canvas_api].call("ADD_GROUP_TO_FAVORITES").proxy(
             "ADD_GROUP_TO_FAVORITES",

data/lib/lms_graphql/mutations/canvas/add_message.rb

@@ -12,7 +12,10 @@ module LMSGraphQL
         argument :recipients, String, required: false
         argument :included_messages, String, required: false
         argument :user_note, Boolean, required: false
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(id:, body:, attachment_ids: nil, media_comment_id: nil, media_comment_type: nil, recipients: nil, included_messages: nil, user_note: nil)
           context[:canvas_api].call("ADD_MESSAGE").proxy(
             "ADD_MESSAGE",

data/lib/lms_graphql/mutations/canvas/add_multiple_allowed_domains_to_account.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AddMultipleAllowedDomainsToAccount < BaseMutation
         argument :account_id, ID, required: true
         argument :domains, String, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(account_id:, domains:)
           context[:canvas_api].call("ADD_MULTIPLE_ALLOWED_DOMAINS_TO_ACCOUNT").proxy(
             "ADD_MULTIPLE_ALLOWED_DOMAINS_TO_ACCOUNT",

data/lib/lms_graphql/mutations/canvas/add_observee.rb

@@ -7,7 +7,10 @@ module LMSGraphQL
         argument :user_id, ID, required: true
         argument :observee_id, ID, required: true
         argument :root_account_id, ID, required: false
+        
+        
         field :user, LMSGraphQL::Types::Canvas::CanvasUser, null: false
+        
         def resolve(user_id:, observee_id:, root_account_id: nil)
           context[:canvas_api].call("ADD_OBSERVEE").proxy(
             "ADD_OBSERVEE",

data/lib/lms_graphql/mutations/canvas/add_observee_with_credentials.rb

@@ -10,7 +10,10 @@ module LMSGraphQL
         argument :access_token, String, required: false
         argument :pairing_code, String, required: false
         argument :root_account_id, ID, required: false
+        
+        
         field :user, LMSGraphQL::Types::Canvas::CanvasUser, null: false
+        
         def resolve(user_id:, observee_unique_id: nil, observee_password: nil, access_token: nil, pairing_code: nil, root_account_id: nil)
           context[:canvas_api].call("ADD_OBSERVEE_WITH_CREDENTIALS").proxy(
             "ADD_OBSERVEE_WITH_CREDENTIALS",

data/lib/lms_graphql/mutations/canvas/add_recipients.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AddRecipient < BaseMutation
         argument :id, ID, required: true
         argument :recipients, String, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(id:, recipients:)
           context[:canvas_api].call("ADD_RECIPIENTS").proxy(
             "ADD_RECIPIENTS",

data/lib/lms_graphql/mutations/canvas/add_tool_to_rce_favorites.rb

@@ -0,0 +1,26 @@
+require_relative "../canvas_base_mutation"
+
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class AddToolToRceFavorite < BaseMutation
+        argument :account_id, ID, required: true
+        argument :id, ID, required: true
+        
+        
+        field :return_value, Boolean, null: false
+        
+        def resolve(account_id:, id:)
+          context[:canvas_api].call("ADD_TOOL_TO_RCE_FAVORITES").proxy(
+            "ADD_TOOL_TO_RCE_FAVORITES",
+            {
+              "account_id": account_id,
+              "id": id
+            },
+            {},
+          ).parsed_response
+        end
+      end
+    end
+  end
+end

data/lib/lms_graphql/mutations/canvas/add_users_to_content_share.rb

@@ -7,7 +7,10 @@ module LMSGraphQL
         argument :user_id, ID, required: true
         argument :id, ID, required: true
         argument :receiver_ids, String, required: false
+        
+        
         field :content_share, LMSGraphQL::Types::Canvas::CanvasContentShare, null: false
+        
         def resolve(user_id:, id:, receiver_ids: nil)
           context[:canvas_api].call("ADD_USERS_TO_CONTENT_SHARE").proxy(
             "ADD_USERS_TO_CONTENT_SHARE",

data/lib/lms_graphql/mutations/canvas/adds_last_attended_date_to_student_enrollment_in_course.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AddsLastAttendedDateToStudentEnrollmentInCourse < BaseMutation
         argument :course_id, ID, required: true
         argument :user_id, ID, required: true
+        
+        
         field :enrollment, LMSGraphQL::Types::Canvas::CanvasEnrollment, null: false
+        
         def resolve(course_id:, user_id:)
           context[:canvas_api].call("ADDS_LAST_ATTENDED_DATE_TO_STUDENT_ENROLLMENT_IN_COURSE").proxy(
             "ADDS_LAST_ATTENDED_DATE_TO_STUDENT_ENROLLMENT_IN_COURSE",

data/lib/lms_graphql/mutations/canvas/answering_questions.rb

@@ -9,7 +9,10 @@ module LMSGraphQL
         argument :validation_token, String, required: true
         argument :access_code, String, required: false
         argument :quiz_questions, [LMSGraphQL::Types::Canvas::CanvasQuizSubmissionQuestionInput], required: false
+        
+        
         field :quiz_submission_question, [LMSGraphQL::Types::Canvas::CanvasQuizSubmissionQuestion], null: false
+        
         def resolve(quiz_submission_id:, attempt:, validation_token:, access_code: nil, quiz_questions: nil)
           context[:canvas_api].call("ANSWERING_QUESTIONS").proxy(
             "ANSWERING_QUESTIONS",

data/lib/lms_graphql/mutations/canvas/assign_unassigned_members.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class AssignUnassignedMember < BaseMutation
         argument :group_category_id, ID, required: true
         argument :sync, Boolean, required: false
+        
+        
         field :group_membership, LMSGraphQL::Types::Canvas::CanvasGroupMembership, null: false
+        
         def resolve(group_category_id:, sync: nil)
           context[:canvas_api].call("ASSIGN_UNASSIGNED_MEMBERS").proxy(
             "ASSIGN_UNASSIGNED_MEMBERS",

data/lib/lms_graphql/mutations/canvas/batch_create_overrides_in_course.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class BatchCreateOverridesInCourse < BaseMutation
         argument :course_id, ID, required: true
         argument :assignment_overrides, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverrideInput], required: true
+        
+        
         field :assignment_override, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverride], null: false
+        
         def resolve(course_id:, assignment_overrides:)
           context[:canvas_api].call("BATCH_CREATE_OVERRIDES_IN_COURSE").proxy(
             "BATCH_CREATE_OVERRIDES_IN_COURSE",

data/lib/lms_graphql/mutations/canvas/batch_update_conversations.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class BatchUpdateConversation < BaseMutation
         argument :conversation_ids, [ID], required: true
         argument :event, String, required: true
+        
+        
         field :progress, LMSGraphQL::Types::Canvas::CanvasProgress, null: false
+        
         def resolve(conversation_ids:, event:)
           context[:canvas_api].call("BATCH_UPDATE_CONVERSATIONS").proxy(
             "BATCH_UPDATE_CONVERSATIONS",

data/lib/lms_graphql/mutations/canvas/batch_update_overrides_in_course.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class BatchUpdateOverridesInCourse < BaseMutation
         argument :course_id, ID, required: true
         argument :assignment_overrides, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverrideInput], required: true
+        
+        
         field :assignment_override, [LMSGraphQL::Types::Canvas::CanvasAssignmentOverride], null: false
+        
         def resolve(course_id:, assignment_overrides:)
           context[:canvas_api].call("BATCH_UPDATE_OVERRIDES_IN_COURSE").proxy(
             "BATCH_UPDATE_OVERRIDES_IN_COURSE",

data/lib/lms_graphql/mutations/canvas/begin_migration_to_push_to_associated_courses.rb

@@ -10,7 +10,10 @@ module LMSGraphQL
         argument :send_notification, Boolean, required: false
         argument :copy_settings, Boolean, required: false
         argument :publish_after_initial_sync, Boolean, required: false
+        
+        
         field :blueprint_migration, LMSGraphQL::Types::Canvas::CanvasBlueprintMigration, null: false
+        
         def resolve(course_id:, template_id:, comment: nil, send_notification: nil, copy_settings: nil, publish_after_initial_sync: nil)
           context[:canvas_api].call("BEGIN_MIGRATION_TO_PUSH_TO_ASSOCIATED_COURSES").proxy(
             "BEGIN_MIGRATION_TO_PUSH_TO_ASSOCIATED_COURSES",

data/lib/lms_graphql/mutations/canvas/bulk_select_provisional_grades.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class BulkSelectProvisionalGrade < BaseMutation
         argument :course_id, ID, required: true
         argument :assignment_id, ID, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, assignment_id:)
           context[:canvas_api].call("BULK_SELECT_PROVISIONAL_GRADES").proxy(
             "BULK_SELECT_PROVISIONAL_GRADES",

data/lib/lms_graphql/mutations/canvas/bulk_update_assignment_dates.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class BulkUpdateAssignmentDate < BaseMutation
         argument :course_id, ID, required: true
+        
+        
         field :progress, LMSGraphQL::Types::Canvas::CanvasProgress, null: false
+        
         def resolve(course_id:)
           context[:canvas_api].call("BULK_UPDATE_ASSIGNMENT_DATES").proxy(
             "BULK_UPDATE_ASSIGNMENT_DATES",

data/lib/lms_graphql/mutations/canvas/bulk_update_column_data.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class BulkUpdateColumnDatum < BaseMutation
         argument :course_id, ID, required: true
         argument :column_data, [String], required: true
+        
+        
         field :progress, LMSGraphQL::Types::Canvas::CanvasProgress, null: false
+        
         def resolve(course_id:, column_data:)
           context[:canvas_api].call("BULK_UPDATE_COLUMN_DATA").proxy(
             "BULK_UPDATE_COLUMN_DATA",

data/lib/lms_graphql/mutations/canvas/clear_course_nicknames.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class ClearCourseNickname < BaseMutation
 
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve()
           context[:canvas_api].call("CLEAR_COURSE_NICKNAMES").proxy(
             "CLEAR_COURSE_NICKNAMES",

data/lib/lms_graphql/mutations/canvas/close_notification_for_user.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class CloseNotificationForUser < BaseMutation
         argument :account_id, ID, required: true
         argument :id, ID, required: true
+        
+        
         field :account_notification, LMSGraphQL::Types::Canvas::CanvasAccountNotification, null: false
+        
         def resolve(account_id:, id:)
           context[:canvas_api].call("CLOSE_NOTIFICATION_FOR_USER").proxy(
             "CLOSE_NOTIFICATION_FOR_USER",

data/lib/lms_graphql/mutations/canvas/complete_quiz_submission_turn_it_in.rb

@@ -10,7 +10,10 @@ module LMSGraphQL
         argument :attempt, Int, required: true
         argument :validation_token, String, required: true
         argument :access_code, String, required: false
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, quiz_id:, id:, attempt:, validation_token:, access_code: nil)
           context[:canvas_api].call("COMPLETE_QUIZ_SUBMISSION_TURN_IT_IN").proxy(
             "COMPLETE_QUIZ_SUBMISSION_TURN_IT_IN",

data/lib/lms_graphql/mutations/canvas/conclude_deactivate_or_delete_enrollment.rb

@@ -7,7 +7,10 @@ module LMSGraphQL
         argument :course_id, ID, required: true
         argument :id, ID, required: true
         argument :task, String, required: false
+        
+        
         field :enrollment, LMSGraphQL::Types::Canvas::CanvasEnrollment, null: false
+        
         def resolve(course_id:, id:, task: nil)
           context[:canvas_api].call("CONCLUDE_DEACTIVATE_OR_DELETE_ENROLLMENT").proxy(
             "CONCLUDE_DEACTIVATE_OR_DELETE_ENROLLMENT",

data/lib/lms_graphql/mutations/canvas/confirm_image_selection.rb

@@ -5,7 +5,10 @@ module LMSGraphQL
     module Canvas
       class ConfirmImageSelection < BaseMutation
         argument :id, ID, required: true
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(id:)
           context[:canvas_api].call("CONFIRM_IMAGE_SELECTION").proxy(
             "CONFIRM_IMAGE_SELECTION",

data/lib/lms_graphql/mutations/canvas/copy_course_content.rb

@@ -8,7 +8,10 @@ module LMSGraphQL
         argument :source_course, String, required: false
         argument :except, String, required: false
         argument :only, String, required: false
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, source_course: nil, except: nil, only: nil)
           context[:canvas_api].call("COPY_COURSE_CONTENT").proxy(
             "COPY_COURSE_CONTENT",

data/lib/lms_graphql/mutations/canvas/copy_file.rb

@@ -7,7 +7,10 @@ module LMSGraphQL
         argument :dest_folder_id, ID, required: true
         argument :source_file_id, ID, required: true
         argument :on_duplicate, String, required: false
+        
+        
         field :file, LMSGraphQL::Types::Canvas::CanvasFile, null: false
+        
         def resolve(dest_folder_id:, source_file_id:, on_duplicate: nil)
           context[:canvas_api].call("COPY_FILE").proxy(
             "COPY_FILE",

data/lib/lms_graphql/mutations/canvas/copy_folder.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class CopyFolder < BaseMutation
         argument :dest_folder_id, ID, required: true
         argument :source_folder_id, ID, required: true
+        
+        
         field :folder, LMSGraphQL::Types::Canvas::CanvasFolder, null: false
+        
         def resolve(dest_folder_id:, source_folder_id:)
           context[:canvas_api].call("COPY_FOLDER").proxy(
             "COPY_FOLDER",

data/lib/lms_graphql/mutations/canvas/course_quiz_extensions_set_extensions_for_student_quiz_submissions.rb

@@ -11,7 +11,10 @@ module LMSGraphQL
         argument :manually_unlocked, Boolean, required: false
         argument :extend_from_now, Int, required: false
         argument :extend_from_end_at, Int, required: false
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, user_id:, extra_attempts: nil, extra_time: nil, manually_unlocked: nil, extend_from_now: nil, extend_from_end_at: nil)
           context[:canvas_api].call("COURSE_QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS").proxy(
             "COURSE_QUIZ_EXTENSIONS_SET_EXTENSIONS_FOR_STUDENT_QUIZ_SUBMISSIONS",

data/lib/lms_graphql/mutations/canvas/courses_preview_processed_html.rb

@@ -6,7 +6,10 @@ module LMSGraphQL
       class CoursesPreviewProcessedHtml < BaseMutation
         argument :course_id, ID, required: true
         argument :html, String, required: false
+        
+        
         field :return_value, Boolean, null: false
+        
         def resolve(course_id:, html: nil)
           context[:canvas_api].call("COURSES_PREVIEW_PROCESSED_HTML").proxy(
             "COURSES_PREVIEW_PROCESSED_HTML",