whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/resources/cards.rbi

@@ -0,0 +1,160 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Cards represent Whop-issued virtual payment cards that spend from an account or
+    # user balance. Cards can be assigned to cardholders and configured with spending
+    # limits for controlled spending.
+    #
+    # Use the Cards API to issue cards, list cards for an account or user, and
+    # retrieve active card details such as the card number and CVC.
+    class Cards
+      # Issues a virtual card. For an individual (consumer) card issuing account, the
+      # card is issued to the account's own cardholder. For a company (business) card
+      # issuing account, pass assigned*user_id to issue the card to a company member; if
+      # that member is not yet an approved card-issuing user, the card is provisioned
+      # asynchronously or an onboarding invitation is sent (HTTP 202). Pass exactly one
+      # of account_id (a biz* identifier) or user*id (a user* identifier). Returns the
+      # newly created card resource.
+      sig do
+        params(
+          account_id: String,
+          assigned_user_id: String,
+          name: String,
+          spend_limit: Float,
+          spend_limit_frequency:
+            WhopSDK::CardCreateParams::SpendLimitFrequency::OrSymbol,
+          transaction_limit: Float,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CardCreateResponse)
+      end
+      def create(
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # The company member (a user\_ identifier) to assign the card to. Required for
+        # company (business) card issuing accounts.
+        assigned_user_id: nil,
+        # A display name for the card.
+        name: nil,
+        # Spending limit amount, in dollars.
+        spend_limit: nil,
+        # The spending limit window.
+        spend_limit_frequency: nil,
+        # Per-transaction limit amount, in dollars.
+        transaction_limit: nil,
+        # The owning user ID (a user\_ identifier). Provide this or account_id.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a single card by its icrd\_ identifier, including its secrets (full
+      # card number, CVC, and cardholder name) for active cards.
+      sig do
+        params(
+          card_id: String,
+          account_id: String,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CardRetrieveResponse)
+      end
+      def retrieve(
+        # Card ID to retrieve, prefixed `icrd_`.
+        card_id,
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # The owning user ID (a user\_ identifier). Provide this or account_id.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Updates an issued card. All fields are optional; only the fields you pass are
+      # changed. Updates the card name, billing address, and spending limits in one
+      # call, sets a new PIN, freezes or unfreezes the card, or cancels it. Pass
+      # canceled: true alone to cancel the card — cancellation is permanent and a
+      # canceled card cannot be uncanceled. Pass exactly one of account*id (a biz*
+      # identifier) or user*id (a user* identifier). Assigned cardholders without the
+      # payout:account:update scope can update the PIN and freeze state of their own
+      # card. The PIN can only be changed on a card assigned to the acting user. Returns
+      # the updated card resource.
+      sig do
+        params(
+          card_id: String,
+          account_id: String,
+          billing: WhopSDK::CardUpdateParams::Billing::OrHash,
+          canceled: T::Boolean,
+          frozen: T::Boolean,
+          name: String,
+          pin: String,
+          remove_limit: T::Boolean,
+          spend_limit: Float,
+          spend_limit_frequency:
+            WhopSDK::CardUpdateParams::SpendLimitFrequency::OrSymbol,
+          transaction_limit: Float,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CardUpdateResponse)
+      end
+      def update(
+        # Card ID to retrieve, prefixed `icrd_`.
+        card_id,
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # New billing address. Requires line1, city, region, postal_code, and
+        # country_code.
+        billing: nil,
+        # Pass `true` to permanently cancel the card. A canceled card cannot be
+        # uncanceled. Cannot be combined with other fields.
+        canceled: nil,
+        # Pass `true` to freeze the card, `false` to unfreeze it.
+        frozen: nil,
+        # A display name for the card.
+        name: nil,
+        # New 4-digit PIN. Can only be set on a card assigned to the acting user.
+        pin: nil,
+        # Pass `true` to remove the spending limit (make the card unlimited).
+        remove_limit: nil,
+        # Spending limit amount, in dollars.
+        spend_limit: nil,
+        # The spending limit window.
+        spend_limit_frequency: nil,
+        # Per-transaction limit amount, in dollars.
+        transaction_limit: nil,
+        # The owning user ID (a user\_ identifier). Provide this or account_id.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists issued Whop virtual cards for an account or user, including pending
+      # invitation cards that have not been issued by the card provider yet. Pass
+      # exactly one of account*id (a biz* identifier) or user*id (a user* identifier).
+      # Non-owner team members only see cards assigned to them. Users without the
+      # payout:account:read scope can still list cards assigned to them (for example
+      # moderators or external cardholders). Use GET /cards/:card_id to retrieve a
+      # single card with its secrets.
+      sig do
+        params(
+          account_id: String,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CardListResponse)
+      end
+      def list(
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # The owning user ID (a user\_ identifier). Provide this or account_id.
+        user_id: 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/chat_channels.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Chat channels
     class ChatChannels
       # Retrieves the details of an existing chat channel.
       #

data/rbi/whop_sdk/resources/checkout_configurations.rbi

@@ -2,70 +2,90 @@
 
 module WhopSDK
   module Resources
-    # Checkout configurations
+    # A Checkout Configuration is a reusable checkout link owned by an account. In
+    # `payment` mode it sells a specific plan; in `setup` mode it collects and saves
+    # payment details without charging. Each configuration can also override which
+    # payment methods are accepted and how 3D Secure is enforced for that checkout.
+    #
+    # Use the Checkout Configurations API to create checkout links for an existing or
+    # inline plan, list configurations for an account, retrieve the configuration
+    # behind a checkout URL, and delete links that should no longer be used.
     class CheckoutConfigurations
-      # Creates a new checkout configuration
-      #
-      # Required permissions:
-      #
-      # - `checkout_configuration:create`
-      # - `plan:create`
-      # - `access_pass:create`
-      # - `access_pass:update`
-      # - `checkout_configuration:basic:read`
+      # Creates a reusable checkout configuration for an existing or inline plan.
       sig do
         params(
-          body:
-            T.any(
-              WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::OrHash,
-              WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::OrHash,
-              WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::OrHash
+          affiliate_code: T.nilable(String),
+          company_id: String,
+          currency: T.nilable(String),
+          metadata: T.nilable(T.anything),
+          mode: WhopSDK::CheckoutConfigurationCreateParams::Mode::OrSymbol,
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::CheckoutConfigurationCreateParams::PaymentMethodConfiguration::OrHash
             ),
+          plan:
+            T.nilable(WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash),
+          plan_id: T.nilable(String),
+          redirect_url: T.nilable(String),
+          three_ds_level: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::CheckoutConfiguration)
+        ).returns(WhopSDK::Models::CheckoutConfigurationCreateResponse)
       end
       def create(
-        # Parameters for CreateCheckoutSession
-        body:,
+        # Affiliate code to apply to the checkout.
+        affiliate_code: nil,
+        # Account ID, prefixed `biz_`.
+        company_id: nil,
+        # Currency used for setup-mode payment method availability.
+        currency: nil,
+        # Custom key-value metadata copied to payments and memberships.
+        metadata: nil,
+        # Checkout mode: `payment` collects payment for a plan now; `setup` saves payment
+        # details without charging. Defaults to `payment`.
+        mode: nil,
+        # Payment method overrides for this checkout. `null` uses the plan or platform
+        # defaults.
+        payment_method_configuration: nil,
+        # Plan attributes used to create or find a plan for this checkout configuration.
+        # Mutually exclusive with `plan_id`.
+        plan: nil,
+        # Existing plan ID, prefixed `plan_`. Mutually exclusive with `plan`.
+        plan_id: nil,
+        # URL customers are sent to after checkout.
+        redirect_url: nil,
+        # 3D Secure behavior for this checkout.
+        three_ds_level: nil,
         request_options: {}
       )
       end
 
-      # Retrieves the details of an existing checkout configuration.
-      #
-      # Required permissions:
-      #
-      # - `checkout_configuration:basic:read`
+      # Retrieves a checkout configuration by ID. This endpoint is public so a checkout
+      # page can load from the configuration URL.
       sig do
         params(
           id: String,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::CheckoutConfiguration)
+        ).returns(WhopSDK::Models::CheckoutConfigurationRetrieveResponse)
       end
       def retrieve(
-        # The unique identifier of the checkout configuration.
+        # The ID of the checkout configuration.
         id,
         request_options: {}
       )
       end
 
-      # Returns a paginated list of checkout configurations for a company, with optional
-      # filtering by plan and creation date.
-      #
-      # Required permissions:
-      #
-      # - `checkout_configuration:basic:read`
+      # Lists checkout configurations for an account.
       sig do
         params(
           company_id: String,
-          after: T.nilable(String),
-          before: T.nilable(String),
-          created_after: T.nilable(Time),
-          created_before: T.nilable(Time),
-          direction: T.nilable(WhopSDK::Direction::OrSymbol),
-          first: T.nilable(Integer),
-          last: T.nilable(Integer),
-          plan_id: T.nilable(String),
+          after: String,
+          created_after: Integer,
+          created_before: Integer,
+          direction:
+            WhopSDK::CheckoutConfigurationListParams::Direction::OrSymbol,
+          first: Integer,
+          order: WhopSDK::CheckoutConfigurationListParams::Order::OrSymbol,
+          plan_id: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[
@@ -74,29 +94,40 @@ module WhopSDK
         )
       end
       def list(
-        # The unique identifier of the company to list checkout configurations for.
+        # Account ID, prefixed `biz_`.
         company_id:,
-        # Returns the elements in the list that come after the specified cursor.
+        # Cursor for the next page of results.
         after: nil,
-        # Returns the elements in the list that come before the specified cursor.
-        before: nil,
-        # Only return checkout configurations created after this timestamp.
+        # Only return checkout configurations created after this Unix timestamp.
         created_after: nil,
-        # Only return checkout configurations created before this timestamp.
+        # Only return checkout configurations created before this Unix timestamp.
         created_before: nil,
-        # The direction of the sort.
+        # Sort direction. Defaults to `desc`.
         direction: nil,
-        # Returns the first _n_ elements from the list.
+        # Number of checkout configurations to return.
         first: nil,
-        # Returns the last _n_ elements from the list.
-        last: nil,
-        # Filter checkout configurations to only those associated with this plan
-        # identifier.
+        # Field used to sort checkout configurations.
+        order: nil,
+        # Only return checkout configurations for this plan ID, prefixed `plan_`.
         plan_id: nil,
         request_options: {}
       )
       end
 
+      # Deletes a checkout configuration so its checkout URL can no longer be used.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # The ID of the checkout configuration.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: WhopSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/whop_sdk/resources/companies.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Companies
     class Companies
       # Create a new company. Pass parent_company_id to create a connected account under
       # a platform, or omit it to create a company for the current user.

data/rbi/whop_sdk/resources/company_token_transactions.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Company token transactions
     class CompanyTokenTransactions
       # Create a token transaction to add, subtract, or transfer tokens for a member
       # within a company.

data/rbi/whop_sdk/resources/course_chapters.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Course chapters
     class CourseChapters
       # Create a new chapter within a course to organize lessons into sections.
       #

data/rbi/whop_sdk/resources/course_lesson_interactions.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Course lesson interactions
     class CourseLessonInteractions
       # Retrieves the details of an existing course lesson interaction.
       #

data/rbi/whop_sdk/resources/course_lessons.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Course lessons
     class CourseLessons
       # Create a new lesson within a course chapter. Lessons can contain video, text, or
       # assessment content.

data/rbi/whop_sdk/resources/course_students.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Course students
     class CourseStudents
       # Retrieves the details of an existing course student.
       #

data/rbi/whop_sdk/resources/courses.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Courses
     class Courses
       # Create a new course within an experience, with optional chapters, lessons, and a
       # certificate.

data/rbi/whop_sdk/resources/deposits.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Deposits describe ways to add funds to an account balance, including hosted
+    # deposit pages, bank deposit instructions, and supported crypto wallet addresses.
+    #
+    # Use the Deposits API to create deposit instructions for an account and retrieve
+    # existing bank deposit activity.
+    class Deposits
+      # Resolves a deposit destination and returns the on-chain addresses that can fund
+      # it. No authentication is required; any business can be resolved by its account
+      # ID. A caller authenticated as a user can additionally resolve their own user
+      # account.
+      sig do
+        params(
+          destination:
+            T.any(
+              String,
+              WhopSDK::DepositCreateParams::Destination::UnionMember1::OrHash
+            ),
+          amount: Float,
+          metadata: T::Hash[Symbol, T.anything],
+          network: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::DepositCreateResponse)
+      end
+      def create(
+        # Destination account ID or wallet address. Object form is supported for
+        # compatibility.
+        destination:,
+        # Amount to prefill on hosted deposit page.
+        amount: nil,
+        # Metadata to include with the deposit response.
+        metadata: nil,
+        # Destination network override.
+        network: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns deposit transactions for a business account. Bank deposit transactions
+      # are nested under the bank field.
+      sig do
+        params(
+          account_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::DepositListResponse)
+      end
+      def list(
+        # Business account ID (biz\_\*).
+        account_id:,
+        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/dispute_alerts.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Dispute alerts
     class DisputeAlerts
       # Retrieves the details of an existing dispute alert.
       #

data/rbi/whop_sdk/resources/disputes.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Disputes
     class Disputes
       # Retrieves the details of an existing dispute.
       #

data/rbi/whop_sdk/resources/dm_channels.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Dm channels
     class DmChannels
       # Create a new DM channel between two or more users, optionally scoped to a
       # specific company. Returns the existing channel if one already exists.

data/rbi/whop_sdk/resources/dm_members.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Dm members
     class DmMembers
       # Add a new user to an existing DM channel. Only an admin of the channel can add
       # members.

data/rbi/whop_sdk/resources/entries.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Entries
     class Entries
       # Retrieves the details of an existing waitlist entry.
       #

data/rbi/whop_sdk/resources/events.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # An Event records conversion or engagement activity for an account, such as page
+    # views, purchases, or leads. Each event ties the action to the
+    # [person](/api-reference/beta/people/person) who took it, so activity can be
+    # attributed to the ads and links that drove it.
+    #
+    # Use the Events API to send new tracking events and list the events recorded for
+    # a person.
+    class Events
+      # Tracks a conversion or engagement event for an account.
+      sig do
+        params(
+          account_id: String,
+          event_name: WhopSDK::EventCreateParams::EventName::OrSymbol,
+          action_source:
+            T.nilable(WhopSDK::EventCreateParams::ActionSource::OrSymbol),
+          context: T.nilable(WhopSDK::EventCreateParams::Context::OrHash),
+          currency: T.nilable(WhopSDK::EventCreateParams::Currency::OrSymbol),
+          custom_name: T.nilable(String),
+          duration: T.nilable(Integer),
+          event_id: T.nilable(String),
+          event_time: T.nilable(Time),
+          plan_id: T.nilable(String),
+          product_id: T.nilable(String),
+          referrer_url: T.nilable(String),
+          resumed: T.nilable(T::Boolean),
+          source: T.nilable(String),
+          title: T.nilable(String),
+          url: T.nilable(String),
+          user: T.nilable(WhopSDK::EventCreateParams::User::OrHash),
+          value: T.nilable(Float),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::EventCreateResponse)
+      end
+      def create(
+        # The account to associate with this event.
+        account_id:,
+        # The type of conversion or engagement event
+        event_name:,
+        # The channel where an event originated
+        action_source: nil,
+        # Tracking and attribution context.
+        context: nil,
+        # The available currencies on the platform
+        currency: nil,
+        # Custom event name when event_name is 'custom'. Maximum 35 chars for this value.
+        custom_name: nil,
+        # For 'leave' events: milliseconds the visitor spent on the page.
+        duration: nil,
+        # Client-provided identifier for deduplication. Generated if omitted.
+        event_id: nil,
+        # When the event occurred. Defaults to now.
+        event_time: nil,
+        # The plan associated with the event.
+        plan_id: nil,
+        # The product associated with the event.
+        product_id: nil,
+        # The referring URL.
+        referrer_url: nil,
+        # For 'page' events: true when the page was restored from the back/forward cache.
+        resumed: nil,
+        # For 'identify' events: where the identity was captured (url, form, manual,
+        # iframe).
+        source: nil,
+        # For 'page' events: the document title.
+        title: nil,
+        # The URL where the event occurred.
+        url: nil,
+        # User identity and profile data.
+        user: nil,
+        # Monetary value associated with the event.
+        value: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists pixel events for a person, most recent first. Events are shaped like the
+      # POST /events intake: attribution in context, identity in user.
+      sig do
+        params(
+          person_id: String,
+          account_id: String,
+          after: String,
+          before: String,
+          first: Integer,
+          from: Integer,
+          to: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::EventListResponse]
+        )
+      end
+      def list(
+        # The ID of the person.
+        person_id:,
+        # The ID of the account, which will look like biz\_******\*******. Optional for
+        # account API keys; required for credentials that can access multiple accounts.
+        account_id: nil,
+        # A cursor for fetching events after a previous page.
+        after: nil,
+        # A cursor for fetching events before a later page.
+        before: nil,
+        # The number of events to return.
+        first: nil,
+        # Start of the time range as a Unix timestamp.
+        from: nil,
+        # End of the time range as a Unix timestamp. Defaults to now.
+        to: 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/experiences.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Experiences
     class Experiences
       # Required permissions:
       #

data/rbi/whop_sdk/resources/fee_markups.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Fee markups
     class FeeMarkups
       # Create or update a fee markup for a company. If a markup for the specified fee
       # type already exists, it will be updated with the new values.