whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/models/transfer_list_response.rbi

@@ -35,6 +35,10 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :fee_amount
 
+      # A hash of metadata attached to the transfer
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The notes of the credit transaction transfer
       sig { returns(T.nilable(String)) }
       attr_accessor :notes
@@ -52,6 +56,7 @@ module WhopSDK
           currency: WhopSDK::Currency::OrSymbol,
           destination_ledger_account_id: String,
           fee_amount: T.nilable(Float),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
           origin_ledger_account_id: String
         ).returns(T.attached_class)
@@ -69,6 +74,8 @@ module WhopSDK
         destination_ledger_account_id:,
         # The decimal fee of the credit transaction transfer
         fee_amount:,
+        # A hash of metadata attached to the transfer
+        metadata:,
         # The notes of the credit transaction transfer
         notes:,
         # The ID of the origin ledger account
@@ -85,6 +92,7 @@ module WhopSDK
             currency: WhopSDK::Currency::TaggedSymbol,
             destination_ledger_account_id: String,
             fee_amount: T.nilable(Float),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             notes: T.nilable(String),
             origin_ledger_account_id: String
           }

data/rbi/whop_sdk/models.rbi

@@ -5,6 +5,8 @@ module WhopSDK
 
   AccessPassType = WhopSDK::Models::AccessPassType
 
+  AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
+
   App = WhopSDK::Models::App
 
   AppBuild = WhopSDK::Models::AppBuild
@@ -70,6 +72,10 @@ module WhopSDK
 
   Company = WhopSDK::Models::Company
 
+  CompanyCreateParams = WhopSDK::Models::CompanyCreateParams
+
+  CompanyListParams = WhopSDK::Models::CompanyListParams
+
   CompanyRetrieveParams = WhopSDK::Models::CompanyRetrieveParams
 
   Course = WhopSDK::Models::Course
@@ -118,8 +124,14 @@ module WhopSDK
 
   CourseRetrieveParams = WhopSDK::Models::CourseRetrieveParams
 
+  CourseStudentListParams = WhopSDK::Models::CourseStudentListParams
+
+  CourseStudentRetrieveParams = WhopSDK::Models::CourseStudentRetrieveParams
+
   CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
 
+  CourseVisibilities = WhopSDK::Models::CourseVisibilities
+
   Currency = WhopSDK::Models::Currency
 
   CustomCta = WhopSDK::Models::CustomCta
@@ -130,6 +142,8 @@ module WhopSDK
 
   EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
 
+  EmbedType = WhopSDK::Models::EmbedType
+
   Entry = WhopSDK::Models::Entry
 
   EntryApprovedWebhookEvent = WhopSDK::Models::EntryApprovedWebhookEvent

data/rbi/whop_sdk/resources/access_tokens.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class AccessTokens
+      # Creates an access token for a user to access a specific resource. These access
+      # tokens are designed to be used with Whop's embedded components.
+      sig do
+        params(
+          scoped_actions: T::Array[String],
+          target_resource_id: String,
+          target_resource_type:
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol,
+          expires_at: T.nilable(Time),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AccessTokenCreateResponse)
+      end
+      def create(
+        # Array of desired scoped actions for the access token. This list must be a subset
+        # of the API keys's existing permissions. Otherwise, an error will be raised.
+        scoped_actions:,
+        # The ID of the target resource (Company, User, etc.) for which the access token
+        # is being created.
+        target_resource_id:,
+        # The type of the target resource (company, user, product, experience, etc.).
+        target_resource_type:,
+        # The expiration timestamp for the access token. If not provided, a default
+        # expiration time of 1 hour will be used. The expiration can be set to a maximum
+        # of 3 hours from the current time.
+        expires_at: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/app_builds.rbi

@@ -10,7 +10,11 @@ module WhopSDK
       # - `developer:manage_builds`
       sig do
         params(
-          attachment: WhopSDK::AppBuildCreateParams::Attachment::OrHash,
+          attachment:
+            T.any(
+              WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+              WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithID::OrHash
+            ),
           checksum: String,
           platform: WhopSDK::AppBuildPlatforms::OrSymbol,
           app_id: T.nilable(String),
@@ -51,7 +55,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::AppBuild)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the app build
+        id,
+        request_options: {}
+      )
       end
 
       # Lists app builds for an app
@@ -103,7 +111,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::AppBuild)
       end
-      def promote(id, request_options: {})
+      def promote(
+        # The ID of the app build to promote.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/apps.rbi

@@ -39,7 +39,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::App)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the app
+        id,
+        request_options: {}
+      )
       end
 
       # Update an existing App
@@ -57,7 +61,13 @@ module WhopSDK
           description: T.nilable(String),
           discover_path: T.nilable(String),
           experience_path: T.nilable(String),
-          icon: T.nilable(WhopSDK::AppUpdateParams::Icon::OrHash),
+          icon:
+            T.nilable(
+              T.any(
+                WhopSDK::AppUpdateParams::Icon::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::AppUpdateParams::Icon::AttachmentInputWithID::OrHash
+              )
+            ),
           name: T.nilable(String),
           required_scopes:
             T.nilable(
@@ -68,6 +78,7 @@ module WhopSDK
         ).returns(WhopSDK::App)
       end
       def update(
+        # The ID of the app
         id,
         # The description of the app for the app store in-depth app view.
         app_store_description: nil,

data/rbi/whop_sdk/resources/authorized_users.rbi

@@ -15,7 +15,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::AuthorizedUserRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the authorized user
+        id,
+        request_options: {}
+      )
       end
 
       # Lists authorized users

data/rbi/whop_sdk/resources/chat_channels.rbi

@@ -14,7 +14,12 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::ChatChannel)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the chat channel to fetch, it can be an experience ID or a chat
+        # channel ID
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a chat channel
@@ -35,6 +40,8 @@ module WhopSDK
         ).returns(WhopSDK::ChatChannel)
       end
       def update(
+        # The ID of the chat channel to update. Can be an experience ID or a chat feed
+        # external ID.
         id,
         # Whether media uploads are banned in this chat
         ban_media: nil,

data/rbi/whop_sdk/resources/checkout_configurations.rbi

@@ -13,24 +13,23 @@ module WhopSDK
       # - `access_pass:update`
       sig do
         params(
+          plan: WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash,
+          plan_id: String,
           affiliate_code: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
-          plan:
-            T.nilable(WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash),
-          plan_id: T.nilable(String),
           redirect_url: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::CheckoutConfiguration)
       end
       def create(
+        # Pass this object to create a new plan for this checkout configuration
+        plan:,
+        # The ID of the plan to use for the checkout configuration
+        plan_id:,
         # The affiliate code to use for the checkout configuration
         affiliate_code: nil,
         # The metadata to use for the checkout configuration
         metadata: nil,
-        # Pass this object to create a new plan for this checkout configuration
-        plan: nil,
-        # The ID of the plan to use for the checkout configuration
-        plan_id: nil,
         # The URL to redirect the user to after the checkout configuration is created
         redirect_url: nil,
         request_options: {}
@@ -48,7 +47,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::CheckoutConfiguration)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the checkout configuration
+        id,
+        request_options: {}
+      )
       end
 
       # Lists checkout configurations

data/rbi/whop_sdk/resources/companies.rbi

@@ -3,6 +3,34 @@
 module WhopSDK
   module Resources
     class Companies
+      # Create a new sub company for your platform
+      #
+      # Required permissions:
+      #
+      # - `company:create_child`
+      # - `company:basic:read`
+      sig do
+        params(
+          email: String,
+          parent_company_id: String,
+          title: String,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Company)
+      end
+      def create(
+        # The email of the user who the company will belong to.
+        email:,
+        # The company ID of the platform creating this company.
+        parent_company_id:,
+        # The name of the company being created.
+        title:,
+        # Additional metadata for the account
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
       # Retrieves an company by ID or its url route
       #
       # Required permissions:
@@ -14,7 +42,46 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Company)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID or route of the company
+        id,
+        request_options: {}
+      )
+      end
+
+      # Lists companies the current user has access to
+      #
+      # Required permissions:
+      #
+      # - `company:basic:read`
+      sig do
+        params(
+          parent_company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::CompanyListResponse]
+        )
+      end
+      def list(
+        # The ID of the parent company to list sub companies for
+        parent_company_id:,
+        # 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,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/course_chapters.rbi

@@ -35,7 +35,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::CourseChapter)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the chapter
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a course chapter
@@ -51,6 +55,7 @@ module WhopSDK
         ).returns(WhopSDK::CourseChapter)
       end
       def update(
+        # The ID of the chapter to update
         id,
         # The title of the chapter
         title:,
@@ -103,7 +108,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The ID of the chapter to delete
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/course_lesson_interactions.rbi

@@ -7,23 +7,27 @@ module WhopSDK
       #
       # Required permissions:
       #
-      # - `course_lesson_interaction:read`
       # - `courses:read`
+      # - `course_analytics:read`
       sig do
         params(
           id: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::CourseLessonInteraction)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the course lesson interaction
+        id,
+        request_options: {}
+      )
       end
 
       # Lists course lesson interactions
       #
       # Required permissions:
       #
-      # - `course_lesson_interaction:read`
       # - `courses:read`
+      # - `course_analytics:read`
       sig do
         params(
           after: T.nilable(String),

data/rbi/whop_sdk/resources/course_lessons.rbi

@@ -14,6 +14,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(WhopSDK::Lesson)
@@ -27,6 +36,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: {}
@@ -44,7 +59,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Lesson)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the lesson
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a course lesson
@@ -55,6 +74,10 @@ module WhopSDK
       sig do
         params(
           id: String,
+          assessment_completion_requirement:
+            T.nilable(
+              WhopSDK::CourseLessonUpdateParams::AssessmentCompletionRequirement::OrHash
+            ),
           assessment_questions:
             T.nilable(
               T::Array[
@@ -63,21 +86,44 @@ module WhopSDK
             ),
           attachments:
             T.nilable(
-              T::Array[WhopSDK::CourseLessonUpdateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::CourseLessonUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           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),
           lesson_type: T.nilable(WhopSDK::LessonTypes::OrSymbol),
           main_pdf:
-            T.nilable(WhopSDK::CourseLessonUpdateParams::MainPdf::OrHash),
+            T.nilable(
+              T.any(
+                WhopSDK::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID::OrHash
+              )
+            ),
+          max_attempts: T.nilable(Integer),
           mux_asset_id: T.nilable(String),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
           title: T.nilable(String),
           visibility: T.nilable(WhopSDK::LessonVisibilities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Lesson)
       end
       def update(
+        # The ID of the lesson to update
         id,
+        # Completion requirements for quiz/knowledge check lessons
+        assessment_completion_requirement: nil,
         # Assessment questions for quiz/knowledge check lessons. Replaces all existing
         # questions.
         assessment_questions: nil,
@@ -88,12 +134,20 @@ 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 available types for a lesson
         lesson_type: nil,
         # The main PDF file for this lesson
         main_pdf: nil,
+        # Maximum number of attempts allowed for assessments
+        max_attempts: nil,
         # The ID of the Mux asset to attach to this lesson for video lessons
         mux_asset_id: nil,
+        # The thumbnail for the lesson in png, jpeg, or gif format
+        thumbnail: nil,
         # The title of the lesson
         title: nil,
         # The available visibilities for a lesson. Determines how / whether a lesson is
@@ -151,7 +205,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The ID of the lesson to delete
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/course_students.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class CourseStudents
+      # Retrieves a course student by interaction ID
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CourseStudentRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the course student interaction
+        id,
+        request_options: {}
+      )
+      end
+
+      # Lists students for a course
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      sig do
+        params(
+          course_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          keyword: T.nilable(String),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::Models::CourseStudentListResponse
+          ]
+        )
+      end
+      def list(
+        # The ID of the course
+        course_id:,
+        # 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,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Filter students by name - returns students whose names match the keyword
+        keyword: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end