whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/product_list_params.rbi

@@ -15,84 +15,97 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :company_id
 
-      # Returns the elements in the list that come after the specified cursor.
+      # Filter to only products matching these types.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :access_pass_types
+
+      sig { params(access_pass_types: T::Array[String]).void }
+      attr_writer :access_pass_types
+
+      # A cursor; returns products after this position.
       sig { returns(T.nilable(String)) }
-      attr_accessor :after
+      attr_reader :after
 
-      # Returns the elements in the list that come before the specified cursor.
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # A cursor; returns products before this position.
       sig { returns(T.nilable(String)) }
-      attr_accessor :before
+      attr_reader :before
 
-      # Only return products created after this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_after
+      sig { params(before: String).void }
+      attr_writer :before
 
-      # Only return products created before this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_before
+      # The sort direction for results. Defaults to descending.
+      sig do
+        returns(T.nilable(WhopSDK::ProductListParams::Direction::OrSymbol))
+      end
+      attr_reader :direction
 
-      # The direction of the sort.
-      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
-      attr_accessor :direction
+      sig do
+        params(direction: WhopSDK::ProductListParams::Direction::OrSymbol).void
+      end
+      attr_writer :direction
 
-      # Returns the first _n_ elements from the list.
+      # The number of products to return (default and max 100).
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :first
+      attr_reader :first
 
-      # Returns the last _n_ elements from the list.
+      sig { params(first: Integer).void }
+      attr_writer :first
+
+      # The number of products to return from the end of the range.
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :last
+      attr_reader :last
+
+      sig { params(last: Integer).void }
+      attr_writer :last
 
-      # The ways a relation of AccessPasses can be ordered
-      sig { returns(T.nilable(WhopSDK::ProductListParams::Order::OrSymbol)) }
-      attr_accessor :order
+      # The field to sort results by. Defaults to created_at.
+      sig { returns(T.nilable(String)) }
+      attr_reader :order
 
-      # Filter to only products matching these type classifications.
-      sig { returns(T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol])) }
-      attr_accessor :product_types
+      sig { params(order: String).void }
+      attr_writer :order
 
       # Filter to only products matching these visibility states.
-      sig { returns(T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol])) }
-      attr_accessor :visibilities
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :visibilities
+
+      sig { params(visibilities: T::Array[String]).void }
+      attr_writer :visibilities
 
       sig do
         params(
           company_id: String,
-          after: T.nilable(String),
-          before: T.nilable(String),
-          created_after: T.nilable(Time),
-          created_before: T.nilable(Time),
-          direction: T.nilable(WhopSDK::Direction::OrSymbol),
-          first: T.nilable(Integer),
-          last: T.nilable(Integer),
-          order: T.nilable(WhopSDK::ProductListParams::Order::OrSymbol),
-          product_types: T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol]),
-          visibilities:
-            T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+          access_pass_types: T::Array[String],
+          after: String,
+          before: String,
+          direction: WhopSDK::ProductListParams::Direction::OrSymbol,
+          first: Integer,
+          last: Integer,
+          order: String,
+          visibilities: T::Array[String],
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # The unique identifier of the company to list products for.
         company_id:,
-        # Returns the elements in the list that come after the specified cursor.
+        # Filter to only products matching these types.
+        access_pass_types: nil,
+        # A cursor; returns products after this position.
         after: nil,
-        # Returns the elements in the list that come before the specified cursor.
+        # A cursor; returns products before this position.
         before: nil,
-        # Only return products created after this timestamp.
-        created_after: nil,
-        # Only return products created before this timestamp.
-        created_before: nil,
-        # The direction of the sort.
+        # The sort direction for results. Defaults to descending.
         direction: nil,
-        # Returns the first _n_ elements from the list.
+        # The number of products to return (default and max 100).
         first: nil,
-        # Returns the last _n_ elements from the list.
+        # The number of products to return from the end of the range.
         last: nil,
-        # The ways a relation of AccessPasses can be ordered
+        # The field to sort results by. Defaults to created_at.
         order: nil,
-        # Filter to only products matching these type classifications.
-        product_types: nil,
         # Filter to only products matching these visibility states.
         visibilities: nil,
         request_options: {}
@@ -103,18 +116,14 @@ module WhopSDK
         override.returns(
           {
             company_id: String,
-            after: T.nilable(String),
-            before: T.nilable(String),
-            created_after: T.nilable(Time),
-            created_before: T.nilable(Time),
-            direction: T.nilable(WhopSDK::Direction::OrSymbol),
-            first: T.nilable(Integer),
-            last: T.nilable(Integer),
-            order: T.nilable(WhopSDK::ProductListParams::Order::OrSymbol),
-            product_types:
-              T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol]),
-            visibilities:
-              T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+            access_pass_types: T::Array[String],
+            after: String,
+            before: String,
+            direction: WhopSDK::ProductListParams::Direction::OrSymbol,
+            first: Integer,
+            last: Integer,
+            order: String,
+            visibilities: T::Array[String],
             request_options: WhopSDK::RequestOptions
           }
         )
@@ -122,32 +131,20 @@ module WhopSDK
       def to_hash
       end
 
-      # The ways a relation of AccessPasses can be ordered
-      module Order
+      # The sort direction for results. Defaults to descending.
+      module Direction
         extend WhopSDK::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias { T.all(Symbol, WhopSDK::ProductListParams::Order) }
+          T.type_alias { T.all(Symbol, WhopSDK::ProductListParams::Direction) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        ACTIVE_MEMBERSHIPS_COUNT =
-          T.let(
-            :active_memberships_count,
-            WhopSDK::ProductListParams::Order::TaggedSymbol
-          )
-        CREATED_AT =
-          T.let(:created_at, WhopSDK::ProductListParams::Order::TaggedSymbol)
-        USD_GMV =
-          T.let(:usd_gmv, WhopSDK::ProductListParams::Order::TaggedSymbol)
-        USD_GMV_30_DAYS =
-          T.let(
-            :usd_gmv_30_days,
-            WhopSDK::ProductListParams::Order::TaggedSymbol
-          )
+        ASC = T.let(:asc, WhopSDK::ProductListParams::Direction::TaggedSymbol)
+        DESC = T.let(:desc, WhopSDK::ProductListParams::Direction::TaggedSymbol)
 
         sig do
           override.returns(
-            T::Array[WhopSDK::ProductListParams::Order::TaggedSymbol]
+            T::Array[WhopSDK::ProductListParams::Direction::TaggedSymbol]
           )
         end
         def self.values

data/rbi/whop_sdk/models/product_update_params.rbi

@@ -14,167 +14,72 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :id
 
-      # Whether the checkout flow collects a shipping address from the customer.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_accessor :collect_shipping_address
-
-      # The different types of custom CTAs that can be selected.
-      sig { returns(T.nilable(WhopSDK::CustomCta::OrSymbol)) }
-      attr_accessor :custom_cta
-
-      # A URL that the call-to-action button links to instead of the default checkout
-      # flow.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :custom_cta_url
-
-      # 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.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :custom_statement_descriptor
-
-      # A written description of the product displayed on its product page.
+      # A written description displayed on the product page.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
-      # The gallery images for the product.
-      sig do
-        returns(T.nilable(T::Array[WhopSDK::ProductUpdateParams::GalleryImage]))
-      end
-      attr_accessor :gallery_images
-
-      # The commission rate as a percentage that affiliates earn through the global
-      # affiliate program.
-      sig { returns(T.nilable(Float)) }
-      attr_accessor :global_affiliate_percentage
-
-      # The different statuses of the global affiliate program for a product.
-      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
-      attr_accessor :global_affiliate_status
-
-      # A short marketing headline displayed prominently on the product page.
+      # A short marketing headline for the product page.
       sig { returns(T.nilable(String)) }
       attr_accessor :headline
 
-      # The commission rate as a percentage that members earn through the member
-      # affiliate program.
-      sig { returns(T.nilable(Float)) }
-      attr_accessor :member_affiliate_percentage
-
-      # The different statuses of the global affiliate program for a product.
-      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
-      attr_accessor :member_affiliate_status
+      # Custom key-value pairs to store on the product.
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :metadata
 
-      # 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).
       sig { returns(T.nilable(String)) }
       attr_accessor :product_tax_code_id
 
-      # A URL to redirect the customer to after completing a purchase.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :redirect_purchase_url
-
-      # The URL slug for the product's public link.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :route
-
       # Whether to send an automated welcome message via support chat when a user joins
       # this product.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :send_welcome_message
 
-      # Layout and display configuration for this product on the company's store page.
-      sig { returns(T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig)) }
-      attr_reader :store_page_config
+      # The display name of the product.
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
 
-      sig do
-        params(
-          store_page_config:
-            T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig::OrHash)
-        ).void
-      end
-      attr_writer :store_page_config
+      sig { params(title: String).void }
+      attr_writer :title
 
-      # The display name of the product. Maximum 80 characters.
+      # Whether the product is visible to customers.
       sig { returns(T.nilable(String)) }
-      attr_accessor :title
+      attr_reader :visibility
 
-      # Visibility of a resource
-      sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
-      attr_accessor :visibility
+      sig { params(visibility: String).void }
+      attr_writer :visibility
 
       sig do
         params(
           id: String,
-          collect_shipping_address: T.nilable(T::Boolean),
-          custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
-          custom_cta_url: T.nilable(String),
-          custom_statement_descriptor: T.nilable(String),
           description: T.nilable(String),
-          gallery_images:
-            T.nilable(
-              T::Array[WhopSDK::ProductUpdateParams::GalleryImage::OrHash]
-            ),
-          global_affiliate_percentage: T.nilable(Float),
-          global_affiliate_status:
-            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
           headline: T.nilable(String),
-          member_affiliate_percentage: T.nilable(Float),
-          member_affiliate_status:
-            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          metadata: T.nilable(T.anything),
           product_tax_code_id: T.nilable(String),
-          redirect_purchase_url: T.nilable(String),
-          route: T.nilable(String),
           send_welcome_message: T.nilable(T::Boolean),
-          store_page_config:
-            T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig::OrHash),
-          title: T.nilable(String),
-          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          title: String,
+          visibility: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
-        # Whether the checkout flow collects a shipping address from the customer.
-        collect_shipping_address: nil,
-        # The different types of custom CTAs that can be selected.
-        custom_cta: nil,
-        # A URL that the call-to-action button links to instead of the default checkout
-        # flow.
-        custom_cta_url: nil,
-        # 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.
-        custom_statement_descriptor: nil,
-        # A written description of the product displayed on its product page.
+        # A written description displayed on the product page.
         description: nil,
-        # The gallery images for the product.
-        gallery_images: nil,
-        # The commission rate as a percentage that affiliates earn through the global
-        # affiliate program.
-        global_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for a product.
-        global_affiliate_status: nil,
-        # A short marketing headline displayed prominently on the product page.
+        # A short marketing headline for the product page.
         headline: nil,
-        # The commission rate as a percentage that members earn through the member
-        # affiliate program.
-        member_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for a product.
-        member_affiliate_status: nil,
-        # The unique identifier of the tax classification code to apply to this product.
+        # Custom key-value pairs to store on the product.
+        metadata: nil,
+        # The unique identifier of the tax classification code. See the available
+        # [product categories](https://docs.numeral.com/essentials/product-categories).
         product_tax_code_id: nil,
-        # A URL to redirect the customer to after completing a purchase.
-        redirect_purchase_url: nil,
-        # The URL slug for the product's public link.
-        route: nil,
         # Whether to send an automated welcome message via support chat when a user joins
         # this product.
         send_welcome_message: nil,
-        # Layout and display configuration for this product on the company's store page.
-        store_page_config: nil,
-        # The display name of the product. Maximum 80 characters.
+        # The display name of the product.
         title: nil,
-        # Visibility of a resource
+        # Whether the product is visible to customers.
         visibility: nil,
         request_options: {}
       )
@@ -184,101 +89,19 @@ module WhopSDK
         override.returns(
           {
             id: String,
-            collect_shipping_address: T.nilable(T::Boolean),
-            custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
-            custom_cta_url: T.nilable(String),
-            custom_statement_descriptor: T.nilable(String),
             description: T.nilable(String),
-            gallery_images:
-              T.nilable(T::Array[WhopSDK::ProductUpdateParams::GalleryImage]),
-            global_affiliate_percentage: T.nilable(Float),
-            global_affiliate_status:
-              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
             headline: T.nilable(String),
-            member_affiliate_percentage: T.nilable(Float),
-            member_affiliate_status:
-              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            metadata: T.nilable(T.anything),
             product_tax_code_id: T.nilable(String),
-            redirect_purchase_url: T.nilable(String),
-            route: T.nilable(String),
             send_welcome_message: T.nilable(T::Boolean),
-            store_page_config:
-              T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig),
-            title: T.nilable(String),
-            visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+            title: String,
+            visibility: String,
             request_options: WhopSDK::RequestOptions
           }
         )
       end
       def to_hash
       end
-
-      class GalleryImage < WhopSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              WhopSDK::ProductUpdateParams::GalleryImage,
-              WhopSDK::Internal::AnyHash
-            )
-          end
-
-        # The ID of an existing file object.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Input for an attachment
-        sig { params(id: String).returns(T.attached_class) }
-        def self.new(
-          # The ID of an existing file object.
-          id:
-        )
-        end
-
-        sig { override.returns({ id: String }) }
-        def to_hash
-        end
-      end
-
-      class StorePageConfig < WhopSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              WhopSDK::ProductUpdateParams::StorePageConfig,
-              WhopSDK::Internal::AnyHash
-            )
-          end
-
-        # Custom call-to-action text for the product's store page.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :custom_cta
-
-        # Whether or not to show the price on the product's store page.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_accessor :show_price
-
-        # Layout and display configuration for this product on the company's store page.
-        sig do
-          params(
-            custom_cta: T.nilable(String),
-            show_price: T.nilable(T::Boolean)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Custom call-to-action text for the product's store page.
-          custom_cta: nil,
-          # Whether or not to show the price on the product's store page.
-          show_price: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { custom_cta: T.nilable(String), show_price: T.nilable(T::Boolean) }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/whop_sdk/models/referral_referred_users_params.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ReferralReferredUsersParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::ReferralReferredUsersParams,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # Cursor to fetch the page after (from page_info.end_cursor).
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor to fetch the page before (from page_info.start_cursor).
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Number of referred users to return from the start of the window.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :first
+
+      sig { params(first: Integer).void }
+      attr_writer :first
+
+      # When true, only referred users who brought at least one business onto Whop.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_businesses
+
+      sig { params(has_businesses: T::Boolean).void }
+      attr_writer :has_businesses
+
+      # When true, only referred users with at least one business that has generated
+      # earnings.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :has_earning_businesses
+
+      sig { params(has_earning_businesses: T::Boolean).void }
+      attr_writer :has_earning_businesses
+
+      # Number of referred users to return from the end of the window.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :last
+
+      sig { params(last: Integer).void }
+      attr_writer :last
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          first: Integer,
+          has_businesses: T::Boolean,
+          has_earning_businesses: T::Boolean,
+          last: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor to fetch the page after (from page_info.end_cursor).
+        after: nil,
+        # Cursor to fetch the page before (from page_info.start_cursor).
+        before: nil,
+        # Number of referred users to return from the start of the window.
+        first: nil,
+        # When true, only referred users who brought at least one business onto Whop.
+        has_businesses: nil,
+        # When true, only referred users with at least one business that has generated
+        # earnings.
+        has_earning_businesses: nil,
+        # Number of referred users to return from the end of the window.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            first: Integer,
+            has_businesses: T::Boolean,
+            has_earning_businesses: T::Boolean,
+            last: Integer,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end