whop_sdk 0.0.4 → 0.0.6

data/rbi/whop_sdk/models/notification_create_params.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class NotificationCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::NotificationCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The content of the notification
+      sig { returns(String) }
+      attr_accessor :content
+
+      # The title of the notification
+      sig { returns(String) }
+      attr_accessor :title
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :icon_user_id
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :rest_path
+
+      # The subtitle of the notification
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subtitle
+
+      # If provided, this will only send to these users if they are also in the main
+      # scope (experience or company)
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :user_ids
+
+      # 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.
+      sig { returns(String) }
+      attr_accessor :experience_id
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            content: String,
+            title: String,
+            icon_user_id: T.nilable(String),
+            rest_path: T.nilable(String),
+            subtitle: T.nilable(String),
+            user_ids: T.nilable(T::Array[String]),
+            experience_id: String,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/notification_create_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class NotificationCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::NotificationCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # Whether the notification was successfully queued for delivery
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      # Response from queuing a notification
+      sig { params(success: T::Boolean).returns(T.attached_class) }
+      def self.new(
+        # Whether the notification was successfully queued for delivery
+        success:
+      )
+      end
+
+      sig { override.returns({ success: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/payment.rbi

@@ -104,7 +104,7 @@ module WhopSDK
       sig { params(plan: T.nilable(WhopSDK::Payment::Plan::OrHash)).void }
       attr_writer :plan
 
-      # The access pass attached to this payment.
+      # The product this payment was made for
       sig { returns(T.nilable(WhopSDK::Payment::Product)) }
       attr_reader :product
 
@@ -248,7 +248,7 @@ module WhopSDK
         payment_method_type:,
         # The plan attached to this payment.
         plan:,
-        # The access pass attached to this payment.
+        # The product this payment was made for
         product:,
         # The promo code used for this payment.
         promo_code:,
@@ -553,7 +553,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass attached to this payment.
+        # The product this payment was made for
         sig do
           params(id: String, route: String, title: String).returns(
             T.attached_class

data/rbi/whop_sdk/models/payment_list_response.rbi

@@ -133,7 +133,7 @@ module WhopSDK
       end
       attr_writer :plan
 
-      # The access pass attached to this payment.
+      # The product this payment was made for
       sig { returns(T.nilable(WhopSDK::Models::PaymentListResponse::Product)) }
       attr_reader :product
 
@@ -299,7 +299,7 @@ module WhopSDK
         payment_method_type:,
         # The plan attached to this payment.
         plan:,
-        # The access pass attached to this payment.
+        # The product this payment was made for
         product:,
         # The promo code used for this payment.
         promo_code:,
@@ -625,7 +625,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass attached to this payment.
+        # The product this payment was made for
         sig do
           params(id: String, route: String, title: String).returns(
             T.attached_class

data/rbi/whop_sdk/models/plan.rbi

@@ -79,7 +79,7 @@ module WhopSDK
       sig { returns(WhopSDK::PlanType::TaggedSymbol) }
       attr_accessor :plan_type
 
-      # The access pass for the plan.
+      # The product that this plan belongs to.
       sig { returns(T.nilable(WhopSDK::Plan::Product)) }
       attr_reader :product
 
@@ -126,7 +126,9 @@ module WhopSDK
       sig { returns(WhopSDK::Visibility::TaggedSymbol) }
       attr_accessor :visibility
 
-      # An object representing a (sanitized) plan of an access pass.
+      # A plan for an product. Plans define the core parameters that define a checkout
+      # and payment on whop. Use plans to create different ways to price your products
+      # (Eg renewal / one_time)
       sig do
         params(
           id: String,
@@ -189,7 +191,7 @@ module WhopSDK
         payment_method_configuration:,
         # Indicates if the plan is a one time payment or recurring.
         plan_type:,
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         product:,
         # The direct link to purchase the product.
         purchase_url:,
@@ -453,7 +455,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         sig { params(id: String, title: String).returns(T.attached_class) }
         def self.new(
           # The internal ID of the public product.

data/rbi/whop_sdk/models/plan_create_params.rbi

@@ -88,7 +88,7 @@ module WhopSDK
       end
       attr_writer :payment_method_configuration
 
-      # The type of plan that can be attached to an access pass
+      # The type of plan that can be attached to a product
       sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
       attr_accessor :plan_type
 
@@ -197,7 +197,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,

data/rbi/whop_sdk/models/plan_list_response.rbi

@@ -90,7 +90,7 @@ module WhopSDK
       sig { returns(WhopSDK::PlanType::TaggedSymbol) }
       attr_accessor :plan_type
 
-      # The access pass for the plan.
+      # The product that this plan belongs to.
       sig { returns(T.nilable(WhopSDK::Models::PlanListResponse::Product)) }
       attr_reader :product
 
@@ -137,7 +137,9 @@ module WhopSDK
       sig { returns(WhopSDK::Visibility::TaggedSymbol) }
       attr_accessor :visibility
 
-      # An object representing a (sanitized) plan of an access pass.
+      # A plan for an product. Plans define the core parameters that define a checkout
+      # and payment on whop. Use plans to create different ways to price your products
+      # (Eg renewal / one_time)
       sig do
         params(
           id: String,
@@ -198,7 +200,7 @@ module WhopSDK
         payment_method_configuration:,
         # Indicates if the plan is a one time payment or recurring.
         plan_type:,
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         product:,
         # The direct link to purchase the product.
         purchase_url:,
@@ -395,7 +397,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass for the plan.
+        # The product that this plan belongs to.
         sig { params(id: String, title: String).returns(T.attached_class) }
         def self.new(
           # The internal ID of the public product.

data/rbi/whop_sdk/models/plan_type.rbi

@@ -2,7 +2,7 @@
 
 module WhopSDK
   module Models
-    # The type of plan that can be attached to an access pass
+    # The type of plan that can be attached to a product
     module PlanType
       extend WhopSDK::Internal::Type::Enum
 

data/rbi/whop_sdk/models/product.rbi

@@ -119,7 +119,7 @@ module WhopSDK
       sig { returns(WhopSDK::Visibility::TaggedSymbol) }
       attr_accessor :visibility
 
-      # An object representing a (sanitized) access pass.
+      # Represents a product on whop. Use products to sell anything on the platform.
       sig do
         params(
           id: String,

data/rbi/whop_sdk/models/product_create_params.rbi

@@ -53,7 +53,7 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :global_affiliate_percentage
 
-      # The different statuses of the global affiliate program for an access pass.
+      # The different statuses of the global affiliate program for a product.
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :global_affiliate_status
 
@@ -69,7 +69,7 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :member_affiliate_percentage
 
-      # The different statuses of the global affiliate program for an access pass.
+      # The different statuses of the global affiliate program for a product.
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :member_affiliate_status
 
@@ -164,7 +164,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,
@@ -172,7 +172,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,
@@ -257,7 +257,7 @@ module WhopSDK
         sig { returns(T.nilable(Float)) }
         attr_accessor :initial_price
 
-        # The type of plan that can be attached to an access pass
+        # The type of plan that can be attached to a product
         sig { returns(T.nilable(WhopSDK::PlanType::OrSymbol)) }
         attr_accessor :plan_type
 
@@ -300,7 +300,7 @@ module WhopSDK
           custom_fields: nil,
           # An additional amount charged upon first purchase.
           initial_price: 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,

data/rbi/whop_sdk/models/product_list_item.rbi

@@ -62,7 +62,7 @@ module WhopSDK
       sig { returns(WhopSDK::Visibility::TaggedSymbol) }
       attr_accessor :visibility
 
-      # An object representing a (sanitized) access pass.
+      # Represents a product on whop. Use products to sell anything on the platform.
       sig do
         params(
           id: String,

data/rbi/whop_sdk/models/product_update_params.rbi

@@ -54,7 +54,7 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :global_affiliate_percentage
 
-      # The different statuses of the global affiliate program for an access pass.
+      # The different statuses of the global affiliate program for a product.
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :global_affiliate_status
 
@@ -70,7 +70,7 @@ module WhopSDK
       sig { returns(T.nilable(Float)) }
       attr_accessor :member_affiliate_percentage
 
-      # The different statuses of the global affiliate program for an access pass.
+      # The different statuses of the global affiliate program for a product.
       sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
       attr_accessor :member_affiliate_status
 
@@ -158,7 +158,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,
@@ -166,7 +166,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,

data/rbi/whop_sdk/models/promo_code.rbi

@@ -58,7 +58,7 @@ module WhopSDK
       sig { returns(T::Boolean) }
       attr_accessor :one_per_customer
 
-      # The access pass associated with the promo code.
+      # The product this promo code applies to
       sig { returns(T.nilable(WhopSDK::PromoCode::Product)) }
       attr_reader :product
 
@@ -141,7 +141,7 @@ module WhopSDK
         new_users_only:,
         # Restricts promo use to only be applied once per customer.
         one_per_customer:,
-        # The access pass associated with the promo code.
+        # The product this promo code applies to
         product:,
         # The number of months the promo is applied for.
         promo_duration_months:,
@@ -229,7 +229,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass associated with the promo code.
+        # The product this promo code applies to
         sig { params(id: String, title: String).returns(T.attached_class) }
         def self.new(
           # The internal ID of the public product.

data/rbi/whop_sdk/models/promo_code_list_response.rbi

@@ -56,7 +56,7 @@ module WhopSDK
       sig { returns(T::Boolean) }
       attr_accessor :one_per_customer
 
-      # The access pass associated with the promo code.
+      # The product this promo code applies to
       sig do
         returns(T.nilable(WhopSDK::Models::PromoCodeListResponse::Product))
       end
@@ -142,7 +142,7 @@ module WhopSDK
         new_users_only:,
         # Restricts promo use to only be applied once per customer.
         one_per_customer:,
-        # The access pass associated with the promo code.
+        # The product this promo code applies to
         product:,
         # The number of months the promo is applied for.
         promo_duration_months:,
@@ -203,7 +203,7 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :title
 
-        # The access pass associated with the promo code.
+        # The product this promo code applies to
         sig { params(id: String, title: String).returns(T.attached_class) }
         def self.new(
           # The internal ID of the public product.

data/rbi/whop_sdk/models/unwrap_webhook_event.rbi

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

data/rbi/whop_sdk/models.rbi

@@ -5,6 +5,8 @@ module WhopSDK
 
   AccessPassType = WhopSDK::Models::AccessPassType
 
+  AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
+
   App = WhopSDK::Models::App
 
   AppBuild = WhopSDK::Models::AppBuild
@@ -128,16 +130,36 @@ module WhopSDK
 
   CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
 
+  CourseVisibilities = WhopSDK::Models::CourseVisibilities
+
   Currency = WhopSDK::Models::Currency
 
   CustomCta = WhopSDK::Models::CustomCta
 
   Direction = WhopSDK::Models::Direction
 
+  Dispute = WhopSDK::Models::Dispute
+
+  DisputeCreatedWebhookEvent = WhopSDK::Models::DisputeCreatedWebhookEvent
+
+  DisputeListParams = WhopSDK::Models::DisputeListParams
+
+  DisputeRetrieveParams = WhopSDK::Models::DisputeRetrieveParams
+
+  DisputeStatuses = WhopSDK::Models::DisputeStatuses
+
+  DisputeSubmitEvidenceParams = WhopSDK::Models::DisputeSubmitEvidenceParams
+
+  DisputeUpdatedWebhookEvent = WhopSDK::Models::DisputeUpdatedWebhookEvent
+
+  DisputeUpdateEvidenceParams = WhopSDK::Models::DisputeUpdateEvidenceParams
+
   DmsPostTypes = WhopSDK::Models::DmsPostTypes
 
   EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
 
+  EmbedType = WhopSDK::Models::EmbedType
+
   Entry = WhopSDK::Models::Entry
 
   EntryApprovedWebhookEvent = WhopSDK::Models::EntryApprovedWebhookEvent
@@ -272,6 +294,8 @@ module WhopSDK
 
   MessageUpdateParams = WhopSDK::Models::MessageUpdateParams
 
+  NotificationCreateParams = WhopSDK::Models::NotificationCreateParams
+
   PageInfo = WhopSDK::Models::PageInfo
 
   Payment = WhopSDK::Models::Payment

data/rbi/whop_sdk/resources/access_tokens.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class AccessTokens
+      # Creates an access token for a user to access a specific resource. These access
+      # tokens are designed to be used with Whop's embedded components.
+      sig do
+        params(
+          scoped_actions: T::Array[String],
+          target_resource_id: String,
+          target_resource_type:
+            WhopSDK::AccessTokenCreateParams::TargetResourceType::OrSymbol,
+          expires_at: T.nilable(Time),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AccessTokenCreateResponse)
+      end
+      def create(
+        # Array of desired scoped actions for the access token. This list must be a subset
+        # of the API keys's existing permissions. Otherwise, an error will be raised.
+        scoped_actions:,
+        # The ID of the target resource (Company, User, etc.) for which the access token
+        # is being created.
+        target_resource_id:,
+        # The type of the target resource (company, user, product, experience, etc.).
+        target_resource_type:,
+        # The expiration timestamp for the access token. If not provided, a default
+        # expiration time of 1 hour will be used. The expiration can be set to a maximum
+        # of 3 hours from the current time.
+        expires_at: 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/app_builds.rbi

@@ -55,7 +55,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::AppBuild)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the app build
+        id,
+        request_options: {}
+      )
       end
 
       # Lists app builds for an app
@@ -107,7 +111,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::AppBuild)
       end
-      def promote(id, request_options: {})
+      def promote(
+        # The ID of the app build to promote.
+        id,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/whop_sdk/resources/apps.rbi

@@ -39,7 +39,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::App)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the app
+        id,
+        request_options: {}
+      )
       end
 
       # Update an existing App
@@ -74,6 +78,7 @@ module WhopSDK
         ).returns(WhopSDK::App)
       end
       def update(
+        # The ID of the app
         id,
         # The description of the app for the app store in-depth app view.
         app_store_description: nil,

data/rbi/whop_sdk/resources/authorized_users.rbi

@@ -15,7 +15,11 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::AuthorizedUserRetrieveResponse)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the authorized user
+        id,
+        request_options: {}
+      )
       end
 
       # Lists authorized users

data/rbi/whop_sdk/resources/chat_channels.rbi

@@ -14,7 +14,12 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::ChatChannel)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the chat channel to fetch, it can be an experience ID or a chat
+        # channel ID
+        id,
+        request_options: {}
+      )
       end
 
       # Updates a chat channel
@@ -35,6 +40,8 @@ module WhopSDK
         ).returns(WhopSDK::ChatChannel)
       end
       def update(
+        # The ID of the chat channel to update. Can be an experience ID or a chat feed
+        # external ID.
         id,
         # Whether media uploads are banned in this chat
         ban_media: nil,