whop_sdk 0.0.2 → 0.0.4

data/lib/whop_sdk/models/message_create_params.rb

@@ -22,9 +22,9 @@ module WhopSDK
       # @!attribute attachments
       #   The attachments for this message, such as videos or images.
       #
-      #   @return [Array<WhopSDK::Models::MessageCreateParams::Attachment>, nil]
+      #   @return [Array<WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithID>, nil]
       optional :attachments,
-               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::MessageCreateParams::Attachment] },
+               -> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::MessageCreateParams::Attachment] },
                nil?: true
 
       # @!attribute poll
@@ -38,38 +38,62 @@ module WhopSDK
       #
       #   @param content [String] The content of the message in Markdown format.
       #
-      #   @param attachments [Array<WhopSDK::Models::MessageCreateParams::Attachment>, nil] The attachments for this message, such as videos or images.
+      #   @param attachments [Array<WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this message, such as videos or images.
       #
       #   @param poll [WhopSDK::Models::MessageCreateParams::Poll, nil] The poll for this message
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class Attachment < WhopSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #   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.
-        #
-        #   @return [String, nil]
-        optional :id, String, nil?: true
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
 
-        # @!attribute direct_upload_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.
-        #
-        #   @return [String, nil]
-        optional :direct_upload_id, String, nil?: true
+        # Input for an attachment
+        variant -> { WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID }
 
-        # @!method initialize(id: nil, direct_upload_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::MessageCreateParams::Attachment} for more details.
-        #
-        #   Input for an attachment
-        #
-        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
-        #
-        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+        # Input for an attachment
+        variant -> { WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute direct_upload_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.
+          #
+          #   @return [String]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   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.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithID} for
+          #   more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageCreateParams::Attachment::AttachmentInputWithID)]
       end
 
       class Poll < WhopSDK::Internal::Type::BaseModel

data/lib/whop_sdk/models/message_update_params.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Messages#update
+    class MessageUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute attachments
+      #   The attachments for this message
+      #
+      #   @return [Array<WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithID>, nil]
+      optional :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::MessageUpdateParams::Attachment] },
+               nil?: true
+
+      # @!attribute content
+      #   The content of the message in Markdown format
+      #
+      #   @return [String, nil]
+      optional :content, String, nil?: true
+
+      # @!attribute is_pinned
+      #   Whether this message is pinned
+      #
+      #   @return [Boolean, nil]
+      optional :is_pinned, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(attachments: nil, content: nil, is_pinned: nil, request_options: {})
+      #   @param attachments [Array<WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this message
+      #
+      #   @param content [String, nil] The content of the message in Markdown format
+      #
+      #   @param is_pinned [Boolean, nil] Whether this message is pinned
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
+
+        # Input for an attachment
+        variant -> { WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID }
+
+        # Input for an attachment
+        variant -> { WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute direct_upload_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.
+          #
+          #   @return [String]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   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.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithID} for
+          #   more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithID)]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payment.rb

@@ -28,16 +28,16 @@ module WhopSDK
       required :billing_address, -> { WhopSDK::Payment::BillingAddress }, nil?: true
 
       # @!attribute billing_reason
-      #   The billing reason
+      #   The reason why a specific payment was billed
       #
-      #   @return [String, nil]
-      required :billing_reason, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::BillingReasons, nil]
+      required :billing_reason, enum: -> { WhopSDK::BillingReasons }, nil?: true
 
       # @!attribute card_brand
-      #   The type of card used as the payment method.
+      #   Possible card brands that a payment token can have
       #
-      #   @return [String, nil]
-      required :card_brand, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::CardBrands, nil]
+      required :card_brand, enum: -> { WhopSDK::CardBrands }, nil?: true
 
       # @!attribute card_last4
       #   The last 4 digits of the card used to make the payment.
@@ -93,6 +93,13 @@ module WhopSDK
       #   @return [WhopSDK::Models::Payment::Membership, nil]
       required :membership, -> { WhopSDK::Payment::Membership }, nil?: true
 
+      # @!attribute metadata
+      #   The custom metadata stored on this payment. This will be copied the checkout
+      #   configuration for which this payment was made
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute paid_at
       #   The datetime the payment was paid
       #
@@ -100,11 +107,10 @@ module WhopSDK
       required :paid_at, Time, nil?: true
 
       # @!attribute payment_method_type
-      #   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.
       #
-      #   @return [String, nil]
-      required :payment_method_type, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
+      required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
 
       # @!attribute plan
       #   The plan attached to this payment.
@@ -125,7 +131,8 @@ module WhopSDK
       required :promo_code, -> { WhopSDK::Payment::PromoCode }, nil?: true
 
       # @!attribute refundable
-      #   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.
       #
       #   @return [Boolean]
       required :refundable, WhopSDK::Internal::Type::Boolean
@@ -143,7 +150,9 @@ module WhopSDK
       required :refunded_at, Time, nil?: true
 
       # @!attribute retryable
-      #   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.
       #
       #   @return [Boolean]
       required :retryable, WhopSDK::Internal::Type::Boolean
@@ -185,12 +194,13 @@ module WhopSDK
       required :user, -> { WhopSDK::Payment::User }, nil?: true
 
       # @!attribute voidable
-      #   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.
       #
       #   @return [Boolean]
       required :voidable, WhopSDK::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, paid_at:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
+      # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, paid_at:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
       #   Some parameter documentations has been truncated, see {WhopSDK::Models::Payment}
       #   for more details.
       #
@@ -204,9 +214,9 @@ module WhopSDK
       #
       #   @param billing_address [WhopSDK::Models::Payment::BillingAddress, nil] The address of the user who made the payment.
       #
-      #   @param billing_reason [String, nil] The billing reason
+      #   @param billing_reason [Symbol, WhopSDK::Models::BillingReasons, nil] The reason why a specific payment was billed
       #
-      #   @param card_brand [String, nil] The type of card used as the payment method.
+      #   @param card_brand [Symbol, WhopSDK::Models::CardBrands, nil] Possible card brands that a payment token can have
       #
       #   @param card_last4 [String, nil] The last 4 digits of the card used to make the payment.
       #
@@ -226,9 +236,11 @@ module WhopSDK
       #
       #   @param membership [WhopSDK::Models::Payment::Membership, nil] The membership attached to this payment.
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied the checkout con
+      #
       #   @param paid_at [Time, nil] The datetime the payment was paid
       #
-      #   @param payment_method_type [String, nil] Returns the type of payment method used for the payment, if available. Ex. klarn
+      #   @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
       #
       #   @param plan [WhopSDK::Models::Payment::Plan, nil] The plan attached to this payment.
       #
@@ -236,13 +248,13 @@ module WhopSDK
       #
       #   @param promo_code [WhopSDK::Models::Payment::PromoCode, nil] The promo code used for this payment.
       #
-      #   @param refundable [Boolean] Whether the payment can be refunded.
+      #   @param refundable [Boolean] True only for payments that are `paid`, have not been fully refunded, and were p
       #
       #   @param refunded_amount [Float, nil] The payment refund amount(if applicable).
       #
       #   @param refunded_at [Time, nil] When the payment was refunded (if applicable).
       #
-      #   @param retryable [Boolean] Whether the payment can be retried.
+      #   @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
       #
       #   @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
       #
@@ -256,7 +268,7 @@ module WhopSDK
       #
       #   @param user [WhopSDK::Models::Payment::User, nil] The user that made this payment.
       #
-      #   @param voidable [Boolean] Whether the payment can be voided.
+      #   @param voidable [Boolean] True when the payment is tied to a membership in `past_due`, the payment status
 
       # @see WhopSDK::Models::Payment#billing_address
       class BillingAddress < WhopSDK::Internal::Type::BaseModel
@@ -465,7 +477,7 @@ module WhopSDK
         required :code, String, nil?: true
 
         # @!attribute number_of_intervals
-        #   The number of billing cycles the promo is applied for.
+        #   The number of months the promo is applied for.
         #
         #   @return [Integer, nil]
         required :number_of_intervals, Integer, nil?: true
@@ -487,7 +499,7 @@ module WhopSDK
         #
         #   @param code [String, nil] The specific code used to apply the promo at checkout.
         #
-        #   @param number_of_intervals [Integer, nil] The number of billing cycles the promo is applied for.
+        #   @param number_of_intervals [Integer, nil] The number of months the promo is applied for.
         #
         #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
       end

data/lib/whop_sdk/models/payment_list_params.rb

@@ -28,9 +28,9 @@ module WhopSDK
       # @!attribute billing_reasons
       #   The billing reason for the payment
       #
-      #   @return [Array<Symbol, WhopSDK::Models::PaymentListParams::BillingReason>, nil]
+      #   @return [Array<Symbol, WhopSDK::Models::BillingReasons>, nil]
       optional :billing_reasons,
-               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentListParams::BillingReason] },
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::BillingReasons] },
                nil?: true
 
       # @!attribute created_after
@@ -114,7 +114,7 @@ module WhopSDK
       #
       #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
       #
-      #   @param billing_reasons [Array<Symbol, WhopSDK::Models::PaymentListParams::BillingReason>, nil] The billing reason for the payment
+      #   @param billing_reasons [Array<Symbol, WhopSDK::Models::BillingReasons>, nil] The billing reason for the payment
       #
       #   @param created_after [Time, nil] The minimum creation date to filter by
       #
@@ -142,21 +142,6 @@ module WhopSDK
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      # The reason why a specific payment was billed
-      module BillingReason
-        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
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # The order to sort the results by.
       module Order
         extend WhopSDK::Internal::Type::Enum

data/lib/whop_sdk/models/payment_list_response.rb

@@ -29,16 +29,16 @@ module WhopSDK
       required :billing_address, -> { WhopSDK::Models::PaymentListResponse::BillingAddress }, nil?: true
 
       # @!attribute billing_reason
-      #   The billing reason
+      #   The reason why a specific payment was billed
       #
-      #   @return [String, nil]
-      required :billing_reason, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::BillingReasons, nil]
+      required :billing_reason, enum: -> { WhopSDK::BillingReasons }, nil?: true
 
       # @!attribute card_brand
-      #   The type of card used as the payment method.
+      #   Possible card brands that a payment token can have
       #
-      #   @return [String, nil]
-      required :card_brand, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::CardBrands, nil]
+      required :card_brand, enum: -> { WhopSDK::CardBrands }, nil?: true
 
       # @!attribute card_last4
       #   The last 4 digits of the card used to make the payment.
@@ -94,6 +94,13 @@ module WhopSDK
       #   @return [WhopSDK::Models::PaymentListResponse::Membership, nil]
       required :membership, -> { WhopSDK::Models::PaymentListResponse::Membership }, nil?: true
 
+      # @!attribute metadata
+      #   The custom metadata stored on this payment. This will be copied the checkout
+      #   configuration for which this payment was made
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute paid_at
       #   The datetime the payment was paid
       #
@@ -101,11 +108,10 @@ module WhopSDK
       required :paid_at, Time, nil?: true
 
       # @!attribute payment_method_type
-      #   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.
       #
-      #   @return [String, nil]
-      required :payment_method_type, String, nil?: true
+      #   @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
+      required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
 
       # @!attribute plan
       #   The plan attached to this payment.
@@ -126,7 +132,8 @@ module WhopSDK
       required :promo_code, -> { WhopSDK::Models::PaymentListResponse::PromoCode }, nil?: true
 
       # @!attribute refundable
-      #   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.
       #
       #   @return [Boolean]
       required :refundable, WhopSDK::Internal::Type::Boolean
@@ -144,7 +151,9 @@ module WhopSDK
       required :refunded_at, Time, nil?: true
 
       # @!attribute retryable
-      #   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.
       #
       #   @return [Boolean]
       required :retryable, WhopSDK::Internal::Type::Boolean
@@ -186,12 +195,13 @@ module WhopSDK
       required :user, -> { WhopSDK::Models::PaymentListResponse::User }, nil?: true
 
       # @!attribute voidable
-      #   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.
       #
       #   @return [Boolean]
       required :voidable, WhopSDK::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, paid_at:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
+      # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, paid_at:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PaymentListResponse} for more details.
       #
@@ -205,9 +215,9 @@ module WhopSDK
       #
       #   @param billing_address [WhopSDK::Models::PaymentListResponse::BillingAddress, nil] The address of the user who made the payment.
       #
-      #   @param billing_reason [String, nil] The billing reason
+      #   @param billing_reason [Symbol, WhopSDK::Models::BillingReasons, nil] The reason why a specific payment was billed
       #
-      #   @param card_brand [String, nil] The type of card used as the payment method.
+      #   @param card_brand [Symbol, WhopSDK::Models::CardBrands, nil] Possible card brands that a payment token can have
       #
       #   @param card_last4 [String, nil] The last 4 digits of the card used to make the payment.
       #
@@ -227,9 +237,11 @@ module WhopSDK
       #
       #   @param membership [WhopSDK::Models::PaymentListResponse::Membership, nil] The membership attached to this payment.
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied the checkout con
+      #
       #   @param paid_at [Time, nil] The datetime the payment was paid
       #
-      #   @param payment_method_type [String, nil] Returns the type of payment method used for the payment, if available. Ex. klarn
+      #   @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
       #
       #   @param plan [WhopSDK::Models::PaymentListResponse::Plan, nil] The plan attached to this payment.
       #
@@ -237,13 +249,13 @@ module WhopSDK
       #
       #   @param promo_code [WhopSDK::Models::PaymentListResponse::PromoCode, nil] The promo code used for this payment.
       #
-      #   @param refundable [Boolean] Whether the payment can be refunded.
+      #   @param refundable [Boolean] True only for payments that are `paid`, have not been fully refunded, and were p
       #
       #   @param refunded_amount [Float, nil] The payment refund amount(if applicable).
       #
       #   @param refunded_at [Time, nil] When the payment was refunded (if applicable).
       #
-      #   @param retryable [Boolean] Whether the payment can be retried.
+      #   @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
       #
       #   @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
       #
@@ -257,7 +269,7 @@ module WhopSDK
       #
       #   @param user [WhopSDK::Models::PaymentListResponse::User, nil] The user that made this payment.
       #
-      #   @param voidable [Boolean] Whether the payment can be voided.
+      #   @param voidable [Boolean] True when the payment is tied to a membership in `past_due`, the payment status
 
       # @see WhopSDK::Models::PaymentListResponse#billing_address
       class BillingAddress < WhopSDK::Internal::Type::BaseModel
@@ -466,7 +478,7 @@ module WhopSDK
         required :code, String, nil?: true
 
         # @!attribute number_of_intervals
-        #   The number of billing cycles the promo is applied for.
+        #   The number of months the promo is applied for.
         #
         #   @return [Integer, nil]
         required :number_of_intervals, Integer, nil?: true
@@ -488,7 +500,7 @@ module WhopSDK
         #
         #   @param code [String, nil] The specific code used to apply the promo at checkout.
         #
-        #   @param number_of_intervals [Integer, nil] The number of billing cycles the promo is applied for.
+        #   @param number_of_intervals [Integer, nil] The number of months the promo is applied for.
         #
         #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
       end

data/lib/whop_sdk/models/payment_method_types.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different types of payment methods that can be used.
+    module PaymentMethodTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      ACSS_DEBIT = :acss_debit
+      AFFIRM = :affirm
+      AFTERPAY_CLEARPAY = :afterpay_clearpay
+      ALIPAY = :alipay
+      ALMA = :alma
+      AMAZON_PAY = :amazon_pay
+      APPLE_PAY = :apple_pay
+      AU_BECS_DEBIT = :au_becs_debit
+      BACS_DEBIT = :bacs_debit
+      BANCONTACT = :bancontact
+      BILLIE = :billie
+      BLIK = :blik
+      BOLETO = :boleto
+      CARD = :card
+      CASHAPP = :cashapp
+      CRYPTO = :crypto
+      EPS = :eps
+      FPX = :fpx
+      GIROPAY = :giropay
+      GOOGLE_PAY = :google_pay
+      GRABPAY = :grabpay
+      IDEAL = :ideal
+      KAKAO_PAY = :kakao_pay
+      KLARNA = :klarna
+      KONBINI = :konbini
+      KR_CARD = :kr_card
+      LINK = :link
+      MOBILEPAY = :mobilepay
+      MULTIBANCO = :multibanco
+      NAVER_PAY = :naver_pay
+      NZ_BANK_ACCOUNT = :nz_bank_account
+      OXXO = :oxxo
+      P24 = :p24
+      PAY_BY_BANK = :pay_by_bank
+      PAYCO = :payco
+      PAYNOW = :paynow
+      PIX = :pix
+      PROMPTPAY = :promptpay
+      REVOLUT_PAY = :revolut_pay
+      SAMSUNG_PAY = :samsung_pay
+      SATISPAY = :satispay
+      SEPA_DEBIT = :sepa_debit
+      SOFORT = :sofort
+      SWISH = :swish
+      TWINT = :twint
+      US_BANK_ACCOUNT = :us_bank_account
+      WECHAT_PAY = :wechat_pay
+      ZIP = :zip
+      BIZUM = :bizum
+      CAPCHASE_PAY = :capchase_pay
+      KRIYA = :kriya
+      MONDU = :mondu
+      NG_WALLET = :ng_wallet
+      PAYPAY = :paypay
+      SEQURA = :sequra
+      SCALAPAY = :scalapay
+      VIPPS = :vipps
+      CUSTOM = :custom
+      CUSTOMER_BALANCE = :customer_balance
+      GOPAY = :gopay
+      MB_WAY = :mb_way
+      NG_BANK = :ng_bank
+      NG_BANK_TRANSFER = :ng_bank_transfer
+      NG_CARD = :ng_card
+      NG_MARKET = :ng_market
+      NG_USSD = :ng_ussd
+      PAYPAL = :paypal
+      PAYTO = :payto
+      QRIS = :qris
+      RECHNUNG = :rechnung
+      SOUTH_KOREA_MARKET = :south_korea_market
+      KR_MARKET = :kr_market
+      SHOPEEPAY = :shopeepay
+      UPI = :upi
+      SUNBIT = :sunbit
+      NETBANKING = :netbanking
+      ID_BANK_TRANSFER = :id_bank_transfer
+      DEMO_PAY = :demo_pay
+      SHOP_PAY = :shop_pay
+      SEZZLE = :sezzle
+      COINBASE = :coinbase
+      SPLITIT = :splitit
+      PLATFORM_BALANCE = :platform_balance
+      APPLE = :apple
+      UNKNOWN = :unknown
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end