whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/models/company_list_response.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CompanyListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::CompanyListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID (tag) of the company.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::TaggedSymbol)) }
+      attr_accessor :business_type
+
+      # When the company was created (signed up)
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The creator pitch for the company.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::TaggedSymbol)) }
+      attr_accessor :industry_type
+
+      # The company's logo.
+      sig { returns(T.nilable(WhopSDK::Models::CompanyListResponse::Logo)) }
+      attr_reader :logo
+
+      sig do
+        params(
+          logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo::OrHash)
+        ).void
+      end
+      attr_writer :logo
+
+      # The number of members in the company.
+      sig { returns(Integer) }
+      attr_accessor :member_count
+
+      # A key-value store of data for the account, created/updated by the platform that
+      # made the account.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # The user who owns this company
+      sig { returns(WhopSDK::Models::CompanyListResponse::OwnerUser) }
+      attr_reader :owner_user
+
+      sig do
+        params(
+          owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser::OrHash
+        ).void
+      end
+      attr_writer :owner_user
+
+      # The number of reviews that have been published for the company.
+      sig { returns(Integer) }
+      attr_accessor :published_reviews_count
+
+      # The slug/route of the company on the Whop site.
+      sig { returns(String) }
+      attr_accessor :route
+
+      # The title of the company.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The time the company was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # If the company is Whop Verified
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      # An object representing a (sanitized) company.
+      sig do
+        params(
+          id: String,
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          created_at: Time,
+          description: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo::OrHash),
+          member_count: Integer,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser::OrHash,
+          published_reviews_count: Integer,
+          route: String,
+          title: String,
+          updated_at: Time,
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID (tag) of the company.
+        id:,
+        # The different business types a company can be.
+        business_type:,
+        # When the company was created (signed up)
+        created_at:,
+        # The creator pitch for the company.
+        description:,
+        # The different industry types a company can be in.
+        industry_type:,
+        # The company's logo.
+        logo:,
+        # The number of members in the company.
+        member_count:,
+        # A key-value store of data for the account, created/updated by the platform that
+        # made the account.
+        metadata:,
+        # The user who owns this company
+        owner_user:,
+        # The number of reviews that have been published for the company.
+        published_reviews_count:,
+        # The slug/route of the company on the Whop site.
+        route:,
+        # The title of the company.
+        title:,
+        # The time the company was last updated.
+        updated_at:,
+        # If the company is Whop Verified
+        verified:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business_type: T.nilable(WhopSDK::BusinessTypes::TaggedSymbol),
+            created_at: Time,
+            description: T.nilable(String),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::TaggedSymbol),
+            logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo),
+            member_count: Integer,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser,
+            published_reviews_count: Integer,
+            route: String,
+            title: String,
+            updated_at: Time,
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CompanyListResponse::Logo,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # 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 company's logo.
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+
+      class OwnerUser < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CompanyListResponse::OwnerUser,
+              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 owns this company
+        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.rbi

@@ -32,6 +32,10 @@ module WhopSDK
       sig { returns(WhopSDK::Languages::TaggedSymbol) }
       attr_accessor :language
 
+      # The order of the course within its experience
+      sig { returns(String) }
+      attr_accessor :order
+
       # Whether the course requires students to complete the previous lesson before
       # moving on to the next one
       sig { returns(T::Boolean) }
@@ -58,6 +62,11 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :updated_at
 
+      # The visibility of the course. Determines how / whether this course is visible to
+      # users.
+      sig { returns(WhopSDK::CourseVisibilities::TaggedSymbol) }
+      attr_accessor :visibility
+
       # A course from the courses app
       sig do
         params(
@@ -67,11 +76,13 @@ module WhopSDK
           created_at: Time,
           description: T.nilable(String),
           language: WhopSDK::Languages::OrSymbol,
+          order: String,
           require_completing_lessons_in_order: T::Boolean,
           tagline: T.nilable(String),
           thumbnail: T.nilable(WhopSDK::Course::Thumbnail::OrHash),
           title: T.nilable(String),
-          updated_at: Time
+          updated_at: Time,
+          visibility: WhopSDK::CourseVisibilities::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
@@ -89,6 +100,8 @@ module WhopSDK
         # The language spoken in the video content of the course, used to generate closed
         # captions in the right language
         language:,
+        # The order of the course within its experience
+        order:,
         # Whether the course requires students to complete the previous lesson before
         # moving on to the next one
         require_completing_lessons_in_order:,
@@ -99,7 +112,10 @@ module WhopSDK
         # The title of the course
         title:,
         # The timestamp of when the course was last updated
-        updated_at:
+        updated_at:,
+        # The visibility of the course. Determines how / whether this course is visible to
+        # users.
+        visibility:
       )
       end
 
@@ -112,11 +128,13 @@ module WhopSDK
             created_at: Time,
             description: T.nilable(String),
             language: WhopSDK::Languages::TaggedSymbol,
+            order: String,
             require_completing_lessons_in_order: T::Boolean,
             tagline: T.nilable(String),
             thumbnail: T.nilable(WhopSDK::Course::Thumbnail),
             title: T.nilable(String),
-            updated_at: Time
+            updated_at: Time,
+            visibility: WhopSDK::CourseVisibilities::TaggedSymbol
           }
         )
       end

data/rbi/whop_sdk/models/course_create_params.rbi

@@ -19,32 +19,65 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :title
 
+      # Whether the course will award its students a PDF certificate after completing
+      # all lessons
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :certificate_after_completion_enabled
+
       # The cover image URL of the course
       sig { returns(T.nilable(String)) }
       attr_accessor :cover_image
 
+      # The decimal order position of the course within its experience. If not provided,
+      # it will be set to the next sequential order. Use fractional values (e.g., 1.5)
+      # to place between existing courses.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :order
+
+      # Whether the course requires students to complete the previous lesson before
+      # moving on to the next one
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :require_completing_lessons_in_order
+
       # The tagline of the course
       sig { returns(T.nilable(String)) }
       attr_accessor :tagline
 
       # The thumbnail for the course in png, jpeg, or gif format
-      sig { returns(T.nilable(WhopSDK::CourseCreateParams::Thumbnail)) }
-      attr_reader :thumbnail
-
       sig do
-        params(
-          thumbnail: T.nilable(WhopSDK::CourseCreateParams::Thumbnail::OrHash)
-        ).void
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID
+            )
+          )
+        )
       end
-      attr_writer :thumbnail
+      attr_accessor :thumbnail
+
+      # The available visibilities for a course. Determines how / whether a course is
+      # visible to users.
+      sig { returns(T.nilable(WhopSDK::CourseVisibilities::OrSymbol)) }
+      attr_accessor :visibility
 
       sig do
         params(
           experience_id: String,
           title: String,
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
           cover_image: T.nilable(String),
+          order: T.nilable(String),
+          require_completing_lessons_in_order: T.nilable(T::Boolean),
           tagline: T.nilable(String),
-          thumbnail: T.nilable(WhopSDK::CourseCreateParams::Thumbnail::OrHash),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
+          visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -53,12 +86,25 @@ module WhopSDK
         experience_id:,
         # The title of the course
         title:,
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled: nil,
         # The cover image URL of the course
         cover_image: nil,
+        # The decimal order position of the course within its experience. If not provided,
+        # it will be set to the next sequential order. Use fractional values (e.g., 1.5)
+        # to place between existing courses.
+        order: nil,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order: nil,
         # The tagline of the course
         tagline: nil,
         # The thumbnail for the course in png, jpeg, or gif format
         thumbnail: nil,
+        # The available visibilities for a course. Determines how / whether a course is
+        # visible to users.
+        visibility: nil,
         request_options: {}
       )
       end
@@ -68,9 +114,19 @@ module WhopSDK
           {
             experience_id: String,
             title: String,
+            certificate_after_completion_enabled: T.nilable(T::Boolean),
             cover_image: T.nilable(String),
+            order: T.nilable(String),
+            require_completing_lessons_in_order: T.nilable(T::Boolean),
             tagline: T.nilable(String),
-            thumbnail: T.nilable(WhopSDK::CourseCreateParams::Thumbnail),
+            thumbnail:
+              T.nilable(
+                T.any(
+                  WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                  WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID
+                )
+              ),
+            visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
             request_options: WhopSDK::RequestOptions
           }
         )
@@ -78,52 +134,84 @@ module WhopSDK
       def to_hash
       end
 
-      class Thumbnail < WhopSDK::Internal::Type::BaseModel
-        OrHash =
+      # The thumbnail for the course in png, jpeg, or gif format
+      module Thumbnail
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              WhopSDK::CourseCreateParams::Thumbnail,
-              WhopSDK::Internal::AnyHash
+              WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID
             )
           end
 
-        # 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.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :id
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
 
-        # 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.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :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.
+          sig { returns(String) }
+          attr_accessor :direct_upload_id
 
-        # The thumbnail for the course in png, jpeg, or gif format
-        sig do
-          params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
-          ).returns(T.attached_class)
+          # Input for an attachment
+          sig { params(direct_upload_id: String).returns(T.attached_class) }
+          def self.new(
+            # 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.
+            direct_upload_id:
+          )
+          end
+
+          sig { override.returns({ direct_upload_id: String }) }
+          def to_hash
+          end
         end
-        def self.new(
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
           # 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.
-          id: nil,
-          # 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.
-          direct_upload_id: nil
-        )
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Input for an attachment
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # 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.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
 
         sig do
           override.returns(
-            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+            T::Array[WhopSDK::CourseCreateParams::Thumbnail::Variants]
           )
         end
-        def to_hash
+        def self.variants
         end
       end
     end

data/rbi/whop_sdk/models/course_lesson_create_params.rbi

@@ -27,6 +27,27 @@ module WhopSDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :days_from_course_start_until_unlock
 
+      # ID for the embed (YouTube video ID or Loom share ID)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :embed_id
+
+      # The type of embed for a lesson
+      sig { returns(T.nilable(WhopSDK::EmbedType::OrSymbol)) }
+      attr_accessor :embed_type
+
+      # The thumbnail for the lesson in png, jpeg, or gif format
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID
+            )
+          )
+        )
+      end
+      attr_accessor :thumbnail
+
       # The title of the lesson
       sig { returns(T.nilable(String)) }
       attr_accessor :title
@@ -37,6 +58,15 @@ module WhopSDK
           lesson_type: WhopSDK::LessonTypes::OrSymbol,
           content: T.nilable(String),
           days_from_course_start_until_unlock: T.nilable(Integer),
+          embed_id: T.nilable(String),
+          embed_type: T.nilable(WhopSDK::EmbedType::OrSymbol),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
           title: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -50,6 +80,12 @@ module WhopSDK
         content: nil,
         # Days from course start until unlock
         days_from_course_start_until_unlock: nil,
+        # ID for the embed (YouTube video ID or Loom share ID)
+        embed_id: nil,
+        # The type of embed for a lesson
+        embed_type: nil,
+        # The thumbnail for the lesson in png, jpeg, or gif format
+        thumbnail: nil,
         # The title of the lesson
         title: nil,
         request_options: {}
@@ -63,6 +99,15 @@ module WhopSDK
             lesson_type: WhopSDK::LessonTypes::OrSymbol,
             content: T.nilable(String),
             days_from_course_start_until_unlock: T.nilable(Integer),
+            embed_id: T.nilable(String),
+            embed_type: T.nilable(WhopSDK::EmbedType::OrSymbol),
+            thumbnail:
+              T.nilable(
+                T.any(
+                  WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                  WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID
+                )
+              ),
             title: T.nilable(String),
             request_options: WhopSDK::RequestOptions
           }
@@ -70,6 +115,87 @@ module WhopSDK
       end
       def to_hash
       end
+
+      # The thumbnail for the lesson in png, jpeg, or gif format
+      module Thumbnail
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+              WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID
+            )
+          end
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :direct_upload_id
+
+          # Input for an attachment
+          sig { params(direct_upload_id: String).returns(T.attached_class) }
+          def self.new(
+            # 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.
+            direct_upload_id:
+          )
+          end
+
+          sig { override.returns({ direct_upload_id: String }) }
+          def to_hash
+          end
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Input for an attachment
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # 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.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::CourseLessonCreateParams::Thumbnail::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
     end
   end
 end