whop_sdk 0.0.4 → 0.0.6

data/rbi/whop_sdk/resources/ledger_accounts.rbi

@@ -3,7 +3,7 @@
 module WhopSDK
   module Resources
     class LedgerAccounts
-      # Retrieves a ledger account by ID
+      # Retrieves a ledger account by its ID, company ID or user ID
       #
       # Required permissions:
       #
@@ -14,7 +14,12 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::LedgerAccountRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # Either a User ID, Company ID, or LedgerAccount ID (user_xxx, biz_xxx, or
+        # ldgr_xxx)
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/members.rbi

@@ -16,7 +16,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::MemberRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the member
+        id,
+        request_options: {}
+      )
       end
 
       # List the members of a company
@@ -30,7 +34,6 @@ module WhopSDK
         params(
           company_id: String,
           access_level: T.nilable(WhopSDK::AccessLevel::OrSymbol),
-          access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
           created_after: T.nilable(Time),
@@ -42,6 +45,7 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::MemberMostRecentActions::OrSymbol]),
           order: T.nilable(WhopSDK::MemberListParams::Order::OrSymbol),
           plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
           promo_code_ids: T.nilable(T::Array[String]),
           query: T.nilable(String),
           statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
@@ -54,10 +58,8 @@ module WhopSDK
       def list(
         # The ID of the company to list members for
         company_id:,
-        # The access level a given user (or company) has to an access pass or company.
+        # The access level a given user (or company) has to a product or company.
         access_level: nil,
-        # The access pass IDs to filter the members by
-        access_pass_ids: nil,
         # 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.
@@ -78,6 +80,8 @@ module WhopSDK
         order: nil,
         # The plan IDs to filter the members by
         plan_ids: nil,
+        # The product IDs to filter the members by
+        product_ids: nil,
         # The promo code IDs to filter the members by
         promo_code_ids: nil,
         # The name, username, or email to filter the members by. The email filter will

data/rbi/whop_sdk/resources/memberships.rbi

@@ -14,7 +14,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Membership)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the membership or a license key
+        id,
+        request_options: {}
+      )
       end
 
       # Update a membership
@@ -31,6 +35,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def update(
+        # The ID of the membership.
         id,
         # The metadata to update the membership with.
         metadata: nil,
@@ -45,7 +50,6 @@ module WhopSDK
       # - `member:basic:read`
       sig do
         params(
-          access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
           cancel_options:
@@ -60,6 +64,7 @@ module WhopSDK
           last: T.nilable(Integer),
           order: T.nilable(WhopSDK::MembershipListParams::Order::OrSymbol),
           plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
           promo_code_ids: T.nilable(T::Array[String]),
           statuses: T.nilable(T::Array[WhopSDK::MembershipStatus::OrSymbol]),
           user_ids: T.nilable(T::Array[String]),
@@ -69,8 +74,6 @@ module WhopSDK
         )
       end
       def list(
-        # The access pass IDs to filter the memberships by
-        access_pass_ids: nil,
         # 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.
@@ -93,6 +96,8 @@ module WhopSDK
         order: nil,
         # The plan IDs to filter the memberships by
         plan_ids: nil,
+        # The product IDs to filter the memberships by
+        product_ids: nil,
         # The promo code IDs to filter the memberships by
         promo_code_ids: nil,
         # The membership status to filter the memberships by
@@ -121,6 +126,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def cancel(
+        # The ID of the membership.
         id,
         # The mode of cancellation for a membership
         cancellation_mode: nil,
@@ -142,6 +148,7 @@ module WhopSDK
         ).returns(WhopSDK::Membership)
       end
       def pause(
+        # The ID of the membership you want to pause.
         id,
         # Whether to void past_due payments associated with the membership to prevent
         # future payment attempts.
@@ -162,7 +169,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Membership)
       end
-      def resume(id, request_options: {})
+      def resume(
+        # The ID of the membership you want to resume.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/messages.rbi

@@ -49,7 +49,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Message)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the message
+        id,
+        request_options: {}
+      )
       end
 
       # Updates an existing message
@@ -71,6 +75,7 @@ module WhopSDK
         ).returns(WhopSDK::Message)
       end
       def update(
+        # The ID of the message to update
         id,
         # The attachments for this message
         attachments: nil,

data/rbi/whop_sdk/resources/notifications.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Notifications
+      # Queues a notification to be sent to users in an experience or company team
+      sig do
+        params(
+          company_id: String,
+          content: String,
+          title: String,
+          experience_id: String,
+          icon_user_id: T.nilable(String),
+          rest_path: T.nilable(String),
+          subtitle: T.nilable(String),
+          user_ids: T.nilable(T::Array[String]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::NotificationCreateResponse)
+      end
+      def create(
+        # The id of the company to target. Only team members of this company will receive
+        # the notification. When clicked will take the user to your dashboard app view.
+        company_id:,
+        # The content of the notification
+        content:,
+        # The title of the notification
+        title:,
+        # The id of the experience to target. All users with access to this experience
+        # (customers and admins) will receive the notification. When clicked, open your
+        # experience view.
+        experience_id:,
+        # Optional: ID of a Whop user whose profile picture will be used as the
+        # notification icon. If not provided, defaults to the experience or company
+        # avatar.
+        icon_user_id: nil,
+        # The rest path to append to the generated deep link that opens your app. Use
+        # [restPath] in your app path in the dashboard to read this parameter.
+        rest_path: nil,
+        # The subtitle of the notification
+        subtitle: nil,
+        # If provided, this will only send to these users if they are also in the main
+        # scope (experience or company)
+        user_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/payments.rbi

@@ -20,7 +20,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the payment
+        id,
+        request_options: {}
+      )
       end
 
       # Lists payments
@@ -115,6 +119,7 @@ module WhopSDK
         ).returns(WhopSDK::Payment)
       end
       def refund(
+        # The ID of the payment you want to update or take action upon.
         id,
         # An amount if the refund is supposed to be partial.
         partial_amount: nil,
@@ -139,7 +144,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def retry_(id, request_options: {})
+      def retry_(
+        # The ID of the payment
+        id,
+        request_options: {}
+      )
       end
 
       # Voids a payment
@@ -159,7 +168,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Payment)
       end
-      def void(id, request_options: {})
+      def void(
+        # The ID of the payment you want to void.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/plans.rbi

@@ -76,7 +76,7 @@ module WhopSDK
         # 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 an access pass
+        # 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,
@@ -114,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
@@ -160,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,
@@ -270,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
@@ -145,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,
@@ -164,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,
@@ -172,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,
@@ -244,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

@@ -52,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/rbi/whop_sdk/resources/webhooks.rbi

@@ -19,7 +19,9 @@ module WhopSDK
             WhopSDK::CourseLessonInteractionCompletedWebhookEvent,
             WhopSDK::PaymentSucceededWebhookEvent,
             WhopSDK::PaymentFailedWebhookEvent,
-            WhopSDK::PaymentPendingWebhookEvent
+            WhopSDK::PaymentPendingWebhookEvent,
+            WhopSDK::DisputeCreatedWebhookEvent,
+            WhopSDK::DisputeUpdatedWebhookEvent
           )
         )
       end

data/sig/whop_sdk/client.rbs

@@ -10,7 +10,7 @@ module WhopSDK
 
     attr_reader api_key: String
 
-    attr_reader app_id: String
+    attr_reader app_id: String?
 
     attr_reader apps: WhopSDK::Resources::Apps
 
@@ -74,6 +74,12 @@ module WhopSDK
 
     attr_reader course_students: WhopSDK::Resources::CourseStudents
 
+    attr_reader access_tokens: WhopSDK::Resources::AccessTokens
+
+    attr_reader notifications: WhopSDK::Resources::Notifications
+
+    attr_reader disputes: WhopSDK::Resources::Disputes
+
     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/company.rbs

@@ -145,6 +145,7 @@ module WhopSDK
           | :linkedin
           | :twitch
           | :website
+          | :custom
 
         module Website
           extend WhopSDK::Internal::Type::Enum
@@ -157,6 +158,7 @@ module WhopSDK
           LINKEDIN: :linkedin
           TWITCH: :twitch
           WEBSITE: :website
+          CUSTOM: :custom
 
           def self?.values: -> ::Array[WhopSDK::Models::Company::SocialLink::website]
         end