whop_sdk 0.0.19 → 0.0.22

data/lib/whop_sdk/resources/payments.rb

@@ -25,7 +25,7 @@ module WhopSDK
       # - `member:phone:read`
       # - `promo_code:basic:read`
       #
-      # @overload create(company_id:, member_id:, payment_method_id:, plan:, plan_id:, request_options: {})
+      # @overload create(company_id:, member_id:, payment_method_id:, plan:, plan_id:, metadata: nil, request_options: {})
       #
       # @param company_id [String] The ID of the company to create the payment for.
       #
@@ -37,6 +37,8 @@ module WhopSDK
       #
       # @param plan_id [String] An ID of an existing plan to use for the payment.
       #
+      # @param metadata [Hash{Symbol=>Object}, nil] Custom metadata to attach to the payment.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Payment]

data/lib/whop_sdk/resources/payout_methods.rb

@@ -3,6 +3,30 @@
 module WhopSDK
   module Resources
     class PayoutMethods
+      # Retrieves a payout method by ID
+      #
+      # Required permissions:
+      #
+      # - `payout:destination:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the payout method
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::PayoutMethodRetrieveResponse]
+      #
+      # @see WhopSDK::Models::PayoutMethodRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["payout_methods/%1$s", id],
+          model: WhopSDK::Models::PayoutMethodRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
       # Lists payout destinations for a company
       #
       # Required permissions:

data/lib/whop_sdk/resources/support_channels.rb

@@ -14,7 +14,7 @@ module WhopSDK
       #
       # @param company_id [String] The ID of the company to create the support chat in
       #
-      # @param user_id [String] The ID of the user to create the support chat for
+      # @param user_id [String] The ID (user_xxx) or username of the user to create the support chat for
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/whop_sdk/resources/topups.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Topups
+      # Add funds to your platform balance by charging a stored payment method.
+      #
+      # Required permissions:
+      #
+      # - `payment:charge`
+      #
+      # @overload create(amount:, company_id:, currency:, payment_method_id:, request_options: {})
+      #
+      # @param amount [Float] The amount to add to the balance.
+      #
+      # @param company_id [String] The ID of the company to add funds to.
+      #
+      # @param currency [Symbol, WhopSDK::Models::Currency] The currency of the top-up.
+      #
+      # @param payment_method_id [String] The ID of the payment method to charge for the top-up.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::TopupCreateResponse]
+      #
+      # @see WhopSDK::Models::TopupCreateParams
+      def create(params)
+        parsed, options = WhopSDK::TopupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "topups",
+          body: parsed,
+          model: WhopSDK::Models::TopupCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/verifications.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Verifications
+      # Retrieves a verification by ID
+      #
+      # Required permissions:
+      #
+      # - `payout:account:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the verification
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::VerificationRetrieveResponse]
+      #
+      # @see WhopSDK::Models::VerificationRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["verifications/%1$s", id],
+          model: WhopSDK::Models::VerificationRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/webhooks.rb

@@ -5,7 +5,7 @@ module WhopSDK
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::SetupIntentRequiresActionWebhookEvent, WhopSDK::Models::SetupIntentSucceededWebhookEvent, WhopSDK::Models::SetupIntentCanceledWebhookEvent, WhopSDK::Models::WithdrawalCreatedWebhookEvent, WhopSDK::Models::WithdrawalUpdatedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentCreatedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent, WhopSDK::Models::RefundCreatedWebhookEvent, WhopSDK::Models::RefundUpdatedWebhookEvent]
+      # @return [WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::SetupIntentRequiresActionWebhookEvent, WhopSDK::Models::SetupIntentSucceededWebhookEvent, WhopSDK::Models::SetupIntentCanceledWebhookEvent, WhopSDK::Models::WithdrawalCreatedWebhookEvent, WhopSDK::Models::WithdrawalUpdatedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PayoutMethodCreatedWebhookEvent, WhopSDK::Models::VerificationSucceededWebhookEvent, WhopSDK::Models::PaymentCreatedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent, WhopSDK::Models::RefundCreatedWebhookEvent, WhopSDK::Models::RefundUpdatedWebhookEvent, WhopSDK::Models::MembershipCancelAtPeriodEndChangedWebhookEvent]
       def unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         WhopSDK::Internal::Type::Converter.coerce(WhopSDK::Models::UnwrapWebhookEvent, parsed)

data/lib/whop_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhopSDK
-  VERSION = "0.0.19"
+  VERSION = "0.0.22"
 end

data/lib/whop_sdk.rb

@@ -215,6 +215,14 @@ require_relative "whop_sdk/models/invoice_voided_webhook_event"
 require_relative "whop_sdk/models/invoice_void_params"
 require_relative "whop_sdk/models/invoice_void_response"
 require_relative "whop_sdk/models/languages"
+require_relative "whop_sdk/models/lead_create_params"
+require_relative "whop_sdk/models/lead_create_response"
+require_relative "whop_sdk/models/lead_list_params"
+require_relative "whop_sdk/models/lead_list_response"
+require_relative "whop_sdk/models/lead_retrieve_params"
+require_relative "whop_sdk/models/lead_retrieve_response"
+require_relative "whop_sdk/models/lead_update_params"
+require_relative "whop_sdk/models/lead_update_response"
 require_relative "whop_sdk/models/ledger_account_retrieve_params"
 require_relative "whop_sdk/models/ledger_account_retrieve_response"
 require_relative "whop_sdk/models/lesson"
@@ -227,6 +235,7 @@ require_relative "whop_sdk/models/member_retrieve_params"
 require_relative "whop_sdk/models/member_retrieve_response"
 require_relative "whop_sdk/models/membership"
 require_relative "whop_sdk/models/membership_activated_webhook_event"
+require_relative "whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event"
 require_relative "whop_sdk/models/membership_cancel_params"
 require_relative "whop_sdk/models/membership_deactivated_webhook_event"
 require_relative "whop_sdk/models/membership_list_params"
@@ -266,8 +275,11 @@ require_relative "whop_sdk/models/payment_retrieve_params"
 require_relative "whop_sdk/models/payment_retry_params"
 require_relative "whop_sdk/models/payment_succeeded_webhook_event"
 require_relative "whop_sdk/models/payment_void_params"
+require_relative "whop_sdk/models/payout_method_created_webhook_event"
 require_relative "whop_sdk/models/payout_method_list_params"
 require_relative "whop_sdk/models/payout_method_list_response"
+require_relative "whop_sdk/models/payout_method_retrieve_params"
+require_relative "whop_sdk/models/payout_method_retrieve_response"
 require_relative "whop_sdk/models/plan"
 require_relative "whop_sdk/models/plan_create_params"
 require_relative "whop_sdk/models/plan_delete_params"
@@ -338,6 +350,8 @@ require_relative "whop_sdk/models/support_channel_list_params"
 require_relative "whop_sdk/models/support_channel_list_response"
 require_relative "whop_sdk/models/support_channel_retrieve_params"
 require_relative "whop_sdk/models/tax_type"
+require_relative "whop_sdk/models/topup_create_params"
+require_relative "whop_sdk/models/topup_create_response"
 require_relative "whop_sdk/models/transfer"
 require_relative "whop_sdk/models/transfer_create_params"
 require_relative "whop_sdk/models/transfer_list_params"
@@ -348,6 +362,9 @@ require_relative "whop_sdk/models/user_check_access_params"
 require_relative "whop_sdk/models/user_check_access_response"
 require_relative "whop_sdk/models/user_retrieve_params"
 require_relative "whop_sdk/models/user_retrieve_response"
+require_relative "whop_sdk/models/verification_retrieve_params"
+require_relative "whop_sdk/models/verification_retrieve_response"
+require_relative "whop_sdk/models/verification_succeeded_webhook_event"
 require_relative "whop_sdk/models/visibility"
 require_relative "whop_sdk/models/visibility_filter"
 require_relative "whop_sdk/models/webhook_unwrap_params"
@@ -388,6 +405,7 @@ require_relative "whop_sdk/resources/fee_markups"
 require_relative "whop_sdk/resources/forum_posts"
 require_relative "whop_sdk/resources/forums"
 require_relative "whop_sdk/resources/invoices"
+require_relative "whop_sdk/resources/leads"
 require_relative "whop_sdk/resources/ledger_accounts"
 require_relative "whop_sdk/resources/members"
 require_relative "whop_sdk/resources/memberships"
@@ -405,8 +423,10 @@ require_relative "whop_sdk/resources/reviews"
 require_relative "whop_sdk/resources/setup_intents"
 require_relative "whop_sdk/resources/shipments"
 require_relative "whop_sdk/resources/support_channels"
+require_relative "whop_sdk/resources/topups"
 require_relative "whop_sdk/resources/transfers"
 require_relative "whop_sdk/resources/users"
+require_relative "whop_sdk/resources/verifications"
 require_relative "whop_sdk/resources/webhooks"
 require_relative "whop_sdk/resources/withdrawals"
 require_relative "whop_sdk/helpers/verify_user_token"

data/rbi/whop_sdk/client.rbi

@@ -142,6 +142,15 @@ module WhopSDK
     sig { returns(WhopSDK::Resources::PayoutMethods) }
     attr_reader :payout_methods
 
+    sig { returns(WhopSDK::Resources::Verifications) }
+    attr_reader :verifications
+
+    sig { returns(WhopSDK::Resources::Leads) }
+    attr_reader :leads
+
+    sig { returns(WhopSDK::Resources::Topups) }
+    attr_reader :topups
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi

@@ -156,6 +156,12 @@ module WhopSDK
         sig { returns(WhopSDK::Currency::OrSymbol) }
         attr_accessor :currency
 
+        # The application fee amount collected by the platform from this connected
+        # account. Must be less than the total payment amount. Only valid for connected
+        # accounts with a parent company.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :application_fee_amount
+
         # The interval at which the plan charges (renewal plans).
         sig { returns(T.nilable(Integer)) }
         attr_accessor :billing_period
@@ -288,6 +294,7 @@ module WhopSDK
           params(
             company_id: String,
             currency: WhopSDK::Currency::OrSymbol,
+            application_fee_amount: T.nilable(Float),
             billing_period: T.nilable(Integer),
             custom_fields:
               T.nilable(
@@ -331,6 +338,10 @@ module WhopSDK
           company_id:,
           # The respective currency identifier for the plan.
           currency:,
+          # The application fee amount collected by the platform from this connected
+          # account. Must be less than the total payment amount. Only valid for connected
+          # accounts with a parent company.
+          application_fee_amount: nil,
           # The interval at which the plan charges (renewal plans).
           billing_period: nil,
           # An array of custom field objects.
@@ -381,6 +392,7 @@ module WhopSDK
             {
               company_id: String,
               currency: WhopSDK::Currency::OrSymbol,
+              application_fee_amount: T.nilable(Float),
               billing_period: T.nilable(Integer),
               custom_fields:
                 T.nilable(

data/rbi/whop_sdk/models/company_create_params.rbi

@@ -23,6 +23,14 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :title
 
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
+      attr_accessor :business_type
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::OrSymbol)) }
+      attr_accessor :industry_type
+
       # Additional metadata for the account
       sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
       attr_accessor :metadata
@@ -39,6 +47,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
@@ -51,6 +61,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.
@@ -68,6 +82,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

data/rbi/whop_sdk/models/company_update_params.rbi

@@ -24,6 +24,14 @@ module WhopSDK
       end
       attr_accessor :banner_image
 
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
+      attr_accessor :business_type
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::OrSymbol)) }
+      attr_accessor :industry_type
+
       # The logo for the company in png, jpeg, or gif format
       sig do
         returns(
@@ -57,6 +65,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(
@@ -72,6 +82,10 @@ module WhopSDK
       def self.new(
         # 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.
@@ -95,6 +109,8 @@ module WhopSDK
                   WhopSDK::CompanyUpdateParams::BannerImage::AttachmentInputWithID
                 )
               ),
+            business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
             logo:
               T.nilable(
                 T.any(

data/rbi/whop_sdk/models/lead_create_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class LeadCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::LeadCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to create a lead for.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Custom metadata for the lead.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # The ID of the product the lead is interested in.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_id
+
+      # The url referrer of the lead, if any.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :referrer
+
+      # The ID of the user to create a lead for. If the request is made by a user, that
+      # user will be used.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :user_id
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end