whop_sdk 0.0.3 → 0.0.5

data/rbi/whop_sdk/resources/plans.rbi

@@ -20,10 +20,20 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanCreateParams::PaymentMethodConfiguration::OrHash
+            ),
           plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
           release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
           renewal_price: T.nilable(Float),
@@ -63,7 +73,10 @@ module WhopSDK
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
-        # The type of plan that can be attached to an access pass
+        # The explicit payment method configuration for the plan. If not provided, the
+        # platform or company's defaults will apply.
+        payment_method_configuration: nil,
+        # The type of plan that can be attached to a product
         plan_type: nil,
         # The methods of how a plan can be released.
         release_method: nil,
@@ -101,7 +114,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Plan)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the plan
+        id,
+        request_options: {}
+      )
       end
 
       # Update an existing Plan
@@ -120,11 +137,21 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           offer_cancel_discount: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanUpdateParams::PaymentMethodConfiguration::OrHash
+            ),
           renewal_price: T.nilable(Float),
           stock: T.nilable(Integer),
           strike_through_initial_price: T.nilable(Float),
@@ -137,6 +164,7 @@ module WhopSDK
         ).returns(WhopSDK::Plan)
       end
       def update(
+        # The ID
         id,
         # The interval at which the plan charges (renewal plans).
         billing_period: nil,
@@ -159,6 +187,9 @@ module WhopSDK
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
+        # The explicit payment method configuration for the plan. If sent as null, the
+        # custom configuration will be removed.
+        payment_method_configuration: nil,
         # The amount the customer is charged every billing period.
         renewal_price: nil,
         # The number of units available for purchase.
@@ -244,7 +275,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The ID of the plan to delete.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/products.rbi

@@ -64,7 +64,7 @@ module WhopSDK
         experience_ids: nil,
         # The percentage of the revenue that goes to the global affiliate program.
         global_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for an access pass.
+        # The different statuses of the global affiliate program for a product.
         global_affiliate_status: nil,
         # The headline of the product.
         headline: nil,
@@ -72,7 +72,7 @@ module WhopSDK
         industry_type: nil,
         # The percentage of the revenue that goes to the member affiliate program.
         member_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for an access pass.
+        # The different statuses of the global affiliate program for a product.
         member_affiliate_status: nil,
         # The details to assign an autogenerated plan.
         plan_options: nil,
@@ -101,7 +101,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Product)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID or route of the product
+        id,
+        request_options: {}
+      )
       end
 
       # Updates an existing Product
@@ -114,7 +118,12 @@ module WhopSDK
         params(
           id: String,
           banner_image:
-            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash),
+            T.nilable(
+              T.any(
+                WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::ProductUpdateParams::BannerImage::AttachmentInputWithID::OrHash
+              )
+            ),
           business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
           collect_shipping_address: T.nilable(T::Boolean),
           custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -140,6 +149,7 @@ module WhopSDK
         ).returns(WhopSDK::Product)
       end
       def update(
+        # The ID (tag) of the product
         id,
         # A banner image for the product in png, jpeg format
         banner_image: nil,
@@ -159,7 +169,7 @@ module WhopSDK
         description: nil,
         # The percentage of the revenue that goes to the global affiliate program.
         global_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for an access pass.
+        # The different statuses of the global affiliate program for a product.
         global_affiliate_status: nil,
         # The headline of the product.
         headline: nil,
@@ -167,7 +177,7 @@ module WhopSDK
         industry_type: nil,
         # The percentage of the revenue that goes to the member affiliate program.
         member_affiliate_percentage: nil,
-        # The different statuses of the global affiliate program for an access pass.
+        # The different statuses of the global affiliate program for a product.
         member_affiliate_status: nil,
         # The ID of the product tax code to apply to this product.
         product_tax_code_id: nil,
@@ -239,7 +249,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The internal ID (tag) of the product to delete.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/promo_codes.rbi

@@ -79,7 +79,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::PromoCode)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the promo code to retrieve
+        id,
+        request_options: {}
+      )
       end
 
       # Lists promo codes for a company
@@ -135,7 +139,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T::Boolean)
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The internal ID of the promo code to archive.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/reactions.rbi

@@ -36,7 +36,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Reaction)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the reaction
+        id,
+        request_options: {}
+      )
       end
 
       # Lists reactions for a post or a message

data/rbi/whop_sdk/resources/reviews.rbi

@@ -10,7 +10,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::ReviewRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the review
+        id,
+        request_options: {}
+      )
       end
 
       # List all reviews

data/rbi/whop_sdk/resources/shipments.rbi

@@ -40,7 +40,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Shipment)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the shipment
+        id,
+        request_options: {}
+      )
       end
 
       # Lists shipments for a payment

data/rbi/whop_sdk/resources/support_channels.rbi

@@ -36,7 +36,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::SupportChannel)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the support channel to fetch
+        id,
+        request_options: {}
+      )
       end
 
       # Lists chat channels inside a company

data/rbi/whop_sdk/resources/transfers.rbi

@@ -15,6 +15,7 @@ module WhopSDK
           destination_id: String,
           origin_id: String,
           idempotence_key: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
           notes: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Transfer)
@@ -32,6 +33,8 @@ module WhopSDK
         origin_id:,
         # A unique key to ensure idempotence. Use a UUID or similar.
         idempotence_key: nil,
+        # A hash of metadata to attach to the transfer.
+        metadata: nil,
         # Notes for the transfer. Maximum of 50 characters.
         notes: nil,
         request_options: {}
@@ -49,7 +52,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Transfer)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the transfer
+        id,
+        request_options: {}
+      )
       end
 
       # Lists transfers

data/rbi/whop_sdk/resources/users.rbi

@@ -10,7 +10,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::UserRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID (user_xxx) or username of the user
+        id,
+        request_options: {}
+      )
       end
 
       # Check if a user has access (and their access level) to a resource
@@ -21,7 +25,14 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::UserCheckAccessResponse)
       end
-      def check_access(resource_id, id:, request_options: {})
+      def check_access(
+        # The ID of the resource. Can be a company (biz_xxx), product (prod_xxx), or
+        # experience (exp_xxx)
+        resource_id,
+        # The ID (user_xxx) or username of the user
+        id:,
+        request_options: {}
+      )
       end
 
       # @api private

data/sig/whop_sdk/client.rbs

@@ -72,6 +72,10 @@ module WhopSDK
 
     attr_reader reviews: WhopSDK::Resources::Reviews
 
+    attr_reader course_students: WhopSDK::Resources::CourseStudents
+
+    attr_reader access_tokens: WhopSDK::Resources::AccessTokens
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/whop_sdk/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module WhopSDK
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs

@@ -17,7 +17,10 @@ module WhopSDK
 
         DEFAULT_MAX_CONNECTIONS: Integer
 
-        def self.connect: (URI::Generic url) -> top
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
 
         def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
 

data/sig/whop_sdk/models/access_token_create_params.rbs

@@ -0,0 +1,56 @@
+module WhopSDK
+  module Models
+    type access_token_create_params =
+      {
+        scoped_actions: ::Array[String],
+        target_resource_id: String,
+        target_resource_type: WhopSDK::Models::AccessTokenCreateParams::target_resource_type,
+        expires_at: Time?
+      }
+      & WhopSDK::Internal::Type::request_parameters
+
+    class AccessTokenCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      attr_accessor scoped_actions: ::Array[String]
+
+      attr_accessor target_resource_id: String
+
+      attr_accessor target_resource_type: WhopSDK::Models::AccessTokenCreateParams::target_resource_type
+
+      attr_accessor expires_at: Time?
+
+      def initialize: (
+        scoped_actions: ::Array[String],
+        target_resource_id: String,
+        target_resource_type: WhopSDK::Models::AccessTokenCreateParams::target_resource_type,
+        ?expires_at: Time?,
+        ?request_options: WhopSDK::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        scoped_actions: ::Array[String],
+        target_resource_id: String,
+        target_resource_type: WhopSDK::Models::AccessTokenCreateParams::target_resource_type,
+        expires_at: Time?,
+        request_options: WhopSDK::RequestOptions
+      }
+
+      type target_resource_type =
+        :company | :product | :experience | :app | :user
+
+      module TargetResourceType
+        extend WhopSDK::Internal::Type::Enum
+
+        COMPANY: :company
+        PRODUCT: :product
+        EXPERIENCE: :experience
+        APP: :app
+        USER: :user
+
+        def self?.values: -> ::Array[WhopSDK::Models::AccessTokenCreateParams::target_resource_type]
+      end
+    end
+  end
+end

data/sig/whop_sdk/models/access_token_create_response.rbs

@@ -0,0 +1,15 @@
+module WhopSDK
+  module Models
+    type access_token_create_response = { token: String, expires_at: Time }
+
+    class AccessTokenCreateResponse < WhopSDK::Internal::Type::BaseModel
+      attr_accessor token: String
+
+      attr_accessor expires_at: Time
+
+      def initialize: (token: String, expires_at: Time) -> void
+
+      def to_hash: -> { token: String, expires_at: Time }
+    end
+  end
+end

data/sig/whop_sdk/models/app_build_create_params.rbs

@@ -2,7 +2,7 @@ module WhopSDK
   module Models
     type app_build_create_params =
       {
-        attachment: WhopSDK::AppBuildCreateParams::Attachment,
+        attachment: WhopSDK::Models::AppBuildCreateParams::attachment,
         checksum: String,
         platform: WhopSDK::Models::app_build_platforms,
         app_id: String?,
@@ -14,7 +14,7 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
-      attr_accessor attachment: WhopSDK::AppBuildCreateParams::Attachment
+      attr_accessor attachment: WhopSDK::Models::AppBuildCreateParams::attachment
 
       attr_accessor checksum: String
 
@@ -25,7 +25,7 @@ module WhopSDK
       attr_accessor supported_app_view_types: ::Array[WhopSDK::Models::app_view_type]?
 
       def initialize: (
-        attachment: WhopSDK::AppBuildCreateParams::Attachment,
+        attachment: WhopSDK::Models::AppBuildCreateParams::attachment,
         checksum: String,
         platform: WhopSDK::Models::app_build_platforms,
         ?app_id: String?,
@@ -34,7 +34,7 @@ module WhopSDK
       ) -> void
 
       def to_hash: -> {
-        attachment: WhopSDK::AppBuildCreateParams::Attachment,
+        attachment: WhopSDK::Models::AppBuildCreateParams::attachment,
         checksum: String,
         platform: WhopSDK::Models::app_build_platforms,
         app_id: String?,
@@ -42,16 +42,35 @@ module WhopSDK
         request_options: WhopSDK::RequestOptions
       }
 
-      type attachment = { id: String?, direct_upload_id: String? }
+      type attachment =
+        WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithDirectUploadID
+        | WhopSDK::AppBuildCreateParams::Attachment::AttachmentInputWithID
 
-      class Attachment < WhopSDK::Internal::Type::BaseModel
-        attr_accessor id: String?
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
 
-        attr_accessor direct_upload_id: String?
+        type attachment_input_with_direct_upload_id =
+          { direct_upload_id: String }
 
-        def initialize: (?id: String?, ?direct_upload_id: String?) -> void
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          attr_accessor direct_upload_id: String
 
-        def to_hash: -> { id: String?, direct_upload_id: String? }
+          def initialize: (direct_upload_id: String) -> void
+
+          def to_hash: -> { direct_upload_id: String }
+        end
+
+        type attachment_input_with_id = { id: String }
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          def initialize: (id: String) -> void
+
+          def to_hash: -> { id: String }
+        end
+
+        def self?.variants: -> ::Array[WhopSDK::Models::AppBuildCreateParams::attachment]
       end
     end
   end

data/sig/whop_sdk/models/app_update_params.rbs

@@ -8,7 +8,7 @@ module WhopSDK
         description: String?,
         discover_path: String?,
         experience_path: String?,
-        icon: WhopSDK::AppUpdateParams::Icon?,
+        icon: WhopSDK::Models::AppUpdateParams::icon?,
         name: String?,
         required_scopes: ::Array[WhopSDK::Models::AppUpdateParams::required_scope]?,
         status: WhopSDK::Models::app_statuses?
@@ -31,7 +31,7 @@ module WhopSDK
 
       attr_accessor experience_path: String?
 
-      attr_accessor icon: WhopSDK::AppUpdateParams::Icon?
+      attr_accessor icon: WhopSDK::Models::AppUpdateParams::icon?
 
       attr_accessor name: String?
 
@@ -46,7 +46,7 @@ module WhopSDK
         ?description: String?,
         ?discover_path: String?,
         ?experience_path: String?,
-        ?icon: WhopSDK::AppUpdateParams::Icon?,
+        ?icon: WhopSDK::Models::AppUpdateParams::icon?,
         ?name: String?,
         ?required_scopes: ::Array[WhopSDK::Models::AppUpdateParams::required_scope]?,
         ?status: WhopSDK::Models::app_statuses?,
@@ -60,23 +60,42 @@ module WhopSDK
         description: String?,
         discover_path: String?,
         experience_path: String?,
-        icon: WhopSDK::AppUpdateParams::Icon?,
+        icon: WhopSDK::Models::AppUpdateParams::icon?,
         name: String?,
         required_scopes: ::Array[WhopSDK::Models::AppUpdateParams::required_scope]?,
         status: WhopSDK::Models::app_statuses?,
         request_options: WhopSDK::RequestOptions
       }
 
-      type icon = { id: String?, direct_upload_id: String? }
+      type icon =
+        WhopSDK::AppUpdateParams::Icon::AttachmentInputWithDirectUploadID
+        | WhopSDK::AppUpdateParams::Icon::AttachmentInputWithID
 
-      class Icon < WhopSDK::Internal::Type::BaseModel
-        attr_accessor id: String?
+      module Icon
+        extend WhopSDK::Internal::Type::Union
 
-        attr_accessor direct_upload_id: String?
+        type attachment_input_with_direct_upload_id =
+          { direct_upload_id: String }
 
-        def initialize: (?id: String?, ?direct_upload_id: String?) -> void
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          attr_accessor direct_upload_id: String
 
-        def to_hash: -> { id: String?, direct_upload_id: String? }
+          def initialize: (direct_upload_id: String) -> void
+
+          def to_hash: -> { direct_upload_id: String }
+        end
+
+        type attachment_input_with_id = { id: String }
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          def initialize: (id: String) -> void
+
+          def to_hash: -> { id: String }
+        end
+
+        def self?.variants: -> ::Array[WhopSDK::Models::AppUpdateParams::icon]
       end
 
       type required_scope = :read_user