whop_sdk 0.0.20 → 0.0.23

data/rbi/whop_sdk/resources/leads.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Leads
+      # Creates a new lead
+      #
+      # Required permissions:
+      #
+      # - `lead:manage`
+      # - `member:email:read`
+      # - `access_pass:basic:read`
+      # - `member:basic:read`
+      sig do
+        params(
+          company_id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          product_id: T.nilable(String),
+          referrer: T.nilable(String),
+          user_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::LeadCreateResponse)
+      end
+      def create(
+        # The ID of the company to create a lead for.
+        company_id:,
+        # Custom metadata for the lead.
+        metadata: nil,
+        # The ID of the product the lead is interested in.
+        product_id: nil,
+        # The url referrer of the lead, if any.
+        referrer: nil,
+        # The ID of the user to create a lead for. If the request is made by a user, that
+        # user will be used.
+        user_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a lead by ID
+      #
+      # Required permissions:
+      #
+      # - `lead:basic:read`
+      # - `member:email:read`
+      # - `access_pass:basic:read`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::LeadRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the lead
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates a lead
+      #
+      # Required permissions:
+      #
+      # - `lead:manage`
+      # - `member:email:read`
+      # - `access_pass:basic:read`
+      # - `member:basic:read`
+      sig do
+        params(
+          id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          referrer: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::LeadUpdateResponse)
+      end
+      def update(
+        # The ID of the lead to update.
+        id,
+        # Custom metadata for the lead.
+        metadata: nil,
+        # The url referrer of the lead.
+        referrer: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists leads for a company
+      #
+      # Required permissions:
+      #
+      # - `lead:basic:read`
+      # - `member:email:read`
+      # - `access_pass:basic:read`
+      # - `member:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_ids: T.nilable(T::Array[String]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::LeadListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list leads for
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The product IDs to filter the leads by
+        product_ids: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/payment_methods.rbi

@@ -7,7 +7,7 @@ module WhopSDK
       # such as a card, bank account, or digital wallet. It holds the necessary billing
       # details and can be attached to a member for future one-time or recurring
       # charges. This lets you reuse the same payment credentials across multiple
-      # payments.
+      # payments. You must provide exactly one of company_id or member_id.
       #
       # Required permissions:
       #
@@ -15,15 +15,18 @@ module WhopSDK
       sig do
         params(
           id: String,
-          member_id: String,
+          company_id: T.nilable(String),
+          member_id: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::PaymentMethodRetrieveResponse::Variants)
       end
       def retrieve(
         # The ID of the PaymentMethod
         id,
-        # The ID of the Member associated with the PaymentMethod
-        member_id:,
+        # The ID of the Company. Provide either this or member_id (not both).
+        company_id: nil,
+        # The ID of the Member. Provide either this or company_id (not both).
+        member_id: nil,
         request_options: {}
       )
       end
@@ -39,14 +42,15 @@ module WhopSDK
       # - `member:payment_methods:read`
       sig do
         params(
-          member_id: String,
           after: T.nilable(String),
           before: T.nilable(String),
+          company_id: T.nilable(String),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
           direction: T.nilable(WhopSDK::Direction::OrSymbol),
           first: T.nilable(Integer),
           last: T.nilable(Integer),
+          member_id: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[
@@ -55,12 +59,12 @@ module WhopSDK
         )
       end
       def list(
-        # The ID of the Member to list payment methods for
-        member_id:,
         # Returns the elements in the list that come after the specified cursor.
         after: nil,
         # Returns the elements in the list that come before the specified cursor.
         before: nil,
+        # The ID of the Company. Provide either this or member_id (not both).
+        company_id: nil,
         # The minimum creation date to filter by
         created_after: nil,
         # The maximum creation date to filter by
@@ -71,6 +75,8 @@ module WhopSDK
         first: nil,
         # Returns the last _n_ elements from the list.
         last: nil,
+        # The ID of the Member to list payment methods for
+        member_id: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/payments.rbi

@@ -28,6 +28,7 @@ module WhopSDK
           payment_method_id: String,
           plan: WhopSDK::PaymentCreateParams::Plan::OrHash,
           plan_id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
@@ -43,6 +44,8 @@ module WhopSDK
         plan:,
         # An ID of an existing plan to use for the payment.
         plan_id:,
+        # Custom metadata to attach to the payment.
+        metadata: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/payout_methods.rbi

@@ -3,6 +3,24 @@
 module WhopSDK
   module Resources
     class PayoutMethods
+      # Retrieves a payout method by ID
+      #
+      # Required permissions:
+      #
+      # - `payout:destination:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::PayoutMethodRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the payout method
+        id,
+        request_options: {}
+      )
+      end
+
       # Lists payout destinations for a company
       #
       # Required permissions:

data/rbi/whop_sdk/resources/plans.rbi

@@ -29,6 +29,7 @@ module WhopSDK
             ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
+          legacy_payment_method_controls: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
           payment_method_configuration:
             T.nilable(
@@ -69,6 +70,8 @@ module WhopSDK
         initial_price: nil,
         # A personal description or notes section for the business.
         internal_notes: nil,
+        # Whether this plan uses legacy payment method controls
+        legacy_payment_method_controls: nil,
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
@@ -141,6 +144,7 @@ module WhopSDK
             ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
+          legacy_payment_method_controls: T.nilable(T::Boolean),
           offer_cancel_discount: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
           payment_method_configuration:
@@ -177,6 +181,8 @@ module WhopSDK
         initial_price: nil,
         # A personal description or notes section for the business.
         internal_notes: nil,
+        # Whether this plan uses legacy payment method controls
+        legacy_payment_method_controls: nil,
         # Whether or not to offer a discount to cancel a subscription.
         offer_cancel_discount: nil,
         # Whether or not the tax is included in a plan's price (or if it hasn't been set

data/rbi/whop_sdk/resources/support_channels.rbi

@@ -19,7 +19,7 @@ module WhopSDK
       def create(
         # The ID of the company to create the support chat in
         company_id:,
-        # The ID of the user to create the support chat for
+        # The ID (user_xxx) or username of the user to create the support chat for
         user_id:,
         request_options: {}
       )

data/rbi/whop_sdk/resources/topups.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Topups
+      # Add funds to your platform balance by charging a stored payment method.
+      #
+      # Required permissions:
+      #
+      # - `payment:charge`
+      sig do
+        params(
+          amount: Float,
+          company_id: String,
+          currency: WhopSDK::Currency::OrSymbol,
+          payment_method_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::TopupCreateResponse)
+      end
+      def create(
+        # The amount to add to the balance.
+        amount:,
+        # The ID of the company to add funds to.
+        company_id:,
+        # The currency of the top-up.
+        currency:,
+        # The ID of the payment method to charge for the top-up.
+        payment_method_id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/verifications.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Verifications
+      # Retrieves a verification by ID
+      #
+      # Required permissions:
+      #
+      # - `payout:account:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::VerificationRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the verification
+        id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/webhooks.rbi

@@ -3,6 +3,146 @@
 module WhopSDK
   module Resources
     class Webhooks
+      # Creates a new webhook
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_webhook`
+      sig do
+        params(
+          url: String,
+          api_version:
+            T.nilable(WhopSDK::WebhookCreateParams::APIVersion::OrSymbol),
+          child_resource_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events:
+            T.nilable(T::Array[WhopSDK::WebhookCreateParams::Event::OrSymbol]),
+          resource_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::WebhookCreateResponse)
+      end
+      def create(
+        # The URL to send the webhook to.
+        url:,
+        # The different API versions
+        api_version: nil,
+        # Whether or not to send events for child resources. For example, if the webhook
+        # is created for a Company, enabling this will only send events from the Company's
+        # sub-merchants (child companies).
+        child_resource_events: nil,
+        # Whether or not the webhook is enabled.
+        enabled: nil,
+        # The events to send the webhook for.
+        events: nil,
+        # The resource to create the webhook for. By default this will use current company
+        resource_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a webhook by ID
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_webhook`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::WebhookRetrieveResponse)
+      end
+      def retrieve(
+        # The ID of the webhook
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates a webhook
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_webhook`
+      sig do
+        params(
+          id: String,
+          api_version:
+            T.nilable(WhopSDK::WebhookUpdateParams::APIVersion::OrSymbol),
+          child_resource_events: T.nilable(T::Boolean),
+          enabled: T.nilable(T::Boolean),
+          events:
+            T.nilable(T::Array[WhopSDK::WebhookUpdateParams::Event::OrSymbol]),
+          url: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::WebhookUpdateResponse)
+      end
+      def update(
+        # The ID of the Webhook to update
+        id,
+        # The different API versions
+        api_version: nil,
+        # Whether or not to send events for child resources.
+        child_resource_events: nil,
+        # Whether or not the webhook is enabled.
+        enabled: nil,
+        # The events to send the webhook for.
+        events: nil,
+        # The URL to send the webhook to.
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists webhooks for a company
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_webhook`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::WebhookListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list webhooks for
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes a webhook
+      #
+      # Required permissions:
+      #
+      # - `developer:manage_webhook`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(
+        # The ID of the webhook to delete.
+        id,
+        request_options: {}
+      )
+      end
+
       sig do
         params(payload: String).returns(
           T.any(
@@ -22,6 +162,8 @@ module WhopSDK
             WhopSDK::WithdrawalCreatedWebhookEvent,
             WhopSDK::WithdrawalUpdatedWebhookEvent,
             WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
+            WhopSDK::PayoutMethodCreatedWebhookEvent,
+            WhopSDK::VerificationSucceededWebhookEvent,
             WhopSDK::PaymentCreatedWebhookEvent,
             WhopSDK::PaymentSucceededWebhookEvent,
             WhopSDK::PaymentFailedWebhookEvent,
@@ -29,7 +171,8 @@ module WhopSDK
             WhopSDK::DisputeCreatedWebhookEvent,
             WhopSDK::DisputeUpdatedWebhookEvent,
             WhopSDK::RefundCreatedWebhookEvent,
-            WhopSDK::RefundUpdatedWebhookEvent
+            WhopSDK::RefundUpdatedWebhookEvent,
+            WhopSDK::MembershipCancelAtPeriodEndChangedWebhookEvent
           )
         )
       end

data/sig/whop_sdk/client.rbs

@@ -94,6 +94,14 @@ module WhopSDK
 
     attr_reader payout_methods: WhopSDK::Resources::PayoutMethods
 
+    attr_reader verifications: WhopSDK::Resources::Verifications
+
+    attr_reader leads: WhopSDK::Resources::Leads
+
+    attr_reader topups: WhopSDK::Resources::Topups
+
+    attr_reader files: WhopSDK::Resources::Files
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbs

@@ -6,7 +6,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::CourseLessonInteraction,
         timestamp: Time,
-        type: :"course_lesson_interaction.completed"
+        type: :"course_lesson_interaction.completed",
+        company_id: String?
       }
 
     class CourseLessonInteractionCompletedWebhookEvent < WhopSDK::Internal::Type::BaseModel
@@ -20,10 +21,13 @@ module WhopSDK
 
       attr_accessor type: :"course_lesson_interaction.completed"
 
+      attr_accessor company_id: String?
+
       def initialize: (
         id: String,
         data: WhopSDK::CourseLessonInteraction,
         timestamp: Time,
+        ?company_id: String?,
         ?api_version: :v1,
         ?type: :"course_lesson_interaction.completed"
       ) -> void
@@ -33,7 +37,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::CourseLessonInteraction,
         timestamp: Time,
-        type: :"course_lesson_interaction.completed"
+        type: :"course_lesson_interaction.completed",
+        company_id: String?
       }
     end
   end

data/sig/whop_sdk/models/dispute_created_webhook_event.rbs

@@ -6,7 +6,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Dispute,
         timestamp: Time,
-        type: :"dispute.created"
+        type: :"dispute.created",
+        company_id: String?
       }
 
     class DisputeCreatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
@@ -20,10 +21,13 @@ module WhopSDK
 
       attr_accessor type: :"dispute.created"
 
+      attr_accessor company_id: String?
+
       def initialize: (
         id: String,
         data: WhopSDK::Dispute,
         timestamp: Time,
+        ?company_id: String?,
         ?api_version: :v1,
         ?type: :"dispute.created"
       ) -> void
@@ -33,7 +37,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Dispute,
         timestamp: Time,
-        type: :"dispute.created"
+        type: :"dispute.created",
+        company_id: String?
       }
     end
   end

data/sig/whop_sdk/models/dispute_updated_webhook_event.rbs

@@ -6,7 +6,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Dispute,
         timestamp: Time,
-        type: :"dispute.updated"
+        type: :"dispute.updated",
+        company_id: String?
       }
 
     class DisputeUpdatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
@@ -20,10 +21,13 @@ module WhopSDK
 
       attr_accessor type: :"dispute.updated"
 
+      attr_accessor company_id: String?
+
       def initialize: (
         id: String,
         data: WhopSDK::Dispute,
         timestamp: Time,
+        ?company_id: String?,
         ?api_version: :v1,
         ?type: :"dispute.updated"
       ) -> void
@@ -33,7 +37,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Dispute,
         timestamp: Time,
-        type: :"dispute.updated"
+        type: :"dispute.updated",
+        company_id: String?
       }
     end
   end

data/sig/whop_sdk/models/entry_approved_webhook_event.rbs

@@ -6,7 +6,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Entry,
         timestamp: Time,
-        type: :"entry.approved"
+        type: :"entry.approved",
+        company_id: String?
       }
 
     class EntryApprovedWebhookEvent < WhopSDK::Internal::Type::BaseModel
@@ -20,10 +21,13 @@ module WhopSDK
 
       attr_accessor type: :"entry.approved"
 
+      attr_accessor company_id: String?
+
       def initialize: (
         id: String,
         data: WhopSDK::Entry,
         timestamp: Time,
+        ?company_id: String?,
         ?api_version: :v1,
         ?type: :"entry.approved"
       ) -> void
@@ -33,7 +37,8 @@ module WhopSDK
         api_version: :v1,
         data: WhopSDK::Entry,
         timestamp: Time,
-        type: :"entry.approved"
+        type: :"entry.approved",
+        company_id: String?
       }
     end
   end