whop_sdk 0.0.3 → 0.0.4

data/lib/whop_sdk/models/course_lesson_update_params.rb

@@ -7,6 +7,14 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
+      # @!attribute assessment_completion_requirement
+      #   Completion requirements for quiz/knowledge check lessons
+      #
+      #   @return [WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil]
+      optional :assessment_completion_requirement,
+               -> { WhopSDK::CourseLessonUpdateParams::AssessmentCompletionRequirement },
+               nil?: true
+
       # @!attribute assessment_questions
       #   Assessment questions for quiz/knowledge check lessons. Replaces all existing
       #   questions.
@@ -20,9 +28,9 @@ module WhopSDK
       #   General attachments for the lesson (PDFs, files, etc). Replaces all existing
       #   attachments.
       #
-      #   @return [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil]
+      #   @return [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID>, nil]
       optional :attachments,
-               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseLessonUpdateParams::Attachment] },
+               -> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::CourseLessonUpdateParams::Attachment] },
                nil?: true
 
       # @!attribute content
@@ -46,8 +54,14 @@ module WhopSDK
       # @!attribute main_pdf
       #   The main PDF file for this lesson
       #
-      #   @return [WhopSDK::Models::CourseLessonUpdateParams::MainPdf, nil]
-      optional :main_pdf, -> { WhopSDK::CourseLessonUpdateParams::MainPdf }, nil?: true
+      #   @return [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil]
+      optional :main_pdf, union: -> { WhopSDK::CourseLessonUpdateParams::MainPdf }, nil?: true
+
+      # @!attribute max_attempts
+      #   Maximum number of attempts allowed for assessments
+      #
+      #   @return [Integer, nil]
+      optional :max_attempts, Integer, nil?: true
 
       # @!attribute mux_asset_id
       #   The ID of the Mux asset to attach to this lesson for video lessons
@@ -68,13 +82,15 @@ module WhopSDK
       #   @return [Symbol, WhopSDK::Models::LessonVisibilities, nil]
       optional :visibility, enum: -> { WhopSDK::LessonVisibilities }, nil?: true
 
-      # @!method initialize(assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
+      # @!method initialize(assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::CourseLessonUpdateParams} for more details.
       #
+      #   @param assessment_completion_requirement [WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil] Completion requirements for quiz/knowledge check lessons
+      #
       #   @param assessment_questions [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil] Assessment questions for quiz/knowledge check lessons. Replaces all existing que
       #
-      #   @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
+      #   @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
       #
       #   @param content [String, nil] The content of the lesson
       #
@@ -82,7 +98,9 @@ module WhopSDK
       #
       #   @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
       #
-      #   @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf, nil] The main PDF file for this lesson
+      #   @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil] The main PDF file for this lesson
+      #
+      #   @param max_attempts [Integer, nil] Maximum number of attempts allowed for assessments
       #
       #   @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
       #
@@ -92,6 +110,33 @@ module WhopSDK
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
+      class AssessmentCompletionRequirement < WhopSDK::Internal::Type::BaseModel
+        # @!attribute minimum_grade_percent
+        #   The minimum grade percentage required to pass (0-100). Cannot be set together
+        #   with minimum_questions_correct.
+        #
+        #   @return [Float, nil]
+        optional :minimum_grade_percent, Float, nil?: true
+
+        # @!attribute minimum_questions_correct
+        #   The minimum number of questions that must be answered correctly. Cannot be set
+        #   together with minimum_grade_percent.
+        #
+        #   @return [Integer, nil]
+        optional :minimum_questions_correct, Integer, nil?: true
+
+        # @!method initialize(minimum_grade_percent: nil, minimum_questions_correct: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement} for
+        #   more details.
+        #
+        #   Completion requirements for quiz/knowledge check lessons
+        #
+        #   @param minimum_grade_percent [Float, nil] The minimum grade percentage required to pass (0-100). Cannot be set together wi
+        #
+        #   @param minimum_questions_correct [Integer, nil] The minimum number of questions that must be answered correctly. Cannot be set t
+      end
+
       class AssessmentQuestion < WhopSDK::Internal::Type::BaseModel
         # @!attribute correct_answer
         #   The correct answer for the question. Used for short answer questions
@@ -121,8 +166,12 @@ module WhopSDK
         # @!attribute image
         #   Optional image attachment for the question
         #
-        #   @return [WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image, nil]
-        optional :image, -> { WhopSDK::CourseLessonUpdateParams::AssessmentQuestion::Image }, nil?: true
+        #   @return [WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithID, nil]
+        optional :image,
+                 union: -> {
+                   WhopSDK::CourseLessonUpdateParams::AssessmentQuestion::Image
+                 },
+                 nil?: true
 
         # @!attribute options
         #   The answer options for multiple choice/select questions
@@ -149,38 +198,62 @@ module WhopSDK
         #
         #   @param id [String, nil] The ID of an existing question. If provided, the question will be updated. If no
         #
-        #   @param image [WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image, nil] Optional image attachment for the question
+        #   @param image [WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithID, nil] Optional image attachment for the question
         #
         #   @param options [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Option>, nil] The answer options for multiple choice/select questions
 
+        # Optional image attachment for the question
+        #
         # @see WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion#image
-        class Image < WhopSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #   The ID of an existing attachment object. Use this when updating a resource and
-          #   keeping a subset of the attachments. Don't use this unless you know what you're
-          #   doing.
-          #
-          #   @return [String, nil]
-          optional :id, String, nil?: true
+        module Image
+          extend WhopSDK::Internal::Type::Union
 
-          # @!attribute direct_upload_id
-          #   This ID should be used the first time you upload an attachment. It is the ID of
-          #   the direct upload that was created when uploading the file to S3 via the
-          #   mediaDirectUpload mutation.
-          #
-          #   @return [String, nil]
-          optional :direct_upload_id, String, nil?: true
+          # Input for an attachment
+          variant -> { WhopSDK::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithDirectUploadID }
 
-          # @!method initialize(id: nil, direct_upload_id: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image} for more
-          #   details.
-          #
-          #   Optional image attachment for the question
-          #
-          #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
-          #
-          #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+          # Input for an attachment
+          variant -> { WhopSDK::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithID }
+
+          class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+            # @!attribute direct_upload_id
+            #   This ID should be used the first time you upload an attachment. It is the ID of
+            #   the direct upload that was created when uploading the file to S3 via the
+            #   mediaDirectUpload mutation.
+            #
+            #   @return [String]
+            required :direct_upload_id, String
+
+            # @!method initialize(direct_upload_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithDirectUploadID}
+            #   for more details.
+            #
+            #   Input for an attachment
+            #
+            #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+          end
+
+          class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   The ID of an existing attachment object. Use this when updating a resource and
+            #   keeping a subset of the attachments. Don't use this unless you know what you're
+            #   doing.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithID}
+            #   for more details.
+            #
+            #   Input for an attachment
+            #
+            #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+          end
+
+          # @!method self.variants
+          #   @return [Array(WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion::Image::AttachmentInputWithID)]
         end
 
         class Option < WhopSDK::Internal::Type::BaseModel
@@ -218,60 +291,108 @@ module WhopSDK
         end
       end
 
-      class Attachment < WhopSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #   The ID of an existing attachment object. Use this when updating a resource and
-        #   keeping a subset of the attachments. Don't use this unless you know what you're
-        #   doing.
-        #
-        #   @return [String, nil]
-        optional :id, String, nil?: true
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
 
-        # @!attribute direct_upload_id
-        #   This ID should be used the first time you upload an attachment. It is the ID of
-        #   the direct upload that was created when uploading the file to S3 via the
-        #   mediaDirectUpload mutation.
-        #
-        #   @return [String, nil]
-        optional :direct_upload_id, String, nil?: true
+        # Input for an attachment
+        variant -> { WhopSDK::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID }
 
-        # @!method initialize(id: nil, direct_upload_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::CourseLessonUpdateParams::Attachment} for more details.
-        #
-        #   Input for an attachment
-        #
-        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
-        #
-        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+        # Input for an attachment
+        variant -> { WhopSDK::CourseLessonUpdateParams::Attachment::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute direct_upload_id
+          #   This ID should be used the first time you upload an attachment. It is the ID of
+          #   the direct upload that was created when uploading the file to S3 via the
+          #   mediaDirectUpload mutation.
+          #
+          #   @return [String]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of an existing attachment object. Use this when updating a resource and
+          #   keeping a subset of the attachments. Don't use this unless you know what you're
+          #   doing.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID)]
       end
 
-      class MainPdf < WhopSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #   The ID of an existing attachment object. Use this when updating a resource and
-        #   keeping a subset of the attachments. Don't use this unless you know what you're
-        #   doing.
-        #
-        #   @return [String, nil]
-        optional :id, String, nil?: true
+      # The main PDF file for this lesson
+      module MainPdf
+        extend WhopSDK::Internal::Type::Union
 
-        # @!attribute direct_upload_id
-        #   This ID should be used the first time you upload an attachment. It is the ID of
-        #   the direct upload that was created when uploading the file to S3 via the
-        #   mediaDirectUpload mutation.
-        #
-        #   @return [String, nil]
-        optional :direct_upload_id, String, nil?: true
+        # Input for an attachment
+        variant -> { WhopSDK::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID }
 
-        # @!method initialize(id: nil, direct_upload_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::CourseLessonUpdateParams::MainPdf} for more details.
-        #
-        #   The main PDF file for this lesson
-        #
-        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
-        #
-        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+        # Input for an attachment
+        variant -> { WhopSDK::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute direct_upload_id
+          #   This ID should be used the first time you upload an attachment. It is the ID of
+          #   the direct upload that was created when uploading the file to S3 via the
+          #   mediaDirectUpload mutation.
+          #
+          #   @return [String]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of an existing attachment object. Use this when updating a resource and
+          #   keeping a subset of the attachments. Don't use this unless you know what you're
+          #   doing.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID} for
+          #   more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID)]
       end
     end
   end

data/lib/whop_sdk/models/course_student_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseStudents#list
+    class CourseStudentListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute course_id
+      #   The ID of the course
+      #
+      #   @return [String]
+      required :course_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute keyword
+      #   Filter students by name - returns students whose names match the keyword
+      #
+      #   @return [String, nil]
+      optional :keyword, String, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!method initialize(course_id:, after: nil, before: nil, first: nil, keyword: nil, last: nil, request_options: {})
+      #   @param course_id [String] The ID of the course
+      #
+      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param keyword [String, nil] Filter students by name - returns students whose names match the keyword
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_student_list_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseStudents#list
+    class CourseStudentListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the course student. Looks like crsi_XXX
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute completed_lessons_count
+      #   The number of lessons the student has completed
+      #
+      #   @return [Integer]
+      required :completed_lessons_count, Integer
+
+      # @!attribute completion_rate
+      #   The percentage of lessons completed (0-100)
+      #
+      #   @return [Float]
+      required :completion_rate, Float
+
+      # @!attribute first_interaction_at
+      #   When the student first interacted with the course
+      #
+      #   @return [Time]
+      required :first_interaction_at, Time
+
+      # @!attribute last_interaction_at
+      #   When the student last interacted with the course
+      #
+      #   @return [Time]
+      required :last_interaction_at, Time
+
+      # @!attribute total_lessons_count
+      #   The total number of lessons the student has access to
+      #
+      #   @return [Integer]
+      required :total_lessons_count, Integer
+
+      # @!attribute user
+      #   The user who is enrolled in the course
+      #
+      #   @return [WhopSDK::Models::CourseStudentListResponse::User]
+      required :user, -> { WhopSDK::Models::CourseStudentListResponse::User }
+
+      # @!method initialize(id:, completed_lessons_count:, completion_rate:, first_interaction_at:, last_interaction_at:, total_lessons_count:, user:)
+      #   A course student (enrollment of a student in a course)
+      #
+      #   @param id [String] The ID of the course student. Looks like crsi_XXX
+      #
+      #   @param completed_lessons_count [Integer] The number of lessons the student has completed
+      #
+      #   @param completion_rate [Float] The percentage of lessons completed (0-100)
+      #
+      #   @param first_interaction_at [Time] When the student first interacted with the course
+      #
+      #   @param last_interaction_at [Time] When the student last interacted with the course
+      #
+      #   @param total_lessons_count [Integer] The total number of lessons the student has access to
+      #
+      #   @param user [WhopSDK::Models::CourseStudentListResponse::User] The user who is enrolled in the course
+
+      # @see WhopSDK::Models::CourseStudentListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user who is enrolled in the course
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/course_student_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseStudents#retrieve
+    class CourseStudentRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end