whop_sdk 0.0.19 → 0.0.22

data/rbi/whop_sdk/resources/companies.rbi

@@ -14,6 +14,8 @@ module WhopSDK
           email: String,
           parent_company_id: String,
           title: String,
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
           metadata: T.nilable(T::Hash[Symbol, T.anything]),
           send_customer_emails: T.nilable(T::Boolean),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -26,6 +28,10 @@ module WhopSDK
         parent_company_id:,
         # The name of the company being created.
         title:,
+        # The different business types a company can be.
+        business_type: nil,
+        # The different industry types a company can be in.
+        industry_type: nil,
         # Additional metadata for the account
         metadata: nil,
         # Whether Whop sends transactional emails to customers on behalf of this company.
@@ -72,6 +78,8 @@ module WhopSDK
                 WhopSDK::CompanyUpdateParams::BannerImage::AttachmentInputWithID::OrHash
               )
             ),
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
           logo:
             T.nilable(
               T.any(
@@ -89,6 +97,10 @@ module WhopSDK
         id,
         # The banner image for the company in png or jpeg format
         banner_image: nil,
+        # The different business types a company can be.
+        business_type: nil,
+        # The different industry types a company can be in.
+        industry_type: nil,
         # The logo for the company in png, jpeg, or gif format
         logo: nil,
         # Whether Whop sends transactional emails to customers on behalf of this company.

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/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

@@ -22,6 +22,8 @@ module WhopSDK
             WhopSDK::WithdrawalCreatedWebhookEvent,
             WhopSDK::WithdrawalUpdatedWebhookEvent,
             WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
+            WhopSDK::PayoutMethodCreatedWebhookEvent,
+            WhopSDK::VerificationSucceededWebhookEvent,
             WhopSDK::PaymentCreatedWebhookEvent,
             WhopSDK::PaymentSucceededWebhookEvent,
             WhopSDK::PaymentFailedWebhookEvent,
@@ -29,7 +31,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,12 @@ 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
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/whop_sdk/models/checkout_configuration_create_params.rbs

@@ -66,6 +66,7 @@ module WhopSDK
         {
           company_id: String,
           currency: WhopSDK::Models::currency,
+          application_fee_amount: Float?,
           billing_period: Integer?,
           custom_fields: ::Array[WhopSDK::CheckoutConfigurationCreateParams::Plan::CustomField]?,
           description: String?,
@@ -92,6 +93,8 @@ module WhopSDK
 
         attr_accessor currency: WhopSDK::Models::currency
 
+        attr_accessor application_fee_amount: Float?
+
         attr_accessor billing_period: Integer?
 
         attr_accessor custom_fields: ::Array[WhopSDK::CheckoutConfigurationCreateParams::Plan::CustomField]?
@@ -133,6 +136,7 @@ module WhopSDK
         def initialize: (
           company_id: String,
           currency: WhopSDK::Models::currency,
+          ?application_fee_amount: Float?,
           ?billing_period: Integer?,
           ?custom_fields: ::Array[WhopSDK::CheckoutConfigurationCreateParams::Plan::CustomField]?,
           ?description: String?,
@@ -157,6 +161,7 @@ module WhopSDK
         def to_hash: -> {
           company_id: String,
           currency: WhopSDK::Models::currency,
+          application_fee_amount: Float?,
           billing_period: Integer?,
           custom_fields: ::Array[WhopSDK::CheckoutConfigurationCreateParams::Plan::CustomField]?,
           description: String?,

data/sig/whop_sdk/models/company_create_params.rbs

@@ -5,6 +5,8 @@ module WhopSDK
         email: String,
         parent_company_id: String,
         title: String,
+        business_type: WhopSDK::Models::business_types?,
+        industry_type: WhopSDK::Models::industry_types?,
         metadata: ::Hash[Symbol, top]?,
         send_customer_emails: bool?
       }
@@ -20,6 +22,10 @@ module WhopSDK
 
       attr_accessor title: String
 
+      attr_accessor business_type: WhopSDK::Models::business_types?
+
+      attr_accessor industry_type: WhopSDK::Models::industry_types?
+
       attr_accessor metadata: ::Hash[Symbol, top]?
 
       attr_accessor send_customer_emails: bool?
@@ -28,6 +34,8 @@ module WhopSDK
         email: String,
         parent_company_id: String,
         title: String,
+        ?business_type: WhopSDK::Models::business_types?,
+        ?industry_type: WhopSDK::Models::industry_types?,
         ?metadata: ::Hash[Symbol, top]?,
         ?send_customer_emails: bool?,
         ?request_options: WhopSDK::request_opts
@@ -37,6 +45,8 @@ module WhopSDK
         email: String,
         parent_company_id: String,
         title: String,
+        business_type: WhopSDK::Models::business_types?,
+        industry_type: WhopSDK::Models::industry_types?,
         metadata: ::Hash[Symbol, top]?,
         send_customer_emails: bool?,
         request_options: WhopSDK::RequestOptions

data/sig/whop_sdk/models/company_update_params.rbs

@@ -3,6 +3,8 @@ module WhopSDK
     type company_update_params =
       {
         banner_image: WhopSDK::Models::CompanyUpdateParams::banner_image?,
+        business_type: WhopSDK::Models::business_types?,
+        industry_type: WhopSDK::Models::industry_types?,
         logo: WhopSDK::Models::CompanyUpdateParams::logo?,
         send_customer_emails: bool?,
         title: String?
@@ -15,6 +17,10 @@ module WhopSDK
 
       attr_accessor banner_image: WhopSDK::Models::CompanyUpdateParams::banner_image?
 
+      attr_accessor business_type: WhopSDK::Models::business_types?
+
+      attr_accessor industry_type: WhopSDK::Models::industry_types?
+
       attr_accessor logo: WhopSDK::Models::CompanyUpdateParams::logo?
 
       attr_accessor send_customer_emails: bool?
@@ -23,6 +29,8 @@ module WhopSDK
 
       def initialize: (
         ?banner_image: WhopSDK::Models::CompanyUpdateParams::banner_image?,
+        ?business_type: WhopSDK::Models::business_types?,
+        ?industry_type: WhopSDK::Models::industry_types?,
         ?logo: WhopSDK::Models::CompanyUpdateParams::logo?,
         ?send_customer_emails: bool?,
         ?title: String?,
@@ -31,6 +39,8 @@ module WhopSDK
 
       def to_hash: -> {
         banner_image: WhopSDK::Models::CompanyUpdateParams::banner_image?,
+        business_type: WhopSDK::Models::business_types?,
+        industry_type: WhopSDK::Models::industry_types?,
         logo: WhopSDK::Models::CompanyUpdateParams::logo?,
         send_customer_emails: bool?,
         title: String?,

data/sig/whop_sdk/models/lead_create_params.rbs

@@ -0,0 +1,46 @@
+module WhopSDK
+  module Models
+    type lead_create_params =
+      {
+        company_id: String,
+        metadata: ::Hash[Symbol, top]?,
+        product_id: String?,
+        referrer: String?,
+        user_id: String?
+      }
+      & WhopSDK::Internal::Type::request_parameters
+
+    class LeadCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      attr_accessor company_id: String
+
+      attr_accessor metadata: ::Hash[Symbol, top]?
+
+      attr_accessor product_id: String?
+
+      attr_accessor referrer: String?
+
+      attr_accessor user_id: String?
+
+      def initialize: (
+        company_id: String,
+        ?metadata: ::Hash[Symbol, top]?,
+        ?product_id: String?,
+        ?referrer: String?,
+        ?user_id: String?,
+        ?request_options: WhopSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        company_id: String,
+        metadata: ::Hash[Symbol, top]?,
+        product_id: String?,
+        referrer: String?,
+        user_id: String?,
+        request_options: WhopSDK::RequestOptions
+      }
+    end
+  end
+end

data/sig/whop_sdk/models/lead_create_response.rbs

@@ -0,0 +1,104 @@
+module WhopSDK
+  module Models
+    type lead_create_response =
+      {
+        id: String,
+        created_at: Time,
+        member: WhopSDK::Models::LeadCreateResponse::Member?,
+        metadata: ::Hash[Symbol, top]?,
+        product: WhopSDK::Models::LeadCreateResponse::Product?,
+        referrer: String?,
+        updated_at: Time,
+        user: WhopSDK::Models::LeadCreateResponse::User
+      }
+
+    class LeadCreateResponse < WhopSDK::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor member: WhopSDK::Models::LeadCreateResponse::Member?
+
+      attr_accessor metadata: ::Hash[Symbol, top]?
+
+      attr_accessor product: WhopSDK::Models::LeadCreateResponse::Product?
+
+      attr_accessor referrer: String?
+
+      attr_accessor updated_at: Time
+
+      attr_accessor user: WhopSDK::Models::LeadCreateResponse::User
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        member: WhopSDK::Models::LeadCreateResponse::Member?,
+        metadata: ::Hash[Symbol, top]?,
+        product: WhopSDK::Models::LeadCreateResponse::Product?,
+        referrer: String?,
+        updated_at: Time,
+        user: WhopSDK::Models::LeadCreateResponse::User
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        member: WhopSDK::Models::LeadCreateResponse::Member?,
+        metadata: ::Hash[Symbol, top]?,
+        product: WhopSDK::Models::LeadCreateResponse::Product?,
+        referrer: String?,
+        updated_at: Time,
+        user: WhopSDK::Models::LeadCreateResponse::User
+      }
+
+      type member = { id: String }
+
+      class Member < WhopSDK::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
+      end
+
+      type product = { id: String, title: String }
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor title: String
+
+        def initialize: (id: String, title: String) -> void
+
+        def to_hash: -> { id: String, title: String }
+      end
+
+      type user =
+        { id: String, email: String?, name: String?, username: String }
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor email: String?
+
+        attr_accessor name: String?
+
+        attr_accessor username: String
+
+        def initialize: (
+          id: String,
+          email: String?,
+          name: String?,
+          username: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          email: String?,
+          name: String?,
+          username: String
+        }
+      end
+    end
+  end
+end