whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/refund_updated_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::RefundUpdatedWebhookEvent::Data::Payment::Plan)
+            )
+          end
+          attr_reader :plan
+
+          sig do
+            params(
+              plan:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Plan::OrHash
+                )
+            ).void
+          end
+          attr_writer :plan
+
+          # The product this payment was made for
+          sig do
+            returns(
+              T.nilable(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Product
+              )
+            )
+          end
+          attr_reader :product
+
+          sig do
+            params(
+              product:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::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::RefundUpdatedWebhookEvent::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::RefundUpdatedWebhookEvent::Data::Payment::Plan::OrHash
+                ),
+              product:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::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::RefundUpdatedWebhookEvent::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::RefundUpdatedWebhookEvent::Data::Payment::Plan
+                  ),
+                product:
+                  T.nilable(
+                    WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Product
+                  ),
                 subtotal: T.nilable(Float),
                 tax_amount: T.nilable(Float),
                 tax_behavior:
@@ -548,6 +616,96 @@ module WhopSDK
             end
           end
 
+          class Plan < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundUpdatedWebhookEvent::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. Max 50 keys, 100 chars per key, 500 chars per
+            # string value.
+            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. Max 50 keys, 100 chars per key, 500 chars per
+              # string value.
+              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::RefundUpdatedWebhookEvent::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 and included in payment and
+            # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+            # per string value.
+            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 and included in payment and
+              # membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+              # per string value.
+              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/resolution_center_case_platform_response.rbi

@@ -27,11 +27,6 @@ module WhopSDK
           :merchant_wins,
           WhopSDK::ResolutionCenterCasePlatformResponse::TaggedSymbol
         )
-      PLATFORM_REFUND =
-        T.let(
-          :platform_refund,
-          WhopSDK::ResolutionCenterCasePlatformResponse::TaggedSymbol
-        )
       MERCHANT_REFUND =
         T.let(
           :merchant_refund,

data/rbi/whop_sdk/models/result_label_keys.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # Types of optimization results tracked from external ad platforms
+    module ResultLabelKeys
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::ResultLabelKeys) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      APP_INSTALLS =
+        T.let(:app_installs, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      MESSAGING_CONVERSATIONS_STARTED =
+        T.let(
+          :messaging_conversations_started,
+          WhopSDK::ResultLabelKeys::TaggedSymbol
+        )
+      POST_ENGAGEMENT =
+        T.let(:post_engagement, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      EVENT_RESPONSES =
+        T.let(:event_responses, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      IMPRESSIONS = T.let(:impressions, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_PURCHASES =
+        T.let(:website_purchases, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      LANDING_PAGE_VIEWS =
+        T.let(:landing_page_views, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      LEADS = T.let(:leads, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      LINK_CLICKS = T.let(:link_clicks, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      QUALITY_CALLS =
+        T.let(:quality_calls, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      APPOINTMENTS_BOOKED =
+        T.let(:appointments_booked, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      MESSAGING_PURCHASES =
+        T.let(:messaging_purchases, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      PAGE_LIKES = T.let(:page_likes, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      INSTAGRAM_PROFILE_VISITS =
+        T.let(:instagram_profile_visits, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      REACH = T.let(:reach, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      REMINDERS_SET =
+        T.let(:reminders_set, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      NEW_SUBSCRIBERS =
+        T.let(:new_subscribers, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      VIDEO_VIEWS = T.let(:video_views, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      REGISTRATIONS =
+        T.let(:registrations, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      CONTENT_VIEWS =
+        T.let(:content_views, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      SEARCHES = T.let(:searches, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      ADDS_TO_CART =
+        T.let(:adds_to_cart, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      ADDS_TO_WISHLIST =
+        T.let(:adds_to_wishlist, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      ADDS_OF_PAYMENT_INFO =
+        T.let(:adds_of_payment_info, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      CHECKOUTS_INITIATED =
+        T.let(:checkouts_initiated, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_SCHEDULES =
+        T.let(:website_schedules, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_SUBMIT_APPLICATIONS =
+        T.let(
+          :website_submit_applications,
+          WhopSDK::ResultLabelKeys::TaggedSymbol
+        )
+      WEBSITE_TRIALS_STARTED =
+        T.let(:website_trials_started, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_SUBSCRIPTIONS =
+        T.let(:website_subscriptions, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_CONTACTS =
+        T.let(:website_contacts, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_DONATIONS =
+        T.let(:website_donations, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_FIND_LOCATIONS =
+        T.let(:website_find_locations, WhopSDK::ResultLabelKeys::TaggedSymbol)
+      WEBSITE_PRODUCT_CUSTOMIZATIONS =
+        T.let(
+          :website_product_customizations,
+          WhopSDK::ResultLabelKeys::TaggedSymbol
+        )
+      CUSTOM = T.let(:custom, WhopSDK::ResultLabelKeys::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::ResultLabelKeys::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/review_list_response.rbi

@@ -153,7 +153,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
-        # The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
+        # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.
         sig { returns(T.nilable(String)) }
         attr_accessor :content_type
 
@@ -182,7 +182,7 @@ module WhopSDK
           # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
           # input value will be accepted as an ID.
           id:,
-          # The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
+          # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.
           content_type:,
           # The original filename of the uploaded attachment, including its file extension.
           filename:,

data/rbi/whop_sdk/models/review_retrieve_response.rbi

@@ -190,7 +190,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
-        # The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
+        # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.
         sig { returns(T.nilable(String)) }
         attr_accessor :content_type
 
@@ -219,7 +219,7 @@ module WhopSDK
           # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
           # input value will be accepted as an ID.
           id:,
-          # The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
+          # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.
           content_type:,
           # The original filename of the uploaded attachment, including its file extension.
           filename:,
@@ -256,7 +256,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
-        # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        # URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         sig { returns(String) }
         attr_accessor :route
 
@@ -273,7 +273,7 @@ module WhopSDK
         def self.new(
           # The unique identifier for the company.
           id:,
-          # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+          # URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
           route:,
           # The display name of the company shown to customers.
           title:

data/rbi/whop_sdk/models/setup_intent.rbi

@@ -73,6 +73,11 @@ module WhopSDK
       sig { returns(WhopSDK::SetupIntentStatus::TaggedSymbol) }
       attr_accessor :status
 
+      # Whether 3D Secure authentication was completed when this payment method was set
+      # up.
+      sig { returns(T::Boolean) }
+      attr_accessor :three_ds_verified
+
       # A setup intent allows a user to save a payment method for future use without
       # making an immediate purchase.
       sig do
@@ -87,7 +92,8 @@ module WhopSDK
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           payment_method:
             T.nilable(WhopSDK::SetupIntent::PaymentMethod::OrHash),
-          status: WhopSDK::SetupIntentStatus::OrSymbol
+          status: WhopSDK::SetupIntentStatus::OrSymbol,
+          three_ds_verified: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
@@ -114,7 +120,10 @@ module WhopSDK
         # completed successfully.
         payment_method:,
         # The current status of the setup intent.
-        status:
+        status:,
+        # Whether 3D Secure authentication was completed when this payment method was set
+        # up.
+        three_ds_verified:
       )
       end
 
@@ -130,7 +139,8 @@ module WhopSDK
             member: T.nilable(WhopSDK::SetupIntent::Member),
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
             payment_method: T.nilable(WhopSDK::SetupIntent::PaymentMethod),
-            status: WhopSDK::SetupIntentStatus::TaggedSymbol
+            status: WhopSDK::SetupIntentStatus::TaggedSymbol,
+            three_ds_verified: T::Boolean
           }
         )
       end

data/rbi/whop_sdk/models/social_account.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class SocialAccount < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::SocialAccount, WhopSDK::Internal::AnyHash)
+        end
+
+      # Unique identifier for the social account.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The platform-specific ID for this social account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # The display name of the social account on the platform.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The platform the social account exists on.
+      sig { returns(WhopSDK::SocialAccount::Platform::TaggedSymbol) }
+      attr_accessor :platform
+
+      # The URL where the profile picture of the social account can be accessed.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :profile_picture_url
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :scopes
+
+      # The URL where the social account can be accessed on the platform. Null while a
+      # Whop-owned page is still being provisioned.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      # The username of the social account on the platform. Null while a Whop-owned page
+      # is still being provisioned.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :username
+
+      # Whether the social account is verified on the platform.
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      sig do
+        params(
+          id: String,
+          external_id: T.nilable(String),
+          name: T.nilable(String),
+          platform: WhopSDK::SocialAccount::Platform::OrSymbol,
+          profile_picture_url: T.nilable(String),
+          scopes: T::Array[String],
+          url: T.nilable(String),
+          username: T.nilable(String),
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the social account.
+        id:,
+        # The platform-specific ID for this social account.
+        external_id:,
+        # The display name of the social account on the platform.
+        name:,
+        # The platform the social account exists on.
+        platform:,
+        # The URL where the profile picture of the social account can be accessed.
+        profile_picture_url:,
+        scopes:,
+        # The URL where the social account can be accessed on the platform. Null while a
+        # Whop-owned page is still being provisioned.
+        url:,
+        # The username of the social account on the platform. Null while a Whop-owned page
+        # is still being provisioned.
+        username:,
+        # Whether the social account is verified on the platform.
+        verified:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            external_id: T.nilable(String),
+            name: T.nilable(String),
+            platform: WhopSDK::SocialAccount::Platform::TaggedSymbol,
+            profile_picture_url: T.nilable(String),
+            scopes: T::Array[String],
+            url: T.nilable(String),
+            username: T.nilable(String),
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The platform the social account exists on.
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::SocialAccount::Platform) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        X = T.let(:x, WhopSDK::SocialAccount::Platform::TaggedSymbol)
+        INSTAGRAM =
+          T.let(:instagram, WhopSDK::SocialAccount::Platform::TaggedSymbol)
+        YOUTUBE =
+          T.let(:youtube, WhopSDK::SocialAccount::Platform::TaggedSymbol)
+        TIKTOK = T.let(:tiktok, WhopSDK::SocialAccount::Platform::TaggedSymbol)
+        FACEBOOK =
+          T.let(:facebook, WhopSDK::SocialAccount::Platform::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::SocialAccount::Platform::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end