whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/resources/referrals/businesses/earnings.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Referrals
+      class Businesses
+        # The Referrals API covers your Whop partner activity: the users you referred onto
+        # Whop, the businesses you referred and the earnings generated from their
+        # processing volume, and the partner leaderboard.
+        #
+        # Use it to enroll as a Whop partner, list the users you referred, list your
+        # referred businesses and review their earnings, and see the partner leaderboard.
+        class Earnings
+          # Lists the earnings Whop pays out for one referred business's activity, most
+          # recent first.
+          #
+          # @overload list(id, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {})
+          #
+          # @param id [String] The business referral ID (a coma\_ identifier).
+          #
+          # @param after [String]
+          #
+          # @param before [String]
+          #
+          # @param created_after [String] Only return earnings created after this timestamp.
+          #
+          # @param created_before [String] Only return earnings created before this timestamp.
+          #
+          # @param direction [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Direction] Sort direction.
+          #
+          # @param first [Integer]
+          #
+          # @param last [Integer]
+          #
+          # @param order [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order] The field to sort earnings by.
+          #
+          # @param status [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Status] Filter by earning status.
+          #
+          # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::Referrals::Businesses::EarningListResponse>]
+          #
+          # @see WhopSDK::Models::Referrals::Businesses::EarningListParams
+          def list(id, params = {})
+            parsed, options = WhopSDK::Referrals::Businesses::EarningListParams.dump_request(params)
+            query = WhopSDK::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["partners/businesses/%1$s/earnings", id],
+              query: query,
+              page: WhopSDK::Internal::CursorPage,
+              model: WhopSDK::Models::Referrals::Businesses::EarningListResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [WhopSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/referrals/businesses.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Referrals
+      # The Referrals API covers your Whop partner activity: the users you referred onto
+      # Whop, the businesses you referred and the earnings generated from their
+      # processing volume, and the partner leaderboard.
+      #
+      # Use it to enroll as a Whop partner, list the users you referred, list your
+      # referred businesses and review their earnings, and see the partner leaderboard.
+      class Businesses
+        # The Referrals API covers your Whop partner activity: the users you referred onto
+        # Whop, the businesses you referred and the earnings generated from their
+        # processing volume, and the partner leaderboard.
+        #
+        # Use it to enroll as a Whop partner, list the users you referred, list your
+        # referred businesses and review their earnings, and see the partner leaderboard.
+        # @return [WhopSDK::Resources::Referrals::Businesses::Earnings]
+        attr_reader :earnings
+
+        # Retrieves a single referred business and its referral terms.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] The business referral ID (a coma\_ identifier).
+        #
+        # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse]
+        #
+        # @see WhopSDK::Models::Referrals::BusinessRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["partners/businesses/%1$s", id],
+            model: WhopSDK::Models::Referrals::BusinessRetrieveResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {WhopSDK::Models::Referrals::BusinessListParams} for more details.
+        #
+        # Lists the businesses the authenticated user referred onto Whop, most recent
+        # first.
+        #
+        # @overload list(after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, has_earnings: nil, last: nil, order: nil, referred_user_id: nil, referred_username: nil, status: nil, tier: nil, request_options: {})
+        #
+        # @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 created_after [String] Only return business referrals created after this timestamp.
+        #
+        # @param created_before [String] Only return business referrals created before this timestamp.
+        #
+        # @param direction [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction] Sort direction.
+        #
+        # @param first [Integer] Number of business referrals to return from the start of the window.
+        #
+        # @param has_earnings [Boolean] When true, only businesses with pending or completed earnings paid to the caller
+        #
+        # @param last [Integer] Number of business referrals to return from the end of the window.
+        #
+        # @param order [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order] The field to sort business referrals by.
+        #
+        # @param referred_user_id [String] Filter to referrals attributed to this user. For first-tier referrals, this is t
+        #
+        # @param referred_username [String] Filter by the referred user's exact username. Ignored when `referred_user_id` is
+        #
+        # @param status [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status] Filter by referral status.
+        #
+        # @param tier [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier] Filter to only first-tier referrals or only second-tier referrals.
+        #
+        # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::Referrals::BusinessListResponse>]
+        #
+        # @see WhopSDK::Models::Referrals::BusinessListParams
+        def list(params = {})
+          parsed, options = WhopSDK::Referrals::BusinessListParams.dump_request(params)
+          query = WhopSDK::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "partners/businesses",
+            query: query,
+            page: WhopSDK::Internal::CursorPage,
+            model: WhopSDK::Models::Referrals::BusinessListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {WhopSDK::Models::Referrals::BusinessLeaderboardParams} for more details.
+        #
+        # Ranks referrers by business referral earnings — all-time by default, or over the
+        # current day, month, year, or trailing 30 days — and includes the caller's own
+        # standing.
+        #
+        # @overload leaderboard(period: nil, request_options: {})
+        #
+        # @param period [Symbol, WhopSDK::Models::Referrals::BusinessLeaderboardParams::Period] Time window for the rankings. `day`, `month`, and `year` count earnings since th
+        #
+        # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse]
+        #
+        # @see WhopSDK::Models::Referrals::BusinessLeaderboardParams
+        def leaderboard(params = {})
+          parsed, options = WhopSDK::Referrals::BusinessLeaderboardParams.dump_request(params)
+          query = WhopSDK::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "partners/leaderboard",
+            query: query,
+            model: WhopSDK::Models::Referrals::BusinessLeaderboardResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [WhopSDK::Client]
+        def initialize(client:)
+          @client = client
+          @earnings = WhopSDK::Resources::Referrals::Businesses::Earnings.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/referrals/partners.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Referrals
+      # The Referrals API covers your Whop partner activity: the users you referred onto
+      # Whop, the businesses you referred and the earnings generated from their
+      # processing volume, and the partner leaderboard.
+      #
+      # Use it to enroll as a Whop partner, list the users you referred, list your
+      # referred businesses and review their earnings, and see the partner leaderboard.
+      class Partners
+        # Enrolls the calling user in the Whop partner program, making their business
+        # referrals eligible for earnings. Idempotent — enrolling again keeps the original
+        # enrollment time.
+        #
+        # @overload create(request_options: {})
+        #
+        # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [WhopSDK::Models::Referrals::PartnerCreateResponse]
+        #
+        # @see WhopSDK::Models::Referrals::PartnerCreateParams
+        def create(params = {})
+          @client.request(
+            method: :post,
+            path: "partners",
+            model: WhopSDK::Models::Referrals::PartnerCreateResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [WhopSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/referrals.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    # The Referrals API covers your Whop partner activity: the users you referred onto
+    # Whop, the businesses you referred and the earnings generated from their
+    # processing volume, and the partner leaderboard.
+    #
+    # Use it to enroll as a Whop partner, list the users you referred, list your
+    # referred businesses and review their earnings, and see the partner leaderboard.
+    class Referrals
+      # The Referrals API covers your Whop partner activity: the users you referred onto
+      # Whop, the businesses you referred and the earnings generated from their
+      # processing volume, and the partner leaderboard.
+      #
+      # Use it to enroll as a Whop partner, list the users you referred, list your
+      # referred businesses and review their earnings, and see the partner leaderboard.
+      # @return [WhopSDK::Resources::Referrals::Businesses]
+      attr_reader :businesses
+
+      # The Referrals API covers your Whop partner activity: the users you referred onto
+      # Whop, the businesses you referred and the earnings generated from their
+      # processing volume, and the partner leaderboard.
+      #
+      # Use it to enroll as a Whop partner, list the users you referred, list your
+      # referred businesses and review their earnings, and see the partner leaderboard.
+      # @return [WhopSDK::Resources::Referrals::Partners]
+      attr_reader :partners
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::ReferralReferredUsersParams} for more details.
+      #
+      # Lists the users the caller referred onto Whop (newest first), each with the
+      # second-tier earnings the caller has made from that user's businesses.
+      #
+      # @overload referred_users(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {})
+      #
+      # @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 first [Integer] Number of referred users to return from the start of the window.
+      #
+      # @param has_businesses [Boolean] When true, only referred users who brought at least one business onto Whop.
+      #
+      # @param has_earning_businesses [Boolean] When true, only referred users with at least one business that has generated ear
+      #
+      # @param last [Integer] Number of referred users to return from the end of the window.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::ReferralReferredUsersResponse]
+      #
+      # @see WhopSDK::Models::ReferralReferredUsersParams
+      def referred_users(params = {})
+        parsed, options = WhopSDK::ReferralReferredUsersParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "partners/referred_users",
+          query: query,
+          model: WhopSDK::Models::ReferralReferredUsersResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+        @businesses = WhopSDK::Resources::Referrals::Businesses.new(client: client)
+        @partners = WhopSDK::Resources::Referrals::Partners.new(client: client)
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/refunds.rb

@@ -2,13 +2,14 @@
 
 module WhopSDK
   module Resources
-    # Refunds
     class Refunds
       # Retrieves the details of an existing refund.
       #
       # Required permissions:
       #
       # - `payment:basic:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
       # - `member:email:read`
       # - `member:basic:read`
       # - `member:phone:read`

data/lib/whop_sdk/resources/resolution_center_cases.rb

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Resolution center cases
     class ResolutionCenterCases
       # Retrieves the details of an existing resolution center case.
       #

data/lib/whop_sdk/resources/reviews.rb

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

data/lib/whop_sdk/resources/setup_intents.rb

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

data/lib/whop_sdk/resources/shipments.rb

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

data/lib/whop_sdk/resources/social_accounts.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+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
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::SocialAccountCreateParams} for more details.
+      #
+      # Creates or returns a Whop-managed Facebook page for an account.
+      #
+      # @overload create(platform:, account_id: nil, request_options: {})
+      #
+      # @param platform [Symbol, WhopSDK::Models::SocialAccountCreateParams::Platform] The platform to create the social account on.
+      #
+      # @param account_id [String] The Account (biz\_ identifier) to create the social account for. An
+      # account-scope
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::SocialAccount]
+      #
+      # @see WhopSDK::Models::SocialAccountCreateParams
+      def create(params)
+        parsed, options = WhopSDK::SocialAccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "social_accounts",
+          body: parsed,
+          model: WhopSDK::SocialAccount,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::SocialAccountListParams} for more details.
+      #
+      # Lists the social accounts linked to an account or user.
+      #
+      # @overload list(account_id: nil, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, platform: nil, scopes: nil, user_id: nil, verified: nil, request_options: {})
+      #
+      # @param account_id [String] The Account that the social accounts are connected to. Provide either this or us
+      #
+      # @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 direction [Symbol, WhopSDK::Models::SocialAccountListParams::Direction] Sort direction.
+      #
+      # @param first [Integer] The number of social accounts to return.
+      #
+      # @param last [Integer] The number of social accounts to return from the end of the range.
+      #
+      # @param order [Symbol, WhopSDK::Models::SocialAccountListParams::Order] The field to sort social accounts by.
+      #
+      # @param platform [Symbol, WhopSDK::Models::SocialAccountListParams::Platform] Only return social accounts for the platform that is specified.
+      #
+      # @param scopes [Array<Symbol, WhopSDK::Models::SocialAccountListParams::Scope>] Only return social accounts that have these scopes.
+      #
+      # @param user_id [String] The User that the social accounts are connected to. Provide either this or accou
+      #
+      # @param verified [Boolean] Only return social accounts that are verified on the platform.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::SocialAccount>]
+      #
+      # @see WhopSDK::Models::SocialAccountListParams
+      def list(params = {})
+        parsed, options = WhopSDK::SocialAccountListParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "social_accounts",
+          query: query,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::SocialAccount,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::SocialAccountDeleteParams} for more details.
+      #
+      # Disconnects a social account from an account or user without deleting the
+      # underlying platform account.
+      #
+      # @overload delete(id, account_id: nil, user_id: nil, request_options: {})
+      #
+      # @param id [String] The ID of the social account to disconnect.
+      #
+      # @param account_id [String] The Account that the social account is connected to. Provide either this or user
+      #
+      # @param user_id [String] The User that the social account is connected to. Provide either this or account
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::SocialAccountDeleteParams
+      def delete(id, params = {})
+        parsed, options = WhopSDK::SocialAccountDeleteParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :delete,
+          path: ["social_accounts/%1$s", id],
+          query: query,
+          model: WhopSDK::Internal::Type::Boolean,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::SocialAccountConnectParams} for more details.
+      #
+      # Starts an OAuth connection flow and returns an authorize_url where the user can
+      # connect a social account.
+      #
+      # @overload connect(platform:, account_id: nil, redirect_url: nil, scopes: nil, request_options: {})
+      #
+      # @param platform [Symbol, WhopSDK::Models::SocialAccountConnectParams::Platform] The platform to connect the social account on. Today, the supported option is `m
+      #
+      # @param account_id [String] The Account (biz\_ identifier) to connect the social account for. An
+      # account-scop
+      #
+      # @param redirect_url [String] The Whop URL to redirect the user to after they finish connecting.
+      #
+      # @param scopes [Array<Symbol, WhopSDK::Models::SocialAccountConnectParams::Scope>] Capabilities to grant for the connected social account. Use `advertise` when con
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::SocialAccountConnectResponse]
+      #
+      # @see WhopSDK::Models::SocialAccountConnectParams
+      def connect(params)
+        parsed, options = WhopSDK::SocialAccountConnectParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "social_accounts/connect",
+          body: parsed,
+          model: WhopSDK::Models::SocialAccountConnectResponse,
+          options: options
+        )
+      end
+
+      # Lists the existing posts of a connected Facebook page or Instagram account.
+      #
+      # @overload posts(id, account_id:, after: nil, first: nil, post_id: nil, request_options: {})
+      #
+      # @param id [String] The social account (a sacc\_ identifier) whose posts to list.
+      #
+      # @param account_id [String] The Account (a biz\_ identifier) the social account is connected to.
+      #
+      # @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      # @param first [Integer] The number of posts to return.
+      #
+      # @param post_id [String] Return only the single post with this platform id, instead of the full list.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::SocialAccountPostsResponse]
+      #
+      # @see WhopSDK::Models::SocialAccountPostsParams
+      def posts(id, params)
+        parsed, options = WhopSDK::SocialAccountPostsParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["social_accounts/%1$s/posts", id],
+          query: query,
+          model: WhopSDK::Models::SocialAccountPostsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/stats.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+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
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::StatRetrieveParams} for more details.
+      #
+      # Retrieves a metric as a time series of points for an account over a date range.
+      #
+      # @overload retrieve(metric, from:, to:, access_level: nil, account_id: nil, ad_campaign_ids: nil, ad_group_ids: nil, ad_ids: nil, breakdown_by: nil, card_network: nil, category: nil, convert_to: nil, currency: nil, fee_type: nil, interval: nil, most_recent_action: nil, payment_method: nil, product: nil, referred_user_id: nil, segment: nil, snapshot_window: nil, source: nil, status: nil, time_zone: nil, request_options: {})
+      #
+      # @param metric [String] The metric to retrieve, for example net_revenue. Use GET /stats to see every met
+      #
+      # @param from [Date] Start of the date range (YYYY-MM-DD).
+      #
+      # @param to [Date] End of the date range (YYYY-MM-DD).
+      #
+      # @param access_level [String] Filter to a single access level. Pair with breakdown_by=access_level. Available
+      #
+      # @param account_id [String] The account this query concerns, for example biz_AbC123.
+      #
+      # @param ad_campaign_ids [Array<String>] Ad campaign ids (adcamp\_...) to scope the report to; stats are summed across
+      # the
+      #
+      # @param ad_group_ids [Array<String>] Ad group ids (adgrp\_...) to scope the report to; stats are summed across them.
+      # A
+      #
+      # @param ad_ids [Array<String>] Ad ids (ad\_...) to scope the report to; stats are summed across them. Available
+      #
+      # @param breakdown_by [String] Split the metric out by one of its properties — each point gets a breakdown arra
+      #
+      # @param card_network [String] Filter to a single card brand, for example visa. A refinement of payment_method=
+      #
+      # @param category [String] Filter to a single balance-activity category, for example payments. Pair with br
+      #
+      # @param convert_to [String] Display currency for money metrics — every amount is converted into this ISO cur
+      #
+      # @param currency [String] Filter to transactions made in this original ISO currency, for example eur — rep
+      #
+      # @param fee_type [String] Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by ty
+      #
+      # @param interval [Symbol, WhopSDK::Models::StatRetrieveParams::Interval] How wide each point is. Defaults to day. Snapshot metrics are day-only.
+      #
+      # @param most_recent_action [String] Filter to a single most-recent member action. Pair with breakdown_by=most_recent
+      #
+      # @param payment_method [String] Filter to a single payment method, for example card or crypto. Available on metr
+      #
+      # @param product [String] Filter to a single product (access pass id), for example prod_AbC123. Pair with
+      #
+      # @param referred_user_id [String] Filter a referral metric to the businesses attributed to one person you referred
+      #
+      # @param segment [String] Filter to a single wallet-balance segment, for example available. Pair with brea
+      #
+      # @param snapshot_window [Symbol, WhopSDK::Models::StatRetrieveParams::SnapshotWindow] Trailing window for snapshot metrics. Only accepted by snapshot metrics (each li
+      #
+      # @param source [String] Filter to a single GMV source, for example payments. Pair with breakdown_by=sour
+      #
+      # @param status [String] Filter to a single membership status. Pair with breakdown_by=status. Available o
+      #
+      # @param time_zone [String] IANA time zone to bucket the series in, for example America/New_York. Defaults t
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::StatRetrieveResponse]
+      #
+      # @see WhopSDK::Models::StatRetrieveParams
+      def retrieve(metric, params)
+        parsed, options = WhopSDK::StatRetrieveParams.dump_request(params)
+        query = WhopSDK::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["stats/%1$s", metric],
+          query: query,
+          model: WhopSDK::Models::StatRetrieveResponse,
+          options: options
+        )
+      end
+
+      # Lists every metric you can query, with its unit and the properties you can
+      # filter or break it down by.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::StatListResponse]
+      #
+      # @see WhopSDK::Models::StatListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "stats",
+          model: WhopSDK::Models::StatListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end