whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/plan_create_params.rb

@@ -7,17 +7,12 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      # @!attribute company_id
-      #   The unique identifier of the company to create this plan for.
+      # @!attribute account_id
+      #   The unique identifier of the account to create this plan for. Defaults to the
+      #   caller's account.
       #
-      #   @return [String]
-      required :company_id, String
-
-      # @!attribute product_id
-      #   The unique identifier of the product to attach this plan to.
-      #
-      #   @return [String]
-      required :product_id, String
+      #   @return [String, nil]
+      optional :account_id, String
 
       # @!attribute adaptive_pricing_enabled
       #   Whether this plan accepts local currency payments via adaptive pricing.
@@ -26,27 +21,26 @@ module WhopSDK
       optional :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute billing_period
-      #   The number of days between recurring charges. For example, 30 for monthly or 365
-      #   for yearly.
+      #   Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
       #   @return [Integer, nil]
       optional :billing_period, Integer, nil?: true
 
       # @!attribute checkout_styling
-      #   Checkout styling overrides for this plan. Pass null to inherit from the company
-      #   default.
+      #   Checkout styling overrides for this plan.
       #
-      #   @return [WhopSDK::Models::PlanCreateParams::CheckoutStyling, nil]
-      optional :checkout_styling, -> { WhopSDK::PlanCreateParams::CheckoutStyling }, nil?: true
+      #   @return [Object, nil]
+      optional :checkout_styling, WhopSDK::Internal::Type::Unknown, nil?: true
 
       # @!attribute currency
-      #   The available currencies on the platform
+      #   The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      #   @return [Symbol, WhopSDK::Models::Currency, nil]
-      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+      #   @return [String, nil]
+      optional :currency, String
 
       # @!attribute custom_fields
       #   An array of custom field definitions to collect from customers at checkout.
+      #   Omitting this field clears existing custom fields.
       #
       #   @return [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil]
       optional :custom_fields,
@@ -60,8 +54,7 @@ module WhopSDK
       optional :description, String, nil?: true
 
       # @!attribute expiration_days
-      #   The number of days until the membership expires and access is revoked. Used for
-      #   expiration-based plans.
+      #   Access duration in days before the membership expires.
       #
       #   @return [Integer, nil]
       optional :expiration_days, Integer, nil?: true
@@ -73,15 +66,13 @@ module WhopSDK
       optional :image, -> { WhopSDK::PlanCreateParams::Image }, nil?: true
 
       # @!attribute initial_price
-      #   The amount charged on the first purchase. For one-time plans, this is the full
-      #   price. For recurring plans, this is an additional charge on top of the renewal
-      #   price. Provided in the plan's currency (e.g., 10.43 for $10.43).
+      #   Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
       #   @return [Float, nil]
       optional :initial_price, Float, nil?: true
 
       # @!attribute internal_notes
-      #   Private notes visible only to the business owner. Not shown to customers.
+      #   Private notes visible only to the account owner. Not shown to customers.
       #
       #   @return [String, nil]
       optional :internal_notes, String, nil?: true
@@ -92,16 +83,23 @@ module WhopSDK
       #   @return [Boolean, nil]
       optional :legacy_payment_method_controls, WhopSDK::Internal::Type::Boolean, nil?: true
 
+      # @!attribute metadata
+      #   Custom key-value pairs to store on the plan. Included in webhook payloads for
+      #   payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+      #   string value.
+      #
+      #   @return [Object, nil]
+      optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
+
       # @!attribute override_tax_type
-      #   Whether or not the tax is included in a plan's price (or if it hasn't been set
-      #   up)
+      #   Override the default tax classification for this specific plan.
       #
-      #   @return [Symbol, WhopSDK::Models::TaxType, nil]
-      optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
+      #   @return [String, nil]
+      optional :override_tax_type, String
 
       # @!attribute payment_method_configuration
       #   Explicit payment method configuration for the plan. When not provided, the
-      #   company's defaults apply.
+      #   account's defaults apply.
       #
       #   @return [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil]
       optional :payment_method_configuration,
@@ -109,26 +107,32 @@ module WhopSDK
                nil?: true
 
       # @!attribute plan_type
-      #   The type of plan that can be attached to a product
+      #   Plan billing type, such as `one_time` or `renewal`.
+      #
+      #   @return [String, nil]
+      optional :plan_type, String
+
+      # @!attribute product_id
+      #   The unique identifier of the product to attach this plan to.
       #
-      #   @return [Symbol, WhopSDK::Models::PlanType, nil]
-      optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
+      #   @return [String, nil]
+      optional :product_id, String
 
       # @!attribute release_method
-      #   The methods of how a plan can be released.
+      #   Sales method for this plan, such as `buy_now` or `waitlist`.
       #
-      #   @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
-      optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
+      #   @return [String, nil]
+      optional :release_method, String
 
       # @!attribute renewal_price
-      #   The amount charged each billing period for recurring plans. Provided in the
-      #   plan's currency (e.g., 10.43 for $10.43).
+      #   The amount charged each billing period for recurring plans, in the plan's
+      #   currency.
       #
       #   @return [Float, nil]
       optional :renewal_price, Float, nil?: true
 
       # @!attribute split_pay_required_payments
-      #   The number of installment payments required before the subscription pauses.
+      #   Installment payments required before the subscription pauses.
       #
       #   @return [Integer, nil]
       optional :split_pay_required_payments, Integer, nil?: true
@@ -140,6 +144,12 @@ module WhopSDK
       #   @return [Integer, nil]
       optional :stock, Integer, nil?: true
 
+      # @!attribute three_ds_level
+      #   3D Secure behavior for this plan. Send `null` to inherit the account default.
+      #
+      #   @return [Symbol, WhopSDK::Models::PlanCreateParams::ThreeDSLevel, nil]
+      optional :three_ds_level, enum: -> { WhopSDK::PlanCreateParams::ThreeDSLevel }
+
       # @!attribute title
       #   The display name of the plan shown to customers on the product page.
       #
@@ -147,147 +157,108 @@ module WhopSDK
       optional :title, String, nil?: true
 
       # @!attribute trial_period_days
-      #   The number of free trial days before the first charge on a recurring plan.
+      #   Free trial duration before the first recurring charge.
       #
       #   @return [Integer, nil]
       optional :trial_period_days, Integer, nil?: true
 
       # @!attribute unlimited_stock
       #   Whether the plan has unlimited stock. When true, the stock field is ignored.
-      #   Defaults to true.
       #
       #   @return [Boolean, nil]
       optional :unlimited_stock, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute visibility
-      #   Visibility of a resource
+      #   Whether the plan is visible to customers or hidden from public view.
       #
-      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
-      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+      #   @return [String, nil]
+      optional :visibility, String
 
-      # @!method initialize(company_id:, product_id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
+      # @!method initialize(account_id: nil, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, metadata: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product_id: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PlanCreateParams} for more details.
       #
-      #   @param company_id [String] The unique identifier of the company to create this plan for.
-      #
-      #   @param product_id [String] The unique identifier of the product to attach this plan to.
+      #   @param account_id [String] The unique identifier of the account to create this plan for. Defaults to the ca
       #
       #   @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
       #
-      #   @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
+      #   @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
-      #   @param checkout_styling [WhopSDK::Models::PlanCreateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to inherit from the company
+      #   @param checkout_styling [Object, nil] Checkout styling overrides for this plan.
       #
-      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #   @param currency [String] The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      #   @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout.
+      #   @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout. Omit
       #
       #   @param description [String, nil] A text description of the plan displayed to customers on the product page.
       #
-      #   @param expiration_days [Integer, nil] The number of days until the membership expires and access is revoked. Used for
+      #   @param expiration_days [Integer, nil] Access duration in days before the membership expires.
       #
       #   @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image displayed on the product page to represent this plan.
       #
-      #   @param initial_price [Float, nil] The amount charged on the first purchase. For one-time plans, this is the full p
+      #   @param initial_price [Float, nil] Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
-      #   @param internal_notes [String, nil] Private notes visible only to the business owner. Not shown to customers.
+      #   @param internal_notes [String, nil] Private notes visible only to the account owner. Not shown to customers.
       #
       #   @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
       #
-      #   @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      #   @param metadata [Object, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
+      #
+      #   @param override_tax_type [String] Override the default tax classification for this specific plan.
       #
-      #   @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the compa
+      #   @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the accou
       #
-      #   @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
+      #   @param plan_type [String] Plan billing type, such as `one_time` or `renewal`.
+      #
+      #   @param product_id [String] The unique identifier of the product to attach this plan to.
       #
-      #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
+      #   @param release_method [String] Sales method for this plan, such as `buy_now` or `waitlist`.
       #
-      #   @param renewal_price [Float, nil] The amount charged each billing period for recurring plans. Provided in the plan
+      #   @param renewal_price [Float, nil] The amount charged each billing period for recurring plans, in the plan's curren
       #
-      #   @param split_pay_required_payments [Integer, nil] The number of installment payments required before the subscription pauses.
+      #   @param split_pay_required_payments [Integer, nil] Installment payments required before the subscription pauses.
       #
       #   @param stock [Integer, nil] The maximum number of units available for purchase. Ignored when unlimited_stock
       #
+      #   @param three_ds_level [Symbol, WhopSDK::Models::PlanCreateParams::ThreeDSLevel] 3D Secure behavior for this plan. Send `null` to inherit the account default.
+      #
       #   @param title [String, nil] The display name of the plan shown to customers on the product page.
       #
-      #   @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
+      #   @param trial_period_days [Integer, nil] Free trial duration before the first recurring charge.
       #
-      #   @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored. Def
+      #   @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored.
       #
-      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #   @param visibility [String] Whether the plan is visible to customers or hidden from public view.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
-        # @!attribute background_color
-        #   A hex color code for the checkout page background, applied to the order summary
-        #   panel (e.g. #F4F4F5).
-        #
-        #   @return [String, nil]
-        optional :background_color, String, nil?: true
-
-        # @!attribute border_style
-        #   The different border-radius styles available for checkout pages.
-        #
-        #   @return [Symbol, WhopSDK::Models::CheckoutShape, nil]
-        optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true
-
-        # @!attribute button_color
-        #   A hex color code for the button color (e.g. #FF5733).
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the custom field (if being updated).
         #
         #   @return [String, nil]
-        optional :button_color, String, nil?: true
-
-        # @!attribute font_family
-        #   The different font families available for checkout pages.
-        #
-        #   @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
-        optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
-
-        # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::PlanCreateParams::CheckoutStyling} for more details.
-        #
-        #   Checkout styling overrides for this plan. Pass null to inherit from the company
-        #   default.
-        #
-        #   @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
-        #
-        #   @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
-        #
-        #   @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
-        #
-        #   @param font_family [Symbol, WhopSDK::Models::CheckoutFont, nil] The different font families available for checkout pages.
-      end
+        optional :id, String
 
-      class CustomField < WhopSDK::Internal::Type::BaseModel
         # @!attribute field_type
         #   The type of the custom field.
         #
-        #   @return [Symbol, :text]
-        required :field_type, const: :text
+        #   @return [Symbol, WhopSDK::Models::PlanCreateParams::CustomField::FieldType, nil]
+        optional :field_type, enum: -> { WhopSDK::PlanCreateParams::CustomField::FieldType }
 
         # @!attribute name
         #   The name of the custom field.
         #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute id
-        #   The ID of the custom field (if being updated)
-        #
         #   @return [String, nil]
-        optional :id, String, nil?: true
+        optional :name, String
 
         # @!attribute order
         #   The order of the field.
         #
         #   @return [Integer, nil]
-        optional :order, Integer, nil?: true
+        optional :order, Integer
 
         # @!attribute placeholder
-        #   The placeholder value of the field.
+        #   An example response displayed in the input field.
         #
         #   @return [String, nil]
         optional :placeholder, String, nil?: true
@@ -296,73 +267,86 @@ module WhopSDK
         #   Whether or not the field is required.
         #
         #   @return [Boolean, nil]
-        optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
+        optional :required, WhopSDK::Internal::Type::Boolean
 
-        # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
-        #   @param name [String] The name of the custom field.
+        # @!method initialize(id: nil, field_type: nil, name: nil, order: nil, placeholder: nil, required: nil)
+        #   @param id [String] The ID of the custom field (if being updated).
         #
-        #   @param id [String, nil] The ID of the custom field (if being updated)
+        #   @param field_type [Symbol, WhopSDK::Models::PlanCreateParams::CustomField::FieldType] The type of the custom field.
         #
-        #   @param order [Integer, nil] The order of the field.
+        #   @param name [String] The name of the custom field.
         #
-        #   @param placeholder [String, nil] The placeholder value of the field.
+        #   @param order [Integer] The order of the field.
         #
-        #   @param required [Boolean, nil] Whether or not the field is required.
+        #   @param placeholder [String, nil] An example response displayed in the input field.
         #
-        #   @param field_type [Symbol, :text] The type of the custom field.
+        #   @param required [Boolean] Whether or not the field is required.
+
+        # The type of the custom field.
+        #
+        # @see WhopSDK::Models::PlanCreateParams::CustomField#field_type
+        module FieldType
+          extend WhopSDK::Internal::Type::Enum
+
+          TEXT = :text
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       class Image < WhopSDK::Internal::Type::BaseModel
         # @!attribute id
-        #   The ID of an existing file object.
         #
-        #   @return [String]
-        required :id, String
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute direct_upload_id
+        #
+        #   @return [String, nil]
+        optional :direct_upload_id, String
 
-        # @!method initialize(id:)
+        # @!method initialize(id: nil, direct_upload_id: nil)
         #   An image displayed on the product page to represent this plan.
         #
-        #   @param id [String] The ID of an existing file object.
+        #   @param id [String]
+        #   @param direct_upload_id [String]
       end
 
       class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
         # @!attribute disabled
-        #   An array of payment method identifiers that are explicitly disabled. Only
-        #   applies if the include_platform_defaults is true.
         #
-        #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
-        required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+        #   @return [Array<String>, nil]
+        optional :disabled, WhopSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute enabled
-        #   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.
         #
-        #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
-        required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+        #   @return [Array<String>, nil]
+        optional :enabled, WhopSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute include_platform_defaults
-        #   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.
         #
         #   @return [Boolean, nil]
-        optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
+        optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean
 
-        # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration} for more
-        #   details.
-        #
+        # @!method initialize(disabled: nil, enabled: nil, include_platform_defaults: nil)
         #   Explicit payment method configuration for the plan. When not provided, the
-        #   company's defaults apply.
-        #
-        #   @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
+        #   account's defaults apply.
         #
-        #   @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
-        #
-        #   @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
+        #   @param disabled [Array<String>]
+        #   @param enabled [Array<String>]
+        #   @param include_platform_defaults [Boolean]
+      end
+
+      # 3D Secure behavior for this plan. Send `null` to inherit the account default.
+      module ThreeDSLevel
+        extend WhopSDK::Internal::Type::Enum
+
+        MANDATE_CHALLENGE = :mandate_challenge
+        FRICTIONLESS = :frictionless
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end