whop_sdk 2.4.0 → 2.5.0

data/lib/whop_sdk/users/passkeys/client.rb

@@ -15,9 +15,9 @@ module Whop_sdk
           @environment = environment
         end
 
-        # Lists the authenticated user's own passkeys, newest first. The list is always the caller's own; there is no
-        # parameter for reading another user's passkeys. Requires a user session: an API key or an OAuth token is
-        # refused, because a passkey confirms the account holder before a sensitive action and no app may enumerate one.
+        # Lists the authenticated user's own passkeys, newest first. You cannot read another user's passkeys. Requires a
+        # user session: an API key or an OAuth token is refused, because a passkey confirms the account holder before a
+        # sensitive action and no app may enumerate one.
         #
         # @param request_options [Hash]
         # @param params [Hash]

data/lib/whop_sdk/users/preferences/client.rb

@@ -15,8 +15,7 @@ module Whop_sdk
           @environment = environment
         end
 
-        # Retrieves the authenticated user's settings document. Addressed only as `me` — the document always belongs to
-        # the session user.
+        # Retrieves the authenticated user's settings document.
         #
         # @param request_options [Hash]
         # @param _params [Hash]

data/lib/whop_sdk/users/preferences/notifications/client.rb

@@ -16,19 +16,10 @@ module Whop_sdk
             @environment = environment
           end
 
-          # Sets the authenticated user's notification preferences. Each preference is addressed by `scope`, not by id,
-          # so a scope read back from either list endpoint can be sent straight here.
-          #
-          # A scope naming an experience with no topic sets that experience's level, and accepts all three levels. Any
-          # other scope sets a topic override, which is binary — `all` or `nothing`. A topic override with no `channel`
-          # applies to every delivery channel.
-          #
-          # `level: null` clears the preference. Preferences are stored as overrides, so clearing one means the scope
-          # inherits its default again rather than being switched off.
-          #
-          # The batch is applied in one transaction: if any entry is rejected, none are written. Experience levels are
-          # applied before topic overrides, because setting a level replaces every topic preference for that experience
-          # — so an override sent alongside a level wins. The response reports what each scope now resolves to, in the
+          # Sets the authenticated user's notification preferences, each addressed by `scope` rather than by ID. The
+          # batch is applied in one transaction: if any entry is rejected, none are written. Experience levels are
+          # applied before topic overrides, because setting a level replaces every topic preference for that experience,
+          # so an override sent alongside a level wins. The response reports what each scope now resolves to, in the
           # order the entries were sent.
           #
           # @param request_options [Hash]

data/lib/whop_sdk/users/preferences/notifications/topics/client.rb

@@ -18,8 +18,8 @@ module Whop_sdk
             end
 
             # Lists the authenticated user's topic-scoped notification preferences, plus user-agnostic platform
-            # defaults. Each filter matches preferences scoped to its value or not narrowed on that dimension.
-            # Per-experience levels are listed separately, by `GET /users/me/preferences/notifications/experiences`.
+            # defaults. Per-experience levels are listed separately, by `GET
+            # /users/me/preferences/notifications/experiences`.
             #
             # @param request_options [Hash]
             # @param params [Hash]

data/lib/whop_sdk/users/preferences/notifications/types/set_notifications_request_preferences_item_scope.rb

@@ -5,7 +5,9 @@ module Whop_sdk
     module Preferences
       module Notifications
         module Types
-          # What the preference applies to. `null` on a dimension means the preference is not narrowed there.
+          # What the preference applies to. `null` on a dimension means the preference is not narrowed there. A scope
+          # read back from either list endpoint can be sent as-is. A scope naming an experience with no topic sets that
+          # experience's level; any other scope sets a topic override.
           class SetNotificationsRequestPreferencesItemScope < Internal::Types::Model
             field :account_id, -> { String }, optional: true, nullable: false
 

data/lib/whop_sdk/variants/client.rb

@@ -14,8 +14,8 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns a paginated list of variants. Omit `account_id` and pass `product_ids` to list a product's public
-      # buyable variants.
+      # Lists an account's variants. To list a product's public, buyable variants without authentication, omit
+      # `account_id` and pass `product_ids`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -102,8 +102,8 @@ module Whop_sdk
         end
       end
 
-      # Create a new pricing variant for a product. The variant defines the billing interval, price, and availability
-      # for customers.
+      # Creates a pricing variant for a product, defining the billing interval, price, and availability customers buy it
+      # with.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Variants::Types::CreateVariantsRequest]
@@ -140,7 +140,8 @@ module Whop_sdk
         end
       end
 
-      # Retrieves the details of an existing variant.
+      # Retrieves a variant. Requires no authentication; fields that need a permission are `null` for callers without
+      # it.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -191,8 +192,7 @@ module Whop_sdk
         end
       end
 
-      # Delete a variant from a product. It stops selling immediately; existing memberships on this variant will not be
-      # affected.
+      # Deletes a variant from a product. It stops selling immediately; existing memberships on it are unaffected.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -229,7 +229,7 @@ module Whop_sdk
         end
       end
 
-      # Update a variant's pricing, billing interval, visibility, stock, and other settings.
+      # Updates a variant's pricing, billing interval, visibility, stock, and other settings.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Variants::Types::UpdateVariantsRequest]
@@ -271,7 +271,8 @@ module Whop_sdk
         end
       end
 
-      # Previews tax for a variant before checkout, based on the buyer's location.
+      # Deprecated. Quote tax with `POST /payment_quotes` instead. Previews tax for a variant before checkout, based on
+      # the buyer's location.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Variants::Types::CalculateTaxVariantsRequest]

data/lib/whop_sdk/verifications/client.rb

@@ -14,7 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns verifications for an account, including their status and any required actions.
+      # Lists the verifications for an account or user, including their status and any required actions.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -62,13 +62,11 @@ module Whop_sdk
       end
 
       # Starts a hosted verification session for an account or user, or returns the active session when one already
-      # exists. Any fields you include in the request body are used to prefill the session. Send `documents` (with
-      # `document_type`) to instead verify the person from identity documents included in this request — no hosted
-      # session involved. Send `share_token` to reuse a verification another Sumsub account has already completed for
-      # this person, instead of verifying them again. Send `verification_id` to reuse a verification the signed-in user
-      # already completed on Whop. Every mode except `verification_id` is rejected once the account has an `approved`
-      # verification — unlink it first to start a new one — while `verification_id` replaces whichever verification of
-      # that kind the account currently has.
+      # exists; any fields you send prefill it. To skip the hosted session, send `documents` to verify the person from
+      # files in this request, `share_token` to reuse a verification another Sumsub account completed, or
+      # `verification_id` to reuse one the signed-in user completed on Whop. For a business, `documents` adds company
+      # formation documents to the verification and the hosted session collects the rest. Once the account has an
+      # `approved` verification, every mode except `verification_id` is rejected — unlink it first to start a new one.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Verifications::Types::CreateVerificationsRequestBody]
@@ -114,7 +112,7 @@ module Whop_sdk
         end
       end
 
-      # Returns verifications for an account, including their status and any required actions.
+      # Retrieves a verification by ID, including its status and any information or documents still required.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/verifications/types/create_verifications_request_body_business.rb

@@ -20,12 +20,18 @@ module Whop_sdk
 
         field :date_of_birth, -> { String }, optional: true, nullable: false
 
+        field :documents, -> { Whop_sdk::Verifications::Types::CreateVerificationsRequestBodyBusinessDocuments }, optional: true, nullable: false
+
         field :first_name, -> { String }, optional: true, nullable: false
 
+        field :incorporation_date, -> { String }, optional: true, nullable: false
+
         field :last_name, -> { String }, optional: true, nullable: false
 
         field :place_of_incorporation, -> { String }, optional: true, nullable: false
 
+        field :registration_number, -> { String }, optional: true, nullable: false
+
         field :share_token, -> { String }, optional: true, nullable: false
 
         field :tax_identification_number, -> { String }, optional: true, nullable: false

data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_documents.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Verifications
+    module Types
+      # Company formation documents, each the ID of a file uploaded with Create File and not yet attached to anything
+      # else, prefixed `file_`. Send the ID once its `upload_status` is `ready`. Each file must be a PDF, JPEG, or PNG
+      # of up to 10MB. They are filed under the business's country, from `country`, `address`, or an earlier request. A
+      # document of a kind already on file is kept unless it was rejected, so a retried request does not add a second
+      # copy. The hosted session at `session_url` collects anything still missing.
+      class CreateVerificationsRequestBodyBusinessDocuments < Internal::Types::Model
+        field :articles_of_incorporation, -> { String }, optional: true, nullable: false
+
+        field :certificate_of_incorporation, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/verifications/types/create_verifications_response.rb

@@ -28,6 +28,8 @@ module Whop_sdk
 
         field :phone, -> { String }, optional: true, nullable: false
 
+        field :registration_number, -> { String }, optional: true, nullable: false
+
         field :requested_information, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::CreateVerificationsResponseRequestedInformationItem] }, optional: true, nullable: false
 
         field :required_documents, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::CreateVerificationsResponseRequiredDocumentsItem] }, optional: true, nullable: false

data/lib/whop_sdk/verifications/types/list_verifications_response_data_item.rb

@@ -28,6 +28,8 @@ module Whop_sdk
 
         field :phone, -> { String }, optional: true, nullable: false
 
+        field :registration_number, -> { String }, optional: true, nullable: false
+
         field :requested_information, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::ListVerificationsResponseDataItemRequestedInformationItem] }, optional: true, nullable: false
 
         field :required_documents, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::ListVerificationsResponseDataItemRequiredDocumentsItem] }, optional: true, nullable: false

data/lib/whop_sdk/verifications/types/retrieve_verifications_response.rb

@@ -28,6 +28,8 @@ module Whop_sdk
 
         field :phone, -> { String }, optional: true, nullable: false
 
+        field :registration_number, -> { String }, optional: true, nullable: false
+
         field :requested_information, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::RetrieveVerificationsResponseRequestedInformationItem] }, optional: true, nullable: false
 
         field :required_documents, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::RetrieveVerificationsResponseRequiredDocumentsItem] }, optional: true, nullable: false

data/lib/whop_sdk/verifications/types/update_verifications_response.rb

@@ -28,6 +28,8 @@ module Whop_sdk
 
         field :phone, -> { String }, optional: true, nullable: false
 
+        field :registration_number, -> { String }, optional: true, nullable: false
+
         field :requested_information, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::UpdateVerificationsResponseRequestedInformationItem] }, optional: true, nullable: false
 
         field :required_documents, -> { Internal::Types::Array[Whop_sdk::Verifications::Types::UpdateVerificationsResponseRequiredDocumentsItem] }, optional: true, nullable: false

data/lib/whop_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whop_sdk
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/lib/whop_sdk/waitlist_entries/client.rb

@@ -14,9 +14,9 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Lists visible waitlist signups. waitlist_entry:read grants the user's own signups; plan:waitlist:read grants
-      # signups for authorized seller accounts. With both permissions, returns their union. Account credentials are
-      # limited to their account. Filters narrow this set.
+      # Lists the waitlist signups you can see. `waitlist_entry:read` returns the user's own signups and
+      # `plan:waitlist:read` returns signups to the seller accounts they are authorized on; with both, you get both
+      # sets. Account credentials see only their own account's signups.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -87,9 +87,9 @@ module Whop_sdk
         end
       end
 
-      # Joins a free waitlist variant as the authenticated user. Requires waitlist_entry:create. Repeated joins return
-      # the existing pending entry, or an approved entry with a valid membership. Paid variants are rejected; no payment
-      # method is collected and no membership is granted.
+      # Joins a free waitlist variant as the authenticated user. Requires `waitlist_entry:create`. Joining again returns
+      # the existing pending signup, or the approved one while its membership is valid. Paid variants are rejected;
+      # joining collects no payment method and grants no membership.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::WaitlistEntries::Types::CreateWaitlistEntriesRequest]
@@ -127,9 +127,9 @@ module Whop_sdk
       end
 
       # Queues approval of every pending signup for an account, optionally narrowed to a variant. Requires
-      # plan:waitlist:manage. Paid signups may charge saved payment methods. Approval runs asynchronously: list signups
-      # with `status` set to `pending` to follow progress, and retrieve a signup to read its outcome. Signups created
-      # after this request are excluded.
+      # `plan:waitlist:manage`. Paid signups may charge saved payment methods. Approval runs asynchronously: list
+      # signups with `status` set to `pending` to follow progress, and retrieve a signup to read its outcome. Signups
+      # created after this request are excluded.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::WaitlistEntries::Types::ApproveAllWaitlistEntriesRequest]
@@ -166,8 +166,8 @@ module Whop_sdk
         end
       end
 
-      # Retrieves a signup owned by the caller with waitlist_entry:read, or submitted to an account they can read with
-      # plan:waitlist:read.
+      # Retrieves a signup the caller owns, with `waitlist_entry:read`, or one submitted to an account they can read,
+      # with `plan:waitlist:read`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -204,7 +204,7 @@ module Whop_sdk
         end
       end
 
-      # Queues approval of a pending signup. Requires plan:waitlist:manage on its seller account. Paid signups may
+      # Queues approval of a pending signup. Requires `plan:waitlist:manage` on its seller account. Paid signups may
       # charge their saved payment method. Returns the signup's current state; retrieve it to read `status` and
       # `approval_failure_reason` after processing.
       #
@@ -243,7 +243,7 @@ module Whop_sdk
         end
       end
 
-      # Withdraws the caller's pending personal signup. Requires waitlist_entry:cancel. Does not cancel an approved
+      # Withdraws the caller's own pending signup. Requires `waitlist_entry:cancel`. Does not cancel an approved
       # membership.
       #
       # @param request_options [Hash]
@@ -281,7 +281,7 @@ module Whop_sdk
         end
       end
 
-      # Denies a pending signup. Requires plan:waitlist:manage on its seller account.
+      # Denies a pending signup. Requires `plan:waitlist:manage` on its seller account.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/webhooks/client.rb

@@ -151,7 +151,8 @@ module Whop_sdk
         end
       end
 
-      # Permanently deletes a webhook endpoint. Returns `true` on success, matching the legacy proxy response.
+      # Permanently deletes a webhook endpoint. To stop deliveries without deleting it, set `enabled` to `false` with
+      # `PATCH /webhooks/:id`.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -283,11 +284,10 @@ module Whop_sdk
         end
       end
 
-      # Re-sends the exact payload of a past delivery to the webhook's current URL and returns the delivery result. By
-      # default the replay keeps the original `webhook-id`, so consumers that deduplicate on it can drop events they
-      # already processed. Pass `regenerate_id` to re-send under a freshly generated `webhook-id` instead, so a
-      # deduplicating consumer processes the replay as a new message. Only available for enabled webhooks on API version
-      # v1; deliveries are retained for 30 days.
+      # Re-sends the exact payload of a past delivery to the webhook's current URL and returns the delivery result. The
+      # replay keeps the original `webhook-id` unless you pass `regenerate_id`, so consumers that deduplicate on it can
+      # drop events they already processed. Only available for enabled webhooks on API version `v1`; deliveries are
+      # retained for 30 days.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Webhooks::Types::ReplayDeliveryWebhooksRequest]
@@ -333,12 +333,11 @@ module Whop_sdk
         end
       end
 
-      # Re-sends the webhook's past deliveries within a time window, optionally limited to specific events or to
-      # messages whose most recent delivery attempt failed. Fire and forget: nothing about the replay is stored, and
-      # each re-send appears as a new entry in the webhook's delivery log. Each matching message is re-sent once, by
-      # default with its original `webhook-id`, so consumers that deduplicate are unaffected; pass `regenerate_ids` to
-      # re-send under freshly generated ids instead. Only available for enabled webhooks on API version v1; deliveries
-      # are retained for 30 days.
+      # Re-sends the webhook's past deliveries within a time window, optionally limited to specific events or to failed
+      # deliveries. Use it to recover events your endpoint missed. The replay runs asynchronously and nothing about it
+      # is stored: each re-send appears as a new entry in the webhook's delivery log. Each matching message is re-sent
+      # once, with its original `webhook-id` unless you pass `regenerate_ids`. Only available for enabled webhooks on
+      # API version `v1`; deliveries are retained for 30 days.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Webhooks::Types::ReplayWebhooksRequest]

data/lib/whop_sdk/webhooks/types/create_webhooks_request_events_item.rb

@@ -9,6 +9,7 @@ module Whop_sdk
         ACCOUNT_UPDATED = "account.updated"
         ACCOUNT_FINANCING_APPROVED = "account.financing_approved"
         ACCOUNT_FINANCING_DENIED = "account.financing_denied"
+        ACCOUNT_FINANCING_DISABLED = "account.financing_disabled"
         INVOICE_CREATED = "invoice.created"
         INVOICE_MARKED_UNCOLLECTIBLE = "invoice.marked_uncollectible"
         INVOICE_PAID = "invoice.paid"

data/lib/whop_sdk/webhooks/types/update_webhooks_request_events_item.rb

@@ -9,6 +9,7 @@ module Whop_sdk
         ACCOUNT_UPDATED = "account.updated"
         ACCOUNT_FINANCING_APPROVED = "account.financing_approved"
         ACCOUNT_FINANCING_DENIED = "account.financing_denied"
+        ACCOUNT_FINANCING_DISABLED = "account.financing_disabled"
         INVOICE_CREATED = "invoice.created"
         INVOICE_MARKED_UNCOLLECTIBLE = "invoice.marked_uncollectible"
         INVOICE_PAID = "invoice.paid"