whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/resources/files.rbi

@@ -2,15 +2,13 @@
 
 module WhopSDK
   module Resources
-    # Files
     class Files
       # Create a new file record and receive a presigned URL for uploading content to
       # S3.
       sig do
         params(
           filename: String,
-          visibility:
-            T.nilable(WhopSDK::FileCreateParams::Visibility::OrSymbol),
+          visibility: T.nilable(WhopSDK::FileVisibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::FileCreateResponse)
       end

data/rbi/whop_sdk/resources/financial_activity.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # A Ledger Activity row is a single financial event on an account's ledger — a
+    # payment, withdrawal, refund, transfer, on-chain deposit, swap, or card
+    # transaction. Each row is derived from the underlying ledger lines and carries a
+    # typed `resource` and `source` so you can present and link the event without
+    # extra lookups.
+    #
+    # Use Ledger Activity to build a statement or transaction feed for an account or
+    # user. Reconcile against your own records with `amount` (signed, in the
+    # currency's smallest precision units) and `posted_at`, and use `available_at` to
+    # know when inflows became withdrawable.
+    class FinancialActivity
+      # Returns a paginated activity feed for one account or user, derived from ledger
+      # lines with typed resource and source objects for presentation. Pass exactly one
+      # of `account_id` (a `biz_` identifier) or `user_id` (a `user_` identifier).
+      # Filter by line type, currency, posted timestamp, or settlement date to reconcile
+      # a specific window. Pass `include_owned_accounts=true` with your own `user_id` to
+      # aggregate your personal ledger and the businesses you own into one feed; each
+      # row then carries the owning `account`.
+      sig do
+        params(
+          account_id: String,
+          available_after: Date,
+          available_before: Date,
+          currency: String,
+          cursor: String,
+          include_owned_accounts: T::Boolean,
+          limit: Integer,
+          line_types: T::Array[String],
+          posted_after: Time,
+          posted_before: Time,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::FinancialActivityListResponse)
+      end
+      def list(
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD`
+        # settlement date (UTC), distinct from posted_at. Requires currency.
+        available_after: nil,
+        # Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD`
+        # settlement date (UTC). Set equal to available_after for a single day. Requires
+        # currency.
+        available_before: nil,
+        # Optional currency code filter, for example `usd`.
+        currency: nil,
+        # Cursor returned by the previous page.
+        cursor: nil,
+        # When true, aggregates the authenticated user's personal ledger with the
+        # businesses they own (owner role with balance read) into one feed. Requires
+        # user_id to be the authenticated user; cannot be combined with account_id or the
+        # settlement-date filters. Each returned row includes the owning `account`.
+        include_owned_accounts: nil,
+        # Maximum number of rows to return.
+        limit: nil,
+        # Optional ledger line categories to include. Some categories (for example
+        # `onchain_deposit`, which covers inbound crypto deposits such as MoonPay onramps)
+        # are only returned when explicitly requested here.
+        line_types: nil,
+        # Only include rows posted after this ISO 8601 timestamp.
+        posted_after: nil,
+        # Only include rows posted before this ISO 8601 timestamp.
+        posted_before: 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/forum_posts.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Forum posts
     class ForumPosts
       # Create a new forum post or comment within an experience. Supports text content,
       # attachments, polls, paywalling, and pinning. Pass experience_id 'public' with a

data/rbi/whop_sdk/resources/forums.rbi

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

data/rbi/whop_sdk/resources/invoices.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Invoices
     class Invoices
       # Create an invoice for a customer. The invoice can be charged automatically using
       # a stored payment method, or sent to the customer for manual payment.

data/rbi/whop_sdk/resources/leads.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Leads
     class Leads
       # Record a new lead for a company, capturing a potential customer's interest in a
       # specific product.

data/rbi/whop_sdk/resources/ledger_accounts.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Ledger accounts
     class LedgerAccounts
       # Retrieves the details of an existing ledger account.
       #

data/rbi/whop_sdk/resources/media.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # A Media Asset is an AI-generated image or video created from a prompt and billed
+    # from an account balance. When generation finishes, the asset includes a file
+    # that can be attached anywhere Whop accepts files.
+    #
+    # Use the Media API to start a generation job and retrieve the asset while it
+    # processes or after it is ready.
+    class Media
+      # Retrieves a media asset by ID. Poll this while the asset is `processing`.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::MediaAsset)
+      end
+      def retrieve(
+        # Media asset ID, prefixed `media_`.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Starts an AI media generation job billed from the account's balance. Generation
+      # is asynchronous — poll `GET /media/{id}` until the asset is `ready`, then use
+      # `file.id` anywhere attachments are accepted.
+      sig do
+        params(
+          prompt: String,
+          type: WhopSDK::MediaGenerateParams::Type::OrSymbol,
+          account_id: String,
+          duration_seconds:
+            WhopSDK::MediaGenerateParams::DurationSeconds::OrInteger,
+          reference_media: T::Array[String],
+          resolution: WhopSDK::MediaGenerateParams::Resolution::OrSymbol,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::MediaAsset)
+      end
+      def generate(
+        # What to generate. Up to 2,000 characters.
+        prompt:,
+        # The kind of media to generate.
+        type:,
+        # Account ID, prefixed `biz_`. Defaults to the account the API key belongs to.
+        account_id: nil,
+        # Video length in seconds. Video only; defaults to 5.
+        duration_seconds: nil,
+        # Optional reference image file IDs (`file_` prefixed), up to 4. For video, a
+        # single reference seeds the opening frame; multiple references guide subject and
+        # style instead.
+        reference_media: nil,
+        # Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by
+        # Seedance 2.0 Fast or Mini; `4k` is only supported by Seedance 2.0.
+        resolution: 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/members.rbi

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

data/rbi/whop_sdk/resources/memberships.rbi

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

data/rbi/whop_sdk/resources/messages.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Messages
     class Messages
       # Send a new message in an experience chat, DM, or group chat channel. Supports
       # text content, attachments, polls, and replies.

data/rbi/whop_sdk/resources/notifications.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Notifications
     class Notifications
       # Send a push notification to users in an experience or company team. The
       # notification is processed asynchronously and supports targeting specific users.

data/rbi/whop_sdk/resources/payment_methods.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Payment methods
     class PaymentMethods
       # Retrieves the details of an existing payment method.
       #

data/rbi/whop_sdk/resources/payments.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Payments
     class Payments
       # Charge an existing member off-session using one of their stored payment methods.
       # You can provide an existing plan, or create a new one in-line. This endpoint
@@ -85,6 +84,7 @@ module WhopSDK
           before: T.nilable(String),
           billing_reasons:
             T.nilable(T::Array[WhopSDK::BillingReasons::OrSymbol]),
+          checkout_configuration_ids: T.nilable(T::Array[String]),
           company_id: T.nilable(String),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
@@ -114,6 +114,8 @@ module WhopSDK
         before: nil,
         # Filter payments by their billing reason.
         billing_reasons: nil,
+        # Only return payments from these checkout configurations.
+        checkout_configuration_ids: nil,
         # The unique identifier of the company to list payments for.
         company_id: nil,
         # Only return payments created after this timestamp.

data/rbi/whop_sdk/resources/payout_accounts.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Payout accounts
     class PayoutAccounts
       # Retrieves the details of an existing payout account.
       #

data/rbi/whop_sdk/resources/payouts/methods.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Payouts
+      # Payouts represent money sent from an account or user balance to an external
+      # destination, such as a bank account, wallet, or other saved payout method.
+      #
+      # Use the Payouts API to create payouts from stablecoin accounts, list payout
+      # history for accounts or users, monitor payout statuses, and show expected
+      # arrival details for funds leaving Whop.
+      class Methods
+        # Lists the saved payout methods (bank accounts, digital wallets, crypto
+        # addresses) that an account or user can withdraw to, most recently added first.
+        # Pass exactly one of account*id (a biz* identifier) or user*id (a user*
+        # identifier). Pass an amount to additionally get a fee and delivery quote per
+        # method for withdrawing that amount.
+        sig do
+          params(
+            account_id: String,
+            after: String,
+            amount: Float,
+            before: String,
+            currency: String,
+            first: Integer,
+            include_available: T::Boolean,
+            last: Integer,
+            status: WhopSDK::Payouts::MethodListParams::Status::OrSymbol,
+            user_id: String,
+            request_options: WhopSDK::RequestOptions::OrHash
+          ).returns(
+            WhopSDK::Internal::CursorPage[
+              WhopSDK::Models::Payouts::MethodListResponse
+            ]
+          )
+        end
+        def list(
+          # The owning account ID (a biz\_ identifier). Provide this or user_id.
+          account_id: nil,
+          # Cursor to fetch the page after (from page_info.end_cursor).
+          after: nil,
+          # Optional withdrawal amount in whole currency units, for example `250.00`. When
+          # provided, each method includes a quote with the estimated fee, amount received,
+          # and delivery date for that amount.
+          amount: nil,
+          # Cursor to fetch the page before (from page_info.start_cursor).
+          before: nil,
+          # Currency code of the amount, for example `usd`. Only meaningful with amount.
+          currency: nil,
+          # Number of payout methods to return from the start of the window. Capped at 25
+          # when an amount is provided.
+          first: nil,
+          # When true, the response also carries available_destinations — payout rails the
+          # account could add as a new payout method, with per-currency quotes when an
+          # amount is provided.
+          include_available: nil,
+          # Number of payout methods to return from the end of the window.
+          last: nil,
+          # Optional status filter. `created` means saved but unused, `active` means a
+          # payout through it succeeded, `broken` means the last payout failed and the
+          # method needs fixing.
+          status: 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
+end

data/rbi/whop_sdk/resources/payouts.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Payouts represent money sent from an account or user balance to an external
+    # destination, such as a bank account, wallet, or other saved payout method.
+    #
+    # Use the Payouts API to create payouts from stablecoin accounts, list payout
+    # history for accounts or users, monitor payout statuses, and show expected
+    # arrival details for funds leaving Whop.
+    class Payouts
+      # Payouts represent money sent from an account or user balance to an external
+      # destination, such as a bank account, wallet, or other saved payout method.
+      #
+      # Use the Payouts API to create payouts from stablecoin accounts, list payout
+      # history for accounts or users, monitor payout statuses, and show expected
+      # arrival details for funds leaving Whop.
+      sig { returns(WhopSDK::Resources::Payouts::Methods) }
+      attr_reader :methods_
+
+      # Creates a payout from a stablecoin account to a saved payout method. The
+      # account's funds move from its stablecoin balance to an external bank account,
+      # wallet, or crypto address. Accounts that pay out from a fiat balance use POST
+      # /withdrawals. Requires the payouts API to be enabled for the account; contact
+      # support to enable it. The payout settles asynchronously; poll GET /payouts for
+      # the entry whose payout_request_id matches this payout's id.
+      sig do
+        params(
+          account_id: String,
+          amount: Float,
+          payout_method_id: String,
+          currency: String,
+          idempotency_key: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::PayoutCreateResponse)
+      end
+      def create(
+        # The account to pay out from (a biz\_ identifier).
+        account_id:,
+        # The amount to pay out in the specified currency.
+        amount:,
+        # The saved payout method to deliver to (a potk\_ identifier).
+        payout_method_id:,
+        # The payout currency. Defaults to usd.
+        currency: nil,
+        # A client-generated key that makes retries safe. Retrying with the same key
+        # returns the original payout instead of creating a second one.
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists payouts (withdrawal requests) for an account or user, most recent first.
+      # Pass exactly one of account*id (a biz* identifier) or user*id (a user*
+      # identifier). The saved payout method on each payout additionally requires the
+      # payout:destination:read scope and is null without it.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          currency: String,
+          first: Integer,
+          last: Integer,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::PayoutListResponse]
+        )
+      end
+      def list(
+        # The owning account ID (a biz\_ identifier). Provide this or user_id.
+        account_id: nil,
+        # Cursor to fetch the page after (from page_info.end_cursor).
+        after: nil,
+        # Cursor to fetch the page before (from page_info.start_cursor).
+        before: nil,
+        # Optional currency code filter, for example `usd`.
+        currency: nil,
+        # Number of payouts to return from the start of the window.
+        first: nil,
+        # Number of payouts to return from the end of the window.
+        last: 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/people.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # A Person represents a visitor or customer of an account, assembled from
+    # [pixel events](/api-reference/beta/events/event) and purchase activity — ad
+    # clicks, storefront visits, and checkouts.
+    #
+    # Use the People API to list the people of an account and retrieve a single
+    # person.
+    class People
+      # Retrieves one person for an account, aggregated from pixel events.
+      sig do
+        params(
+          person_id: String,
+          account_id: String,
+          from: Integer,
+          to: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::PersonRetrieveResponse)
+      end
+      def retrieve(
+        # 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,
+        # 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
+
+      # Lists the people (visitors and customers) of an account, aggregated from pixel
+      # events. The account is inferred from an account API key; other credentials must
+      # pass account_id.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          direction: WhopSDK::PersonListParams::Direction::OrSymbol,
+          filters: String,
+          first: Integer,
+          from: Integer,
+          sort: String,
+          to: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::PersonListResponse]
+        )
+      end
+      def list(
+        # 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 people after a previous page.
+        after: nil,
+        # A cursor for fetching people before a later page.
+        before: nil,
+        # Sort direction. Defaults to desc.
+        direction: nil,
+        # A JSON-encoded array of filters, each with field, operator, and value keys.
+        filters: nil,
+        # The number of people to return (default 100, max 100).
+        first: nil,
+        # Start of the time range as a Unix timestamp. Defaults to 366 days before `to`.
+        from: nil,
+        # Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to
+        # last_seen_at.
+        sort: 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