whop_sdk 2.4.0 → 2.5.0

data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_visibility.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Payments
+    module Types
+      module CreatePaymentsRequestLineItemsItemPlanVisibility
+        extend Whop_sdk::Internal::Types::Enum
+
+        VISIBLE = "visible"
+        HIDDEN = "hidden"
+        ARCHIVED = "archived"
+        QUICK_LINK = "quick_link"
+      end
+    end
+  end
+end

data/lib/whop_sdk/payments/types/resume_payments_request.rb

@@ -5,6 +5,8 @@ module Whop_sdk
     module Types
       class ResumePaymentsRequest < Internal::Types::Model
         field :payment_id, -> { String }, optional: false, nullable: false
+
+        field :return_url, -> { String }, optional: true, nullable: false
       end
     end
   end

data/lib/whop_sdk/payout_methods/client.rb

@@ -14,7 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns a list of active payout methods configured for a company, ordered by most recently created.
+      # Lists the active payout methods configured for an account, newest first.
       #
       # Required permissions:
       #  - `payout:destination:read`

data/lib/whop_sdk/payouts/client.rb

@@ -125,8 +125,8 @@ module Whop_sdk
         end
       end
 
-      # Creates a short-lived, provider-backed quote for a payout. No funds move until the returned quote_token is
-      # submitted to POST /payouts. An Idempotency-Key header is required.
+      # Creates a short-lived, provider-backed quote of a payout's fee, exchange rate, and destination amount. No funds
+      # move until you submit the returned `quote_token` to `POST /payouts`.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Payouts::Types::CreateQuotePayoutsRequest]
@@ -166,11 +166,10 @@ module Whop_sdk
         end
       end
 
-      # Fetches one payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a stablecoin payout carries as
-      # `payout_request_id` — both ids answer with the same payout object. Authentication is optional. Anyone with the
-      # ID can view payout tracking details, including notes, trace code, exchange rate, and payout request ID.
-      # Accounting fields require payout:withdrawal:read on the owning ledger. A supplied invalid credential returns
-      # 401.
+      # Retrieves a payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a stablecoin payout carries as
+      # `payout_request_id`. Authentication is optional: anyone with the ID can view tracking details, including notes,
+      # trace code, exchange rate, and payout request ID, while accounting fields require `payout:withdrawal:read` on
+      # the account or user that owns the payout. A supplied invalid credential returns 401.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -214,11 +213,10 @@ module Whop_sdk
         end
       end
 
-      # Cancels a payout that is still in review and returns the funds, fees included, to the balance. A payout can be
-      # canceled while its status is `in_review`. A `requested` payout is still being prepared (its funds may be
-      # converting) and answers 409 until it reaches review; from `processing` on, the money is on its way and the
-      # answer is 409 with error type `not_cancelable`. Canceling a payout that is already canceled succeeds and returns
-      # it unchanged.
+      # Cancels a payout whose `status` is `in_review` and returns the funds, fees included, to the balance. A
+      # `requested` payout is still being prepared (its funds may be converting) and returns 409 until it reaches
+      # review; from `processing` on, the money is on its way and the response is 409 with error type `not_cancelable`.
+      # Canceling an already-canceled payout succeeds and returns it unchanged.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -267,6 +265,11 @@ module Whop_sdk
         @methods ||= Whop_sdk::Payouts::Methods::Client.new(client: @client, base_url: @base_url, environment: @environment)
       end
 
+      # @return [Whop_sdk::PaypalLinkSessions::Client]
+      def paypal_link_sessions
+        @paypal_link_sessions ||= Whop_sdk::Payouts::PaypalLinkSessions::Client.new(client: @client, base_url: @base_url, environment: @environment)
+      end
+
       # @return [Whop_sdk::SupportedMethods::Client]
       def supported_methods
         @supported_methods ||= Whop_sdk::Payouts::SupportedMethods::Client.new(client: @client, base_url: @base_url, environment: @environment)

data/lib/whop_sdk/payouts/methods/client.rb

@@ -84,8 +84,8 @@ module Whop_sdk
           end
         end
 
-        # Saves a new place an account or user can pay out to. Sensitive details are vaulted in transit and never stored
-        # raw.
+        # Saves a bank account, wallet, or crypto address an account or user can pay out to, from a method listed by
+        # `GET /payouts/supported_methods`. Sensitive details are vaulted in transit and never stored raw.
         #
         # @param request_options [Hash]
         # @param params [Whop_sdk::Payouts::Methods::Types::CreateMethodsRequest]

data/lib/whop_sdk/payouts/methods/types/create_methods_request.rb

@@ -15,6 +15,8 @@ module Whop_sdk
 
           field :nickname, -> { String }, optional: true, nullable: false
 
+          field :paypal_link_token, -> { String }, optional: true, nullable: false
+
           field :recipient, -> { Whop_sdk::Payouts::Methods::Types::CreateMethodsRequestRecipient }, optional: true, nullable: false
 
           field :supported_payout_method_id, -> { String }, optional: false, nullable: false

data/lib/whop_sdk/payouts/methods/types/list_methods_response_limits_standard_error_code.rb

@@ -9,8 +9,8 @@ module Whop_sdk
 
           ACCOUNT_SUSPENDED = "account_suspended"
           BLOCK_MOVE_MONEY_OUT_BECAUSE_CLAWBACK = "block_move_money_out_because_clawback"
-          SUPPORTABILITY_CHECK_PAYOUT_STATUS_HOLD = "supportability_check_payout_status_hold"
           CARD_USAGE_REVIEW_PAYOUT_STATUS_HOLD = "card_usage_review_payout_status_hold"
+          UNDER_REVIEW = "under_review"
           KYC_COMPLETED = "kyc_completed"
           RMI_CLEAR = "rmi_clear"
           IDENTITY_RFI_CLEAR = "identity_rfi_clear"

data/lib/whop_sdk/payouts/paypal_link_sessions/client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Payouts
+    module PaypalLinkSessions
+      class Client
+        # @param client [Whop_sdk::Internal::Http::RawClient]
+        # @param base_url [String, nil]
+        # @param environment [Hash[Symbol, String], nil]
+        #
+        # @return [void]
+        def initialize(client:, base_url: nil, environment: nil)
+          @client = client
+          @base_url = base_url
+          @environment = environment
+        end
+
+        # Starts a Log in with PayPal session so PayPal itself can confirm the account holder owns a verified PayPal
+        # account. Send the holder to `authorize_url`; after they log in, PayPal returns them to Whop, and Whop
+        # redirects the browser to your `return_url` with a `paypal_link_token` query parameter to pass to `POST
+        # /payouts/methods`. If the login fails or is canceled, `return_url` receives an `error` query parameter
+        # (`paypal_login_canceled` or `paypal_login_failed`) instead. The payout method saved this way pays the email on
+        # the PayPal account, and its holder name must match the name on the account's payout setup. PayPal login is
+        # rolling out per account: until it is enabled for the account this answers `403 forbidden`, and
+        # `supports_paypal_login` on `GET /payouts/supported_methods` is false.
+        #
+        # @param request_options [Hash]
+        # @param params [Whop_sdk::Payouts::PaypalLinkSessions::Types::CreatePaypalLinkSessionsRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @example
+        #   client.payouts.paypal_link_sessions.create(
+        #     return_url: "https://example.com/settings/payouts",
+        #     supported_payout_method_id: "podst_xxxxxxxxxxxxxx"
+        #   )
+        #
+        # @return [Whop_sdk::Payouts::PaypalLinkSessions::Types::CreatePaypalLinkSessionsResponse]
+        def create(request_options: {}, **params)
+          params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+          request = Whop_sdk::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+            method: "POST",
+            path: "payouts/paypal_link_sessions",
+            body: Whop_sdk::Payouts::PaypalLinkSessions::Types::CreatePaypalLinkSessionsRequest.new(params).to_h,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Whop_sdk::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Whop_sdk::Payouts::PaypalLinkSessions::Types::CreatePaypalLinkSessionsResponse.load(response.body))
+          else
+            error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Payouts
+    module PaypalLinkSessions
+      module Types
+        class CreatePaypalLinkSessionsRequest < Internal::Types::Model
+          field :account_id, -> { String }, optional: true, nullable: false
+
+          field :destination_currency, -> { String }, optional: true, nullable: false
+
+          field :return_url, -> { String }, optional: false, nullable: false
+
+          field :supported_payout_method_id, -> { String }, optional: false, nullable: false
+
+          field :user_id, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Payouts
+    module PaypalLinkSessions
+      module Types
+        class CreatePaypalLinkSessionsResponse < Internal::Types::Model
+          field :authorize_url, -> { String }, optional: false, nullable: false
+
+          field :expires_at, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/payouts/supported_methods/client.rb

@@ -15,7 +15,8 @@ module Whop_sdk
           @environment = environment
         end
 
-        # Lists the payout methods an account or user is eligible to add.
+        # Lists the payout methods an account or user is eligible to add. Pass a result's ID as
+        # `supported_payout_method_id` to `POST /payouts/methods` to save one.
         #
         # @param request_options [Hash]
         # @param params [Hash]

data/lib/whop_sdk/payouts/supported_methods/types/list_supported_methods_response_data_item.rb

@@ -21,6 +21,8 @@ module Whop_sdk
 
           field :supports_instant_delivery, -> { Internal::Types::Boolean }, optional: false, nullable: false
 
+          field :supports_paypal_login, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
           field :supports_standard_delivery, -> { Internal::Types::Boolean }, optional: false, nullable: false
         end
       end

data/lib/whop_sdk/people/client.rb

@@ -14,9 +14,8 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Lists the people (visitors and customers) of an account: the identity-linked person profiles aggregated from
-      # every pixel, payment, and platform event — identities, purchases and LTV, geo/device profile, traffic sources,
-      # and first/last marketing touches.
+      # Lists the people (visitors and customers) of an account: identity-linked profiles assembled from every pixel,
+      # payment, and platform event. Filter and sort them to segment an account's audience.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -156,8 +155,7 @@ module Whop_sdk
         end
       end
 
-      # Retrieves one person for an account. The identifier can be a person ID (prefixed `prsn_`), a user ID (prefixed
-      # `user_`), an email address, or a phone number — merged people resolve to the surviving profile.
+      # Retrieves one person for an account, looked up by person ID, user ID, email address, or phone number.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/plans/client.rb

@@ -240,7 +240,7 @@ module Whop_sdk
         end
       end
 
-      # Deprecated compatibility endpoint. Preview variant tax with `POST /variants/{id}/calculate_tax` instead.
+      # Deprecated compatibility endpoint. Quote tax with `POST /payment_quotes` instead.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Plans::Types::CalculateTaxPlansRequest]

data/lib/whop_sdk/products/client.rb

@@ -14,7 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns a paginated list of products. Omit `account_id` to search the public marketplace.
+      # Lists an account's products, or searches the public marketplace when you omit `account_id`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -135,7 +135,7 @@ module Whop_sdk
         end
       end
 
-      # Retrieves a product. Public — no credentials.
+      # Retrieves a product. Requires no authentication.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/promo_codes/client.rb

@@ -14,7 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Lists promo codes for an account with cursor pagination, filters, and sorting.
+      # Lists an account's promo codes.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/refunds/client.rb

@@ -14,8 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Lists refunds, newest first. Without filters this is every refund the caller can read; narrow it to one payment
-      # with `payment_id`, one account with `account_id`, or one buyer with `user_id`.
+      # Lists refunds the caller can read, newest first. Filter by payment, account, or buyer to narrow the results.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/reviews/client.rb

@@ -14,8 +14,9 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns a paginated list of customer reviews for a specific product, with optional filtering by star rating and
-      # creation date.
+      # Lists the published reviews for a product or account. Without `account_id` or `product_id`, a user lists the
+      # reviews they wrote, an account or app API key lists its account's reviews, and a request without credentials
+      # returns 400.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -24,40 +25,41 @@ module Whop_sdk
       # @option request_options [Hash{String => Object}] :additional_query_parameters
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
-      # @option params [String, nil] :after
-      # @option params [String, nil] :before
-      # @option params [Integer, nil] :first
-      # @option params [Integer, nil] :last
-      # @option params [String] :product_id
+      # @option params [String, nil] :account_id
+      # @option params [String, nil] :product_id
       # @option params [Integer, nil] :min_stars
       # @option params [Integer, nil] :max_stars
       # @option params [String, nil] :created_before
       # @option params [String, nil] :created_after
+      # @option params [Whop_sdk::Reviews::Types::ListReviewsRequestOrder, nil] :order
+      # @option params [Whop_sdk::Reviews::Types::ListReviewsRequestDirection, nil] :direction
+      # @option params [Integer, nil] :first
+      # @option params [String, nil] :after
+      # @option params [Integer, nil] :last
+      # @option params [String, nil] :before
       #
       # @example
       #   client.reviews.list(
-      #     first: 42,
-      #     last: 42,
-      #     product_id: "prod_xxxxxxxxxxxxx",
-      #     min_stars: 42,
-      #     max_stars: 42,
-      #     created_before: "2023-12-01T05:00:00Z",
-      #     created_after: "2023-12-01T05:00:00Z"
+      #     account_id: "biz_xxxxxxxxxxxxxx",
+      #     product_id: "prod_xxxxxxxxxxxxx"
       #   )
       #
       # @return [Whop_sdk::Reviews::Types::ListReviewsResponse]
       def list(request_options: {}, **params)
         params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
-        query_params["after"] = params[:after] if params.key?(:after)
-        query_params["before"] = params[:before] if params.key?(:before)
-        query_params["first"] = params[:first] if params.key?(:first)
-        query_params["last"] = params[:last] if params.key?(:last)
+        query_params["account_id"] = params[:account_id] if params.key?(:account_id)
         query_params["product_id"] = params[:product_id] if params.key?(:product_id)
         query_params["min_stars"] = params[:min_stars] if params.key?(:min_stars)
         query_params["max_stars"] = params[:max_stars] if params.key?(:max_stars)
         query_params["created_before"] = params[:created_before] if params.key?(:created_before)
         query_params["created_after"] = params[:created_after] if params.key?(:created_after)
+        query_params["order"] = params[:order] if params.key?(:order)
+        query_params["direction"] = params[:direction] if params.key?(:direction)
+        query_params["first"] = params[:first] if params.key?(:first)
+        query_params["after"] = params[:after] if params.key?(:after)
+        query_params["last"] = params[:last] if params.key?(:last)
+        query_params["before"] = params[:before] if params.key?(:before)
 
         Whop_sdk::Internal::CursorItemIterator.new(
           cursor_field: :end_cursor,
@@ -88,7 +90,7 @@ module Whop_sdk
         end
       end
 
-      # Retrieves the details of an existing review.
+      # Retrieves a published review. Reviews that are not published return 404.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -124,6 +126,44 @@ module Whop_sdk
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # Deletes a review the signed-in user wrote. Requires the `review:delete` scope, and returns 404 for a review
+      # another user wrote.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.reviews.delete(id: "rev_xxxxxxxxxxxxxx")
+      #
+      # @return [Whop_sdk::Reviews::Types::DeleteReviewsResponse]
+      def delete(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+          method: "DELETE",
+          path: "reviews/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Whop_sdk::Reviews::Types::DeleteReviewsResponse.load(response.body))
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
     end
   end
 end

data/lib/whop_sdk/reviews/types/delete_reviews_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Reviews
+    module Types
+      class DeleteReviewsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/reviews/types/delete_reviews_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Reviews
+    module Types
+      class DeleteReviewsResponse < Internal::Types::Model
+        field :deleted, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/reviews/types/list_reviews_request.rb

@@ -4,15 +4,9 @@ module Whop_sdk
   module Reviews
     module Types
       class ListReviewsRequest < Internal::Types::Model
-        field :after, -> { String }, optional: true, nullable: false
+        field :account_id, -> { String }, optional: true, nullable: false
 
-        field :before, -> { String }, optional: true, nullable: false
-
-        field :first, -> { Integer }, optional: true, nullable: false
-
-        field :last, -> { Integer }, optional: true, nullable: false
-
-        field :product_id, -> { String }, optional: false, nullable: false
+        field :product_id, -> { String }, optional: true, nullable: false
 
         field :min_stars, -> { Integer }, optional: true, nullable: false
 
@@ -21,6 +15,18 @@ module Whop_sdk
         field :created_before, -> { String }, optional: true, nullable: false
 
         field :created_after, -> { String }, optional: true, nullable: false
+
+        field :order, -> { Whop_sdk::Reviews::Types::ListReviewsRequestOrder }, optional: true, nullable: false
+
+        field :direction, -> { Whop_sdk::Reviews::Types::ListReviewsRequestDirection }, optional: true, nullable: false
+
+        field :first, -> { Integer }, optional: true, nullable: false
+
+        field :after, -> { String }, optional: true, nullable: false
+
+        field :last, -> { Integer }, optional: true, nullable: false
+
+        field :before, -> { String }, optional: true, nullable: false
       end
     end
   end

data/lib/whop_sdk/reviews/types/list_reviews_request_direction.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Reviews
+    module Types
+      module ListReviewsRequestDirection
+        extend Whop_sdk::Internal::Types::Enum
+
+        ASC = "asc"
+        DESC = "desc"
+      end
+    end
+  end
+end

data/lib/whop_sdk/reviews/types/list_reviews_request_order.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Reviews
+    module Types
+      module ListReviewsRequestOrder
+        extend Whop_sdk::Internal::Types::Enum
+
+        CREATED_AT = "created_at"
+        STARS = "stars"
+      end
+    end
+  end
+end

data/lib/whop_sdk/reviews/types/list_reviews_response.rb

@@ -3,11 +3,10 @@
 module Whop_sdk
   module Reviews
     module Types
-      # The connection type for Review.
       class ListReviewsResponse < Internal::Types::Model
         field :data, -> { Internal::Types::Array[Whop_sdk::Types::ReviewListItem] }, optional: false, nullable: false
 
-        field :page_info, -> { Whop_sdk::Types::PageInfo }, optional: false, nullable: false
+        field :page_info, -> { Whop_sdk::Reviews::Types::ListReviewsResponsePageInfo }, optional: false, nullable: false
       end
     end
   end

data/lib/whop_sdk/reviews/types/list_reviews_response_page_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Reviews
+    module Types
+      class ListReviewsResponsePageInfo < Internal::Types::Model
+        field :end_cursor, -> { String }, optional: false, nullable: true
+
+        field :has_next_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :has_previous_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :start_cursor, -> { String }, optional: false, nullable: true
+      end
+    end
+  end
+end

data/lib/whop_sdk/setup_intents/client.rb

@@ -15,8 +15,7 @@ module Whop_sdk
       end
 
       # Lists setup intents newest first. An account API key lists its own account; a user token lists every account it
-      # can read, or one account with `account_id`. `client_secret` is always null on list rows — retrieve the setup
-      # intent for it.
+      # can read, or one account with `account_id`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -83,12 +82,11 @@ module Whop_sdk
         end
       end
 
-      # Saves a buyer's payment method for later without charging it. Pass a `confirmation_token` for a method the buyer
-      # just supplied through the payment elements in setup mode, or a `payment_method_id` already on file to re-verify
-      # it. The response is the setup intent as created, not its outcome: it is `processing` while the payment method is
-      # saved in the background, and `requires_action` when the buyer still has a step. Hand `client_secret` to the
-      # elements' `handleNextAction`, or poll Retrieve setup status, for the outcome. A buyer's own token holding
-      # `member:payment_methods:use` may create a setup intent for itself from a confirmation token.
+      # Saves a buyer's payment method for later without charging it — one the buyer just supplied through the payment
+      # elements in setup mode, or one already on file to re-verify. The setup completes in the background, so the
+      # response is the setup intent as created, not its outcome: hand `client_secret` to the elements'
+      # `handleNextAction`, or poll Retrieve setup status. A buyer's own token holding `member:payment_methods:use` may
+      # create a setup intent for itself from a confirmation token.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::SetupIntents::Types::CreateSetupIntentsRequest]
@@ -125,8 +123,8 @@ module Whop_sdk
         end
       end
 
-      # Returns one setup intent. Related records are ids — once `status` is `succeeded`, `payment_method_id` is the
-      # saved method to charge or retrieve. The buyer's own token may retrieve a setup intent that belongs to it.
+      # Retrieves a setup intent. Once its `status` is `succeeded`, charge the saved method by its `payment_method_id`.
+      # The buyer's own token may retrieve a setup intent that belongs to it.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/setup_intents/direct/client.rb

@@ -15,13 +15,12 @@ module Whop_sdk
           @environment = environment
         end
 
-        # Saves a card for later charges from card details the caller holds itself, for integrators whose own systems
-        # are PCI compliant. Card details are accepted only on the vault host, where the card is tokenized before it
-        # reaches Whop; the official SDKs route this operation there, and raw card details sent to the regular host are
-        # refused. (Whop's own clients, which tokenize with the Basis Theory SDK, send the resulting token intent id to
-        # the regular host.) The setup runs in the background: poll Retrieve setup status for its outcome and for
-        # anything the buyer must still do, such as 3D Secure. Once it succeeds, the saved payment method arrives on the
-        # `setup_intent.succeeded` webhook and in List payment methods for the member.
+        # Saves a card for later charges from card details you hold yourself, for integrators whose own systems are PCI
+        # compliant. Send this operation to the vault host, which tokenizes the card before it reaches Whop; the
+        # official SDKs route it there, and raw card details sent to the regular host are refused. The setup runs in the
+        # background: poll Retrieve setup status for its outcome and for anything the buyer must still do, such as 3D
+        # Secure. Once it succeeds, the saved payment method arrives on the `setup_intent.succeeded` webhook and in List
+        # payment methods for the member.
         #
         # @param request_options [Hash]
         # @param params [Whop_sdk::SetupIntents::Direct::Types::CreateDirectRequest]