whop_sdk 0.0.3 → 0.0.4

data/rbi/whop_sdk/models/plan_update_params.rbi

@@ -34,13 +34,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::PlanUpdateParams::Image)) }
-      attr_reader :image
-
       sig do
-        params(image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash)).void
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID,
+              WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID
+            )
+          )
+        )
       end
-      attr_writer :image
+      attr_accessor :image
 
       # An additional amount charged upon first purchase.
       sig { returns(T.nilable(Float)) }
@@ -59,6 +63,25 @@ module WhopSDK
       sig { returns(T.nilable(WhopSDK::TaxType::OrSymbol)) }
       attr_accessor :override_tax_type
 
+      # The explicit payment method configuration for the plan. If sent as null, the
+      # custom configuration will be removed.
+      sig do
+        returns(
+          T.nilable(WhopSDK::PlanUpdateParams::PaymentMethodConfiguration)
+        )
+      end
+      attr_reader :payment_method_configuration
+
+      sig do
+        params(
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanUpdateParams::PaymentMethodConfiguration::OrHash
+            )
+        ).void
+      end
+      attr_writer :payment_method_configuration
+
       # The amount the customer is charged every billing period.
       sig { returns(T.nilable(Float)) }
       attr_accessor :renewal_price
@@ -101,11 +124,21 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           offer_cancel_discount: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanUpdateParams::PaymentMethodConfiguration::OrHash
+            ),
           renewal_price: T.nilable(Float),
           stock: T.nilable(Integer),
           strike_through_initial_price: T.nilable(Float),
@@ -139,6 +172,9 @@ 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 explicit payment method configuration for the plan. If sent as null, the
+        # custom configuration will be removed.
+        payment_method_configuration: nil,
         # The amount the customer is charged every billing period.
         renewal_price: nil,
         # The number of units available for purchase.
@@ -170,11 +206,19 @@ module WhopSDK
               T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField]),
             description: T.nilable(String),
             expiration_days: T.nilable(Integer),
-            image: T.nilable(WhopSDK::PlanUpdateParams::Image),
+            image:
+              T.nilable(
+                T.any(
+                  WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID,
+                  WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID
+                )
+              ),
             initial_price: T.nilable(Float),
             internal_notes: T.nilable(String),
             offer_cancel_discount: T.nilable(T::Boolean),
             override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+            payment_method_configuration:
+              T.nilable(WhopSDK::PlanUpdateParams::PaymentMethodConfiguration),
             renewal_price: T.nilable(Float),
             stock: T.nilable(Integer),
             strike_through_initial_price: T.nilable(Float),
@@ -265,46 +309,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::PlanUpdateParams::Image, WhopSDK::Internal::AnyHash)
+            T.any(
+              WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID,
+              WhopSDK::PlanUpdateParams::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::PlanUpdateParams::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::PlanUpdateParams::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::PlanUpdateParams::Image::Variants])
+        end
+        def self.variants
+        end
+      end
+
+      class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::PlanUpdateParams::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 sent as null, the
+        # custom configuration will be removed.
         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/product_update_params.rbi

@@ -12,16 +12,17 @@ module WhopSDK
         end
 
       # A banner image for the product in png, jpeg format
-      sig { returns(T.nilable(WhopSDK::ProductUpdateParams::BannerImage)) }
-      attr_reader :banner_image
-
       sig do
-        params(
-          banner_image:
-            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash)
-        ).void
+        returns(
+          T.nilable(
+            T.any(
+              WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID,
+              WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithID
+            )
+          )
+        )
       end
-      attr_writer :banner_image
+      attr_accessor :banner_image
 
       # The different business types a company can be.
       sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
@@ -108,7 +109,12 @@ module WhopSDK
       sig do
         params(
           banner_image:
-            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash),
+            T.nilable(
+              T.any(
+                WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithID::OrHash
+              )
+            ),
           business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
           collect_shipping_address: T.nilable(T::Boolean),
           custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -181,7 +187,13 @@ module WhopSDK
       sig do
         override.returns(
           {
-            banner_image: T.nilable(WhopSDK::ProductUpdateParams::BannerImage),
+            banner_image:
+              T.nilable(
+                T.any(
+                  WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID,
+                  WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithID
+                )
+              ),
             business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
             collect_shipping_address: T.nilable(T::Boolean),
             custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -210,52 +222,84 @@ module WhopSDK
       def to_hash
       end
 
-      class BannerImage < WhopSDK::Internal::Type::BaseModel
-        OrHash =
+      # A banner image for the product in png, jpeg format
+      module BannerImage
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
           T.type_alias do
             T.any(
-              WhopSDK::ProductUpdateParams::BannerImage,
-              WhopSDK::Internal::AnyHash
+              WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID,
+              WhopSDK::ProductUpdateParams::BannerImage::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::ProductUpdateParams::BannerImage::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
 
-        # A banner image for the product in png, jpeg format
-        sig do
-          params(
-            id: T.nilable(String),
-            direct_upload_id: T.nilable(String)
-          ).returns(T.attached_class)
+          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::ProductUpdateParams::BannerImage::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::ProductUpdateParams::BannerImage::Variants]
           )
         end
-        def to_hash
+        def self.variants
         end
       end
 

data/rbi/whop_sdk/models/transfer.rbi

@@ -34,6 +34,10 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :fee_amount
 
+      # A hash of metadata attached to the transfer
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The notes of the credit transaction transfer
       sig { returns(T.nilable(String)) }
       attr_accessor :notes
@@ -62,6 +66,7 @@ module WhopSDK
             ),
           destination_ledger_account_id: String,
           fee_amount: T.nilable(Float),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
           origin:
             T.nilable(
@@ -88,6 +93,8 @@ module WhopSDK
         destination_ledger_account_id:,
         # The decimal fee of the credit transaction transfer
         fee_amount:,
+        # A hash of metadata attached to the transfer
+        metadata:,
         # The notes of the credit transaction transfer
         notes:,
         # The sender of the credit transaction transfer
@@ -107,6 +114,7 @@ module WhopSDK
             destination: T.nilable(WhopSDK::Transfer::Destination::Variants),
             destination_ledger_account_id: String,
             fee_amount: T.nilable(Float),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             notes: T.nilable(String),
             origin: T.nilable(WhopSDK::Transfer::Origin::Variants),
             origin_ledger_account_id: String

data/rbi/whop_sdk/models/transfer_create_params.rbi

@@ -33,6 +33,10 @@ module WhopSDK
       sig { returns(T.nilable(String)) }
       attr_accessor :idempotence_key
 
+      # A hash of metadata to attach to the transfer.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # Notes for the transfer. Maximum of 50 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :notes
@@ -44,6 +48,7 @@ module WhopSDK
           destination_id: String,
           origin_id: String,
           idempotence_key: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -61,6 +66,8 @@ module WhopSDK
         origin_id:,
         # A unique key to ensure idempotence. Use a UUID or similar.
         idempotence_key: nil,
+        # A hash of metadata to attach to the transfer.
+        metadata: nil,
         # Notes for the transfer. Maximum of 50 characters.
         notes: nil,
         request_options: {}
@@ -75,6 +82,7 @@ module WhopSDK
             destination_id: String,
             origin_id: String,
             idempotence_key: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             notes: T.nilable(String),
             request_options: WhopSDK::RequestOptions
           }

data/rbi/whop_sdk/models/transfer_list_response.rbi

@@ -35,6 +35,10 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :fee_amount
 
+      # A hash of metadata attached to the transfer
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
       # The notes of the credit transaction transfer
       sig { returns(T.nilable(String)) }
       attr_accessor :notes
@@ -52,6 +56,7 @@ module WhopSDK
           currency: WhopSDK::Currency::OrSymbol,
           destination_ledger_account_id: String,
           fee_amount: T.nilable(Float),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
           origin_ledger_account_id: String
         ).returns(T.attached_class)
@@ -69,6 +74,8 @@ module WhopSDK
         destination_ledger_account_id:,
         # The decimal fee of the credit transaction transfer
         fee_amount:,
+        # A hash of metadata attached to the transfer
+        metadata:,
         # The notes of the credit transaction transfer
         notes:,
         # The ID of the origin ledger account
@@ -85,6 +92,7 @@ module WhopSDK
             currency: WhopSDK::Currency::TaggedSymbol,
             destination_ledger_account_id: String,
             fee_amount: T.nilable(Float),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
             notes: T.nilable(String),
             origin_ledger_account_id: String
           }

data/rbi/whop_sdk/models.rbi

@@ -70,6 +70,10 @@ module WhopSDK
 
   Company = WhopSDK::Models::Company
 
+  CompanyCreateParams = WhopSDK::Models::CompanyCreateParams
+
+  CompanyListParams = WhopSDK::Models::CompanyListParams
+
   CompanyRetrieveParams = WhopSDK::Models::CompanyRetrieveParams
 
   Course = WhopSDK::Models::Course
@@ -118,6 +122,10 @@ module WhopSDK
 
   CourseRetrieveParams = WhopSDK::Models::CourseRetrieveParams
 
+  CourseStudentListParams = WhopSDK::Models::CourseStudentListParams
+
+  CourseStudentRetrieveParams = WhopSDK::Models::CourseStudentRetrieveParams
+
   CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
 
   Currency = WhopSDK::Models::Currency

data/rbi/whop_sdk/resources/app_builds.rbi

@@ -10,7 +10,11 @@ module WhopSDK
       # - `developer:manage_builds`
       sig do
         params(
-          attachment: WhopSDK::AppBuildCreateParams::Attachment::OrHash,
+          attachment:
+            T.any(
+              WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+              WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithID::OrHash
+            ),
           checksum: String,
           platform: WhopSDK::AppBuildPlatforms::OrSymbol,
           app_id: T.nilable(String),

data/rbi/whop_sdk/resources/apps.rbi

@@ -57,7 +57,13 @@ module WhopSDK
           description: T.nilable(String),
           discover_path: T.nilable(String),
           experience_path: T.nilable(String),
-          icon: T.nilable(WhopSDK::AppUpdateParams::Icon::OrHash),
+          icon:
+            T.nilable(
+              T.any(
+                WhopSDK::AppUpdateParams::Icon::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::AppUpdateParams::Icon::AttachmentInputWithID::OrHash
+              )
+            ),
           name: T.nilable(String),
           required_scopes:
             T.nilable(

data/rbi/whop_sdk/resources/checkout_configurations.rbi

@@ -13,24 +13,23 @@ module WhopSDK
       # - `access_pass:update`
       sig do
         params(
+          plan: WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash,
+          plan_id: String,
           affiliate_code: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
-          plan:
-            T.nilable(WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash),
-          plan_id: T.nilable(String),
           redirect_url: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::CheckoutConfiguration)
       end
       def create(
+        # Pass this object to create a new plan for this checkout configuration
+        plan:,
+        # The ID of the plan to use for the checkout configuration
+        plan_id:,
         # The affiliate code to use for the checkout configuration
         affiliate_code: nil,
         # The metadata to use for the checkout configuration
         metadata: nil,
-        # Pass this object to create a new plan for this checkout configuration
-        plan: nil,
-        # The ID of the plan to use for the checkout configuration
-        plan_id: nil,
         # The URL to redirect the user to after the checkout configuration is created
         redirect_url: nil,
         request_options: {}