whop_sdk 0.0.2 → 0.0.4

data/rbi/whop_sdk/models/lesson.rbi

@@ -0,0 +1,521 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Lesson < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Lesson, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the lesson
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Assessment questions for quiz/knowledge check lessons
+      sig { returns(T::Array[WhopSDK::Lesson::AssessmentQuestion]) }
+      attr_accessor :assessment_questions
+
+      # The attached files in this lesson as a flat array
+      sig { returns(T::Array[WhopSDK::Lesson::Attachment]) }
+      attr_accessor :attachments
+
+      # The content of the lesson
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content
+
+      # Number of days from course start until the lesson is unlocked
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :days_from_course_start_until_unlock
+
+      # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+      sig { returns(WhopSDK::LessonTypes::TaggedSymbol) }
+      attr_accessor :lesson_type
+
+      # The main PDF file for this lesson
+      sig { returns(T.nilable(WhopSDK::Lesson::MainPdf)) }
+      attr_reader :main_pdf
+
+      sig { params(main_pdf: T.nilable(WhopSDK::Lesson::MainPdf::OrHash)).void }
+      attr_writer :main_pdf
+
+      # The order of the lesson within its chapter
+      sig { returns(Integer) }
+      attr_accessor :order
+
+      # The title of the lesson
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The associated Mux asset for video lessons
+      sig { returns(T.nilable(WhopSDK::Lesson::VideoAsset)) }
+      attr_reader :video_asset
+
+      sig do
+        params(video_asset: T.nilable(WhopSDK::Lesson::VideoAsset::OrHash)).void
+      end
+      attr_writer :video_asset
+
+      # The visibility of the lesson. Determines how / whether this lesson is visible to
+      # users.
+      sig { returns(WhopSDK::LessonVisibilities::TaggedSymbol) }
+      attr_accessor :visibility
+
+      # A lesson from the courses app
+      sig do
+        params(
+          id: String,
+          assessment_questions:
+            T::Array[WhopSDK::Lesson::AssessmentQuestion::OrHash],
+          attachments: T::Array[WhopSDK::Lesson::Attachment::OrHash],
+          content: T.nilable(String),
+          days_from_course_start_until_unlock: T.nilable(Integer),
+          lesson_type: WhopSDK::LessonTypes::OrSymbol,
+          main_pdf: T.nilable(WhopSDK::Lesson::MainPdf::OrHash),
+          order: Integer,
+          title: String,
+          video_asset: T.nilable(WhopSDK::Lesson::VideoAsset::OrHash),
+          visibility: WhopSDK::LessonVisibilities::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the lesson
+        id:,
+        # Assessment questions for quiz/knowledge check lessons
+        assessment_questions:,
+        # The attached files in this lesson as a flat array
+        attachments:,
+        # The content of the lesson
+        content:,
+        # Number of days from course start until the lesson is unlocked
+        days_from_course_start_until_unlock:,
+        # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+        lesson_type:,
+        # The main PDF file for this lesson
+        main_pdf:,
+        # The order of the lesson within its chapter
+        order:,
+        # The title of the lesson
+        title:,
+        # The associated Mux asset for video lessons
+        video_asset:,
+        # The visibility of the lesson. Determines how / whether this lesson is visible to
+        # users.
+        visibility:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            assessment_questions: T::Array[WhopSDK::Lesson::AssessmentQuestion],
+            attachments: T::Array[WhopSDK::Lesson::Attachment],
+            content: T.nilable(String),
+            days_from_course_start_until_unlock: T.nilable(Integer),
+            lesson_type: WhopSDK::LessonTypes::TaggedSymbol,
+            main_pdf: T.nilable(WhopSDK::Lesson::MainPdf),
+            order: Integer,
+            title: String,
+            video_asset: T.nilable(WhopSDK::Lesson::VideoAsset),
+            visibility: WhopSDK::LessonVisibilities::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class AssessmentQuestion < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Lesson::AssessmentQuestion,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the assessment question
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The correct answer for the question. Used for short answer questions. Only
+        # visible to admins (users with courses:update permission)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :correct_answer
+
+        # When the question was created
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Optional image attachment for the question
+        sig { returns(T.nilable(WhopSDK::Lesson::AssessmentQuestion::Image)) }
+        attr_reader :image
+
+        sig do
+          params(
+            image: T.nilable(WhopSDK::Lesson::AssessmentQuestion::Image::OrHash)
+          ).void
+        end
+        attr_writer :image
+
+        # The answer options for multiple choice/select questions
+        sig { returns(T::Array[WhopSDK::Lesson::AssessmentQuestion::Option]) }
+        attr_accessor :options
+
+        # The order of the question within its lesson
+        sig { returns(Integer) }
+        attr_accessor :order
+
+        # The text of the question
+        sig { returns(String) }
+        attr_accessor :question_text
+
+        # The type of the question
+        sig { returns(WhopSDK::AssessmentQuestionTypes::TaggedSymbol) }
+        attr_accessor :question_type
+
+        # An assessment question in a course quiz or knowledge check
+        sig do
+          params(
+            id: String,
+            correct_answer: T.nilable(String),
+            created_at: Time,
+            image:
+              T.nilable(WhopSDK::Lesson::AssessmentQuestion::Image::OrHash),
+            options:
+              T::Array[WhopSDK::Lesson::AssessmentQuestion::Option::OrHash],
+            order: Integer,
+            question_text: String,
+            question_type: WhopSDK::AssessmentQuestionTypes::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the assessment question
+          id:,
+          # The correct answer for the question. Used for short answer questions. Only
+          # visible to admins (users with courses:update permission)
+          correct_answer:,
+          # When the question was created
+          created_at:,
+          # Optional image attachment for the question
+          image:,
+          # The answer options for multiple choice/select questions
+          options:,
+          # The order of the question within its lesson
+          order:,
+          # The text of the question
+          question_text:,
+          # The type of the question
+          question_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              correct_answer: T.nilable(String),
+              created_at: Time,
+              image: T.nilable(WhopSDK::Lesson::AssessmentQuestion::Image),
+              options: T::Array[WhopSDK::Lesson::AssessmentQuestion::Option],
+              order: Integer,
+              question_text: String,
+              question_type: WhopSDK::AssessmentQuestionTypes::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Image < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Lesson::AssessmentQuestion::Image,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of the attachment
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The attachment's content type (e.g., image/jpg, video/mp4)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :content_type
+
+          # The name of the file
+          sig { returns(T.nilable(String)) }
+          attr_accessor :filename
+
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :url
+
+          # Optional image attachment for the question
+          sig do
+            params(
+              id: String,
+              content_type: T.nilable(String),
+              filename: T.nilable(String),
+              url: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the attachment
+            id:,
+            # The attachment's content type (e.g., image/jpg, video/mp4)
+            content_type:,
+            # The name of the file
+            filename:,
+            # This is the URL you use to render optimized attachments on the client. This
+            # should be used for apps.
+            url:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                content_type: T.nilable(String),
+                filename: T.nilable(String),
+                url: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Option < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Lesson::AssessmentQuestion::Option,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of the assessment question option
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Whether this option is a correct answer. Only visible to admins (users with
+          # courses:update permission)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :is_correct
+
+          # The text of the answer option
+          sig { returns(String) }
+          attr_accessor :option_text
+
+          # The order of this option within the question
+          sig { returns(Integer) }
+          attr_accessor :order
+
+          # An answer option for a multiple choice or multiple select assessment question
+          sig do
+            params(
+              id: String,
+              is_correct: T.nilable(T::Boolean),
+              option_text: String,
+              order: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the assessment question option
+            id:,
+            # Whether this option is a correct answer. Only visible to admins (users with
+            # courses:update permission)
+            is_correct:,
+            # The text of the answer option
+            option_text:,
+            # The order of this option within the question
+            order:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                is_correct: T.nilable(T::Boolean),
+                option_text: String,
+                order: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Lesson::Attachment, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the attachment
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The attachment's content type (e.g., image/jpg, video/mp4)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :content_type
+
+        # The name of the file
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # Represents an image attachment
+        sig do
+          params(
+            id: String,
+            content_type: T.nilable(String),
+            filename: T.nilable(String),
+            url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the attachment
+          id:,
+          # The attachment's content type (e.g., image/jpg, video/mp4)
+          content_type:,
+          # The name of the file
+          filename:,
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content_type: T.nilable(String),
+              filename: T.nilable(String),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class MainPdf < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Lesson::MainPdf, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the attachment
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The attachment's content type (e.g., image/jpg, video/mp4)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :content_type
+
+        # The name of the file
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # The main PDF file for this lesson
+        sig do
+          params(
+            id: String,
+            content_type: T.nilable(String),
+            filename: T.nilable(String),
+            url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the attachment
+          id:,
+          # The attachment's content type (e.g., image/jpg, video/mp4)
+          content_type:,
+          # The name of the file
+          filename:,
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content_type: T.nilable(String),
+              filename: T.nilable(String),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class VideoAsset < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Lesson::VideoAsset, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the Mux asset
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Mux-provided ID of the asset
+        sig { returns(T.nilable(String)) }
+        attr_accessor :asset_id
+
+        # The public playback ID of the Mux asset
+        sig { returns(T.nilable(String)) }
+        attr_accessor :playback_id
+
+        # The associated Mux asset for video lessons
+        sig do
+          params(
+            id: String,
+            asset_id: T.nilable(String),
+            playback_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the Mux asset
+          id:,
+          # The Mux-provided ID of the asset
+          asset_id:,
+          # The public playback ID of the Mux asset
+          playback_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              asset_id: T.nilable(String),
+              playback_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/lesson_types.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The available types for a lesson
+    module LessonTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::LessonTypes) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      TEXT = T.let(:text, WhopSDK::LessonTypes::TaggedSymbol)
+      VIDEO = T.let(:video, WhopSDK::LessonTypes::TaggedSymbol)
+      PDF = T.let(:pdf, WhopSDK::LessonTypes::TaggedSymbol)
+      MULTI = T.let(:multi, WhopSDK::LessonTypes::TaggedSymbol)
+      QUIZ = T.let(:quiz, WhopSDK::LessonTypes::TaggedSymbol)
+      KNOWLEDGE_CHECK =
+        T.let(:knowledge_check, WhopSDK::LessonTypes::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::LessonTypes::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/lesson_visibilities.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The available visibilities for a lesson. Determines how / whether a lesson is
+    # visible to users.
+    module LessonVisibilities
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::LessonVisibilities) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      VISIBLE = T.let(:visible, WhopSDK::LessonVisibilities::TaggedSymbol)
+      HIDDEN = T.let(:hidden, WhopSDK::LessonVisibilities::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[WhopSDK::LessonVisibilities::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/member_list_params.rbi

@@ -78,6 +78,10 @@ module WhopSDK
       sig { returns(T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol])) }
       attr_accessor :statuses
 
+      # The user IDs to filter the members by
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :user_ids
+
       sig do
         params(
           company_id: String,
@@ -97,6 +101,7 @@ module WhopSDK
           promo_code_ids: T.nilable(T::Array[String]),
           query: T.nilable(String),
           statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
+          user_ids: T.nilable(T::Array[String]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -134,6 +139,8 @@ module WhopSDK
         query: nil,
         # The statuses to filter the members by
         statuses: nil,
+        # The user IDs to filter the members by
+        user_ids: nil,
         request_options: {}
       )
       end
@@ -158,6 +165,7 @@ module WhopSDK
             promo_code_ids: T.nilable(T::Array[String]),
             query: T.nilable(String),
             statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
+            user_ids: T.nilable(T::Array[String]),
             request_options: WhopSDK::RequestOptions
           }
         )

data/rbi/whop_sdk/models/membership.rbi

@@ -71,6 +71,13 @@ module WhopSDK
       sig { params(plan: WhopSDK::Membership::Plan::OrHash).void }
       attr_writer :plan
 
+      # The Product this Membership grants access to.
+      sig { returns(WhopSDK::Membership::Product) }
+      attr_reader :product
+
+      sig { params(product: WhopSDK::Membership::Product::OrHash).void }
+      attr_writer :product
+
       # The Promo Code that is currently applied to this Membership.
       sig { returns(T.nilable(WhopSDK::Membership::PromoCode)) }
       attr_reader :promo_code
@@ -124,6 +131,7 @@ module WhopSDK
           metadata: T::Hash[Symbol, T.anything],
           payment_collection_paused: T::Boolean,
           plan: WhopSDK::Membership::Plan::OrHash,
+          product: WhopSDK::Membership::Product::OrHash,
           promo_code: T.nilable(WhopSDK::Membership::PromoCode::OrHash),
           renewal_period_end: T.nilable(Time),
           renewal_period_start: T.nilable(Time),
@@ -161,6 +169,8 @@ module WhopSDK
         payment_collection_paused:,
         # The Plan this Membership is for.
         plan:,
+        # The Product this Membership grants access to.
+        product:,
         # The Promo Code that is currently applied to this Membership.
         promo_code:,
         # The timestamp in seconds at which the current billing cycle for this
@@ -194,6 +204,7 @@ module WhopSDK
             metadata: T::Hash[Symbol, T.anything],
             payment_collection_paused: T::Boolean,
             plan: WhopSDK::Membership::Plan,
+            product: WhopSDK::Membership::Product,
             promo_code: T.nilable(WhopSDK::Membership::PromoCode),
             renewal_period_end: T.nilable(Time),
             renewal_period_start: T.nilable(Time),
@@ -281,6 +292,35 @@ module WhopSDK
         end
       end
 
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Membership::Product, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The Product this Membership grants access to.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
       class PromoCode < WhopSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do