whop_sdk 0.0.2 → 0.0.3

data/rbi/whop_sdk/models/membership_list_params.rbi

@@ -11,10 +11,6 @@ module WhopSDK
           T.any(WhopSDK::MembershipListParams, WhopSDK::Internal::AnyHash)
         end
 
-      # The ID of the company to list memberships for
-      sig { returns(String) }
-      attr_accessor :company_id
-
       # The access pass IDs to filter the memberships by
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :access_pass_ids
@@ -37,6 +33,10 @@ module WhopSDK
       end
       attr_accessor :cancel_options
 
+      # The ID of the company to list memberships for
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
       # The minimum creation date to filter by
       sig { returns(T.nilable(Time)) }
       attr_accessor :created_after
@@ -73,9 +73,12 @@ module WhopSDK
       sig { returns(T.nilable(T::Array[WhopSDK::MembershipStatus::OrSymbol])) }
       attr_accessor :statuses
 
+      # Only return memberships from these whop user ids
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :user_ids
+
       sig do
         params(
-          company_id: String,
           access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
@@ -83,6 +86,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),
@@ -92,12 +96,11 @@ 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(T.attached_class)
       end
       def self.new(
-        # 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.
@@ -106,6 +109,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
@@ -124,6 +129,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
@@ -131,7 +138,6 @@ module WhopSDK
       sig do
         override.returns(
           {
-            company_id: String,
             access_pass_ids: T.nilable(T::Array[String]),
             after: T.nilable(String),
             before: T.nilable(String),
@@ -139,6 +145,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),
@@ -148,6 +155,7 @@ 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
           }
         )

data/rbi/whop_sdk/models/membership_list_response.rbi

@@ -87,6 +87,17 @@ module WhopSDK
       end
       attr_writer :plan
 
+      # The Product this Membership grants access to.
+      sig { returns(WhopSDK::Models::MembershipListResponse::Product) }
+      attr_reader :product
+
+      sig do
+        params(
+          product: WhopSDK::Models::MembershipListResponse::Product::OrHash
+        ).void
+      end
+      attr_writer :product
+
       # The Promo Code that is currently applied to this Membership.
       sig do
         returns(T.nilable(WhopSDK::Models::MembershipListResponse::PromoCode))
@@ -150,6 +161,7 @@ module WhopSDK
           metadata: T::Hash[Symbol, T.anything],
           payment_collection_paused: T::Boolean,
           plan: WhopSDK::Models::MembershipListResponse::Plan::OrHash,
+          product: WhopSDK::Models::MembershipListResponse::Product::OrHash,
           promo_code:
             T.nilable(
               WhopSDK::Models::MembershipListResponse::PromoCode::OrHash
@@ -190,6 +202,8 @@ module WhopSDK
         payment_collection_paused:,
         # The Plan this Membership is for.
         plan:,
+        # The Product this Membership grants access to.
+        product:,
         # The Promo Code that is currently applied to this Membership.
         promo_code:,
         # The timestamp in seconds at which the current billing cycle for this
@@ -223,6 +237,7 @@ module WhopSDK
             metadata: T::Hash[Symbol, T.anything],
             payment_collection_paused: T::Boolean,
             plan: WhopSDK::Models::MembershipListResponse::Plan,
+            product: WhopSDK::Models::MembershipListResponse::Product,
             promo_code:
               T.nilable(WhopSDK::Models::MembershipListResponse::PromoCode),
             renewal_period_end: T.nilable(Time),
@@ -320,6 +335,38 @@ module WhopSDK
         end
       end
 
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::MembershipListResponse::Product,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The Product this Membership grants access to.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
       class PromoCode < WhopSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/whop_sdk/models/message_update_params.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class MessageUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::MessageUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The attachments for this message
+      sig do
+        returns(T.nilable(T::Array[WhopSDK::MessageUpdateParams::Attachment]))
+      end
+      attr_accessor :attachments
+
+      # The content of the message in Markdown format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content
+
+      # Whether this message is pinned
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_pinned
+
+      sig do
+        params(
+          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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            attachments:
+              T.nilable(T::Array[WhopSDK::MessageUpdateParams::Attachment]),
+            content: T.nilable(String),
+            is_pinned: T.nilable(T::Boolean),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::MessageUpdateParams::Attachment,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of an existing attachment object. Use this when updating a resource and
+        # keeping a subset of the attachments. Don't use this unless you know what you're
+        # doing.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # This ID should be used the first time you upload an attachment. It is the ID of
+        # the direct upload that was created when uploading the file to S3 via the
+        # mediaDirectUpload mutation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :direct_upload_id
+
+        # Input for an attachment
+        sig do
+          params(
+            id: T.nilable(String),
+            direct_upload_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of an existing attachment object. Use this when updating a resource and
+          # keeping a subset of the attachments. Don't use this unless you know what you're
+          # doing.
+          id: nil,
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          direct_upload_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/payment.rbi

@@ -29,12 +29,12 @@ module WhopSDK
       end
       attr_writer :billing_address
 
-      # The billing reason
-      sig { returns(T.nilable(String)) }
+      # The reason why a specific payment was billed
+      sig { returns(T.nilable(WhopSDK::BillingReasons::TaggedSymbol)) }
       attr_accessor :billing_reason
 
-      # The type of card used as the payment method.
-      sig { returns(T.nilable(String)) }
+      # Possible card brands that a payment token can have
+      sig { returns(T.nilable(WhopSDK::CardBrands::TaggedSymbol)) }
       attr_accessor :card_brand
 
       # The last 4 digits of the card used to make the payment.
@@ -88,9 +88,8 @@ module WhopSDK
       sig { returns(T.nilable(Time)) }
       attr_accessor :paid_at
 
-      # Returns the type of payment method used for the payment, if available. Ex.
-      # klarna, affirm, card, cashapp
-      sig { returns(T.nilable(String)) }
+      # The different types of payment methods that can be used.
+      sig { returns(T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol)) }
       attr_accessor :payment_method_type
 
       # The plan attached to this payment.
@@ -116,7 +115,8 @@ module WhopSDK
       end
       attr_writer :promo_code
 
-      # Whether the payment can be refunded.
+      # True only for payments that are `paid`, have not been fully refunded, and were
+      # processed by a payment processor that allows refunds.
       sig { returns(T::Boolean) }
       attr_accessor :refundable
 
@@ -128,7 +128,9 @@ module WhopSDK
       sig { returns(T.nilable(Time)) }
       attr_accessor :refunded_at
 
-      # Whether the payment can be retried.
+      # True when the payment status is `open` and its membership is in one of the
+      # retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+      # otherwise false. Used to decide if Whop can attempt the charge again.
       sig { returns(T::Boolean) }
       attr_accessor :retryable
 
@@ -159,7 +161,8 @@ module WhopSDK
       sig { params(user: T.nilable(WhopSDK::Payment::User::OrHash)).void }
       attr_writer :user
 
-      # Whether the payment can be voided.
+      # True when the payment is tied to a membership in `past_due`, the payment status
+      # is `open`, and the processor allows voiding payments; otherwise false.
       sig { returns(T::Boolean) }
       attr_accessor :voidable
 
@@ -170,8 +173,8 @@ module WhopSDK
           amount_after_fees: Float,
           auto_refunded: T::Boolean,
           billing_address: T.nilable(WhopSDK::Payment::BillingAddress::OrHash),
-          billing_reason: T.nilable(String),
-          card_brand: T.nilable(String),
+          billing_reason: T.nilable(WhopSDK::BillingReasons::OrSymbol),
+          card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
           card_last4: T.nilable(String),
           company: T.nilable(WhopSDK::Payment::Company::OrHash),
           created_at: Time,
@@ -182,7 +185,7 @@ module WhopSDK
           member: T.nilable(WhopSDK::Payment::Member::OrHash),
           membership: T.nilable(WhopSDK::Payment::Membership::OrHash),
           paid_at: T.nilable(Time),
-          payment_method_type: T.nilable(String),
+          payment_method_type: T.nilable(WhopSDK::PaymentMethodTypes::OrSymbol),
           plan: T.nilable(WhopSDK::Payment::Plan::OrHash),
           product: T.nilable(WhopSDK::Payment::Product::OrHash),
           promo_code: T.nilable(WhopSDK::Payment::PromoCode::OrHash),
@@ -208,9 +211,9 @@ module WhopSDK
         auto_refunded:,
         # The address of the user who made the payment.
         billing_address:,
-        # The billing reason
+        # The reason why a specific payment was billed
         billing_reason:,
-        # The type of card used as the payment method.
+        # Possible card brands that a payment token can have
         card_brand:,
         # The last 4 digits of the card used to make the payment.
         card_last4:,
@@ -232,8 +235,7 @@ module WhopSDK
         membership:,
         # The datetime the payment was paid
         paid_at:,
-        # Returns the type of payment method used for the payment, if available. Ex.
-        # klarna, affirm, card, cashapp
+        # The different types of payment methods that can be used.
         payment_method_type:,
         # The plan attached to this payment.
         plan:,
@@ -241,13 +243,16 @@ module WhopSDK
         product:,
         # The promo code used for this payment.
         promo_code:,
-        # Whether the payment can be refunded.
+        # True only for payments that are `paid`, have not been fully refunded, and were
+        # processed by a payment processor that allows refunds.
         refundable:,
         # The payment refund amount(if applicable).
         refunded_amount:,
         # When the payment was refunded (if applicable).
         refunded_at:,
-        # Whether the payment can be retried.
+        # True when the payment status is `open` and its membership is in one of the
+        # retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+        # otherwise false. Used to decide if Whop can attempt the charge again.
         retryable:,
         # The status of a receipt
         status:,
@@ -261,7 +266,8 @@ module WhopSDK
         usd_total:,
         # The user that made this payment.
         user:,
-        # Whether the payment can be voided.
+        # True when the payment is tied to a membership in `past_due`, the payment status
+        # is `open`, and the processor allows voiding payments; otherwise false.
         voidable:
       )
       end
@@ -273,8 +279,8 @@ module WhopSDK
             amount_after_fees: Float,
             auto_refunded: T::Boolean,
             billing_address: T.nilable(WhopSDK::Payment::BillingAddress),
-            billing_reason: T.nilable(String),
-            card_brand: T.nilable(String),
+            billing_reason: T.nilable(WhopSDK::BillingReasons::TaggedSymbol),
+            card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
             card_last4: T.nilable(String),
             company: T.nilable(WhopSDK::Payment::Company),
             created_at: Time,
@@ -285,7 +291,8 @@ module WhopSDK
             member: T.nilable(WhopSDK::Payment::Member),
             membership: T.nilable(WhopSDK::Payment::Membership),
             paid_at: T.nilable(Time),
-            payment_method_type: T.nilable(String),
+            payment_method_type:
+              T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
             plan: T.nilable(WhopSDK::Payment::Plan),
             product: T.nilable(WhopSDK::Payment::Product),
             promo_code: T.nilable(WhopSDK::Payment::PromoCode),
@@ -579,7 +586,7 @@ module WhopSDK
         sig { returns(T.nilable(String)) }
         attr_accessor :code
 
-        # The number of billing cycles the promo is applied for.
+        # The number of months the promo is applied for.
         sig { returns(T.nilable(Integer)) }
         attr_accessor :number_of_intervals
 
@@ -607,7 +614,7 @@ module WhopSDK
           base_currency:,
           # The specific code used to apply the promo at checkout.
           code:,
-          # The number of billing cycles the promo is applied for.
+          # The number of months the promo is applied for.
           number_of_intervals:,
           # The type (% or flat amount) of the promo.
           promo_type:

data/rbi/whop_sdk/models/payment_list_params.rbi

@@ -24,13 +24,7 @@ module WhopSDK
       attr_accessor :before
 
       # The billing reason for the payment
-      sig do
-        returns(
-          T.nilable(
-            T::Array[WhopSDK::PaymentListParams::BillingReason::OrSymbol]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Array[WhopSDK::BillingReasons::OrSymbol])) }
       attr_accessor :billing_reasons
 
       # The minimum creation date to filter by
@@ -89,9 +83,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]),
@@ -152,9 +144,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]),
@@ -175,56 +165,6 @@ module WhopSDK
       def to_hash
       end
 
-      # The reason why a specific payment was billed
-      module BillingReason
-        extend WhopSDK::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, WhopSDK::PaymentListParams::BillingReason)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        SUBSCRIPTION_CREATE =
-          T.let(
-            :subscription_create,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-        SUBSCRIPTION_CYCLE =
-          T.let(
-            :subscription_cycle,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-        SUBSCRIPTION_UPDATE =
-          T.let(
-            :subscription_update,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-        ONE_TIME =
-          T.let(
-            :one_time,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-        MANUAL =
-          T.let(
-            :manual,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-        SUBSCRIPTION =
-          T.let(
-            :subscription,
-            WhopSDK::PaymentListParams::BillingReason::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[WhopSDK::PaymentListParams::BillingReason::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
       # The order to sort the results by.
       module Order
         extend WhopSDK::Internal::Type::Enum