whop_sdk 0.0.40 → 0.0.41

data/rbi/whop_sdk/resources/setup_intents.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Setup intents
     class SetupIntents
       # Retrieves the details of an existing setup intent.
       #

data/rbi/whop_sdk/resources/shipments.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Shipments
     class Shipments
       # Create a new shipment with a tracking code for a specific payment within a
       # company.

data/rbi/whop_sdk/resources/social_accounts.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # A Social Account represents an external profile connected to a Whop account or
+    # user, such as a Facebook page or Instagram account. Connecting a social account
+    # lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity
+    # and promote its existing posts.
+    #
+    # Use the Social Accounts API to list connected accounts, create a Whop-managed
+    # Facebook page, start an OAuth connection, disconnect a social account, and list
+    # a connected profile's posts.
+    class SocialAccounts
+      # Creates or returns a Whop-managed Facebook page for an account.
+      sig do
+        params(
+          platform: WhopSDK::SocialAccountCreateParams::Platform::OrSymbol,
+          account_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::SocialAccount)
+      end
+      def create(
+        # The platform to create the social account on.
+        platform:,
+        # The Account (biz\_ identifier) to create the social account for. An
+        # account-scoped API key may omit this to default to its own account.
+        account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists the social accounts linked to an account or user.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          before: String,
+          direction: WhopSDK::SocialAccountListParams::Direction::OrSymbol,
+          first: Integer,
+          last: Integer,
+          order: WhopSDK::SocialAccountListParams::Order::OrSymbol,
+          platform: WhopSDK::SocialAccountListParams::Platform::OrSymbol,
+          scopes: T::Array[WhopSDK::SocialAccountListParams::Scope::OrSymbol],
+          user_id: String,
+          verified: T::Boolean,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Internal::CursorPage[WhopSDK::SocialAccount])
+      end
+      def list(
+        # The Account that the social accounts are connected to. Provide either 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,
+        # Sort direction.
+        direction: nil,
+        # The number of social accounts to return.
+        first: nil,
+        # The number of social accounts to return from the end of the range.
+        last: nil,
+        # The field to sort social accounts by.
+        order: nil,
+        # Only return social accounts for the platform that is specified.
+        platform: nil,
+        # Only return social accounts that have these scopes.
+        scopes: nil,
+        # The User that the social accounts are connected to. Provide either this or
+        # account_id.
+        user_id: nil,
+        # Only return social accounts that are verified on the platform.
+        verified: nil,
+        request_options: {}
+      )
+      end
+
+      # Disconnects a social account from an account or user without deleting the
+      # underlying platform account.
+      sig do
+        params(
+          id: String,
+          account_id: String,
+          user_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(
+        # The ID of the social account to disconnect.
+        id,
+        # The Account that the social account is connected to. Provide either this or
+        # user_id.
+        account_id: nil,
+        # The User that the social account is connected to. Provide either this or
+        # account_id.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Starts an OAuth connection flow and returns an authorize_url where the user can
+      # connect a social account.
+      sig do
+        params(
+          platform: WhopSDK::SocialAccountConnectParams::Platform::OrSymbol,
+          account_id: String,
+          redirect_url: String,
+          scopes:
+            T::Array[WhopSDK::SocialAccountConnectParams::Scope::OrSymbol],
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::SocialAccountConnectResponse)
+      end
+      def connect(
+        # The platform to connect the social account on. Today, the supported option is
+        # `meta_business`.
+        platform:,
+        # The Account (biz\_ identifier) to connect the social account for. An
+        # account-scoped API key may omit this to default to its own account.
+        account_id: nil,
+        # The Whop URL to redirect the user to after they finish connecting.
+        redirect_url: nil,
+        # Capabilities to grant for the connected social account. Use `advertise` when
+        # connecting a Meta Business account for ads.
+        scopes: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists the existing posts of a connected Facebook page or Instagram account.
+      sig do
+        params(
+          id: String,
+          account_id: String,
+          after: String,
+          first: Integer,
+          post_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::SocialAccountPostsResponse)
+      end
+      def posts(
+        # The social account (a sacc\_ identifier) whose posts to list.
+        id,
+        # The Account (a biz\_ identifier) the social account is connected to.
+        account_id:,
+        # Cursor to fetch the page after (from page_info.end_cursor).
+        after: nil,
+        # The number of posts to return.
+        first: nil,
+        # Return only the single post with this platform id, instead of the full list.
+        post_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/stats.rbi

@@ -0,0 +1,143 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Stats represent aggregated activity for an account over time. They help you
+    # understand revenue, transactions, disputes, members, referrals, and advertising
+    # performance across reporting periods like days, weeks, or months.
+    #
+    # Use the Stats API to list available metrics and their filterable properties,
+    # then retrieve time-series values for a date range.
+    class Stats
+      # Retrieves a metric as a time series of points for an account over a date range.
+      sig do
+        params(
+          metric: String,
+          from: Date,
+          to: Date,
+          access_level: String,
+          account_id: String,
+          ad_campaign_ids: T::Array[String],
+          ad_group_ids: T::Array[String],
+          ad_ids: T::Array[String],
+          breakdown_by: String,
+          card_network: String,
+          category: String,
+          convert_to: String,
+          currency: String,
+          fee_type: String,
+          interval: WhopSDK::StatRetrieveParams::Interval::OrSymbol,
+          most_recent_action: String,
+          payment_method: String,
+          product: String,
+          referred_user_id: String,
+          segment: String,
+          snapshot_window:
+            WhopSDK::StatRetrieveParams::SnapshotWindow::OrSymbol,
+          source: String,
+          status: String,
+          time_zone: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::StatRetrieveResponse)
+      end
+      def retrieve(
+        # The metric to retrieve, for example net_revenue. Use GET /stats to see every
+        # metric key. The metric sets the unit and the properties you can filter or break
+        # down by.
+        metric,
+        # Start of the date range (YYYY-MM-DD).
+        from:,
+        # End of the date range (YYYY-MM-DD).
+        to:,
+        # Filter to a single access level. Pair with breakdown_by=access_level. Available
+        # on metrics that list access_level.
+        access_level: nil,
+        # The account this query concerns, for example biz_AbC123.
+        account_id: nil,
+        # Ad campaign ids (adcamp\_...) to scope the report to; stats are summed across
+        # them. Available on metrics that list ad_campaign_ids.
+        ad_campaign_ids: nil,
+        # Ad group ids (adgrp\_...) to scope the report to; stats are summed across them.
+        # Available on metrics that list ad_group_ids.
+        ad_group_ids: nil,
+        # Ad ids (ad\_...) to scope the report to; stats are summed across them. Available
+        # on metrics that list ad_ids.
+        ad_ids: nil,
+        # Split the metric out by one of its properties — each point gets a breakdown
+        # array. For example breakdown_by=currency returns an entry for usd, an entry for
+        # eur, and so on.
+        breakdown_by: nil,
+        # Filter to a single card brand, for example visa. A refinement of
+        # payment_method=card. Available on metrics that list card_network.
+        card_network: nil,
+        # Filter to a single balance-activity category, for example payments. Pair with
+        # breakdown_by=category to split the activity. Available on metrics that list
+        # category.
+        category: nil,
+        # Display currency for money metrics — every amount is converted into this ISO
+        # currency using the exchange rate on each period's date. Defaults to usd. For the
+        # ads metrics (ad_spend, ad_report), pass the account's ads reporting currency to
+        # match the ad entity endpoints. Ignored when you filter or break down by currency
+        # (those report the original transaction currency, unconverted).
+        convert_to: nil,
+        # Filter to transactions made in this original ISO currency, for example eur —
+        # reported in that currency, not converted. Pair with breakdown_by=currency to
+        # split a metric by currency. Available on metrics that list currency.
+        currency: nil,
+        # Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by
+        # type. Available on metrics that list fee_type.
+        fee_type: nil,
+        # How wide each point is. Defaults to day. Snapshot metrics are day-only.
+        interval: nil,
+        # Filter to a single most-recent member action. Pair with
+        # breakdown_by=most_recent_action. Available on metrics that list
+        # most_recent_action.
+        most_recent_action: nil,
+        # Filter to a single payment method, for example card or crypto. Available on
+        # metrics that list payment_method.
+        payment_method: nil,
+        # Filter to a single product (access pass id), for example prod_AbC123. Pair with
+        # breakdown_by=product. Available on metrics that list product.
+        product: nil,
+        # Filter a referral metric to the businesses attributed to one person you
+        # referred, for example user_AbC123. Available on metrics that list
+        # referred_user_id.
+        referred_user_id: nil,
+        # Filter to a single wallet-balance segment, for example available. Pair with
+        # breakdown_by=segment to split the balance. Available on metrics that list
+        # segment.
+        segment: nil,
+        # Trailing window for snapshot metrics. Only accepted by snapshot metrics (each
+        # lists its allowed windows in the catalog); defaults to the metric's first
+        # supported window. Only 30d today.
+        snapshot_window: nil,
+        # Filter to a single GMV source, for example payments. Pair with
+        # breakdown_by=source to split by source. Available on metrics that list source.
+        source: nil,
+        # Filter to a single membership status. Pair with breakdown_by=status. Available
+        # on metrics that list status.
+        status: nil,
+        # IANA time zone to bucket the series in, for example America/New_York. Defaults
+        # to UTC. Not accepted by snapshot metrics, which are UTC only.
+        time_zone: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists every metric you can query, with its unit and the properties you can
+      # filter or break it down by.
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          WhopSDK::Models::StatListResponse
+        )
+      end
+      def list(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/support_channels.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Support channels
     class SupportChannels
       # Open a new support channel between a company team member and a customer. Returns
       # the existing channel if one already exists for that user.

data/rbi/whop_sdk/resources/swaps.rbi

@@ -2,7 +2,77 @@
 
 module WhopSDK
   module Resources
+    # Swaps convert value between supported tokens, chains, or wallet destinations for
+    # an account. A swap quote describes the expected output, fees, and approval
+    # requirements before you create the swap.
+    #
+    # Use the Swaps API to quote a conversion, create the swap, list recent swaps, and
+    # retrieve status until the transaction completes.
     class Swaps
+      # Executes a swap from the account's wallet. Runs asynchronously; poll GET
+      # /swaps/{id} for status.
+      sig do
+        params(
+          account_id: String,
+          amount: String,
+          from_token: String,
+          to_token: String,
+          from_chain: T.nilable(WhopSDK::SwapCreateParams::FromChain::Variants),
+          slippage_bps: T.nilable(Integer),
+          to_chain: T.nilable(WhopSDK::SwapCreateParams::ToChain::Variants),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::SwapCreateResponse)
+      end
+      def create(
+        # Business or user account ID (biz*\* / user*\*).
+        account_id:,
+        # Source token amount.
+        amount:,
+        # Source token contract address or ticker symbol, such as "USDT".
+        from_token:,
+        # Destination token contract address or ticker symbol, such as "XAUT".
+        to_token:,
+        # Source chain name or chain ID. Defaults to the source token's chain when
+        # omitted.
+        from_chain: nil,
+        # Maximum slippage tolerance in basis points.
+        slippage_bps: nil,
+        # Destination chain name or chain ID. Defaults to the destination token's chain
+        # when omitted.
+        to_chain: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns the status of a specific swap, by the id returned from POST /swaps.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::SwapRetrieveResponse)
+      end
+      def retrieve(
+        # Swap ID returned from POST /swaps.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Lists the account's swaps. Currently returns the in-flight or most recent swap,
+      # so zero or one rows.
+      sig do
+        params(
+          account_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::SwapListResponse)
+      end
+      def list(
+        # Business or user account ID (biz*\* / user*\*).
+        account_id:,
+        request_options: {}
+      )
+      end
+
       # Returns a stateless swap price preview. No funds move and nothing is persisted.
       sig do
         params(
@@ -21,17 +91,25 @@ module WhopSDK
         ).returns(WhopSDK::Models::SwapCreateQuoteResponse)
       end
       def create_quote(
-        # Input token amount.
+        # Source token amount.
         amount:,
-        # Source token contract address.
+        # Source token contract address or ticker symbol, such as "USDT".
         from_token:,
-        # Destination token contract address.
+        # Destination token contract address or ticker symbol, such as "XAUT".
         to_token:,
+        # Source wallet address used for the quote.
         from_address: nil,
+        # Source chain name or chain ID. Defaults to the source token's chain when
+        # omitted.
         from_chain: nil,
+        # Metadata to include with the quote response.
         metadata: nil,
+        # Maximum slippage tolerance in basis points.
         slippage_bps: nil,
+        # Destination wallet address used for the quote.
         to_address: nil,
+        # Destination chain name or chain ID. Defaults to the destination token's chain
+        # when omitted.
         to_chain: nil,
         request_options: {}
       )

data/rbi/whop_sdk/resources/topups.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Topups
     class Topups
       # Add funds to a company's platform balance by charging a stored payment method.
       # Top-ups have no fees or taxes and do not count as revenue.

data/rbi/whop_sdk/resources/transfers.rbi

@@ -2,115 +2,116 @@
 
 module WhopSDK
   module Resources
-    # Transfers
+    # Transfers move value between identities on Whop. They are used for
+    # account-to-account money movement, user payouts inside Whop, crypto transfers,
+    # and claim links depending on the destination type.
+    #
+    # Use the Transfers API to create a transfer, list previous transfers, and
+    # retrieve a transfer by ID when reconciling money movement between accounts or
+    # users.
     class Transfers
-      # Transfer funds between two ledger accounts, such as from a company balance to a
-      # user balance.
-      #
-      # Required permissions:
-      #
-      # - `payout:transfer_funds`
+      # Moves funds out of an account. `type` selects the kind of movement (default
+      # `ledger`): `ledger` transfers credit between two ledger accounts and returns a
+      # Transfer; `wallet_send` sends USDT from the origin account's Ethereum wallet to
+      # a recipient; `claim_link` funds a shareable claim link anyone with the URL can
+      # redeem.
       sig do
         params(
           amount: Float,
-          currency: WhopSDK::Currency::OrSymbol,
-          destination_id: String,
           origin_id: String,
+          currency: String,
+          destination_id: String,
+          expires_at: T.nilable(Time),
           idempotence_key: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
+          redeemable_count: Integer,
+          type: WhopSDK::TransferCreateParams::Type::OrSymbol,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Transfer)
+        ).returns(WhopSDK::Models::TransferCreateResponse::Variants)
       end
       def create(
-        # The amount to transfer in the specified currency. For example, 25.00 for $25.00
-        # USD.
+        # The amount to move, in the transfer currency. For example 25.00.
         amount:,
-        # The currency of the transfer amount, such as 'usd'.
-        currency:,
-        # The identifier of the account receiving the funds. Accepts a user ID
-        # ('user_xxx'), company ID ('biz_xxx'), ledger account ID ('ldgr_xxx'), or an
-        # email address — emails without an existing Whop user trigger a placeholder-user
-        # signup.
-        destination_id:,
-        # The identifier of the account sending the funds. Accepts a user ID ('user_xxx'),
-        # company ID ('biz_xxx'), or ledger account ID ('ldgr_xxx').
+        # The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or
+        # ledger account ID (ldgr_xxx).
         origin_id:,
-        # A unique key to prevent duplicate transfers. Use a UUID or similar unique
-        # string.
+        # Currency, such as `usd`. Required for ledger transfers.
+        currency: nil,
+        # The recipient. Required for ledger and wallet*send (a user*/biz*/ldgr* ID, or —
+        # for sends — an email). Omit for claim_link.
+        destination_id: nil,
+        # claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from
+        # creation.
+        expires_at: nil,
+        # Ledger transfers only. A unique key to prevent duplicate transfers.
         idempotence_key: nil,
-        # A JSON object of custom metadata to attach to the transfer for tracking
-        # purposes.
+        # Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50
+        # keys, 100 chars per key, 500 chars per string value.
         metadata: nil,
-        # A short note describing the transfer, up to 50 characters.
+        # Ledger transfers only. A short note describing the transfer.
         notes: nil,
+        # claim_link only. How many different users can claim the link. Defaults to 1.
+        redeemable_count: nil,
+        # The kind of money movement. Defaults to ledger.
+        type: nil,
         request_options: {}
       )
       end
 
-      # Retrieves the details of an existing transfer.
-      #
-      # Required permissions:
-      #
-      # - `payout:transfer:read`
+      # Retrieves a ledger transfer by ID.
       sig do
         params(
           id: String,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Transfer)
+        ).returns(WhopSDK::Models::TransferRetrieveResponse)
       end
       def retrieve(
-        # The unique identifier of the transfer to retrieve.
+        # The transfer ID.
         id,
         request_options: {}
       )
       end
 
-      # Returns a paginated list of fund transfers, filtered by origin or destination
-      # account, with optional sorting and date filtering.
-      #
-      # Required permissions:
-      #
-      # - `payout:transfer:read`
+      # Lists ledger transfers for an account. You must specify an origin_id or a
+      # destination_id.
       sig do
         params(
-          after: T.nilable(String),
-          before: T.nilable(String),
-          created_after: T.nilable(Time),
-          created_before: T.nilable(Time),
-          destination_id: T.nilable(String),
-          direction: T.nilable(WhopSDK::Direction::OrSymbol),
-          first: T.nilable(Integer),
-          last: T.nilable(Integer),
-          order: T.nilable(WhopSDK::TransferListParams::Order::OrSymbol),
-          origin_id: T.nilable(String),
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          destination_id: String,
+          direction: WhopSDK::TransferListParams::Direction::OrSymbol,
+          first: Integer,
+          last: Integer,
+          order: WhopSDK::TransferListParams::Order::OrSymbol,
+          origin_id: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[WhopSDK::Models::TransferListResponse]
         )
       end
       def list(
-        # Returns the elements in the list that come after the specified cursor.
+        # Cursor to fetch the page after (from page_info.end_cursor).
         after: nil,
-        # Returns the elements in the list that come before the specified cursor.
+        # Cursor to fetch the page before (from page_info.start_cursor).
         before: nil,
-        # Only return transfers created after this timestamp.
+        # Only transfers created strictly after this ISO 8601 timestamp.
         created_after: nil,
-        # Only return transfers created before this timestamp.
+        # Only transfers created strictly before this ISO 8601 timestamp.
         created_before: nil,
-        # Filter to transfers received by this account. Accepts a user, company, or ledger
-        # account ID.
+        # Filter to transfers received by this account.
         destination_id: nil,
-        # The direction of the sort.
+        # Sort direction. Defaults to desc.
         direction: nil,
-        # Returns the first _n_ elements from the list.
+        # Number of transfers to return from the start of the window.
         first: nil,
-        # Returns the last _n_ elements from the list.
+        # Number of transfers to return from the end of the window.
         last: nil,
-        # Which columns can be used to sort.
+        # Sort column. Defaults to created_at.
         order: nil,
-        # Filter to transfers sent from this account. Accepts a user, company, or ledger
-        # account ID.
+        # Filter to transfers sent from this account.
         origin_id: nil,
         request_options: {}
       )