whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/resources/courses.rbi

@@ -12,9 +12,19 @@ module WhopSDK
         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(WhopSDK::Course)
       end
@@ -23,12 +33,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
@@ -44,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
@@ -61,14 +88,23 @@ 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: T.nilable(WhopSDK::CourseUpdateParams::Thumbnail::OrHash),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
           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
@@ -81,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,
@@ -90,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
@@ -140,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/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:
@@ -46,7 +50,13 @@ module WhopSDK
           id: String,
           access_level:
             T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
-          logo: T.nilable(WhopSDK::ExperienceUpdateParams::Logo::OrHash),
+          logo:
+            T.nilable(
+              T.any(
+                WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithID::OrHash
+              )
+            ),
           name: T.nilable(String),
           order: T.nilable(String),
           section_id: T.nilable(String),
@@ -54,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,
@@ -116,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
@@ -133,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:,
@@ -154,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:,
@@ -179,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

@@ -13,7 +13,12 @@ module WhopSDK
           experience_id: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::ForumPostCreateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           content: T.nilable(String),
           is_mention: T.nilable(T::Boolean),
@@ -67,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
@@ -76,7 +85,12 @@ module WhopSDK
           id: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::ForumPostUpdateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           content: T.nilable(String),
           is_pinned: T.nilable(T::Boolean),
@@ -85,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

@@ -14,16 +14,16 @@ module WhopSDK
           collection_method: WhopSDK::CollectionMethod::OrSymbol,
           company_id: String,
           due_date: Time,
+          member_id: String,
           plan: WhopSDK::InvoiceCreateParams::Plan::OrHash,
+          product: WhopSDK::InvoiceCreateParams::Product::OrHash,
+          email_address: String,
+          product_id: String,
           charge_buyer_fee: T.nilable(T::Boolean),
           customer_name: T.nilable(String),
-          email_address: T.nilable(String),
-          member_id: T.nilable(String),
           payment_token_id: T.nilable(String),
-          product: T.nilable(WhopSDK::InvoiceCreateParams::Product::OrHash),
-          product_id: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::InvoiceCreateResponse)
+        ).returns(WhopSDK::Invoice)
       end
       def create(
         # The method of collection for this invoice. If using charge_automatically, you
@@ -33,30 +33,30 @@ module WhopSDK
         company_id:,
         # The date the invoice is due, if applicable.
         due_date:,
+        # The member ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing member. If you do not have a member ID, you must provide
+        # an email_address and customer_name.
+        member_id:,
         # The properties of the plan to create for this invoice.
         plan:,
+        # The properties of the product to create for this invoice. Include this if you
+        # want to create an invoice for a new product.
+        product:,
+        # The email address to create this invoice for. This is required if you want to
+        # create an invoice for a user who does not have a member of your company yet.
+        email_address:,
+        # The product ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing product.
+        product_id:,
         # Whether or not to charge the customer a buyer fee.
         charge_buyer_fee: nil,
         # The name of the customer to create this invoice for. This is required if you
         # want to create an invoice for a customer who does not have a member of your
         # company yet.
         customer_name: nil,
-        # The email address to create this invoice for. This is required if you want to
-        # create an invoice for a user who does not have a member of your company yet.
-        email_address: nil,
-        # The member ID to create this invoice for. Include this if you want to create an
-        # invoice for an existing member. If you do not have a member ID, you must provide
-        # an email_address and customer_name.
-        member_id: nil,
         # The payment token ID to use for this invoice. If using charge_automatically, you
         # must provide a payment_token.
         payment_token_id: nil,
-        # The properties of the product to create for this invoice. Include this if you
-        # want to create an invoice for a new product.
-        product: nil,
-        # The product ID to create this invoice for. Include this if you want to create an
-        # invoice for an existing product.
-        product_id: nil,
         request_options: {}
       )
       end
@@ -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

data/rbi/whop_sdk/resources/ledger_accounts.rbi

@@ -3,7 +3,7 @@
 module WhopSDK
   module Resources
     class LedgerAccounts
-      # Retrieves a ledger account by ID
+      # Retrieves a ledger account by its ID, company ID or user ID
       #
       # Required permissions:
       #
@@ -14,7 +14,12 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::LedgerAccountRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # Either a User ID, Company ID, or LedgerAccount ID (user_xxx, biz_xxx, or
+        # ldgr_xxx)
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/members.rbi

@@ -16,7 +16,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::MemberRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the member
+        id,
+        request_options: {}
+      )
       end
 
       # List the members of a company
@@ -30,7 +34,6 @@ module WhopSDK
         params(
           company_id: String,
           access_level: T.nilable(WhopSDK::AccessLevel::OrSymbol),
-          access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
           created_after: T.nilable(Time),
@@ -42,6 +45,7 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::MemberMostRecentActions::OrSymbol]),
           order: T.nilable(WhopSDK::MemberListParams::Order::OrSymbol),
           plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
           promo_code_ids: T.nilable(T::Array[String]),
           query: T.nilable(String),
           statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
@@ -54,10 +58,8 @@ module WhopSDK
       def list(
         # The ID of the company to list members for
         company_id:,
-        # The access level a given user (or company) has to an access pass or company.
+        # The access level a given user (or company) has to a product or company.
         access_level: nil,
-        # The access pass IDs to filter the members by
-        access_pass_ids: nil,
         # 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.
@@ -78,6 +80,8 @@ module WhopSDK
         order: nil,
         # The plan IDs to filter the members by
         plan_ids: nil,
+        # The product IDs to filter the members by
+        product_ids: nil,
         # The promo code IDs to filter the members by
         promo_code_ids: nil,
         # The name, username, or email to filter the members by. The email filter will

data/rbi/whop_sdk/resources/memberships.rbi

@@ -14,7 +14,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Membership)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the membership or a license key
+        id,
+        request_options: {}
+      )
       end
 
       # Update a membership
@@ -31,6 +35,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def update(
+        # The ID of the membership.
         id,
         # The metadata to update the membership with.
         metadata: nil,
@@ -45,7 +50,6 @@ module WhopSDK
       # - `member:basic:read`
       sig do
         params(
-          access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
           cancel_options:
@@ -60,6 +64,7 @@ module WhopSDK
           last: T.nilable(Integer),
           order: T.nilable(WhopSDK::MembershipListParams::Order::OrSymbol),
           plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
           promo_code_ids: T.nilable(T::Array[String]),
           statuses: T.nilable(T::Array[WhopSDK::MembershipStatus::OrSymbol]),
           user_ids: T.nilable(T::Array[String]),
@@ -69,8 +74,6 @@ module WhopSDK
         )
       end
       def list(
-        # The access pass IDs to filter the memberships by
-        access_pass_ids: nil,
         # 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.
@@ -93,6 +96,8 @@ module WhopSDK
         order: nil,
         # The plan IDs to filter the memberships by
         plan_ids: nil,
+        # The product IDs to filter the memberships by
+        product_ids: nil,
         # The promo code IDs to filter the memberships by
         promo_code_ids: nil,
         # The membership status to filter the memberships by
@@ -121,6 +126,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def cancel(
+        # The ID of the membership.
         id,
         # The mode of cancellation for a membership
         cancellation_mode: nil,
@@ -142,6 +148,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def pause(
+        # The ID of the membership you want to pause.
         id,
         # Whether to void past_due payments associated with the membership to prevent
         # future payment attempts.
@@ -162,7 +169,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Membership)
       end
-      def resume(id, request_options: {})
+      def resume(
+        # The ID of the membership you want to resume.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/messages.rbi

@@ -14,7 +14,12 @@ module WhopSDK
           content: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::MessageCreateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           poll: T.nilable(WhopSDK::MessageCreateParams::Poll::OrHash),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -44,7 +49,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Message)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the message
+        id,
+        request_options: {}
+      )
       end
 
       # Updates an existing message
@@ -53,7 +62,12 @@ module WhopSDK
           id: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::MessageUpdateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           content: T.nilable(String),
           is_pinned: T.nilable(T::Boolean),
@@ -61,6 +75,7 @@ module WhopSDK
         ).returns(WhopSDK::Message)
       end
       def update(
+        # The ID of the message to update
         id,
         # The attachments for this message
         attachments: nil,

data/rbi/whop_sdk/resources/payments.rbi

@@ -20,7 +20,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the payment
+        id,
+        request_options: {}
+      )
       end
 
       # Lists payments
@@ -115,6 +119,7 @@ module WhopSDK
         ).returns(WhopSDK::Payment)
       end
       def refund(
+        # The ID of the payment you want to update or take action upon.
         id,
         # An amount if the refund is supposed to be partial.
         partial_amount: nil,
@@ -139,7 +144,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def retry_(id, request_options: {})
+      def retry_(
+        # The ID of the payment
+        id,
+        request_options: {}
+      )
       end
 
       # Voids a payment
@@ -159,7 +168,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def void(id, request_options: {})
+      def void(
+        # The ID of the payment you want to void.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private