whop_sdk 0.0.39 → 0.0.40

data/rbi/whop_sdk/models/product.rbi

@@ -81,6 +81,11 @@ module WhopSDK
       sig { returns(Integer) }
       attr_accessor :member_count
 
+      # Custom key-value pairs stored on the product. Included in webhook payloads for
+      # payment and membership events.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The user who owns the company that sells this product.
       sig { returns(WhopSDK::Product::OwnerUser) }
       attr_reader :owner_user
@@ -146,6 +151,7 @@ module WhopSDK
           member_affiliate_percentage: T.nilable(Float),
           member_affiliate_status: WhopSDK::GlobalAffiliateStatus::OrSymbol,
           member_count: Integer,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           owner_user: WhopSDK::Product::OwnerUser::OrHash,
           product_tax_code: T.nilable(WhopSDK::Product::ProductTaxCode::OrHash),
           published_reviews_count: Integer,
@@ -199,6 +205,9 @@ module WhopSDK
         # The number of users who currently hold an active membership to this product.
         # Returns 0 if the company has disabled public member counts.
         member_count:,
+        # Custom key-value pairs stored on the product. Included in webhook payloads for
+        # payment and membership events.
+        metadata:,
         # The user who owns the company that sells this product.
         owner_user:,
         # The tax classification code applied to purchases of this product for sales tax
@@ -242,6 +251,7 @@ module WhopSDK
             member_affiliate_status:
               WhopSDK::GlobalAffiliateStatus::TaggedSymbol,
             member_count: Integer,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             owner_user: WhopSDK::Product::OwnerUser,
             product_tax_code: T.nilable(WhopSDK::Product::ProductTaxCode),
             published_reviews_count: Integer,

data/rbi/whop_sdk/models/product_create_params.rbi

@@ -68,6 +68,12 @@ module WhopSDK
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :member_affiliate_status
 
+      # Custom key-value pairs to store on the product. Included in webhook payloads for
+      # payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+      # value.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # Configuration for an automatically generated plan to attach to this product.
       sig { returns(T.nilable(WhopSDK::ProductCreateParams::PlanOptions)) }
       attr_reader :plan_options
@@ -118,6 +124,7 @@ module WhopSDK
           member_affiliate_percentage: T.nilable(Float),
           member_affiliate_status:
             T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           plan_options:
             T.nilable(WhopSDK::ProductCreateParams::PlanOptions::OrHash),
           product_tax_code_id: T.nilable(String),
@@ -160,6 +167,10 @@ module WhopSDK
         member_affiliate_percentage: nil,
         # The different statuses of the global affiliate program for a product.
         member_affiliate_status: nil,
+        # Custom key-value pairs to store on the product. Included in webhook payloads for
+        # payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+        # value.
+        metadata: nil,
         # Configuration for an automatically generated plan to attach to this product.
         plan_options: nil,
         # The unique identifier of the tax classification code to apply to this product.
@@ -195,6 +206,7 @@ module WhopSDK
             member_affiliate_percentage: T.nilable(Float),
             member_affiliate_status:
               T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             plan_options: T.nilable(WhopSDK::ProductCreateParams::PlanOptions),
             product_tax_code_id: T.nilable(String),
             redirect_purchase_url: T.nilable(String),

data/rbi/whop_sdk/models/product_list_item.rbi

@@ -31,6 +31,11 @@ module WhopSDK
       sig { returns(Integer) }
       attr_accessor :member_count
 
+      # Custom key-value pairs stored on the product. Included in webhook payloads for
+      # payment and membership events.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The total number of published customer reviews for this product's company.
       sig { returns(Integer) }
       attr_accessor :published_reviews_count
@@ -67,6 +72,7 @@ module WhopSDK
           external_identifier: T.nilable(String),
           headline: T.nilable(String),
           member_count: Integer,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           published_reviews_count: Integer,
           route: String,
           title: String,
@@ -89,6 +95,9 @@ module WhopSDK
         # The number of users who currently hold an active membership to this product.
         # Returns 0 if the company has disabled public member counts.
         member_count:,
+        # Custom key-value pairs stored on the product. Included in webhook payloads for
+        # payment and membership events.
+        metadata:,
         # The total number of published customer reviews for this product's company.
         published_reviews_count:,
         # The URL slug used in the product's public link (e.g., 'my-product' in
@@ -115,6 +124,7 @@ module WhopSDK
             external_identifier: T.nilable(String),
             headline: T.nilable(String),
             member_count: Integer,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             published_reviews_count: Integer,
             route: String,
             title: String,

data/rbi/whop_sdk/models/product_update_params.rbi

@@ -65,6 +65,12 @@ module WhopSDK
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :member_affiliate_status
 
+      # Custom key-value pairs to store on the product. Included in webhook payloads for
+      # payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+      # value.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The unique identifier of the tax classification code to apply to this product.
       sig { returns(T.nilable(String)) }
       attr_accessor :product_tax_code_id
@@ -121,6 +127,7 @@ module WhopSDK
           member_affiliate_percentage: T.nilable(Float),
           member_affiliate_status:
             T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           product_tax_code_id: T.nilable(String),
           redirect_purchase_url: T.nilable(String),
           route: T.nilable(String),
@@ -161,6 +168,10 @@ module WhopSDK
         member_affiliate_percentage: nil,
         # The different statuses of the global affiliate program for a product.
         member_affiliate_status: nil,
+        # Custom key-value pairs to store on the product. Included in webhook payloads for
+        # payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
+        # value.
+        metadata: nil,
         # The unique identifier of the tax classification code to apply to this product.
         product_tax_code_id: nil,
         # A URL to redirect the customer to after completing a purchase.
@@ -198,6 +209,7 @@ module WhopSDK
             member_affiliate_percentage: T.nilable(Float),
             member_affiliate_status:
               T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             product_tax_code_id: T.nilable(String),
             redirect_purchase_url: T.nilable(String),
             route: T.nilable(String),

data/rbi/whop_sdk/models/refund_created_webhook_event.rbi

@@ -255,8 +255,8 @@ module WhopSDK
           sig { returns(Time) }
           attr_accessor :created_at
 
-          # The available currencies on the platform
-          sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+          # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+          sig { returns(WhopSDK::Currency::TaggedSymbol) }
           attr_accessor :currency
 
           # When an alert came in that this transaction will be disputed
@@ -303,6 +303,11 @@ module WhopSDK
           end
           attr_writer :membership
 
+          # The custom metadata stored on this payment. This will be copied over to the
+          # checkout configuration for which this payment was made
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_accessor :metadata
+
           # The time at which this payment was successfully collected. Null if the payment
           # has not yet succeeded. As a Unix timestamp.
           sig { returns(T.nilable(Time)) }
@@ -312,6 +317,44 @@ module WhopSDK
           sig { returns(T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol)) }
           attr_accessor :payment_method_type
 
+          # The plan attached to this payment.
+          sig do
+            returns(
+              T.nilable(WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan)
+            )
+          end
+          attr_reader :plan
+
+          sig do
+            params(
+              plan:
+                T.nilable(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan::OrHash
+                )
+            ).void
+          end
+          attr_writer :plan
+
+          # The product this payment was made for
+          sig do
+            returns(
+              T.nilable(
+                WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product
+              )
+            )
+          end
+          attr_reader :product
+
+          sig do
+            params(
+              product:
+                T.nilable(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product::OrHash
+                )
+            ).void
+          end
+          attr_writer :product
+
           # The subtotal to show to the creator (excluding buyer fees).
           sig { returns(T.nilable(Float)) }
           attr_accessor :subtotal
@@ -364,7 +407,7 @@ module WhopSDK
               card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
               card_last4: T.nilable(String),
               created_at: Time,
-              currency: T.nilable(WhopSDK::Currency::OrSymbol),
+              currency: WhopSDK::Currency::OrSymbol,
               dispute_alerted_at: T.nilable(Time),
               member:
                 T.nilable(
@@ -374,9 +417,18 @@ module WhopSDK
                 T.nilable(
                   WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Membership::OrHash
                 ),
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
               paid_at: T.nilable(Time),
               payment_method_type:
                 T.nilable(WhopSDK::PaymentMethodTypes::OrSymbol),
+              plan:
+                T.nilable(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan::OrHash
+                ),
+              product:
+                T.nilable(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product::OrHash
+                ),
               subtotal: T.nilable(Float),
               tax_amount: T.nilable(Float),
               tax_behavior: T.nilable(WhopSDK::ReceiptTaxBehavior::OrSymbol),
@@ -401,7 +453,7 @@ module WhopSDK
             card_last4:,
             # The datetime the payment was created.
             created_at:,
-            # The available currencies on the platform
+            # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
             currency:,
             # When an alert came in that this transaction will be disputed
             dispute_alerted_at:,
@@ -409,11 +461,18 @@ module WhopSDK
             member:,
             # The membership attached to this payment.
             membership:,
+            # The custom metadata stored on this payment. This will be copied over to the
+            # checkout configuration for which this payment was made
+            metadata:,
             # The time at which this payment was successfully collected. Null if the payment
             # has not yet succeeded. As a Unix timestamp.
             paid_at:,
             # The different types of payment methods that can be used.
             payment_method_type:,
+            # The plan attached to this payment.
+            plan:,
+            # The product this payment was made for
+            product:,
             # The subtotal to show to the creator (excluding buyer fees).
             subtotal:,
             # The calculated amount of the sales/VAT tax (if applicable).
@@ -441,7 +500,7 @@ module WhopSDK
                 card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
                 card_last4: T.nilable(String),
                 created_at: Time,
-                currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
+                currency: WhopSDK::Currency::TaggedSymbol,
                 dispute_alerted_at: T.nilable(Time),
                 member:
                   T.nilable(
@@ -451,9 +510,18 @@ module WhopSDK
                   T.nilable(
                     WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Membership
                   ),
+                metadata: T.nilable(T::Hash[Symbol, T.anything]),
                 paid_at: T.nilable(Time),
                 payment_method_type:
                   T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
+                plan:
+                  T.nilable(
+                    WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan
+                  ),
+                product:
+                  T.nilable(
+                    WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product
+                  ),
                 subtotal: T.nilable(Float),
                 tax_amount: T.nilable(Float),
                 tax_behavior:
@@ -548,6 +616,92 @@ module WhopSDK
             end
           end
 
+          class Plan < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan,
+                  WhopSDK::Internal::AnyHash
+                )
+              end
+
+            # The unique identifier for the plan.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Custom key-value pairs stored on the plan. Included in webhook payloads for
+            # payment and membership events.
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+            attr_accessor :metadata
+
+            # The plan attached to this payment.
+            sig do
+              params(
+                id: String,
+                metadata: T.nilable(T::Hash[Symbol, T.anything])
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The unique identifier for the plan.
+              id:,
+              # Custom key-value pairs stored on the plan. Included in webhook payloads for
+              # payment and membership events.
+              metadata:
+            )
+            end
+
+            sig do
+              override.returns(
+                { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class Product < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product,
+                  WhopSDK::Internal::AnyHash
+                )
+              end
+
+            # The unique identifier for the product.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Custom key-value pairs stored on the product. Included in webhook payloads for
+            # payment and membership events.
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+            attr_accessor :metadata
+
+            # The product this payment was made for
+            sig do
+              params(
+                id: String,
+                metadata: T.nilable(T::Hash[Symbol, T.anything])
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The unique identifier for the product.
+              id:,
+              # Custom key-value pairs stored on the product. Included in webhook payloads for
+              # payment and membership events.
+              metadata:
+            )
+            end
+
+            sig do
+              override.returns(
+                { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+              )
+            end
+            def to_hash
+            end
+          end
+
           class User < WhopSDK::Internal::Type::BaseModel
             OrHash =
               T.type_alias do

data/rbi/whop_sdk/models/refund_retrieve_response.rbi

@@ -172,8 +172,8 @@ module WhopSDK
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # The available currencies on the platform
-        sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+        # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+        sig { returns(WhopSDK::Currency::TaggedSymbol) }
         attr_accessor :currency
 
         # When an alert came in that this transaction will be disputed
@@ -218,6 +218,11 @@ module WhopSDK
         end
         attr_writer :membership
 
+        # The custom metadata stored on this payment. This will be copied over to the
+        # checkout configuration for which this payment was made
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The time at which this payment was successfully collected. Null if the payment
         # has not yet succeeded. As a Unix timestamp.
         sig { returns(T.nilable(Time)) }
@@ -227,6 +232,42 @@ module WhopSDK
         sig { returns(T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol)) }
         attr_accessor :payment_method_type
 
+        # The plan attached to this payment.
+        sig do
+          returns(
+            T.nilable(WhopSDK::Models::RefundRetrieveResponse::Payment::Plan)
+          )
+        end
+        attr_reader :plan
+
+        sig do
+          params(
+            plan:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Plan::OrHash
+              )
+          ).void
+        end
+        attr_writer :plan
+
+        # The product this payment was made for
+        sig do
+          returns(
+            T.nilable(WhopSDK::Models::RefundRetrieveResponse::Payment::Product)
+          )
+        end
+        attr_reader :product
+
+        sig do
+          params(
+            product:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Product::OrHash
+              )
+          ).void
+        end
+        attr_writer :product
+
         # The subtotal to show to the creator (excluding buyer fees).
         sig { returns(T.nilable(Float)) }
         attr_accessor :subtotal
@@ -279,7 +320,7 @@ module WhopSDK
             card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
             card_last4: T.nilable(String),
             created_at: Time,
-            currency: T.nilable(WhopSDK::Currency::OrSymbol),
+            currency: WhopSDK::Currency::OrSymbol,
             dispute_alerted_at: T.nilable(Time),
             member:
               T.nilable(
@@ -289,9 +330,18 @@ module WhopSDK
               T.nilable(
                 WhopSDK::Models::RefundRetrieveResponse::Payment::Membership::OrHash
               ),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             paid_at: T.nilable(Time),
             payment_method_type:
               T.nilable(WhopSDK::PaymentMethodTypes::OrSymbol),
+            plan:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Plan::OrHash
+              ),
+            product:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Product::OrHash
+              ),
             subtotal: T.nilable(Float),
             tax_amount: T.nilable(Float),
             tax_behavior: T.nilable(WhopSDK::ReceiptTaxBehavior::OrSymbol),
@@ -316,7 +366,7 @@ module WhopSDK
           card_last4:,
           # The datetime the payment was created.
           created_at:,
-          # The available currencies on the platform
+          # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
           currency:,
           # When an alert came in that this transaction will be disputed
           dispute_alerted_at:,
@@ -324,11 +374,18 @@ module WhopSDK
           member:,
           # The membership attached to this payment.
           membership:,
+          # The custom metadata stored on this payment. This will be copied over to the
+          # checkout configuration for which this payment was made
+          metadata:,
           # The time at which this payment was successfully collected. Null if the payment
           # has not yet succeeded. As a Unix timestamp.
           paid_at:,
           # The different types of payment methods that can be used.
           payment_method_type:,
+          # The plan attached to this payment.
+          plan:,
+          # The product this payment was made for
+          product:,
           # The subtotal to show to the creator (excluding buyer fees).
           subtotal:,
           # The calculated amount of the sales/VAT tax (if applicable).
@@ -355,7 +412,7 @@ module WhopSDK
               card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
               card_last4: T.nilable(String),
               created_at: Time,
-              currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
+              currency: WhopSDK::Currency::TaggedSymbol,
               dispute_alerted_at: T.nilable(Time),
               member:
                 T.nilable(
@@ -365,9 +422,18 @@ module WhopSDK
                 T.nilable(
                   WhopSDK::Models::RefundRetrieveResponse::Payment::Membership
                 ),
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
               paid_at: T.nilable(Time),
               payment_method_type:
                 T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
+              plan:
+                T.nilable(
+                  WhopSDK::Models::RefundRetrieveResponse::Payment::Plan
+                ),
+              product:
+                T.nilable(
+                  WhopSDK::Models::RefundRetrieveResponse::Payment::Product
+                ),
               subtotal: T.nilable(Float),
               tax_amount: T.nilable(Float),
               tax_behavior:
@@ -462,6 +528,92 @@ module WhopSDK
           end
         end
 
+        class Plan < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Plan,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier for the plan.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Custom key-value pairs stored on the plan. Included in webhook payloads for
+          # payment and membership events.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_accessor :metadata
+
+          # The plan attached to this payment.
+          sig do
+            params(
+              id: String,
+              metadata: T.nilable(T::Hash[Symbol, T.anything])
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier for the plan.
+            id:,
+            # Custom key-value pairs stored on the plan. Included in webhook payloads for
+            # payment and membership events.
+            metadata:
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Product < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Product,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The unique identifier for the product.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Custom key-value pairs stored on the product. Included in webhook payloads for
+          # payment and membership events.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_accessor :metadata
+
+          # The product this payment was made for
+          sig do
+            params(
+              id: String,
+              metadata: T.nilable(T::Hash[Symbol, T.anything])
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique identifier for the product.
+            id:,
+            # Custom key-value pairs stored on the product. Included in webhook payloads for
+            # payment and membership events.
+            metadata:
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, metadata: T.nilable(T::Hash[Symbol, T.anything]) }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class User < WhopSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do