whop_sdk 0.0.40 → 0.0.41

data/lib/whop_sdk/resources/fee_markups.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Fee markups
     class FeeMarkups
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::FeeMarkupCreateParams} for more details.

data/lib/whop_sdk/resources/files.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Files
     class Files
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::FileCreateParams} for more details.

data/lib/whop_sdk/resources/financial_activity.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+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
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::FinancialActivityListParams} for more details.
+      #
+      # 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`.
+      #
+      # @overload list(account_id: nil, available_after: nil, available_before: nil, currency: nil, cursor: nil, include_owned_accounts: nil, limit: nil, line_types: nil, posted_after: nil, posted_before: nil, user_id: nil, request_options: {})
+      #
+      # @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      # @param available_after [Date] Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD`
+      #
+      # @param available_before [Date] Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD`
+      #
+      # @param currency [String] Optional currency code filter, for example `usd`.
+      #
+      # @param cursor [String] Cursor returned by the previous page.
+      #
+      # @param include_owned_accounts [Boolean] When true, aggregates the authenticated user's personal ledger with the business
+      #
+      # @param limit [Integer] Maximum number of rows to return.
+      #
+      # @param line_types [Array<String>] Optional ledger line categories to include. Some categories (for example `onchai
+      #
+      # @param posted_after [Time] Only include rows posted after this ISO 8601 timestamp.
+      #
+      # @param posted_before [Time] Only include rows posted before this ISO 8601 timestamp.
+      #
+      # @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::FinancialActivityListResponse]
+      #
+      # @see WhopSDK::Models::FinancialActivityListParams
+      def list(params = {})
+        parsed, options = WhopSDK::FinancialActivityListParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "financial-activity",
+          query: query,
+          model: WhopSDK::Models::FinancialActivityListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/forum_posts.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Forum posts
     class ForumPosts
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::ForumPostCreateParams} for more details.

data/lib/whop_sdk/resources/forums.rb

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

data/lib/whop_sdk/resources/invoices.rb

@@ -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/lib/whop_sdk/resources/leads.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Leads
     class Leads
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::LeadCreateParams} for more details.

data/lib/whop_sdk/resources/ledger_accounts.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Ledger accounts
     class LedgerAccounts
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::LedgerAccountRetrieveParams} for more details.

data/lib/whop_sdk/resources/media.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+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`.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Media asset ID, prefixed `media_`.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::MediaAsset]
+      #
+      # @see WhopSDK::Models::MediaRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["media/%1$s", id],
+          model: WhopSDK::MediaAsset,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::MediaGenerateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload generate(prompt:, type:, account_id: nil, duration_seconds: nil, reference_media: nil, resolution: nil, request_options: {})
+      #
+      # @param prompt [String] What to generate. Up to 2,000 characters.
+      #
+      # @param type [Symbol, WhopSDK::Models::MediaGenerateParams::Type] The kind of media to generate.
+      #
+      # @param account_id [String] Account ID, prefixed `biz_`. Defaults to the account the API key belongs to.
+      #
+      # @param duration_seconds [Integer, WhopSDK::Models::MediaGenerateParams::DurationSeconds] Video length in seconds. Video only; defaults to 5.
+      #
+      # @param reference_media [Array<String>] Optional reference image file IDs (`file_` prefixed), up to 4. For video, a sing
+      #
+      # @param resolution [Symbol, WhopSDK::Models::MediaGenerateParams::Resolution] Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by S
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::MediaAsset]
+      #
+      # @see WhopSDK::Models::MediaGenerateParams
+      def generate(params)
+        parsed, options = WhopSDK::MediaGenerateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "media/generate",
+          body: parsed,
+          model: WhopSDK::MediaAsset,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/members.rb

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

data/lib/whop_sdk/resources/memberships.rb

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

data/lib/whop_sdk/resources/messages.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Messages
     class Messages
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::MessageCreateParams} for more details.

data/lib/whop_sdk/resources/notifications.rb

@@ -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/lib/whop_sdk/resources/payment_methods.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Payment methods
     class PaymentMethods
       # Some parameter documentations has been truncated, see
       # {WhopSDK::Models::PaymentMethodRetrieveParams} for more details.

data/lib/whop_sdk/resources/payments.rb

@@ -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

data/lib/whop_sdk/resources/payout_accounts.rb

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

data/lib/whop_sdk/resources/payouts/methods.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+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
+        # Some parameter documentations has been truncated, see
+        # {WhopSDK::Models::Payouts::MethodListParams} for more details.
+        #
+        # 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.
+        #
+        # @overload list(account_id: nil, after: nil, amount: nil, before: nil, currency: nil, first: nil, include_available: nil, last: nil, status: nil, user_id: nil, request_options: {})
+        #
+        # @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+        #
+        # @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        # @param amount [Float] Optional withdrawal amount in whole currency units, for example `250.00`. When p
+        #
+        # @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        # @param currency [String] Currency code of the amount, for example `usd`. Only meaningful with amount.
+        #
+        # @param first [Integer] Number of payout methods to return from the start of the window. Capped at 25 wh
+        #
+        # @param include_available [Boolean] When true, the response also carries available_destinations — payout rails the a
+        #
+        # @param last [Integer] Number of payout methods to return from the end of the window.
+        #
+        # @param status [Symbol, WhopSDK::Models::Payouts::MethodListParams::Status] Optional status filter. `created` means saved but unused, `active` means a payou
+        #
+        # @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+        #
+        # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::Payouts::MethodListResponse>]
+        #
+        # @see WhopSDK::Models::Payouts::MethodListParams
+        def list(params = {})
+          parsed, options = WhopSDK::Payouts::MethodListParams.dump_request(params)
+          query = WhopSDK::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "payouts/methods",
+            query: query,
+            page: WhopSDK::Internal::CursorPage,
+            model: WhopSDK::Models::Payouts::MethodListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [WhopSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/payouts.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+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.
+      # @return [WhopSDK::Resources::Payouts::Methods]
+      attr_reader :methods_
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::PayoutCreateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload create(account_id:, amount:, payout_method_id:, currency: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param account_id [String] The account to pay out from (a biz\_ identifier).
+      #
+      # @param amount [Float] The amount to pay out in the specified currency.
+      #
+      # @param payout_method_id [String] The saved payout method to deliver to (a potk\_ identifier).
+      #
+      # @param currency [String] The payout currency. Defaults to usd.
+      #
+      # @param idempotency_key [String] A client-generated key that makes retries safe. Retrying with the same key retur
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PayoutCreateResponse]
+      #
+      # @see WhopSDK::Models::PayoutCreateParams
+      def create(params)
+        parsed, options = WhopSDK::PayoutCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "payouts",
+          body: parsed,
+          model: WhopSDK::Models::PayoutCreateResponse,
+          options: 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.
+      #
+      # @overload list(account_id: nil, after: nil, before: nil, currency: nil, first: nil, last: nil, user_id: nil, request_options: {})
+      #
+      # @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      # @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      # @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      # @param currency [String] Optional currency code filter, for example `usd`.
+      #
+      # @param first [Integer] Number of payouts to return from the start of the window.
+      #
+      # @param last [Integer] Number of payouts to return from the end of the window.
+      #
+      # @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::PayoutListResponse>]
+      #
+      # @see WhopSDK::Models::PayoutListParams
+      def list(params = {})
+        parsed, options = WhopSDK::PayoutListParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "payouts",
+          query: query,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::PayoutListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+        @methods_ = WhopSDK::Resources::Payouts::Methods.new(client: client)
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/people.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+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
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::PersonRetrieveParams} for more details.
+      #
+      # Retrieves one person for an account, aggregated from pixel events.
+      #
+      # @overload retrieve(person_id, account_id: nil, from: nil, to: nil, request_options: {})
+      #
+      # @param person_id [String] The ID of the person.
+      #
+      # @param account_id [String] The ID of the account, which will look like biz\_******\*******. Optional for
+      # acco
+      #
+      # @param from [Integer] Start of the time range as a Unix timestamp.
+      #
+      # @param to [Integer] End of the time range as a Unix timestamp. Defaults to now.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PersonRetrieveResponse]
+      #
+      # @see WhopSDK::Models::PersonRetrieveParams
+      def retrieve(person_id, params = {})
+        parsed, options = WhopSDK::PersonRetrieveParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["people/%1$s", person_id],
+          query: query,
+          model: WhopSDK::Models::PersonRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::PersonListParams} for more details.
+      #
+      # 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.
+      #
+      # @overload list(account_id: nil, after: nil, before: nil, direction: nil, filters: nil, first: nil, from: nil, sort: nil, to: nil, request_options: {})
+      #
+      # @param account_id [String] The ID of the account, which will look like biz\_******\*******. Optional for
+      # acco
+      #
+      # @param after [String] A cursor for fetching people after a previous page.
+      #
+      # @param before [String] A cursor for fetching people before a later page.
+      #
+      # @param direction [Symbol, WhopSDK::Models::PersonListParams::Direction] Sort direction. Defaults to desc.
+      #
+      # @param filters [String] A JSON-encoded array of filters, each with field, operator, and value keys.
+      #
+      # @param first [Integer] The number of people to return (default 100, max 100).
+      #
+      # @param from [Integer] Start of the time range as a Unix timestamp. Defaults to 366 days before `to`.
+      #
+      # @param sort [String] Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to last_see
+      #
+      # @param to [Integer] End of the time range as a Unix timestamp. Defaults to now.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::PersonListResponse>]
+      #
+      # @see WhopSDK::Models::PersonListParams
+      def list(params = {})
+        parsed, options = WhopSDK::PersonListParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "people",
+          query: query,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::PersonListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end