whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/referrals/business_leaderboard_response.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Referrals
+      # @see WhopSDK::Resources::Referrals::Businesses#leaderboard
+      class BusinessLeaderboardResponse < WhopSDK::Internal::Type::BaseModel
+        # @!attribute leaders
+        #   The top referrers by total earnings, best first.
+        #
+        #   @return [Array<WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader>]
+        required :leaders,
+                 -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader] }
+
+        # @!attribute me
+        #   The caller's own standing; null when the caller has no referral earnings.
+        #
+        #   @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me, nil]
+        required :me, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me }, nil?: true
+
+        # @!method initialize(leaders:, me:)
+        #   @param leaders [Array<WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader>] The top referrers by total earnings, best first.
+        #
+        #   @param me [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me, nil] The caller's own standing; null when the caller has no referral earnings.
+
+        class Leader < WhopSDK::Internal::Type::BaseModel
+          # @!attribute first_referral_started_at
+          #   When the referrer's earliest business referral became active.
+          #
+          #   @return [Time]
+          required :first_referral_started_at, Time
+
+          # @!attribute rank
+          #   1-based leaderboard position.
+          #
+          #   @return [Integer]
+          required :rank, Integer
+
+          # @!attribute total_earnings_usd
+          #   The referrer's pending + completed earnings across all referred businesses, in
+          #   USD.
+          #
+          #   @return [String]
+          required :total_earnings_usd, String
+
+          # @!attribute total_volume_usd
+          #   Credited GMV across all the referrer's referred businesses, in USD.
+          #
+          #   @return [String]
+          required :total_volume_usd, String
+
+          # @!attribute user
+          #   The ranked referrer. Identity fields (id, name, username, profile_picture) are
+          #   returned only on the caller's own entry; other referrers expose coarse location
+          #   only.
+          #
+          #   @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User, nil]
+          required :user, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User }, nil?: true
+
+          # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader} for more
+          #   details.
+          #
+          #   @param first_referral_started_at [Time] When the referrer's earliest business referral became active.
+          #
+          #   @param rank [Integer] 1-based leaderboard position.
+          #
+          #   @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U
+          #
+          #   @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD.
+          #
+          #   @param user [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r
+
+          # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader#user
+          class User < WhopSDK::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city where the referrer is located, derived from their IP address. Null if
+            #   location sharing is disabled.
+            #
+            #   @return [String, nil]
+            required :city, String, nil?: true
+
+            # @!attribute country
+            #   The country where the referrer is located, derived from their IP address. Null
+            #   if location sharing is disabled.
+            #
+            #   @return [String, nil]
+            required :country, String, nil?: true
+
+            # @!attribute id
+            #   User ID, prefixed `user_`. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute name
+            #   The user's display name. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute profile_picture
+            #   The user's profile picture. Present only on the caller's own entry.
+            #
+            #   @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, nil]
+            optional :profile_picture,
+                     -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture }
+
+            # @!attribute username
+            #   The user's unique username. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :username, String
+
+            # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User} for more
+            #   details.
+            #
+            #   The ranked referrer. Identity fields (id, name, username, profile_picture) are
+            #   returned only on the caller's own entry; other referrers expose coarse location
+            #   only.
+            #
+            #   @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l
+            #
+            #   @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i
+            #
+            #   @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry.
+            #
+            #   @param name [String, nil] The user's display name. Present only on the caller's own entry.
+            #
+            #   @param profile_picture [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry.
+            #
+            #   @param username [String] The user's unique username. Present only on the caller's own entry.
+
+            # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User#profile_picture
+            class ProfilePicture < WhopSDK::Internal::Type::BaseModel
+              # @!attribute url
+              #   The user's profile picture URL.
+              #
+              #   @return [String]
+              required :url, String
+
+              # @!method initialize(url:)
+              #   The user's profile picture. Present only on the caller's own entry.
+              #
+              #   @param url [String] The user's profile picture URL.
+            end
+          end
+        end
+
+        # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse#me
+        class Me < WhopSDK::Internal::Type::BaseModel
+          # @!attribute first_referral_started_at
+          #   When the referrer's earliest business referral became active.
+          #
+          #   @return [Time]
+          required :first_referral_started_at, Time
+
+          # @!attribute rank
+          #   1-based leaderboard position.
+          #
+          #   @return [Integer]
+          required :rank, Integer
+
+          # @!attribute total_earnings_usd
+          #   The referrer's pending + completed earnings across all referred businesses, in
+          #   USD.
+          #
+          #   @return [String]
+          required :total_earnings_usd, String
+
+          # @!attribute total_volume_usd
+          #   Credited GMV across all the referrer's referred businesses, in USD.
+          #
+          #   @return [String]
+          required :total_volume_usd, String
+
+          # @!attribute user
+          #   The ranked referrer. Identity fields (id, name, username, profile_picture) are
+          #   returned only on the caller's own entry; other referrers expose coarse location
+          #   only.
+          #
+          #   @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, nil]
+          required :user, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User }, nil?: true
+
+          # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me} for more details.
+          #
+          #   The caller's own standing; null when the caller has no referral earnings.
+          #
+          #   @param first_referral_started_at [Time] When the referrer's earliest business referral became active.
+          #
+          #   @param rank [Integer] 1-based leaderboard position.
+          #
+          #   @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U
+          #
+          #   @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD.
+          #
+          #   @param user [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r
+
+          # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me#user
+          class User < WhopSDK::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city where the referrer is located, derived from their IP address. Null if
+            #   location sharing is disabled.
+            #
+            #   @return [String, nil]
+            required :city, String, nil?: true
+
+            # @!attribute country
+            #   The country where the referrer is located, derived from their IP address. Null
+            #   if location sharing is disabled.
+            #
+            #   @return [String, nil]
+            required :country, String, nil?: true
+
+            # @!attribute id
+            #   User ID, prefixed `user_`. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute name
+            #   The user's display name. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute profile_picture
+            #   The user's profile picture. Present only on the caller's own entry.
+            #
+            #   @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, nil]
+            optional :profile_picture,
+                     -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture }
+
+            # @!attribute username
+            #   The user's unique username. Present only on the caller's own entry.
+            #
+            #   @return [String, nil]
+            optional :username, String
+
+            # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User} for more
+            #   details.
+            #
+            #   The ranked referrer. Identity fields (id, name, username, profile_picture) are
+            #   returned only on the caller's own entry; other referrers expose coarse location
+            #   only.
+            #
+            #   @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l
+            #
+            #   @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i
+            #
+            #   @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry.
+            #
+            #   @param name [String, nil] The user's display name. Present only on the caller's own entry.
+            #
+            #   @param profile_picture [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry.
+            #
+            #   @param username [String] The user's unique username. Present only on the caller's own entry.
+
+            # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User#profile_picture
+            class ProfilePicture < WhopSDK::Internal::Type::BaseModel
+              # @!attribute url
+              #   The user's profile picture URL.
+              #
+              #   @return [String]
+              required :url, String
+
+              # @!method initialize(url:)
+              #   The user's profile picture. Present only on the caller's own entry.
+              #
+              #   @param url [String] The user's profile picture URL.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/referrals/business_list_params.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Referrals
+      # @see WhopSDK::Resources::Referrals::Businesses#list
+      class BusinessListParams < WhopSDK::Internal::Type::BaseModel
+        extend WhopSDK::Internal::Type::RequestParameters::Converter
+        include WhopSDK::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute before
+        #   Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute created_after
+        #   Only return business referrals created after this timestamp.
+        #
+        #   @return [String, nil]
+        optional :created_after, String
+
+        # @!attribute created_before
+        #   Only return business referrals created before this timestamp.
+        #
+        #   @return [String, nil]
+        optional :created_before, String
+
+        # @!attribute direction
+        #   Sort direction.
+        #
+        #   @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction, nil]
+        optional :direction, enum: -> { WhopSDK::Referrals::BusinessListParams::Direction }
+
+        # @!attribute first
+        #   Number of business referrals to return from the start of the window.
+        #
+        #   @return [Integer, nil]
+        optional :first, Integer
+
+        # @!attribute has_earnings
+        #   When true, only businesses with pending or completed earnings paid to the
+        #   caller.
+        #
+        #   @return [Boolean, nil]
+        optional :has_earnings, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute last
+        #   Number of business referrals to return from the end of the window.
+        #
+        #   @return [Integer, nil]
+        optional :last, Integer
+
+        # @!attribute order
+        #   The field to sort business referrals by.
+        #
+        #   @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order, nil]
+        optional :order, enum: -> { WhopSDK::Referrals::BusinessListParams::Order }
+
+        # @!attribute referred_user_id
+        #   Filter to referrals attributed to this user. For first-tier referrals, this is
+        #   the referred account owner; for second-tier referrals, this is the partner you
+        #   recruited.
+        #
+        #   @return [String, nil]
+        optional :referred_user_id, String
+
+        # @!attribute referred_username
+        #   Filter by the referred user's exact username. Ignored when `referred_user_id` is
+        #   present.
+        #
+        #   @return [String, nil]
+        optional :referred_username, String
+
+        # @!attribute status
+        #   Filter by referral status.
+        #
+        #   @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status, nil]
+        optional :status, enum: -> { WhopSDK::Referrals::BusinessListParams::Status }
+
+        # @!attribute tier
+        #   Filter to only first-tier referrals or only second-tier referrals.
+        #
+        #   @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier, nil]
+        optional :tier, enum: -> { WhopSDK::Referrals::BusinessListParams::Tier }
+
+        # @!method initialize(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: {})
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Referrals::BusinessListParams} for more details.
+        #
+        #   @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}]
+
+        # Sort direction.
+        module Direction
+          extend WhopSDK::Internal::Type::Enum
+
+          ASC = :asc
+          DESC = :desc
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The field to sort business referrals by.
+        module Order
+          extend WhopSDK::Internal::Type::Enum
+
+          CREATED_AT = :created_at
+          REFERRAL_STARTED_AT = :referral_started_at
+          REFERRAL_EXPIRES_AT = :referral_expires_at
+          PAYOUT_PERCENTAGE = :payout_percentage
+          VOLUME_USD = :volume_usd
+          EARNINGS_USD = :earnings_usd
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Filter by referral status.
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          ACTIVE = :active
+          REMOVED = :removed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Filter to only first-tier referrals or only second-tier referrals.
+        module Tier
+          extend WhopSDK::Internal::Type::Enum
+
+          FIRST = :first
+          SECOND = :second
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end