whop_sdk 0.0.4 → 0.0.6

data/rbi/whop_sdk/resources/checkout_configurations.rbi

@@ -47,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

@@ -42,7 +42,11 @@ 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

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

@@ -15,7 +15,11 @@ module WhopSDK
           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

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
@@ -76,6 +95,8 @@ module WhopSDK
             ),
           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(
@@ -86,12 +107,20 @@ module WhopSDK
             ),
           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,
@@ -105,6 +134,10 @@ 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
@@ -113,6 +146,8 @@ module WhopSDK
         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
@@ -170,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

@@ -15,7 +15,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::CourseStudentRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the course student interaction
+        id,
+        request_options: {}
+      )
       end
 
       # Lists students for a course

data/rbi/whop_sdk/resources/courses.rbi

@@ -14,6 +14,7 @@ module WhopSDK
           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:
@@ -23,6 +24,7 @@ module WhopSDK
                 WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID::OrHash
               )
             ),
+          visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Course)
       end
@@ -36,6 +38,10 @@ module WhopSDK
         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,
@@ -43,6 +49,9 @@ module WhopSDK
         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
@@ -58,7 +67,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Course)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the course
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a course
@@ -75,6 +88,7 @@ module WhopSDK
           cover_image: T.nilable(String),
           description: T.nilable(String),
           language: T.nilable(WhopSDK::Languages::OrSymbol),
+          order: T.nilable(String),
           require_completing_lessons_in_order: T.nilable(T::Boolean),
           tagline: T.nilable(String),
           thumbnail:
@@ -85,10 +99,12 @@ module WhopSDK
               )
             ),
           title: T.nilable(String),
+          visibility: T.nilable(WhopSDK::CourseVisibilities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Course)
       end
       def update(
+        # The ID of the course to update
         id,
         # Whether the course will award its students a PDF certificate after completing
         # all lessons
@@ -101,6 +117,9 @@ module WhopSDK
         description: nil,
         # The available languages for a course
         language: nil,
+        # The decimal order position of the course within its experience. 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,
@@ -110,6 +129,9 @@ module WhopSDK
         thumbnail: nil,
         # The title of the course
         title: nil,
+        # The available visibilities for a course. Determines how / whether a course is
+        # visible to users.
+        visibility: nil,
         request_options: {}
       )
       end
@@ -160,7 +182,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The ID of the course to delete
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/disputes.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Disputes
+      # Retrieves a Dispute by ID
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def retrieve(
+        # The ID of the dispute
+        id,
+        request_options: {}
+      )
+      end
+
+      # Lists disputes the current actor has access to
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      sig do
+        params(
+          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::DisputeListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list disputes for
+        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
+
+      # Submit a payment dispute to the payment processor for review. Once submitted, no
+      # further edits can be made.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def submit_evidence(
+        # The ID of the dispute (Ex. dspt_xxxx) you want to finalize evidence submission
+        # for and send to the processor.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Update a dispute with evidence data to attempt to win the dispute.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      sig do
+        params(
+          id: String,
+          access_activity_log: T.nilable(String),
+          billing_address: T.nilable(String),
+          cancellation_policy_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          cancellation_policy_disclosure: T.nilable(String),
+          customer_communication_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          customer_email_address: T.nilable(String),
+          customer_name: T.nilable(String),
+          notes: T.nilable(String),
+          product_description: T.nilable(String),
+          refund_policy_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          refund_policy_disclosure: T.nilable(String),
+          refund_refusal_explanation: T.nilable(String),
+          service_date: T.nilable(String),
+          uncategorized_attachment:
+            T.nilable(
+              T.any(
+                WhopSDK::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithID::OrHash
+              )
+            ),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Dispute)
+      end
+      def update_evidence(
+        # The ID of the dispute you want to update.
+        id,
+        # An IP access log for the user from Whop.
+        access_activity_log: nil,
+        # The billing address of the user from their payment details.
+        billing_address: nil,
+        # A file containing the cancellation policy from the company.
+        cancellation_policy_attachment: nil,
+        # A cancellation policy disclosure from the company.
+        cancellation_policy_disclosure: nil,
+        # A file containing the customer communication from the company (An image).
+        customer_communication_attachment: nil,
+        # The email of the customer from their payment details.
+        customer_email_address: nil,
+        # The name of the customer from their payment details.
+        customer_name: nil,
+        # Additional notes the company chooses to submit regarding the dispute.
+        notes: nil,
+        # The description of the product from the company.
+        product_description: nil,
+        # A file containing the refund policy from the company.
+        refund_policy_attachment: nil,
+        # A refund policy disclosure from the company.
+        refund_policy_disclosure: nil,
+        # A description on why the refund is being refused by the company.
+        refund_refusal_explanation: nil,
+        # When the product was delivered by the company.
+        service_date: nil,
+        # A file that does not fit in the other categories.
+        uncategorized_attachment: 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/entries.rbi

@@ -15,7 +15,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Entry)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the entry
+        id,
+        request_options: {}
+      )
       end
 
       # Lists entries for a company
@@ -77,7 +81,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::EntryApproveResponse)
       end
-      def approve(id, request_options: {})
+      def approve(
+        # The ID of the entry to approve.
+        id,
+        request_options: {}
+      )
       end
 
       # Deny an entry
@@ -93,7 +101,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Entry)
       end
-      def deny(id, request_options: {})
+      def deny(
+        # The ID of the entry
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/experiences.rbi

@@ -35,7 +35,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Experience)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the experience
+        id,
+        request_options: {}
+      )
       end
 
       # Required permissions:
@@ -60,6 +64,7 @@ module WhopSDK
         ).returns(WhopSDK::Experience)
       end
       def update(
+        # The id of the experience to update.
         id,
         # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
         access_level: nil,
@@ -122,7 +127,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The internal ID of the experience to delete.
+        id,
+        request_options: {}
+      )
       end
 
       # Adds an experience to an product, making it accessible to the product's
@@ -139,6 +148,7 @@ module WhopSDK
         ).returns(WhopSDK::Experience)
       end
       def attach(
+        # The ID of the Experience to be added to an Access Pass.
         id,
         # The ID of the Access Pass to add the Experience to.
         product_id:,
@@ -160,6 +170,7 @@ module WhopSDK
         ).returns(WhopSDK::Experience)
       end
       def detach(
+        # The ID of the Experience to be added to an Access Pass.
         id,
         # The ID of the Access Pass to add the Experience to.
         product_id:,
@@ -185,6 +196,7 @@ module WhopSDK
         ).returns(WhopSDK::Experience)
       end
       def duplicate(
+        # The ID of the experience to duplicate
         id,
         # The name of the new experience
         name: nil,

data/rbi/whop_sdk/resources/forum_posts.rbi

@@ -72,7 +72,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::ForumPost)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the forum post
+        id,
+        request_options: {}
+      )
       end
 
       # Update an existing forum post
@@ -95,6 +99,7 @@ module WhopSDK
         ).returns(WhopSDK::ForumPost)
       end
       def update(
+        # The ID of the forum post to update
         id,
         # The attachments for this post
         attachments: nil,

data/rbi/whop_sdk/resources/forums.rbi

@@ -14,7 +14,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Forum)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the forum to fetch, it can be an experience ID or a forum ID
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a forum
@@ -33,6 +37,7 @@ module WhopSDK
         ).returns(WhopSDK::Forum)
       end
       def update(
+        # Experience ID (exp\_\*) or Forum external ID
         id,
         # Email notification preference option for a forum feed
         email_notification_preference: nil,

data/rbi/whop_sdk/resources/invoices.rbi

@@ -73,7 +73,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Invoice)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the invoice or a token
+        id,
+        request_options: {}
+      )
       end
 
       # Lists invoices
@@ -87,11 +91,14 @@ module WhopSDK
           company_id: String,
           after: T.nilable(String),
           before: T.nilable(String),
+          collection_methods:
+            T.nilable(T::Array[WhopSDK::CollectionMethod::OrSymbol]),
           direction: T.nilable(WhopSDK::Direction::OrSymbol),
-          filters: T.nilable(WhopSDK::InvoiceListParams::Filters::OrHash),
           first: T.nilable(Integer),
           last: T.nilable(Integer),
           order: T.nilable(WhopSDK::InvoiceListParams::Order::OrSymbol),
+          product_ids: T.nilable(T::Array[String]),
+          statuses: T.nilable(T::Array[WhopSDK::InvoiceStatus::OrSymbol]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Internal::CursorPage[WhopSDK::InvoiceListItem])
       end
@@ -102,16 +109,20 @@ module WhopSDK
         after: nil,
         # Returns the elements in the list that come before the specified cursor.
         before: nil,
+        # Filter invoices by their collection method
+        collection_methods: nil,
         # The direction of the sort.
         direction: nil,
-        # The filters to apply to the invoices
-        filters: nil,
         # Returns the first _n_ elements from the list.
         first: nil,
         # Returns the last _n_ elements from the list.
         last: nil,
         # Which columns can be used to sort.
         order: nil,
+        # Return only invoices created for these specific product ids
+        product_ids: nil,
+        # The statuses to filter the invoices by
+        statuses: nil,
         request_options: {}
       )
       end
@@ -127,7 +138,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def void(id, request_options: {})
+      def void(
+        # The ID of the invoice to void
+        id,
+        request_options: {}
+      )
       end
 
       # @api private