whop_sdk 0.0.2 → 0.0.3

data/rbi/whop_sdk/resources/memberships.rbi

@@ -45,7 +45,6 @@ module WhopSDK
       # - `member:basic:read`
       sig do
         params(
-          company_id: String,
           access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
@@ -53,6 +52,7 @@ module WhopSDK
             T.nilable(
               T::Array[WhopSDK::MembershipListParams::CancelOption::OrSymbol]
             ),
+          company_id: T.nilable(String),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
           direction: T.nilable(WhopSDK::Direction::OrSymbol),
@@ -62,14 +62,13 @@ module WhopSDK
           plan_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]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[WhopSDK::Models::MembershipListResponse]
         )
       end
       def list(
-        # The ID of the company to list memberships for
-        company_id:,
         # 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.
@@ -78,6 +77,8 @@ module WhopSDK
         before: nil,
         # The cancel options to filter the memberships by
         cancel_options: nil,
+        # The ID of the company to list memberships for
+        company_id: nil,
         # The minimum creation date to filter by
         created_after: nil,
         # The maximum creation date to filter by
@@ -96,6 +97,8 @@ module WhopSDK
         promo_code_ids: nil,
         # The membership status to filter the memberships by
         statuses: nil,
+        # Only return memberships from these whop user ids
+        user_ids: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/messages.rbi

@@ -47,6 +47,31 @@ module WhopSDK
       def retrieve(id, request_options: {})
       end
 
+      # Updates an existing message
+      sig do
+        params(
+          id: String,
+          attachments:
+            T.nilable(
+              T::Array[WhopSDK::MessageUpdateParams::Attachment::OrHash]
+            ),
+          content: T.nilable(String),
+          is_pinned: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Message)
+      end
+      def update(
+        id,
+        # The attachments for this message
+        attachments: nil,
+        # The content of the message in Markdown format
+        content: nil,
+        # Whether this message is pinned
+        is_pinned: nil,
+        request_options: {}
+      )
+      end
+
       # Lists messages inside a channel
       #
       # Required permissions:

data/rbi/whop_sdk/resources/payments.rbi

@@ -40,9 +40,7 @@ module WhopSDK
           after: T.nilable(String),
           before: T.nilable(String),
           billing_reasons:
-            T.nilable(
-              T::Array[WhopSDK::PaymentListParams::BillingReason::OrSymbol]
-            ),
+            T.nilable(T::Array[WhopSDK::BillingReasons::OrSymbol]),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
           currencies: T.nilable(T::Array[WhopSDK::Currency::OrSymbol]),

data/rbi/whop_sdk/resources/plans.rbi

@@ -27,8 +27,12 @@ module WhopSDK
           plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
           release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
           renewal_price: T.nilable(Float),
+          stock: T.nilable(Integer),
+          strike_through_initial_price: T.nilable(Float),
+          strike_through_renewal_price: T.nilable(Float),
           title: T.nilable(String),
           trial_period_days: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Plan)
@@ -38,7 +42,7 @@ module WhopSDK
         company_id:,
         # The product the plan is related to.
         product_id:,
-        # The interval at which the plan charges (renewal plans).
+        # The interval in days at which the plan charges (renewal plans).
         billing_period: nil,
         # The available currencies on the platform
         currency: nil,
@@ -66,10 +70,20 @@ module WhopSDK
         # The amount the customer is charged every billing period. Use only if a recurring
         # payment. Provided as a number in dollars. Eg: 10.43 for $10.43
         renewal_price: nil,
+        # The number of units available for purchase.
+        stock: nil,
+        # The price to display with a strikethrough for the initial price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_initial_price: nil,
+        # The price to display with a strikethrough for the renewal price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_renewal_price: nil,
         # The title of the plan. This will be visible on the product page to customers.
         title: nil,
         # The number of free trial days added before a renewal plan.
         trial_period_days: nil,
+        # Limits/doesn't limit the number of units available for purchase.
+        unlimited_stock: nil,
         # Visibility of a resource
         visibility: nil,
         request_options: {}
@@ -112,8 +126,12 @@ module WhopSDK
           offer_cancel_discount: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
           renewal_price: T.nilable(Float),
+          stock: T.nilable(Integer),
+          strike_through_initial_price: T.nilable(Float),
+          strike_through_renewal_price: T.nilable(Float),
           title: T.nilable(String),
           trial_period_days: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Plan)
@@ -143,10 +161,20 @@ module WhopSDK
         override_tax_type: nil,
         # The amount the customer is charged every billing period.
         renewal_price: nil,
+        # The number of units available for purchase.
+        stock: nil,
+        # The price to display with a strikethrough for the initial price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_initial_price: nil,
+        # The price to display with a strikethrough for the renewal price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_renewal_price: nil,
         # The title of the plan. This will be visible on the product page to customers.
         title: nil,
         # The number of free trial days added before a renewal plan.
         trial_period_days: nil,
+        # Limits/doesn't limit the number of units available for purchase.
+        unlimited_stock: nil,
         # Visibility of a resource
         visibility: nil,
         request_options: {}

data/rbi/whop_sdk/resources/products.rbi

@@ -13,9 +13,6 @@ module WhopSDK
         params(
           company_id: String,
           title: String,
-          access_pass_type: T.nilable(WhopSDK::AccessPassType::OrSymbol),
-          banner_image:
-            T.nilable(WhopSDK::ProductCreateParams::BannerImage::OrHash),
           business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
           collect_shipping_address: T.nilable(T::Boolean),
           custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
@@ -49,10 +46,6 @@ module WhopSDK
         company_id:,
         # The title of the product.
         title:,
-        # The different types an access pass can be.
-        access_pass_type: nil,
-        # A banner image for the product in png, jpeg format
-        banner_image: nil,
         # The different business types a company can be.
         business_type: nil,
         # Whether or not to collect shipping information at checkout from the customer.
@@ -139,6 +132,8 @@ module WhopSDK
           product_tax_code_id: T.nilable(String),
           redirect_purchase_url: T.nilable(String),
           route: T.nilable(String),
+          store_page_config:
+            T.nilable(WhopSDK::ProductUpdateParams::StorePageConfig::OrHash),
           title: T.nilable(String),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -180,6 +175,8 @@ module WhopSDK
         redirect_purchase_url: nil,
         # The route of the product.
         route: nil,
+        # Configuration for a product on the company's store page.
+        store_page_config: nil,
         # The title of the product.
         title: nil,
         # Visibility of a resource

data/rbi/whop_sdk/resources/promo_codes.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class PromoCodes
+      # Create a new promo code for a product or plan
+      #
+      # Required permissions:
+      #
+      # - `promo_code:create`
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          amount_off: Float,
+          base_currency: WhopSDK::Currency::OrSymbol,
+          code: String,
+          company_id: String,
+          new_users_only: T::Boolean,
+          promo_duration_months: Integer,
+          promo_type: WhopSDK::PromoType::OrSymbol,
+          churned_users_only: T.nilable(T::Boolean),
+          existing_memberships_only: T.nilable(T::Boolean),
+          expires_at: T.nilable(Time),
+          one_per_customer: T.nilable(T::Boolean),
+          plan_ids: T.nilable(T::Array[String]),
+          product_id: T.nilable(String),
+          stock: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::PromoCode)
+      end
+      def create(
+        # The amount off (% or flat amount) for the promo.
+        amount_off:,
+        # The monetary currency of the promo code.
+        base_currency:,
+        # The specific code used to apply the promo at checkout.
+        code:,
+        # The id of the company to create the promo code for.
+        company_id:,
+        # Restricts promo use to only users who have never purchased from the company
+        # before.
+        new_users_only:,
+        # The number of months this promo code is applied and valid for.
+        promo_duration_months:,
+        # The type (% or flat amount) of the promo.
+        promo_type:,
+        # Restricts promo use to only users who have churned from the company before.
+        churned_users_only: nil,
+        # Whether this promo code is for existing memberships only (cancelations)
+        existing_memberships_only: nil,
+        # The date/time of when the promo expires.
+        expires_at: nil,
+        # Restricts promo use to only be applied once per customer.
+        one_per_customer: nil,
+        # The IDs of the plans that the promo code applies to. If product_id is provided,
+        # it will only apply to plans attached to that product
+        plan_ids: nil,
+        # The product to lock the promo code to, if any. If provided will filter out any
+        # plan ids not attached to this product
+        product_id: nil,
+        # The quantity limit on the number of uses.
+        stock: nil,
+        # Whether or not the promo code should have unlimited stock.
+        unlimited_stock: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a promo code by ID
+      #
+      # Required permissions:
+      #
+      # - `promo_code:basic:read`
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::PromoCode)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists promo codes for a company
+      #
+      # Required permissions:
+      #
+      # - `promo_code:basic:read`
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
+          status: T.nilable(WhopSDK::PromoCodeStatus::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::PromoCodeListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list promo codes 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,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # Filter promo codes by plan ID(s)
+        plan_ids: nil,
+        # Filter promo codes by product ID(s)
+        product_ids: nil,
+        # Statuses for promo codes
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Archive a promo code, preventing further use
+      #
+      # Required permissions:
+      #
+      # - `promo_code:delete`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(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/reviews.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Reviews
+      # Retrieve a review by its ID
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::ReviewRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # List all reviews
+      sig do
+        params(
+          product_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          max_stars: T.nilable(Integer),
+          min_stars: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ReviewListResponse]
+        )
+      end
+      def list(
+        # The ID of the product
+        product_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,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The maximum star rating of the review (inclusive)
+        max_stars: nil,
+        # The minimum star rating of the review (inclusive)
+        min_stars: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/whop_sdk/client.rbs

@@ -62,6 +62,16 @@ module WhopSDK
 
     attr_reader forums: WhopSDK::Resources::Forums
 
+    attr_reader promo_codes: WhopSDK::Resources::PromoCodes
+
+    attr_reader courses: WhopSDK::Resources::Courses
+
+    attr_reader course_chapters: WhopSDK::Resources::CourseChapters
+
+    attr_reader course_lessons: WhopSDK::Resources::CourseLessons
+
+    attr_reader reviews: WhopSDK::Resources::Reviews
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/whop_sdk/models/assessment_question_types.rbs

@@ -0,0 +1,17 @@
+module WhopSDK
+  module Models
+    type assessment_question_types =
+      :short_answer | :true_false | :multiple_choice | :multiple_select
+
+    module AssessmentQuestionTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      SHORT_ANSWER: :short_answer
+      TRUE_FALSE: :true_false
+      MULTIPLE_CHOICE: :multiple_choice
+      MULTIPLE_SELECT: :multiple_select
+
+      def self?.values: -> ::Array[WhopSDK::Models::assessment_question_types]
+    end
+  end
+end

data/sig/whop_sdk/models/billing_reasons.rbs

@@ -0,0 +1,24 @@
+module WhopSDK
+  module Models
+    type billing_reasons =
+      :subscription_create
+      | :subscription_cycle
+      | :subscription_update
+      | :one_time
+      | :manual
+      | :subscription
+
+    module BillingReasons
+      extend WhopSDK::Internal::Type::Enum
+
+      SUBSCRIPTION_CREATE: :subscription_create
+      SUBSCRIPTION_CYCLE: :subscription_cycle
+      SUBSCRIPTION_UPDATE: :subscription_update
+      ONE_TIME: :one_time
+      MANUAL: :manual
+      SUBSCRIPTION: :subscription
+
+      def self?.values: -> ::Array[WhopSDK::Models::billing_reasons]
+    end
+  end
+end

data/sig/whop_sdk/models/card_brands.rbs

@@ -0,0 +1,44 @@
+module WhopSDK
+  module Models
+    type card_brands =
+      :mastercard
+      | :visa
+      | :amex
+      | :discover
+      | :unionpay
+      | :jcb
+      | :diners
+      | :link
+      | :troy
+      | :visadankort
+      | :visabancontact
+      | :china_union_pay
+      | :rupay
+      | :jcbrupay
+      | :elo
+      | :unknown
+
+    module CardBrands
+      extend WhopSDK::Internal::Type::Enum
+
+      MASTERCARD: :mastercard
+      VISA: :visa
+      AMEX: :amex
+      DISCOVER: :discover
+      UNIONPAY: :unionpay
+      JCB: :jcb
+      DINERS: :diners
+      LINK: :link
+      TROY: :troy
+      VISADANKORT: :visadankort
+      VISABANCONTACT: :visabancontact
+      CHINA_UNION_PAY: :china_union_pay
+      RUPAY: :rupay
+      JCBRUPAY: :jcbrupay
+      ELO: :elo
+      UNKNOWN: :unknown
+
+      def self?.values: -> ::Array[WhopSDK::Models::card_brands]
+    end
+  end
+end

data/sig/whop_sdk/models/checkout_configuration_create_params.rbs

@@ -56,6 +56,7 @@ module WhopSDK
           internal_notes: String?,
           override_tax_type: WhopSDK::Models::tax_type?,
           plan_type: WhopSDK::Models::plan_type?,
+          product: WhopSDK::CheckoutConfigurationCreateParams::Plan::Product?,
           product_id: String?,
           release_method: WhopSDK::Models::release_method?,
           renewal_price: Float?,
@@ -89,6 +90,8 @@ module WhopSDK
 
         attr_accessor plan_type: WhopSDK::Models::plan_type?
 
+        attr_accessor product: WhopSDK::CheckoutConfigurationCreateParams::Plan::Product?
+
         attr_accessor product_id: String?
 
         attr_accessor release_method: WhopSDK::Models::release_method?
@@ -114,6 +117,7 @@ module WhopSDK
           ?internal_notes: String?,
           ?override_tax_type: WhopSDK::Models::tax_type?,
           ?plan_type: WhopSDK::Models::plan_type?,
+          ?product: WhopSDK::CheckoutConfigurationCreateParams::Plan::Product?,
           ?product_id: String?,
           ?release_method: WhopSDK::Models::release_method?,
           ?renewal_price: Float?,
@@ -135,6 +139,7 @@ module WhopSDK
           internal_notes: String?,
           override_tax_type: WhopSDK::Models::tax_type?,
           plan_type: WhopSDK::Models::plan_type?,
+          product: WhopSDK::CheckoutConfigurationCreateParams::Plan::Product?,
           product_id: String?,
           release_method: WhopSDK::Models::release_method?,
           renewal_price: Float?,
@@ -196,6 +201,88 @@ module WhopSDK
 
           def to_hash: -> { id: String?, direct_upload_id: String? }
         end
+
+        type product =
+          {
+            external_identifier: String,
+            title: String,
+            business_type: WhopSDK::Models::business_types?,
+            collect_shipping_address: bool?,
+            custom_statement_descriptor: String?,
+            description: String?,
+            global_affiliate_percentage: Float?,
+            global_affiliate_status: WhopSDK::Models::global_affiliate_status?,
+            headline: String?,
+            industry_type: WhopSDK::Models::industry_types?,
+            product_tax_code_id: String?,
+            redirect_purchase_url: String?,
+            route: String?,
+            visibility: WhopSDK::Models::visibility?
+          }
+
+        class Product < WhopSDK::Internal::Type::BaseModel
+          attr_accessor external_identifier: String
+
+          attr_accessor title: String
+
+          attr_accessor business_type: WhopSDK::Models::business_types?
+
+          attr_accessor collect_shipping_address: bool?
+
+          attr_accessor custom_statement_descriptor: String?
+
+          attr_accessor description: String?
+
+          attr_accessor global_affiliate_percentage: Float?
+
+          attr_accessor global_affiliate_status: WhopSDK::Models::global_affiliate_status?
+
+          attr_accessor headline: String?
+
+          attr_accessor industry_type: WhopSDK::Models::industry_types?
+
+          attr_accessor product_tax_code_id: String?
+
+          attr_accessor redirect_purchase_url: String?
+
+          attr_accessor route: String?
+
+          attr_accessor visibility: WhopSDK::Models::visibility?
+
+          def initialize: (
+            external_identifier: String,
+            title: String,
+            ?business_type: WhopSDK::Models::business_types?,
+            ?collect_shipping_address: bool?,
+            ?custom_statement_descriptor: String?,
+            ?description: String?,
+            ?global_affiliate_percentage: Float?,
+            ?global_affiliate_status: WhopSDK::Models::global_affiliate_status?,
+            ?headline: String?,
+            ?industry_type: WhopSDK::Models::industry_types?,
+            ?product_tax_code_id: String?,
+            ?redirect_purchase_url: String?,
+            ?route: String?,
+            ?visibility: WhopSDK::Models::visibility?
+          ) -> void
+
+          def to_hash: -> {
+            external_identifier: String,
+            title: String,
+            business_type: WhopSDK::Models::business_types?,
+            collect_shipping_address: bool?,
+            custom_statement_descriptor: String?,
+            description: String?,
+            global_affiliate_percentage: Float?,
+            global_affiliate_status: WhopSDK::Models::global_affiliate_status?,
+            headline: String?,
+            industry_type: WhopSDK::Models::industry_types?,
+            product_tax_code_id: String?,
+            redirect_purchase_url: String?,
+            route: String?,
+            visibility: WhopSDK::Models::visibility?
+          }
+        end
       end
     end
   end