whop_sdk 0.0.2

data/rbi/whop_sdk/models/course_lesson_interaction.rbi

@@ -0,0 +1,256 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseLessonInteraction < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CourseLessonInteraction, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the lesson interaction
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether the lesson has been completed by the user
+      sig { returns(T::Boolean) }
+      attr_accessor :completed
+
+      # The course for this lesson interaction
+      sig { returns(WhopSDK::CourseLessonInteraction::Course) }
+      attr_reader :course
+
+      sig do
+        params(course: WhopSDK::CourseLessonInteraction::Course::OrHash).void
+      end
+      attr_writer :course
+
+      # When the interaction was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The lesson this interaction is for
+      sig { returns(WhopSDK::CourseLessonInteraction::Lesson) }
+      attr_reader :lesson
+
+      sig do
+        params(lesson: WhopSDK::CourseLessonInteraction::Lesson::OrHash).void
+      end
+      attr_writer :lesson
+
+      # The user who interacted with the lesson
+      sig { returns(WhopSDK::CourseLessonInteraction::User) }
+      attr_reader :user
+
+      sig { params(user: WhopSDK::CourseLessonInteraction::User::OrHash).void }
+      attr_writer :user
+
+      # A lesson interaction tracking user progress in courses
+      sig do
+        params(
+          id: String,
+          completed: T::Boolean,
+          course: WhopSDK::CourseLessonInteraction::Course::OrHash,
+          created_at: Time,
+          lesson: WhopSDK::CourseLessonInteraction::Lesson::OrHash,
+          user: WhopSDK::CourseLessonInteraction::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the lesson interaction
+        id:,
+        # Whether the lesson has been completed by the user
+        completed:,
+        # The course for this lesson interaction
+        course:,
+        # When the interaction was created
+        created_at:,
+        # The lesson this interaction is for
+        lesson:,
+        # The user who interacted with the lesson
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            completed: T::Boolean,
+            course: WhopSDK::CourseLessonInteraction::Course,
+            created_at: Time,
+            lesson: WhopSDK::CourseLessonInteraction::Lesson,
+            user: WhopSDK::CourseLessonInteraction::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Course < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonInteraction::Course,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the course. Looks like cors_XXX
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The experience that the course belongs to
+        sig { returns(WhopSDK::CourseLessonInteraction::Course::Experience) }
+        attr_reader :experience
+
+        sig do
+          params(
+            experience:
+              WhopSDK::CourseLessonInteraction::Course::Experience::OrHash
+          ).void
+        end
+        attr_writer :experience
+
+        # The title of the course
+        sig { returns(T.nilable(String)) }
+        attr_accessor :title
+
+        # The course for this lesson interaction
+        sig do
+          params(
+            id: String,
+            experience:
+              WhopSDK::CourseLessonInteraction::Course::Experience::OrHash,
+            title: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the course. Looks like cors_XXX
+          id:,
+          # The experience that the course belongs to
+          experience:,
+          # The title of the course
+          title:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              experience: WhopSDK::CourseLessonInteraction::Course::Experience,
+              title: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Experience < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseLessonInteraction::Course::Experience,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The unique ID representing this experience
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The experience that the course belongs to
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID representing this experience
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+      end
+
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonInteraction::Lesson,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the lesson
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the lesson
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The lesson this interaction is for
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the lesson
+          id:,
+          # The title of the lesson
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonInteraction::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who interacted with the lesson
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionCompletedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # A lesson interaction tracking user progress in courses
+      sig { returns(WhopSDK::CourseLessonInteraction) }
+      attr_reader :data
+
+      sig { params(data: WhopSDK::CourseLessonInteraction::OrHash).void }
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::CourseLessonInteraction::OrHash,
+          timestamp: Time,
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # A lesson interaction tracking user progress in courses
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"course_lesson_interaction.completed"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::CourseLessonInteraction,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_lesson_interaction_list_item.rbi

@@ -0,0 +1,165 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionListItem < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::CourseLessonInteractionListItem,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID of the lesson interaction
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether the lesson has been completed by the user
+      sig { returns(T::Boolean) }
+      attr_accessor :completed
+
+      # When the interaction was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The lesson this interaction is for
+      sig { returns(WhopSDK::CourseLessonInteractionListItem::Lesson) }
+      attr_reader :lesson
+
+      sig do
+        params(
+          lesson: WhopSDK::CourseLessonInteractionListItem::Lesson::OrHash
+        ).void
+      end
+      attr_writer :lesson
+
+      # The user who interacted with the lesson
+      sig { returns(WhopSDK::CourseLessonInteractionListItem::User) }
+      attr_reader :user
+
+      sig do
+        params(
+          user: WhopSDK::CourseLessonInteractionListItem::User::OrHash
+        ).void
+      end
+      attr_writer :user
+
+      # A lesson interaction tracking user progress in courses
+      sig do
+        params(
+          id: String,
+          completed: T::Boolean,
+          created_at: Time,
+          lesson: WhopSDK::CourseLessonInteractionListItem::Lesson::OrHash,
+          user: WhopSDK::CourseLessonInteractionListItem::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the lesson interaction
+        id:,
+        # Whether the lesson has been completed by the user
+        completed:,
+        # When the interaction was created
+        created_at:,
+        # The lesson this interaction is for
+        lesson:,
+        # The user who interacted with the lesson
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            completed: T::Boolean,
+            created_at: Time,
+            lesson: WhopSDK::CourseLessonInteractionListItem::Lesson,
+            user: WhopSDK::CourseLessonInteractionListItem::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonInteractionListItem::Lesson,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the lesson
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the lesson
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The lesson this interaction is for
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the lesson
+          id:,
+          # The title of the lesson
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonInteractionListItem::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who interacted with the lesson
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_lesson_interaction_list_params.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::CourseLessonInteractionListParams,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Whether the lesson has been completed by the user
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :completed
+
+      # The ID of the course to list course lesson interactions for
+      sig { returns(T.nilable(String)) }
+      attr_accessor :course_id
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # The ID of the lesson to list course lesson interactions for
+      sig { returns(T.nilable(String)) }
+      attr_accessor :lesson_id
+
+      # The ID of the user to list course lesson interactions for
+      sig { returns(T.nilable(String)) }
+      attr_accessor :user_id
+
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          completed: T.nilable(T::Boolean),
+          course_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          lesson_id: T.nilable(String),
+          user_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Whether the lesson has been completed by the user
+        completed: nil,
+        # The ID of the course to list course lesson interactions for
+        course_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the lesson to list course lesson interactions for
+        lesson_id: nil,
+        # The ID of the user to list course lesson interactions for
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: T.nilable(String),
+            before: T.nilable(String),
+            completed: T.nilable(T::Boolean),
+            course_id: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            lesson_id: T.nilable(String),
+            user_id: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course_lesson_interaction_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::CourseLessonInteractionRetrieveParams,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end