whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/checkout_configuration_create_response.rb

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#create
+    class CheckoutConfigurationCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Checkout configuration ID, prefixed `ch_`.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_id
+      #   Account ID, prefixed `biz_`.
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute created_at
+      #   When the checkout configuration was created, as an ISO 8601 timestamp.
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute mode
+      #   Checkout mode: `payment` collects payment now; `setup` saves payment details for
+      #   later.
+      #
+      #   @return [Symbol, WhopSDK::Models::CheckoutConfigurationCreateResponse::Mode]
+      required :mode, enum: -> { WhopSDK::Models::CheckoutConfigurationCreateResponse::Mode }
+
+      # @!attribute updated_at
+      #   When the checkout configuration was last updated, as an ISO 8601 timestamp.
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute affiliate_code
+      #   Affiliate code applied at checkout, or `null` when none is set.
+      #
+      #   @return [String, nil]
+      optional :affiliate_code, String, nil?: true
+
+      # @!attribute currency
+      #   Currency used for setup-mode payment method availability; defaults to `usd` when
+      #   omitted.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute metadata
+      #   Custom key-value metadata copied to payments and memberships. `null` without the
+      #   `checkout_configuration:basic:read` scope.
+      #
+      #   @return [Object, nil]
+      optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
+
+      # @!attribute payment_method_configuration
+      #   Payment method overrides for this checkout. `null` when it uses the plan or
+      #   platform defaults.
+      #
+      #   @return [WhopSDK::Models::CheckoutConfigurationCreateResponse::PaymentMethodConfiguration, nil]
+      optional :payment_method_configuration,
+               -> { WhopSDK::Models::CheckoutConfigurationCreateResponse::PaymentMethodConfiguration },
+               nil?: true
+
+      # @!attribute plan
+      #   Plan used for payment checkout. `null` in setup mode.
+      #
+      #   @return [WhopSDK::Models::CheckoutConfigurationCreateResponse::Plan, nil]
+      optional :plan, -> { WhopSDK::Models::CheckoutConfigurationCreateResponse::Plan }, nil?: true
+
+      # @!attribute purchase_url
+      #   Checkout URL you can send to customers.
+      #
+      #   @return [String, nil]
+      optional :purchase_url, String, nil?: true
+
+      # @!attribute redirect_url
+      #   URL customers are sent to after checkout, or `null` when no redirect is
+      #   configured.
+      #
+      #   @return [String, nil]
+      optional :redirect_url, String, nil?: true
+
+      # @!attribute three_ds_level
+      #   3D Secure behavior for this checkout, or `null` to use the account default.
+      #
+      #   @return [String, nil]
+      optional :three_ds_level, String, nil?: true
+
+      # @!method initialize(id:, company_id:, created_at:, mode:, updated_at:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, plan: nil, purchase_url: nil, redirect_url: nil, three_ds_level: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CheckoutConfigurationCreateResponse} for more details.
+      #
+      #   @param id [String] Checkout configuration ID, prefixed `ch_`.
+      #
+      #   @param company_id [String] Account ID, prefixed `biz_`.
+      #
+      #   @param created_at [String] When the checkout configuration was created, as an ISO 8601 timestamp.
+      #
+      #   @param mode [Symbol, WhopSDK::Models::CheckoutConfigurationCreateResponse::Mode] Checkout mode: `payment` collects payment now; `setup` saves payment details for
+      #
+      #   @param updated_at [String] When the checkout configuration was last updated, as an ISO 8601 timestamp.
+      #
+      #   @param affiliate_code [String, nil] Affiliate code applied at checkout, or `null` when none is set.
+      #
+      #   @param currency [String, nil] Currency used for setup-mode payment method availability; defaults to `usd` when
+      #
+      #   @param metadata [Object, nil] Custom key-value metadata copied to payments and memberships. `null` without the
+      #
+      #   @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateResponse::PaymentMethodConfiguration, nil] Payment method overrides for this checkout. `null` when it uses the plan or plat
+      #
+      #   @param plan [WhopSDK::Models::CheckoutConfigurationCreateResponse::Plan, nil] Plan used for payment checkout. `null` in setup mode.
+      #
+      #   @param purchase_url [String, nil] Checkout URL you can send to customers.
+      #
+      #   @param redirect_url [String, nil] URL customers are sent to after checkout, or `null` when no redirect is configur
+      #
+      #   @param three_ds_level [String, nil] 3D Secure behavior for this checkout, or `null` to use the account default.
+
+      # Checkout mode: `payment` collects payment now; `setup` saves payment details for
+      # later.
+      #
+      # @see WhopSDK::Models::CheckoutConfigurationCreateResponse#mode
+      module Mode
+        extend WhopSDK::Internal::Type::Enum
+
+        PAYMENT = :payment
+        SETUP = :setup
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::CheckoutConfigurationCreateResponse#payment_method_configuration
+      class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+        # @!attribute disabled
+        #   Payment methods explicitly disabled for checkout.
+        #
+        #   @return [Array<String>, nil]
+        optional :disabled, WhopSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute enabled
+        #   Payment methods explicitly enabled for checkout.
+        #
+        #   @return [Array<String>, nil]
+        optional :enabled, WhopSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute include_platform_defaults
+        #   Whether platform default payment methods are included.
+        #
+        #   @return [Boolean, nil]
+        optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean
+
+        # @!method initialize(disabled: nil, enabled: nil, include_platform_defaults: nil)
+        #   Payment method overrides for this checkout. `null` when it uses the plan or
+        #   platform defaults.
+        #
+        #   @param disabled [Array<String>] Payment methods explicitly disabled for checkout.
+        #
+        #   @param enabled [Array<String>] Payment methods explicitly enabled for checkout.
+        #
+        #   @param include_platform_defaults [Boolean] Whether platform default payment methods are included.
+      end
+
+      # @see WhopSDK::Models::CheckoutConfigurationCreateResponse#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   Plan ID, prefixed `plan_`.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute adaptive_pricing_enabled
+        #   Whether this plan accepts local currency payments via adaptive pricing.
+        #
+        #   @return [Boolean]
+        required :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute billing_period
+        #   Recurring billing interval in days, such as 30 for monthly or 365 for annual.
+        #   `null` for one-time plans.
+        #
+        #   @return [Integer, nil]
+        required :billing_period, Integer, nil?: true
+
+        # @!attribute currency
+        #   Three-letter ISO currency code for the plan's prices.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute expiration_days
+        #   Access duration in days for expiration-based plans.
+        #
+        #   @return [Integer, nil]
+        required :expiration_days, Integer, nil?: true
+
+        # @!attribute initial_price
+        #   Initial purchase price in the plan currency.
+        #
+        #   @return [Float]
+        required :initial_price, Float
+
+        # @!attribute plan_type
+        #   Billing model for the plan: `renewal` (recurring) or `one_time` (single
+        #   payment).
+        #
+        #   @return [String]
+        required :plan_type, String
+
+        # @!attribute release_method
+        #   Sales method for the plan, such as `buy_now` or `waitlist`.
+        #
+        #   @return [String]
+        required :release_method, String
+
+        # @!attribute renewal_price
+        #   Recurring price charged each billing period.
+        #
+        #   @return [Float]
+        required :renewal_price, Float
+
+        # @!attribute three_ds_level
+        #   3D Secure behavior for this plan, or `null` to use the account default.
+        #
+        #   @return [String, nil]
+        required :three_ds_level, String, nil?: true
+
+        # @!attribute trial_period_days
+        #   Free trial days before the first renewal charge.
+        #
+        #   @return [Integer, nil]
+        required :trial_period_days, Integer, nil?: true
+
+        # @!attribute visibility
+        #   Whether the plan is visible to customers or hidden from public view.
+        #
+        #   @return [String]
+        required :visibility, String
+
+        # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, three_ds_level:, trial_period_days:, visibility:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::CheckoutConfigurationCreateResponse::Plan} for more details.
+        #
+        #   Plan used for payment checkout. `null` in setup mode.
+        #
+        #   @param id [String] Plan ID, prefixed `plan_`.
+        #
+        #   @param adaptive_pricing_enabled [Boolean] Whether this plan accepts local currency payments via adaptive pricing.
+        #
+        #   @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual. `n
+        #
+        #   @param currency [String] Three-letter ISO currency code for the plan's prices.
+        #
+        #   @param expiration_days [Integer, nil] Access duration in days for expiration-based plans.
+        #
+        #   @param initial_price [Float] Initial purchase price in the plan currency.
+        #
+        #   @param plan_type [String] Billing model for the plan: `renewal` (recurring) or `one_time` (single payment)
+        #
+        #   @param release_method [String] Sales method for the plan, such as `buy_now` or `waitlist`.
+        #
+        #   @param renewal_price [Float] Recurring price charged each billing period.
+        #
+        #   @param three_ds_level [String, nil] 3D Secure behavior for this plan, or `null` to use the account default.
+        #
+        #   @param trial_period_days [Integer, nil] Free trial days before the first renewal charge.
+        #
+        #   @param visibility [String] Whether the plan is visible to customers or hidden from public view.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CheckoutConfigurations#delete
+    class CheckoutConfigurationDeleteParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/checkout_configuration_list_params.rb

@@ -8,83 +8,92 @@ module WhopSDK
       include WhopSDK::Internal::Type::RequestParameters
 
       # @!attribute company_id
-      #   The unique identifier of the company to list checkout configurations for.
+      #   Account ID, prefixed `biz_`.
       #
       #   @return [String]
       required :company_id, String
 
       # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      #   Cursor for the next page of results.
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
-
-      # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
-      #
-      #   @return [String, nil]
-      optional :before, String, nil?: true
+      optional :after, String
 
       # @!attribute created_after
-      #   Only return checkout configurations created after this timestamp.
+      #   Only return checkout configurations created after this Unix timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_after, Time, nil?: true
+      #   @return [Integer, nil]
+      optional :created_after, Integer
 
       # @!attribute created_before
-      #   Only return checkout configurations created before this timestamp.
+      #   Only return checkout configurations created before this Unix timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_before, Time, nil?: true
+      #   @return [Integer, nil]
+      optional :created_before, Integer
 
       # @!attribute direction
-      #   The direction of the sort.
+      #   Sort direction. Defaults to `desc`.
       #
-      #   @return [Symbol, WhopSDK::Models::Direction, nil]
-      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::CheckoutConfigurationListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::CheckoutConfigurationListParams::Direction }
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   Number of checkout configurations to return.
       #
       #   @return [Integer, nil]
-      optional :first, Integer, nil?: true
+      optional :first, Integer
 
-      # @!attribute last
-      #   Returns the last _n_ elements from the list.
+      # @!attribute order
+      #   Field used to sort checkout configurations.
       #
-      #   @return [Integer, nil]
-      optional :last, Integer, nil?: true
+      #   @return [Symbol, WhopSDK::Models::CheckoutConfigurationListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::CheckoutConfigurationListParams::Order }
 
       # @!attribute plan_id
-      #   Filter checkout configurations to only those associated with this plan
-      #   identifier.
+      #   Only return checkout configurations for this plan ID, prefixed `plan_`.
       #
       #   @return [String, nil]
-      optional :plan_id, String, nil?: true
+      optional :plan_id, String
 
-      # @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {WhopSDK::Models::CheckoutConfigurationListParams} for more details.
-      #
-      #   @param company_id [String] The unique identifier of the company to list checkout configurations for.
+      # @!method initialize(company_id:, after: nil, created_after: nil, created_before: nil, direction: nil, first: nil, order: nil, plan_id: nil, request_options: {})
+      #   @param company_id [String] Account ID, prefixed `biz_`.
       #
-      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #   @param after [String] Cursor for the next page of results.
       #
-      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #   @param created_after [Integer] Only return checkout configurations created after this Unix timestamp.
       #
-      #   @param created_after [Time, nil] Only return checkout configurations created after this timestamp.
+      #   @param created_before [Integer] Only return checkout configurations created before this Unix timestamp.
       #
-      #   @param created_before [Time, nil] Only return checkout configurations created before this timestamp.
+      #   @param direction [Symbol, WhopSDK::Models::CheckoutConfigurationListParams::Direction] Sort direction. Defaults to `desc`.
       #
-      #   @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #   @param first [Integer] Number of checkout configurations to return.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param order [Symbol, WhopSDK::Models::CheckoutConfigurationListParams::Order] Field used to sort checkout configurations.
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
-      #
-      #   @param plan_id [String, nil] Filter checkout configurations to only those associated with this plan identifie
+      #   @param plan_id [String] Only return checkout configurations for this plan ID, prefixed `plan_`.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Sort direction. Defaults to `desc`.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Field used to sort checkout configurations.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end