whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/product_update_params.rb

@@ -12,97 +12,31 @@ module WhopSDK
       #   @return [String]
       required :id, String
 
-      # @!attribute collect_shipping_address
-      #   Whether the checkout flow collects a shipping address from the customer.
-      #
-      #   @return [Boolean, nil]
-      optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true
-
-      # @!attribute custom_cta
-      #   The different types of custom CTAs that can be selected.
-      #
-      #   @return [Symbol, WhopSDK::Models::CustomCta, nil]
-      optional :custom_cta, enum: -> { WhopSDK::CustomCta }, nil?: true
-
-      # @!attribute custom_cta_url
-      #   A URL that the call-to-action button links to instead of the default checkout
-      #   flow.
-      #
-      #   @return [String, nil]
-      optional :custom_cta_url, String, nil?: true
-
-      # @!attribute custom_statement_descriptor
-      #   A custom text label that appears on the customer's bank statement. Must be 5-22
-      #   characters, contain at least one letter, and not contain <, >, \, ', or "
-      #   characters.
-      #
-      #   @return [String, nil]
-      optional :custom_statement_descriptor, String, nil?: true
-
       # @!attribute description
-      #   A written description of the product displayed on its product page.
+      #   A written description displayed on the product page.
       #
       #   @return [String, nil]
       optional :description, String, nil?: true
 
-      # @!attribute gallery_images
-      #   The gallery images for the product.
-      #
-      #   @return [Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>, nil]
-      optional :gallery_images,
-               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductUpdateParams::GalleryImage] },
-               nil?: true
-
-      # @!attribute global_affiliate_percentage
-      #   The commission rate as a percentage that affiliates earn through the global
-      #   affiliate program.
-      #
-      #   @return [Float, nil]
-      optional :global_affiliate_percentage, Float, nil?: true
-
-      # @!attribute global_affiliate_status
-      #   The different statuses of the global affiliate program for a product.
-      #
-      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
-      optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
-
       # @!attribute headline
-      #   A short marketing headline displayed prominently on the product page.
+      #   A short marketing headline for the product page.
       #
       #   @return [String, nil]
       optional :headline, String, nil?: true
 
-      # @!attribute member_affiliate_percentage
-      #   The commission rate as a percentage that members earn through the member
-      #   affiliate program.
+      # @!attribute metadata
+      #   Custom key-value pairs to store on the product.
       #
-      #   @return [Float, nil]
-      optional :member_affiliate_percentage, Float, nil?: true
-
-      # @!attribute member_affiliate_status
-      #   The different statuses of the global affiliate program for a product.
-      #
-      #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
-      optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
+      #   @return [Object, nil]
+      optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
 
       # @!attribute product_tax_code_id
-      #   The unique identifier of the tax classification code to apply to this product.
+      #   The unique identifier of the tax classification code. See the available
+      #   [product categories](https://docs.numeral.com/essentials/product-categories).
       #
       #   @return [String, nil]
       optional :product_tax_code_id, String, nil?: true
 
-      # @!attribute redirect_purchase_url
-      #   A URL to redirect the customer to after completing a purchase.
-      #
-      #   @return [String, nil]
-      optional :redirect_purchase_url, String, nil?: true
-
-      # @!attribute route
-      #   The URL slug for the product's public link.
-      #
-      #   @return [String, nil]
-      optional :route, String, nil?: true
-
       # @!attribute send_welcome_message
       #   Whether to send an automated welcome message via support chat when a user joins
       #   this product.
@@ -110,101 +44,39 @@ module WhopSDK
       #   @return [Boolean, nil]
       optional :send_welcome_message, WhopSDK::Internal::Type::Boolean, nil?: true
 
-      # @!attribute store_page_config
-      #   Layout and display configuration for this product on the company's store page.
-      #
-      #   @return [WhopSDK::Models::ProductUpdateParams::StorePageConfig, nil]
-      optional :store_page_config, -> { WhopSDK::ProductUpdateParams::StorePageConfig }, nil?: true
-
       # @!attribute title
-      #   The display name of the product. Maximum 80 characters.
+      #   The display name of the product.
       #
       #   @return [String, nil]
-      optional :title, String, nil?: true
+      optional :title, String
 
       # @!attribute visibility
-      #   Visibility of a resource
+      #   Whether the product is visible to customers.
       #
-      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
-      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+      #   @return [String, nil]
+      optional :visibility, String
 
-      # @!method initialize(id:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, gallery_images: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
+      # @!method initialize(id:, description: nil, headline: nil, metadata: nil, product_tax_code_id: nil, send_welcome_message: nil, title: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::ProductUpdateParams} for more details.
       #
       #   @param id [String]
       #
-      #   @param collect_shipping_address [Boolean, nil] Whether the checkout flow collects a shipping address from the customer.
-      #
-      #   @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
-      #
-      #   @param custom_cta_url [String, nil] A URL that the call-to-action button links to instead of the default checkout fl
-      #
-      #   @param custom_statement_descriptor [String, nil] A custom text label that appears on the customer's bank statement. Must be 5-22
-      #
-      #   @param description [String, nil] A written description of the product displayed on its product page.
-      #
-      #   @param gallery_images [Array<WhopSDK::Models::ProductUpdateParams::GalleryImage>, nil] The gallery images for the product.
+      #   @param description [String, nil] A written description displayed on the product page.
       #
-      #   @param global_affiliate_percentage [Float, nil] The commission rate as a percentage that affiliates earn through the global affi
+      #   @param headline [String, nil] A short marketing headline for the product page.
       #
-      #   @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
+      #   @param metadata [Object, nil] Custom key-value pairs to store on the product.
       #
-      #   @param headline [String, nil] A short marketing headline displayed prominently on the product page.
-      #
-      #   @param member_affiliate_percentage [Float, nil] The commission rate as a percentage that members earn through the member affilia
-      #
-      #   @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
-      #
-      #   @param product_tax_code_id [String, nil] The unique identifier of the tax classification code to apply to this product.
-      #
-      #   @param redirect_purchase_url [String, nil] A URL to redirect the customer to after completing a purchase.
-      #
-      #   @param route [String, nil] The URL slug for the product's public link.
+      #   @param product_tax_code_id [String, nil] The unique identifier of the tax classification code. See the available [product
       #
       #   @param send_welcome_message [Boolean, nil] Whether to send an automated welcome message via support chat when a user joins
       #
-      #   @param store_page_config [WhopSDK::Models::ProductUpdateParams::StorePageConfig, nil] Layout and display configuration for this product on the company's store page.
-      #
-      #   @param title [String, nil] The display name of the product. Maximum 80 characters.
+      #   @param title [String] The display name of the product.
       #
-      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #   @param visibility [String] Whether the product is visible to customers.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
-
-      class GalleryImage < WhopSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #   The ID of an existing file object.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:)
-        #   Input for an attachment
-        #
-        #   @param id [String] The ID of an existing file object.
-      end
-
-      class StorePageConfig < WhopSDK::Internal::Type::BaseModel
-        # @!attribute custom_cta
-        #   Custom call-to-action text for the product's store page.
-        #
-        #   @return [String, nil]
-        optional :custom_cta, String, nil?: true
-
-        # @!attribute show_price
-        #   Whether or not to show the price on the product's store page.
-        #
-        #   @return [Boolean, nil]
-        optional :show_price, WhopSDK::Internal::Type::Boolean, nil?: true
-
-        # @!method initialize(custom_cta: nil, show_price: nil)
-        #   Layout and display configuration for this product on the company's store page.
-        #
-        #   @param custom_cta [String, nil] Custom call-to-action text for the product's store page.
-        #
-        #   @param show_price [Boolean, nil] Whether or not to show the price on the product's store page.
-      end
     end
   end
 end

data/lib/whop_sdk/models/referral_referred_users_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Referrals#referred_users
+    class ReferralReferredUsersParams < 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 first
+      #   Number of referred users to return from the start of the window.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute has_businesses
+      #   When true, only referred users who brought at least one business onto Whop.
+      #
+      #   @return [Boolean, nil]
+      optional :has_businesses, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute has_earning_businesses
+      #   When true, only referred users with at least one business that has generated
+      #   earnings.
+      #
+      #   @return [Boolean, nil]
+      optional :has_earning_businesses, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute last
+      #   Number of referred users to return from the end of the window.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer
+
+      # @!method initialize(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ReferralReferredUsersParams} 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 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}]
+    end
+  end
+end

data/lib/whop_sdk/models/referral_referred_users_response.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Referrals#referred_users
+    class ReferralReferredUsersResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<WhopSDK::Models::ReferralReferredUsersResponse::Data>]
+      required :data,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReferralReferredUsersResponse::Data] }
+
+      # @!attribute page_info
+      #
+      #   @return [WhopSDK::Models::ReferralReferredUsersResponse::PageInfo]
+      required :page_info, -> { WhopSDK::Models::ReferralReferredUsersResponse::PageInfo }
+
+      # @!method initialize(data:, page_info:)
+      #   @param data [Array<WhopSDK::Models::ReferralReferredUsersResponse::Data>]
+      #   @param page_info [WhopSDK::Models::ReferralReferredUsersResponse::PageInfo]
+
+      class Data < WhopSDK::Internal::Type::BaseModel
+        # @!attribute total_earnings_usd
+        #
+        #   @return [String]
+        required :total_earnings_usd, String
+
+        # @!attribute total_volume_usd
+        #
+        #   @return [String]
+        required :total_volume_usd, String
+
+        # @!attribute user
+        #
+        #   @return [WhopSDK::Models::ReferralReferredUsersResponse::Data::User]
+        required :user, -> { WhopSDK::Models::ReferralReferredUsersResponse::Data::User }
+
+        # @!method initialize(total_earnings_usd:, total_volume_usd:, user:)
+        #   @param total_earnings_usd [String]
+        #   @param total_volume_usd [String]
+        #   @param user [WhopSDK::Models::ReferralReferredUsersResponse::Data::User]
+
+        # @see WhopSDK::Models::ReferralReferredUsersResponse::Data#user
+        class User < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute username
+          #
+          #   @return [String]
+          required :username, String
+
+          # @!attribute city
+          #
+          #   @return [String, nil]
+          optional :city, String, nil?: true
+
+          # @!attribute country
+          #
+          #   @return [String, nil]
+          optional :country, String, nil?: true
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute profile_picture
+          #
+          #   @return [WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture, nil]
+          optional :profile_picture,
+                   -> { WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture }
+
+          # @!method initialize(id:, username:, city: nil, country: nil, name: nil, profile_picture: nil)
+          #   @param id [String]
+          #   @param username [String]
+          #   @param city [String, nil]
+          #   @param country [String, nil]
+          #   @param name [String, nil]
+          #   @param profile_picture [WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture]
+
+          # @see WhopSDK::Models::ReferralReferredUsersResponse::Data::User#profile_picture
+          class ProfilePicture < WhopSDK::Internal::Type::BaseModel
+            # @!attribute url
+            #
+            #   @return [String, nil]
+            optional :url, String, nil?: true
+
+            # @!method initialize(url: nil)
+            #   @param url [String, nil]
+          end
+        end
+      end
+
+      # @see WhopSDK::Models::ReferralReferredUsersResponse#page_info
+      class PageInfo < WhopSDK::Internal::Type::BaseModel
+        # @!attribute end_cursor
+        #
+        #   @return [String, nil]
+        required :end_cursor, String, nil?: true
+
+        # @!attribute has_next_page
+        #
+        #   @return [Boolean]
+        required :has_next_page, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute has_previous_page
+        #
+        #   @return [Boolean]
+        required :has_previous_page, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute start_cursor
+        #
+        #   @return [String, nil]
+        required :start_cursor, String, nil?: true
+
+        # @!method initialize(end_cursor:, has_next_page:, has_previous_page:, start_cursor:)
+        #   @param end_cursor [String, nil]
+        #   @param has_next_page [Boolean]
+        #   @param has_previous_page [Boolean]
+        #   @param start_cursor [String, nil]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Referrals
+      # @see WhopSDK::Resources::Referrals::Businesses#leaderboard
+      class BusinessLeaderboardParams < WhopSDK::Internal::Type::BaseModel
+        extend WhopSDK::Internal::Type::RequestParameters::Converter
+        include WhopSDK::Internal::Type::RequestParameters
+
+        # @!attribute period
+        #   Time window for the rankings. `day`, `month`, and `year` count earnings since
+        #   the start of the current calendar day, month, or year; `last_30_days` counts
+        #   earnings over the trailing 30 days; `all_time` ranks lifetime earnings.
+        #
+        #   @return [Symbol, WhopSDK::Models::Referrals::BusinessLeaderboardParams::Period, nil]
+        optional :period, enum: -> { WhopSDK::Referrals::BusinessLeaderboardParams::Period }
+
+        # @!method initialize(period: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Referrals::BusinessLeaderboardParams} for more details.
+        #
+        #   @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}]
+
+        # Time window for the rankings. `day`, `month`, and `year` count earnings since
+        # the start of the current calendar day, month, or year; `last_30_days` counts
+        # earnings over the trailing 30 days; `all_time` ranks lifetime earnings.
+        module Period
+          extend WhopSDK::Internal::Type::Enum
+
+          DAY = :day
+          MONTH = :month
+          YEAR = :year
+          LAST_30_DAYS = :last_30_days
+          ALL_TIME = :all_time
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end