whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/user.rb

@@ -5,78 +5,323 @@ module WhopSDK
     # @see WhopSDK::Resources::Users#retrieve
     class User < WhopSDK::Internal::Type::BaseModel
       # @!attribute id
-      #   The unique identifier for the user.
+      #   User ID, prefixed `user_`.
       #
       #   @return [String]
       required :id, String
 
+      # @!attribute balance
+      #   The user's balance: personal cash + crypto + in-flight treasury deposits, plus
+      #   account balances for accounts they own. Computed only on `GET /users/me`
+      #   self-view for callers with balance-read scope; `null` otherwise.
+      #
+      #   @return [WhopSDK::Models::UserBalance, nil]
+      required :balance, -> { WhopSDK::UserBalance }, nil?: true
+
+      # @!attribute balance_history
+      #   The user's cumulative wallet balance over time (USD `{ t, v }` points plus
+      #   last/min/max), for the balance chart. Opt in with `include_balance_history=true`
+      #   on `GET /users/me`; populated only for callers with balance-read scope and
+      #   `null` otherwise. A user with no wallet activity returns an empty series.
+      #
+      #   @return [WhopSDK::Models::User::BalanceHistory, nil]
+      required :balance_history, -> { WhopSDK::User::BalanceHistory }, nil?: true
+
       # @!attribute bio
-      #   A short biography written by the user, displayed on their public profile.
+      #   The user's biography
       #
       #   @return [String, nil]
       required :bio, String, nil?: true
 
       # @!attribute created_at
-      #   The datetime the user was created.
+      #   When the user was created, as an ISO 8601 timestamp
       #
-      #   @return [Time]
-      required :created_at, Time
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute earnings_usd
+      #   The user's gross USD income over time. Populated only on single-user self reads
+      #   for callers with balance-read scope; `null` otherwise.
+      #
+      #   @return [WhopSDK::Models::User::EarningsUsd, nil]
+      required :earnings_usd, -> { WhopSDK::User::EarningsUsd }, nil?: true
 
       # @!attribute name
-      #   The user's display name shown on their public profile.
+      #   The user's display name
       #
       #   @return [String, nil]
       required :name, String, nil?: true
 
       # @!attribute profile_picture
-      #   The user's profile picture attachment with URL, content type, and file metadata.
-      #   Null if using a legacy profile picture.
+      #   The user's profile picture, an object with a url
       #
-      #   @return [WhopSDK::Models::User::ProfilePicture, nil]
-      required :profile_picture, -> { WhopSDK::User::ProfilePicture }, nil?: true
+      #   @return [Object, nil]
+      required :profile_picture, WhopSDK::Internal::Type::Unknown, nil?: true
 
       # @!attribute username
-      #   The user's unique username shown on their public profile.
+      #   The user's unique username
       #
       #   @return [String]
       required :username, String
 
-      # @!method initialize(id:, bio:, created_at:, name:, profile_picture:, username:)
+      # @!attribute verification
+      #   Identity verification status for the user's `individual` (KYC) and `business`
+      #   (KYB) profiles. Each is `null` until created, otherwise a `status` of
+      #   `not_started`, `pending`, `approved`, or `rejected`.
+      #
+      #   @return [Object]
+      required :verification, WhopSDK::Internal::Type::Unknown
+
+      # @!attribute whop_partner_enabled_at
+      #   When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. `null`
+      #   if never enrolled.
+      #
+      #   @return [String, nil]
+      required :whop_partner_enabled_at, String, nil?: true
+
+      # @!method initialize(id:, balance:, balance_history:, bio:, created_at:, earnings_usd:, name:, profile_picture:, username:, verification:, whop_partner_enabled_at:)
       #   Some parameter documentations has been truncated, see {WhopSDK::Models::User}
       #   for more details.
       #
-      #   A user account on Whop. Contains profile information, identity details, and
-      #   social connections.
+      #   @param id [String] User ID, prefixed `user_`.
+      #
+      #   @param balance [WhopSDK::Models::UserBalance, nil] The user's balance: personal cash + crypto + in-flight treasury deposits, plus a
+      #
+      #   @param balance_history [WhopSDK::Models::User::BalanceHistory, nil] The user's cumulative wallet balance over time (USD `{ t, v }` points plus last/
+      #
+      #   @param bio [String, nil] The user's biography
       #
-      #   @param id [String] The unique identifier for the user.
+      #   @param created_at [String] When the user was created, as an ISO 8601 timestamp
       #
-      #   @param bio [String, nil] A short biography written by the user, displayed on their public profile.
+      #   @param earnings_usd [WhopSDK::Models::User::EarningsUsd, nil] The user's gross USD income over time. Populated only on single-user self reads
       #
-      #   @param created_at [Time] The datetime the user was created.
+      #   @param name [String, nil] The user's display name
       #
-      #   @param name [String, nil] The user's display name shown on their public profile.
+      #   @param profile_picture [Object, nil] The user's profile picture, an object with a url
       #
-      #   @param profile_picture [WhopSDK::Models::User::ProfilePicture, nil] The user's profile picture attachment with URL, content type, and file metadata.
+      #   @param username [String] The user's unique username
       #
-      #   @param username [String] The user's unique username shown on their public profile.
+      #   @param verification [Object] Identity verification status for the user's `individual` (KYC) and `business` (K
+      #
+      #   @param whop_partner_enabled_at [String, nil] When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. `null`
+
+      # @see WhopSDK::Models::User#balance_history
+      class BalanceHistory < WhopSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<WhopSDK::Models::User::BalanceHistory::Data>]
+        required :data, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::User::BalanceHistory::Data] }
+
+        # @!attribute last
+        #   Value of the most recent point, in USD.
+        #
+        #   @return [Float]
+        required :last, Float
+
+        # @!attribute max
+        #   Maximum value across the window, in USD.
+        #
+        #   @return [Float]
+        required :max, Float
 
-      # @see WhopSDK::Models::User#profile_picture
-      class ProfilePicture < WhopSDK::Internal::Type::BaseModel
-        # @!attribute url
-        #   A pre-optimized URL for rendering this attachment on the client. This should be
-        #   used for displaying attachments in apps.
+        # @!attribute min
+        #   Minimum value across the window, in USD.
+        #
+        #   @return [Float]
+        required :min, Float
+
+        # @!method initialize(data:, last:, max:, min:)
+        #   The user's cumulative wallet balance over time (USD `{ t, v }` points plus
+        #   last/min/max), for the balance chart. Opt in with `include_balance_history=true`
+        #   on `GET /users/me`; populated only for callers with balance-read scope and
+        #   `null` otherwise. A user with no wallet activity returns an empty series.
+        #
+        #   @param data [Array<WhopSDK::Models::User::BalanceHistory::Data>]
+        #
+        #   @param last [Float] Value of the most recent point, in USD.
+        #
+        #   @param max [Float] Maximum value across the window, in USD.
+        #
+        #   @param min [Float] Minimum value across the window, in USD.
+
+        class Data < WhopSDK::Internal::Type::BaseModel
+          # @!attribute t
+          #   Point timestamp, in Unix seconds.
+          #
+          #   @return [Integer]
+          required :t, Integer
+
+          # @!attribute v
+          #   Cumulative wallet balance at this point, in USD.
+          #
+          #   @return [Float]
+          required :v, Float
+
+          # @!method initialize(t:, v:)
+          #   Cumulative balance points over the requested window, oldest first.
+          #
+          #   @param t [Integer] Point timestamp, in Unix seconds.
+          #
+          #   @param v [Float] Cumulative wallet balance at this point, in USD.
+        end
+      end
+
+      # @see WhopSDK::Models::User#earnings_usd
+      class EarningsUsd < WhopSDK::Internal::Type::BaseModel
+        # @!attribute first_earned_at
+        #   The first time the user earned gross income, as an ISO 8601 timestamp.
         #
         #   @return [String, nil]
-        required :url, String, nil?: true
+        required :first_earned_at, String, nil?: true
+
+        # @!attribute owned_accounts
+        #   Gross income from accounts the user owns or is owner-authorized on.
+        #
+        #   @return [WhopSDK::Models::User::EarningsUsd::OwnedAccounts]
+        required :owned_accounts, -> { WhopSDK::User::EarningsUsd::OwnedAccounts }
+
+        # @!attribute personal
+        #   Gross income from the user's personal wallet.
+        #
+        #   @return [WhopSDK::Models::User::EarningsUsd::Personal]
+        required :personal, -> { WhopSDK::User::EarningsUsd::Personal }
+
+        # @!attribute total
+        #   Gross income from the user's personal wallet plus accounts they own or are
+        #   owner-authorized on.
+        #
+        #   @return [WhopSDK::Models::User::EarningsUsd::Total]
+        required :total, -> { WhopSDK::User::EarningsUsd::Total }
 
-        # @!method initialize(url:)
+        # @!method initialize(first_earned_at:, owned_accounts:, personal:, total:)
         #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::User::ProfilePicture} for more details.
+        #   {WhopSDK::Models::User::EarningsUsd} for more details.
+        #
+        #   The user's gross USD income over time. Populated only on single-user self reads
+        #   for callers with balance-read scope; `null` otherwise.
         #
-        #   The user's profile picture attachment with URL, content type, and file metadata.
-        #   Null if using a legacy profile picture.
+        #   @param first_earned_at [String, nil] The first time the user earned gross income, as an ISO 8601 timestamp.
         #
-        #   @param url [String, nil] A pre-optimized URL for rendering this attachment on the client. This should be
+        #   @param owned_accounts [WhopSDK::Models::User::EarningsUsd::OwnedAccounts] Gross income from accounts the user owns or is owner-authorized on.
+        #
+        #   @param personal [WhopSDK::Models::User::EarningsUsd::Personal] Gross income from the user's personal wallet.
+        #
+        #   @param total [WhopSDK::Models::User::EarningsUsd::Total] Gross income from the user's personal wallet plus accounts they own or are owner
+
+        # @see WhopSDK::Models::User::EarningsUsd#owned_accounts
+        class OwnedAccounts < WhopSDK::Internal::Type::BaseModel
+          # @!attribute last_24_hours
+          #   Gross income in USD over the last 24 hours.
+          #
+          #   @return [String]
+          required :last_24_hours, String
+
+          # @!attribute last_30_days
+          #   Gross income in USD over the last 30 days.
+          #
+          #   @return [String]
+          required :last_30_days, String
+
+          # @!attribute last_7_days
+          #   Gross income in USD over the last 7 days.
+          #
+          #   @return [String]
+          required :last_7_days, String
+
+          # @!attribute lifetime
+          #   All-time gross income in USD.
+          #
+          #   @return [String]
+          required :lifetime, String
+
+          # @!method initialize(last_24_hours:, last_30_days:, last_7_days:, lifetime:)
+          #   Gross income from accounts the user owns or is owner-authorized on.
+          #
+          #   @param last_24_hours [String] Gross income in USD over the last 24 hours.
+          #
+          #   @param last_30_days [String] Gross income in USD over the last 30 days.
+          #
+          #   @param last_7_days [String] Gross income in USD over the last 7 days.
+          #
+          #   @param lifetime [String] All-time gross income in USD.
+        end
+
+        # @see WhopSDK::Models::User::EarningsUsd#personal
+        class Personal < WhopSDK::Internal::Type::BaseModel
+          # @!attribute last_24_hours
+          #   Gross income in USD over the last 24 hours.
+          #
+          #   @return [String]
+          required :last_24_hours, String
+
+          # @!attribute last_30_days
+          #   Gross income in USD over the last 30 days.
+          #
+          #   @return [String]
+          required :last_30_days, String
+
+          # @!attribute last_7_days
+          #   Gross income in USD over the last 7 days.
+          #
+          #   @return [String]
+          required :last_7_days, String
+
+          # @!attribute lifetime
+          #   All-time gross income in USD.
+          #
+          #   @return [String]
+          required :lifetime, String
+
+          # @!method initialize(last_24_hours:, last_30_days:, last_7_days:, lifetime:)
+          #   Gross income from the user's personal wallet.
+          #
+          #   @param last_24_hours [String] Gross income in USD over the last 24 hours.
+          #
+          #   @param last_30_days [String] Gross income in USD over the last 30 days.
+          #
+          #   @param last_7_days [String] Gross income in USD over the last 7 days.
+          #
+          #   @param lifetime [String] All-time gross income in USD.
+        end
+
+        # @see WhopSDK::Models::User::EarningsUsd#total
+        class Total < WhopSDK::Internal::Type::BaseModel
+          # @!attribute last_24_hours
+          #   Gross income in USD over the last 24 hours.
+          #
+          #   @return [String]
+          required :last_24_hours, String
+
+          # @!attribute last_30_days
+          #   Gross income in USD over the last 30 days.
+          #
+          #   @return [String]
+          required :last_30_days, String
+
+          # @!attribute last_7_days
+          #   Gross income in USD over the last 7 days.
+          #
+          #   @return [String]
+          required :last_7_days, String
+
+          # @!attribute lifetime
+          #   All-time gross income in USD.
+          #
+          #   @return [String]
+          required :lifetime, String
+
+          # @!method initialize(last_24_hours:, last_30_days:, last_7_days:, lifetime:)
+          #   Gross income from the user's personal wallet plus accounts they own or are
+          #   owner-authorized on.
+          #
+          #   @param last_24_hours [String] Gross income in USD over the last 24 hours.
+          #
+          #   @param last_30_days [String] Gross income in USD over the last 30 days.
+          #
+          #   @param last_7_days [String] Gross income in USD over the last 7 days.
+          #
+          #   @param lifetime [String] All-time gross income in USD.
+        end
       end
     end
   end

data/lib/whop_sdk/models/user_balance.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class UserBalance < WhopSDK::Internal::Type::BaseModel
+      # @!attribute businesses
+      #
+      #   @return [Array<WhopSDK::Models::UserBalance::Business>]
+      required :businesses, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Business] }
+
+      # @!attribute businesses_total_usd
+      #   Combined USD balance across every account the user owns.
+      #
+      #   @return [String]
+      required :businesses_total_usd, String
+
+      # @!attribute cash
+      #
+      #   @return [Array<WhopSDK::Models::UserBalance::Cash>]
+      required :cash, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Cash] }
+
+      # @!attribute cash_usd
+      #   Fiat cash in USD, including pending and reserve.
+      #
+      #   @return [String]
+      required :cash_usd, String
+
+      # @!attribute crypto
+      #
+      #   @return [Array<WhopSDK::Models::UserBalance::Crypto>]
+      required :crypto, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Crypto] }
+
+      # @!attribute crypto_usd
+      #   Crypto holdings in USD.
+      #
+      #   @return [String]
+      required :crypto_usd, String
+
+      # @!attribute pending_usd
+      #   Pending funds in USD: fiat pending + in-flight treasury deposits.
+      #
+      #   @return [String]
+      required :pending_usd, String
+
+      # @!attribute total_usd
+      #   The user's personal balance in USD: cash (available + pending + reserve) +
+      #   crypto + in-flight treasury deposits. Excludes account balances (see
+      #   businesses_total_usd).
+      #
+      #   @return [String]
+      required :total_usd, String
+
+      # @!attribute treasury_pending_usd
+      #   Balance-to-wallet USDT0 withdrawals still in flight, in USD.
+      #
+      #   @return [String]
+      required :treasury_pending_usd, String
+
+      # @!method initialize(businesses:, businesses_total_usd:, cash:, cash_usd:, crypto:, crypto_usd:, pending_usd:, total_usd:, treasury_pending_usd:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::UserBalance} for more details.
+      #
+      #   @param businesses [Array<WhopSDK::Models::UserBalance::Business>]
+      #
+      #   @param businesses_total_usd [String] Combined USD balance across every account the user owns.
+      #
+      #   @param cash [Array<WhopSDK::Models::UserBalance::Cash>]
+      #
+      #   @param cash_usd [String] Fiat cash in USD, including pending and reserve.
+      #
+      #   @param crypto [Array<WhopSDK::Models::UserBalance::Crypto>]
+      #
+      #   @param crypto_usd [String] Crypto holdings in USD.
+      #
+      #   @param pending_usd [String] Pending funds in USD: fiat pending + in-flight treasury deposits.
+      #
+      #   @param total_usd [String] The user's personal balance in USD: cash (available + pending + reserve) + crypt
+      #
+      #   @param treasury_pending_usd [String] Balance-to-wallet USDT0 withdrawals still in flight, in USD.
+
+      class Business < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The account ID, which looks like biz\_******\*******.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute balance_usd
+        #   The account's total balance in USD.
+        #
+        #   @return [String]
+        required :balance_usd, String
+
+        # @!attribute logo_url
+        #   The account's logo URL.
+        #
+        #   @return [String, nil]
+        required :logo_url, String, nil?: true
+
+        # @!attribute name
+        #   The account's display name.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(id:, balance_usd:, logo_url:, name:)
+        #   Account balances for accounts the user owns, highest balance first. Excludes
+        #   accounts with no balance.
+        #
+        #   @param id [String] The account ID, which looks like biz\_******\*******.
+        #
+        #   @param balance_usd [String] The account's total balance in USD.
+        #
+        #   @param logo_url [String, nil] The account's logo URL.
+        #
+        #   @param name [String, nil] The account's display name.
+      end
+
+      class Cash < WhopSDK::Internal::Type::BaseModel
+        # @!attribute balance
+        #   Available balance in the native currency.
+        #
+        #   @return [Float]
+        required :balance, Float
+
+        # @!attribute balance_usd
+        #   Available balance converted to USD.
+        #
+        #   @return [Float]
+        required :balance_usd, Float
+
+        # @!attribute currency
+        #   Lowercase ISO currency code, such as `usd` or `eur`.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute pending_balance_usd
+        #   Pending balance converted to USD.
+        #
+        #   @return [Float]
+        required :pending_balance_usd, Float
+
+        # @!attribute reserve_balance_usd
+        #   Reserved balance converted to USD.
+        #
+        #   @return [Float]
+        required :reserve_balance_usd, Float
+
+        # @!attribute total_withdrawable_balance
+        #   Withdrawable amount in the native currency.
+        #
+        #   @return [Float]
+        required :total_withdrawable_balance, Float
+
+        # @!method initialize(balance:, balance_usd:, currency:, pending_balance_usd:, reserve_balance_usd:, total_withdrawable_balance:)
+        #   Per-currency fiat cash balances.
+        #
+        #   @param balance [Float] Available balance in the native currency.
+        #
+        #   @param balance_usd [Float] Available balance converted to USD.
+        #
+        #   @param currency [String] Lowercase ISO currency code, such as `usd` or `eur`.
+        #
+        #   @param pending_balance_usd [Float] Pending balance converted to USD.
+        #
+        #   @param reserve_balance_usd [Float] Reserved balance converted to USD.
+        #
+        #   @param total_withdrawable_balance [Float] Withdrawable amount in the native currency.
+      end
+
+      class Crypto < WhopSDK::Internal::Type::BaseModel
+        # @!attribute balance
+        #   Amount held in native token units, as a decimal string.
+        #
+        #   @return [String]
+        required :balance, String
+
+        # @!attribute icon_url
+        #   Token icon URL.
+        #
+        #   @return [String, nil]
+        required :icon_url, String, nil?: true
+
+        # @!attribute name
+        #   The token's display name.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute price_usd
+        #   USD price per token, or `null` when unknown.
+        #
+        #   @return [Float, nil]
+        required :price_usd, Float, nil?: true
+
+        # @!attribute symbol
+        #   Token display symbol, such as `USDT`, `XAUT`, or `cbBTC`.
+        #
+        #   @return [String]
+        required :symbol, String
+
+        # @!attribute value_usd
+        #   Holding USD value.
+        #
+        #   @return [Float]
+        required :value_usd, Float
+
+        # @!method initialize(balance:, icon_url:, name:, price_usd:, symbol:, value_usd:)
+        #   Per-token crypto holdings in the ledger's own wallet.
+        #
+        #   @param balance [String] Amount held in native token units, as a decimal string.
+        #
+        #   @param icon_url [String, nil] Token icon URL.
+        #
+        #   @param name [String, nil] The token's display name.
+        #
+        #   @param price_usd [Float, nil] USD price per token, or `null` when unknown.
+        #
+        #   @param symbol [String] Token display symbol, such as `USDT`, `XAUT`, or `cbBTC`.
+        #
+        #   @param value_usd [Float] Holding USD value.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/user_check_access_response.rb

@@ -5,23 +5,30 @@ module WhopSDK
     # @see WhopSDK::Resources::Users#check_access
     class UserCheckAccessResponse < WhopSDK::Internal::Type::BaseModel
       # @!attribute access_level
-      #   The permission level of the user
       #
-      #   @return [Symbol, WhopSDK::Models::AccessLevel]
-      required :access_level, enum: -> { WhopSDK::AccessLevel }
+      #   @return [Symbol, WhopSDK::Models::UserCheckAccessResponse::AccessLevel]
+      required :access_level, enum: -> { WhopSDK::Models::UserCheckAccessResponse::AccessLevel }
 
       # @!attribute has_access
-      #   Whether the user has access to the resource
       #
       #   @return [Boolean]
       required :has_access, WhopSDK::Internal::Type::Boolean
 
       # @!method initialize(access_level:, has_access:)
-      #   The result of a has access check for the developer API
-      #
-      #   @param access_level [Symbol, WhopSDK::Models::AccessLevel] The permission level of the user
-      #
-      #   @param has_access [Boolean] Whether the user has access to the resource
+      #   @param access_level [Symbol, WhopSDK::Models::UserCheckAccessResponse::AccessLevel]
+      #   @param has_access [Boolean]
+
+      # @see WhopSDK::Models::UserCheckAccessResponse#access_level
+      module AccessLevel
+        extend WhopSDK::Internal::Type::Enum
+
+        NO_ACCESS = :no_access
+        ADMIN = :admin
+        CUSTOMER = :customer
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/whop_sdk/models/user_list_params.rb

@@ -8,45 +8,45 @@ module WhopSDK
       include WhopSDK::Internal::Type::RequestParameters
 
       # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      #   A cursor; returns users after this position.
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
+      optional :after, String
 
       # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
+      #   A cursor; returns users before this position.
       #
       #   @return [String, nil]
-      optional :before, String, nil?: true
+      optional :before, String
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   The number of users to return (max 50).
       #
       #   @return [Integer, nil]
-      optional :first, Integer, nil?: true
+      optional :first, Integer
 
       # @!attribute last
-      #   Returns the last _n_ elements from the list.
+      #   The number of users to return from the end of the range.
       #
       #   @return [Integer, nil]
-      optional :last, Integer, nil?: true
+      optional :last, Integer
 
       # @!attribute query
-      #   Search term to filter by name or username.
+      #   A search term to filter users by name or username.
       #
       #   @return [String, nil]
-      optional :query, String, nil?: true
+      optional :query, String
 
       # @!method initialize(after: nil, before: nil, first: nil, last: nil, query: nil, request_options: {})
-      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #   @param after [String] A cursor; returns users after this position.
       #
-      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #   @param before [String] A cursor; returns users before this position.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param first [Integer] The number of users to return (max 50).
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #   @param last [Integer] The number of users to return from the end of the range.
       #
-      #   @param query [String, nil] Search term to filter by name or username.
+      #   @param query [String] A search term to filter users by name or username.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
     end