whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/models/plan_create_params.rbi

@@ -42,13 +42,17 @@ module WhopSDK
       attr_accessor :expiration_days
 
       # An image for the plan. This will be visible on the product page to customers.
-      sig { returns(T.nilable(WhopSDK::PlanCreateParams::Image)) }
-      attr_reader :image
-
       sig do
-        params(image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash)).void
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID,
+              WhopSDK::PlanCreateParams::Image::AttachmentInputWithID
+            )
+          )
+        )
       end
-      attr_writer :image
+      attr_accessor :image
 
       # An additional amount charged upon first purchase. Use only if a one time payment
       # OR you want to charge an additional amount on top of the renewal price. Provided
@@ -65,7 +69,26 @@ module WhopSDK
       sig { returns(T.nilable(WhopSDK::TaxType::OrSymbol)) }
       attr_accessor :override_tax_type
 
-      # The type of plan that can be attached to an access pass
+      # The explicit payment method configuration for the plan. If not provided, the
+      # platform or company's defaults will apply.
+      sig do
+        returns(
+          T.nilable(WhopSDK::PlanCreateParams::PaymentMethodConfiguration)
+        )
+      end
+      attr_reader :payment_method_configuration
+
+      sig do
+        params(
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanCreateParams::PaymentMethodConfiguration::OrHash
+            )
+        ).void
+      end
+      attr_writer :payment_method_configuration
+
+      # The type of plan that can be attached to a product
       sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
       attr_accessor :plan_type
 
@@ -118,10 +141,20 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanCreateParams::PaymentMethodConfiguration::OrHash
+            ),
           plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
           release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
           renewal_price: T.nilable(Float),
@@ -161,7 +194,10 @@ module WhopSDK
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
-        # The type of plan that can be attached to an access pass
+        # The explicit payment method configuration for the plan. If not provided, the
+        # platform or company's defaults will apply.
+        payment_method_configuration: nil,
+        # The type of plan that can be attached to a product
         plan_type: nil,
         # The methods of how a plan can be released.
         release_method: nil,
@@ -199,10 +235,18 @@ module WhopSDK
               T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField]),
             description: T.nilable(String),
             expiration_days: T.nilable(Integer),
-            image: T.nilable(WhopSDK::PlanCreateParams::Image),
+            image:
+              T.nilable(
+                T.any(
+                  WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID,
+                  WhopSDK::PlanCreateParams::Image::AttachmentInputWithID
+                )
+              ),
             initial_price: T.nilable(Float),
             internal_notes: T.nilable(String),
             override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+            payment_method_configuration:
+              T.nilable(WhopSDK::PlanCreateParams::PaymentMethodConfiguration),
             plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
             release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
             renewal_price: T.nilable(Float),
@@ -295,46 +339,144 @@ module WhopSDK
         end
       end
 
-      class Image < WhopSDK::Internal::Type::BaseModel
-        OrHash =
+      # An image for the plan. This will be visible on the product page to customers.
+      module Image
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
           T.type_alias do
-            T.any(WhopSDK::PlanCreateParams::Image, WhopSDK::Internal::AnyHash)
+            T.any(
+              WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID,
+              WhopSDK::PlanCreateParams::Image::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::PlanCreateParams::Image::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 { 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
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::PlanCreateParams::Image::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.
+          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
 
-        # An image for the plan. This will be visible on the product page to customers.
+        sig do
+          override.returns(T::Array[WhopSDK::PlanCreateParams::Image::Variants])
+        end
+        def self.variants
+        end
+      end
+
+      class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::PlanCreateParams::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::OrSymbol]) }
+        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::OrSymbol]) }
+        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 not provided, the
+        # platform or company's defaults will apply.
         sig do
           params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
+            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(
-          # 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
+          # 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(
-            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+            {
+              disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
+              enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
+              include_platform_defaults: T::Boolean
+            }
           )
         end
         def to_hash

data/rbi/whop_sdk/models/plan_list_response.rbi

@@ -66,11 +66,31 @@ module WhopSDK
       sig { returns(T.nilable(Integer)) }
       attr_accessor :member_count
 
+      # The explicit payment method configuration for the plan, if any.
+      sig do
+        returns(
+          T.nilable(
+            WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration
+          )
+        )
+      end
+      attr_reader :payment_method_configuration
+
+      sig do
+        params(
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::Models::PlanListResponse::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::Models::PlanListResponse::Product)) }
       attr_reader :product
 
@@ -117,7 +137,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,
@@ -133,6 +155,10 @@ module WhopSDK
           invoice:
             T.nilable(WhopSDK::Models::PlanListResponse::Invoice::OrHash),
           member_count: T.nilable(Integer),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration::OrHash
+            ),
           plan_type: WhopSDK::PlanType::OrSymbol,
           product:
             T.nilable(WhopSDK::Models::PlanListResponse::Product::OrHash),
@@ -170,9 +196,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:,
@@ -209,6 +237,10 @@ module WhopSDK
             internal_notes: T.nilable(String),
             invoice: T.nilable(WhopSDK::Models::PlanListResponse::Invoice),
             member_count: T.nilable(Integer),
+            payment_method_configuration:
+              T.nilable(
+                WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration
+              ),
             plan_type: WhopSDK::PlanType::TaggedSymbol,
             product: T.nilable(WhopSDK::Models::PlanListResponse::Product),
             purchase_url: String,
@@ -284,6 +316,70 @@ module WhopSDK
         end
       end
 
+      class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PlanListResponse::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
@@ -301,7 +397,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.

data/rbi/whop_sdk/models/plan_type.rbi

@@ -2,7 +2,7 @@
 
 module WhopSDK
   module Models
-    # The type of plan that can be attached to an access pass
+    # The type of plan that can be attached to a product
     module PlanType
       extend WhopSDK::Internal::Type::Enum