whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/models/message_create_params.rbi

@@ -21,7 +21,16 @@ module WhopSDK
 
       # The attachments for this message, such as videos or images.
       sig do
-        returns(T.nilable(T::Array[WhopSDK::MessageCreateParams::Attachment]))
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(
+                WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID,
+                WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID
+              )
+            ]
+          )
+        )
       end
       attr_accessor :attachments
 
@@ -40,7 +49,12 @@ module WhopSDK
           content: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::MessageCreateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           poll: T.nilable(WhopSDK::MessageCreateParams::Poll::OrHash),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -65,7 +79,14 @@ module WhopSDK
             channel_id: String,
             content: String,
             attachments:
-              T.nilable(T::Array[WhopSDK::MessageCreateParams::Attachment]),
+              T.nilable(
+                T::Array[
+                  T.any(
+                    WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID,
+                    WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID
+                  )
+                ]
+              ),
             poll: T.nilable(WhopSDK::MessageCreateParams::Poll),
             request_options: WhopSDK::RequestOptions
           }
@@ -74,52 +95,84 @@ module WhopSDK
       def to_hash
       end
 
-      class Attachment < WhopSDK::Internal::Type::BaseModel
-        OrHash =
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              WhopSDK::MessageCreateParams::Attachment,
-              WhopSDK::Internal::AnyHash
+              WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID,
+              WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID
             )
           end
 
-        # The ID of an existing attachment object. Use this when updating a resource and
-        # keeping a subset of the attachments. Don't use this unless you know what you're
-        # doing.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :id
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
 
-        # This ID should be used the first time you upload an attachment. It is the ID of
-        # the direct upload that was created when uploading the file to S3 via the
-        # mediaDirectUpload mutation.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :direct_upload_id
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          sig { returns(String) }
+          attr_accessor :direct_upload_id
 
-        # Input for an attachment
-        sig do
-          params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
-          ).returns(T.attached_class)
+          # Input for an attachment
+          sig { params(direct_upload_id: String).returns(T.attached_class) }
+          def self.new(
+            # This ID should be used the first time you upload an attachment. It is the ID of
+            # the direct upload that was created when uploading the file to S3 via the
+            # mediaDirectUpload mutation.
+            direct_upload_id:
+          )
+          end
+
+          sig { override.returns({ direct_upload_id: String }) }
+          def to_hash
+          end
         end
-        def self.new(
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
           # The ID of an existing attachment object. Use this when updating a resource and
           # keeping a subset of the attachments. Don't use this unless you know what you're
           # doing.
-          id: nil,
-          # This ID should be used the first time you upload an attachment. It is the ID of
-          # the direct upload that was created when uploading the file to S3 via the
-          # mediaDirectUpload mutation.
-          direct_upload_id: nil
-        )
+          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 attachment object. Use this when updating a resource and
+            # keeping a subset of the attachments. Don't use this unless you know what you're
+            # doing.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
 
         sig do
           override.returns(
-            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+            T::Array[WhopSDK::MessageCreateParams::Attachment::Variants]
           )
         end
-        def to_hash
+        def self.variants
         end
       end
 

data/rbi/whop_sdk/models/message_list_response.rbi

@@ -11,7 +11,7 @@ module WhopSDK
           )
         end
 
-      # The unique identifier for the entity
+      # The unique identifier of the resource.
       sig { returns(String) }
       attr_accessor :id
 
@@ -100,7 +100,7 @@ module WhopSDK
         ).returns(T.attached_class)
       end
       def self.new(
-        # The unique identifier for the entity
+        # The unique identifier of the resource.
         id:,
         # The content of the message in Markdown format
         content:,

data/rbi/whop_sdk/models/message_update_params.rbi

@@ -13,7 +13,16 @@ module WhopSDK
 
       # The attachments for this message
       sig do
-        returns(T.nilable(T::Array[WhopSDK::MessageUpdateParams::Attachment]))
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(
+                WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID,
+                WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID
+              )
+            ]
+          )
+        )
       end
       attr_accessor :attachments
 
@@ -29,7 +38,12 @@ module WhopSDK
         params(
           attachments:
             T.nilable(
-              T::Array[WhopSDK::MessageUpdateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           content: T.nilable(String),
           is_pinned: T.nilable(T::Boolean),
@@ -51,7 +65,14 @@ module WhopSDK
         override.returns(
           {
             attachments:
-              T.nilable(T::Array[WhopSDK::MessageUpdateParams::Attachment]),
+              T.nilable(
+                T::Array[
+                  T.any(
+                    WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID,
+                    WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID
+                  )
+                ]
+              ),
             content: T.nilable(String),
             is_pinned: T.nilable(T::Boolean),
             request_options: WhopSDK::RequestOptions
@@ -61,52 +82,84 @@ module WhopSDK
       def to_hash
       end
 
-      class Attachment < WhopSDK::Internal::Type::BaseModel
-        OrHash =
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              WhopSDK::MessageUpdateParams::Attachment,
-              WhopSDK::Internal::AnyHash
+              WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID,
+              WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID
             )
           end
 
-        # The ID of an existing attachment object. Use this when updating a resource and
-        # keeping a subset of the attachments. Don't use this unless you know what you're
-        # doing.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :id
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
 
-        # This ID should be used the first time you upload an attachment. It is the ID of
-        # the direct upload that was created when uploading the file to S3 via the
-        # mediaDirectUpload mutation.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :direct_upload_id
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          sig { returns(String) }
+          attr_accessor :direct_upload_id
 
-        # Input for an attachment
-        sig do
-          params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
-          ).returns(T.attached_class)
+          # Input for an attachment
+          sig { params(direct_upload_id: String).returns(T.attached_class) }
+          def self.new(
+            # This ID should be used the first time you upload an attachment. It is the ID of
+            # the direct upload that was created when uploading the file to S3 via the
+            # mediaDirectUpload mutation.
+            direct_upload_id:
+          )
+          end
+
+          sig { override.returns({ direct_upload_id: String }) }
+          def to_hash
+          end
         end
-        def self.new(
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
           # The ID of an existing attachment object. Use this when updating a resource and
           # keeping a subset of the attachments. Don't use this unless you know what you're
           # doing.
-          id: nil,
-          # This ID should be used the first time you upload an attachment. It is the ID of
-          # the direct upload that was created when uploading the file to S3 via the
-          # mediaDirectUpload mutation.
-          direct_upload_id: nil
-        )
+          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 attachment object. Use this when updating a resource and
+            # keeping a subset of the attachments. Don't use this unless you know what you're
+            # doing.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
 
         sig do
           override.returns(
-            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+            T::Array[WhopSDK::MessageUpdateParams::Attachment::Variants]
           )
         end
-        def to_hash
+        def self.variants
         end
       end
     end

data/rbi/whop_sdk/models/payment.rbi

@@ -84,6 +84,11 @@ module WhopSDK
       end
       attr_writer :membership
 
+      # The custom metadata stored on this payment. This will be copied the checkout
+      # configuration for which this payment was made
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The datetime the payment was paid
       sig { returns(T.nilable(Time)) }
       attr_accessor :paid_at
@@ -99,7 +104,7 @@ module WhopSDK
       sig { params(plan: T.nilable(WhopSDK::Payment::Plan::OrHash)).void }
       attr_writer :plan
 
-      # The access pass attached to this payment.
+      # The product this payment was made for
       sig { returns(T.nilable(WhopSDK::Payment::Product)) }
       attr_reader :product
 
@@ -184,6 +189,7 @@ module WhopSDK
           last_payment_attempt: T.nilable(Time),
           member: T.nilable(WhopSDK::Payment::Member::OrHash),
           membership: T.nilable(WhopSDK::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::Payment::Plan::OrHash),
@@ -233,13 +239,16 @@ module WhopSDK
         member:,
         # The membership attached to this payment.
         membership:,
+        # The custom metadata stored on this payment. This will be copied the checkout
+        # configuration for which this payment was made
+        metadata:,
         # The datetime the payment was paid
         paid_at:,
         # The different types of payment methods that can be used.
         payment_method_type:,
         # The plan attached to this payment.
         plan:,
-        # The access pass attached to this payment.
+        # The product this payment was made for
         product:,
         # The promo code used for this payment.
         promo_code:,
@@ -290,6 +299,7 @@ module WhopSDK
             last_payment_attempt: T.nilable(Time),
             member: T.nilable(WhopSDK::Payment::Member),
             membership: T.nilable(WhopSDK::Payment::Membership),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             paid_at: T.nilable(Time),
             payment_method_type:
               T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
@@ -543,7 +553,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass attached to this payment.
+        # The product this payment was made for
         sig do
           params(id: String, route: String, title: String).returns(
             T.attached_class

data/rbi/whop_sdk/models/payment_list_response.rbi

@@ -109,6 +109,11 @@ module WhopSDK
       end
       attr_writer :membership
 
+      # The custom metadata stored on this payment. This will be copied the checkout
+      # configuration for which this payment was made
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The datetime the payment was paid
       sig { returns(T.nilable(Time)) }
       attr_accessor :paid_at
@@ -128,7 +133,7 @@ module WhopSDK
       end
       attr_writer :plan
 
-      # The access pass attached to this payment.
+      # The product this payment was made for
       sig { returns(T.nilable(WhopSDK::Models::PaymentListResponse::Product)) }
       attr_reader :product
 
@@ -233,6 +238,7 @@ module WhopSDK
             T.nilable(WhopSDK::Models::PaymentListResponse::Member::OrHash),
           membership:
             T.nilable(WhopSDK::Models::PaymentListResponse::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::PaymentListResponse::Plan::OrHash),
@@ -284,13 +290,16 @@ module WhopSDK
         member:,
         # The membership attached to this payment.
         membership:,
+        # The custom metadata stored on this payment. This will be copied the checkout
+        # configuration for which this payment was made
+        metadata:,
         # The datetime the payment was paid
         paid_at:,
         # The different types of payment methods that can be used.
         payment_method_type:,
         # The plan attached to this payment.
         plan:,
-        # The access pass attached to this payment.
+        # The product this payment was made for
         product:,
         # The promo code used for this payment.
         promo_code:,
@@ -343,6 +352,7 @@ module WhopSDK
             member: T.nilable(WhopSDK::Models::PaymentListResponse::Member),
             membership:
               T.nilable(WhopSDK::Models::PaymentListResponse::Membership),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             paid_at: T.nilable(Time),
             payment_method_type:
               T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
@@ -615,7 +625,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass attached to this payment.
+        # The product this payment was made for
         sig do
           params(id: String, route: String, title: String).returns(
             T.attached_class

data/rbi/whop_sdk/models/payment_method_types.rbi

@@ -100,10 +100,12 @@ module WhopSDK
         T.let(:id_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       DEMO_PAY = T.let(:demo_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       SHOP_PAY = T.let(:shop_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
-      APPLE = T.let(:apple, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       SEZZLE = T.let(:sezzle, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       COINBASE = T.let(:coinbase, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       SPLITIT = T.let(:splitit, WhopSDK::PaymentMethodTypes::TaggedSymbol)
+      PLATFORM_BALANCE =
+        T.let(:platform_balance, WhopSDK::PaymentMethodTypes::TaggedSymbol)
+      APPLE = T.let(:apple, WhopSDK::PaymentMethodTypes::TaggedSymbol)
       UNKNOWN = T.let(:unknown, WhopSDK::PaymentMethodTypes::TaggedSymbol)
 
       sig do

data/rbi/whop_sdk/models/plan.rbi

@@ -63,11 +63,23 @@ module WhopSDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :member_count
 
+      # The explicit payment method configuration for the plan, if any.
+      sig { returns(T.nilable(WhopSDK::Plan::PaymentMethodConfiguration)) }
+      attr_reader :payment_method_configuration
+
+      sig do
+        params(
+          payment_method_configuration:
+            T.nilable(WhopSDK::Plan::PaymentMethodConfiguration::OrHash)
+        ).void
+      end
+      attr_writer :payment_method_configuration
+
       # Indicates if the plan is a one time payment or recurring.
       sig { returns(WhopSDK::PlanType::TaggedSymbol) }
       attr_accessor :plan_type
 
-      # The access pass for the plan.
+      # The product that this plan belongs to.
       sig { returns(T.nilable(WhopSDK::Plan::Product)) }
       attr_reader :product
 
@@ -114,7 +126,9 @@ module WhopSDK
       sig { returns(WhopSDK::Visibility::TaggedSymbol) }
       attr_accessor :visibility
 
-      # An object representing a (sanitized) plan of an access pass.
+      # A plan for an product. Plans define the core parameters that define a checkout
+      # and payment on whop. Use plans to create different ways to price your products
+      # (Eg renewal / one_time)
       sig do
         params(
           id: String,
@@ -130,6 +144,8 @@ module WhopSDK
           internal_notes: T.nilable(String),
           invoice: T.nilable(WhopSDK::Plan::Invoice::OrHash),
           member_count: T.nilable(Integer),
+          payment_method_configuration:
+            T.nilable(WhopSDK::Plan::PaymentMethodConfiguration::OrHash),
           plan_type: WhopSDK::PlanType::OrSymbol,
           product: T.nilable(WhopSDK::Plan::Product::OrHash),
           purchase_url: String,
@@ -171,9 +187,11 @@ module WhopSDK
         invoice:,
         # The number of members for the plan.
         member_count:,
+        # The explicit payment method configuration for the plan, if any.
+        payment_method_configuration:,
         # Indicates if the plan is a one time payment or recurring.
         plan_type:,
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         product:,
         # The direct link to purchase the product.
         purchase_url:,
@@ -214,6 +232,8 @@ module WhopSDK
             internal_notes: T.nilable(String),
             invoice: T.nilable(WhopSDK::Plan::Invoice),
             member_count: T.nilable(Integer),
+            payment_method_configuration:
+              T.nilable(WhopSDK::Plan::PaymentMethodConfiguration),
             plan_type: WhopSDK::PlanType::TaggedSymbol,
             product: T.nilable(WhopSDK::Plan::Product),
             purchase_url: String,
@@ -357,6 +377,70 @@ module WhopSDK
         end
       end
 
+      class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Plan::PaymentMethodConfiguration,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # An array of payment method identifiers that are explicitly disabled. Only
+        # applies if the include_platform_defaults is true.
+        sig { returns(T::Array[WhopSDK::PaymentMethodTypes::TaggedSymbol]) }
+        attr_accessor :disabled
+
+        # An array of payment method identifiers that are explicitly enabled. This means
+        # these payment methods will be shown on checkout. Example use case is to only
+        # enable a specific payment method like cashapp, or extending the platform
+        # defaults with additional methods.
+        sig { returns(T::Array[WhopSDK::PaymentMethodTypes::TaggedSymbol]) }
+        attr_accessor :enabled
+
+        # Whether Whop's platform default payment method enablement settings are included
+        # in this configuration. The full list of default payment methods can be found in
+        # the documentation at docs.whop.com/payments.
+        sig { returns(T::Boolean) }
+        attr_accessor :include_platform_defaults
+
+        # The explicit payment method configuration for the plan, if any.
+        sig do
+          params(
+            disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
+            enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
+            include_platform_defaults: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of payment method identifiers that are explicitly disabled. Only
+          # applies if the include_platform_defaults is true.
+          disabled:,
+          # An array of payment method identifiers that are explicitly enabled. This means
+          # these payment methods will be shown on checkout. Example use case is to only
+          # enable a specific payment method like cashapp, or extending the platform
+          # defaults with additional methods.
+          enabled:,
+          # Whether Whop's platform default payment method enablement settings are included
+          # in this configuration. The full list of default payment methods can be found in
+          # the documentation at docs.whop.com/payments.
+          include_platform_defaults:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              disabled: T::Array[WhopSDK::PaymentMethodTypes::TaggedSymbol],
+              enabled: T::Array[WhopSDK::PaymentMethodTypes::TaggedSymbol],
+              include_platform_defaults: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class Product < WhopSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -371,7 +455,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         sig { params(id: String, title: String).returns(T.attached_class) }
         def self.new(
           # The internal ID of the public product.