whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/payment_list_response.rb

@@ -73,10 +73,10 @@ module WhopSDK
       required :created_at, Time
 
       # @!attribute currency
-      #   The available currencies on the platform
+      #   The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
-      #   @return [Symbol, WhopSDK::Models::Currency, nil]
-      required :currency, enum: -> { WhopSDK::Currency }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
 
       # @!attribute dispute_alerted_at
       #   When an alert came in that this transaction will be disputed
@@ -193,12 +193,17 @@ module WhopSDK
       required :retryable, WhopSDK::Internal::Type::Boolean
 
       # @!attribute settlement_currency
-      #   The currency in which the creator receives payouts and fees are charged (e.g.,
-      #   'usd', 'eur'). For multi-currency payments this differs from the payment
-      #   currency.
+      #   The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
-      #   @return [String]
-      required :settlement_currency, String
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :settlement_currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute shipping_address
+      #   The shipping address provided by the customer for physical goods. Null if no
+      #   shipping address was collected.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::ShippingAddress, nil]
+      required :shipping_address, -> { WhopSDK::Models::PaymentListResponse::ShippingAddress }, nil?: true
 
       # @!attribute status
       #   The status of a receipt
@@ -262,7 +267,7 @@ module WhopSDK
       #   @return [Boolean]
       required :voidable, WhopSDK::Internal::Type::Boolean
 
-      # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, next_payment_attempt:, paid_at:, payment_method:, payment_method_type:, payments_failed:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, settlement_currency:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, total:, updated_at:, usd_total:, user:, voidable:)
+      # @!method initialize(id:, amount_after_fees:, application_fee:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, checkout_configuration_id:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, metadata:, next_payment_attempt:, paid_at:, payment_method:, payment_method_type:, payments_failed:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, settlement_currency:, shipping_address:, status:, substatus:, subtotal:, tax_amount:, tax_behavior:, total:, updated_at:, usd_total:, user:, voidable:)
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PaymentListResponse} for more details.
       #
@@ -291,7 +296,7 @@ module WhopSDK
       #
       #   @param created_at [Time] The datetime the payment was created.
       #
-      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
       #
       #   @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
       #
@@ -329,7 +334,9 @@ module WhopSDK
       #
       #   @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
       #
-      #   @param settlement_currency [String] The currency in which the creator receives payouts and fees are charged (e.g., '
+      #   @param settlement_currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+      #
+      #   @param shipping_address [WhopSDK::Models::PaymentListResponse::ShippingAddress, nil] The shipping address provided by the customer for physical goods. Null if no shi
       #
       #   @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
       #
@@ -527,17 +534,25 @@ module WhopSDK
         #   @return [String]
         required :id, String
 
+        # @!attribute phone_number
+        #   The phone number associated with this membership.
+        #
+        #   @return [String, nil]
+        required :phone_number, String, nil?: true
+
         # @!attribute status
         #   The state of the membership.
         #
         #   @return [Symbol, WhopSDK::Models::MembershipStatus]
         required :status, enum: -> { WhopSDK::MembershipStatus }
 
-        # @!method initialize(id:, status:)
+        # @!method initialize(id:, phone_number:, status:)
         #   The membership attached to this payment.
         #
         #   @param id [String] The unique identifier for the membership.
         #
+        #   @param phone_number [String, nil] The phone number associated with this membership.
+        #
         #   @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
       end
 
@@ -639,12 +654,25 @@ module WhopSDK
         #   @return [String, nil]
         required :internal_notes, String, nil?: true
 
-        # @!method initialize(id:, internal_notes:)
+        # @!attribute metadata
+        #   Custom key-value pairs stored on the plan. Included in webhook payloads for
+        #   payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+        #   string value.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+        # @!method initialize(id:, internal_notes:, metadata:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::PaymentListResponse::Plan} for more details.
+        #
         #   The plan attached to this payment.
         #
         #   @param id [String] The unique identifier for the plan.
         #
         #   @param internal_notes [String, nil] A personal description or notes section for the business.
+        #
+        #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
       end
 
       # @see WhopSDK::Models::PaymentListResponse#product
@@ -655,9 +683,17 @@ module WhopSDK
         #   @return [String]
         required :id, String
 
+        # @!attribute metadata
+        #   Custom key-value pairs stored on the product and included in payment and
+        #   membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+        #   per string value.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
         # @!attribute route
-        #   The URL slug used in the product's public link (e.g., 'my-product' in
-        #   whop.com/company/my-product).
+        #   URL slug in the product's public link, e.g. `pickaxe-analytics` in
+        #   whop.com/company/pickaxe-analytics.
         #
         #   @return [String]
         required :route, String
@@ -669,7 +705,7 @@ module WhopSDK
         #   @return [String]
         required :title, String
 
-        # @!method initialize(id:, route:, title:)
+        # @!method initialize(id:, metadata:, route:, title:)
         #   Some parameter documentations has been truncated, see
         #   {WhopSDK::Models::PaymentListResponse::Product} for more details.
         #
@@ -677,7 +713,9 @@ module WhopSDK
         #
         #   @param id [String] The unique identifier for the product.
         #
-        #   @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
+        #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product and included in payment and members
+        #
+        #   @param route [String] URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/comp
         #
         #   @param title [String] The display name of the product shown to customers on the product page and in se
       end
@@ -741,6 +779,69 @@ module WhopSDK
         #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
       end
 
+      # @see WhopSDK::Models::PaymentListResponse#shipping_address
+      class ShippingAddress < WhopSDK::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the address.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute country
+        #   The country of the address.
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute line1
+        #   The line 1 of the address.
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #   The line 2 of the address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute name
+        #   The name of the customer.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   The state of the address.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!method initialize(city:, country:, line1:, line2:, name:, postal_code:, state:)
+        #   The shipping address provided by the customer for physical goods. Null if no
+        #   shipping address was collected.
+        #
+        #   @param city [String, nil] The city of the address.
+        #
+        #   @param country [String, nil] The country of the address.
+        #
+        #   @param line1 [String, nil] The line 1 of the address.
+        #
+        #   @param line2 [String, nil] The line 2 of the address.
+        #
+        #   @param name [String, nil] The name of the customer.
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param state [String, nil] The state of the address.
+      end
+
       # @see WhopSDK::Models::PaymentListResponse#user
       class User < WhopSDK::Internal::Type::BaseModel
         # @!attribute id

data/lib/whop_sdk/models/payout_create_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#create
+    class PayoutCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The account to pay out from (a biz\_ identifier).
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute amount
+      #   The amount to pay out in the specified currency.
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute payout_method_id
+      #   The saved payout method to deliver to (a potk\_ identifier).
+      #
+      #   @return [String]
+      required :payout_method_id, String
+
+      # @!attribute currency
+      #   The payout currency. Defaults to usd.
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!attribute idempotency_key
+      #   A client-generated key that makes retries safe. Retrying with the same key
+      #   returns the original payout instead of creating a second one.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(account_id:, amount:, payout_method_id:, currency: nil, idempotency_key: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PayoutCreateParams} for more details.
+      #
+      #   @param account_id [String] The account to pay out from (a biz\_ identifier).
+      #
+      #   @param amount [Float] The amount to pay out in the specified currency.
+      #
+      #   @param payout_method_id [String] The saved payout method to deliver to (a potk\_ identifier).
+      #
+      #   @param currency [String] The payout currency. Defaults to usd.
+      #
+      #   @param idempotency_key [String] A client-generated key that makes retries safe. Retrying with the same key retur
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/payout_create_response.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#create
+    class PayoutCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Payout ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The payout amount in whole currency units.
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   When the payout was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Payout currency.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute estimated_arrival
+      #   Estimated time the funds become available in the destination account. Null until
+      #   the payout settles.
+      #
+      #   @return [Time, nil]
+      required :estimated_arrival, Time, nil?: true
+
+      # @!attribute fee_amount
+      #   The fee charged for the payout, in the payout currency.
+      #
+      #   @return [Float]
+      required :fee_amount, Float
+
+      # @!attribute object
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Object]
+      required :object, enum: -> { WhopSDK::Models::PayoutCreateResponse::Object }
+
+      # @!attribute payer_name
+      #   Name of the entity processing the payout. Null until the payout settles.
+      #
+      #   @return [String, nil]
+      required :payer_name, String, nil?: true
+
+      # @!attribute payout_token
+      #   The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @return [WhopSDK::Models::PayoutCreateResponse::PayoutToken, nil]
+      required :payout_token, -> { WhopSDK::Models::PayoutCreateResponse::PayoutToken }, nil?: true
+
+      # @!attribute speed
+      #   Payout delivery speed.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Speed]
+      required :speed, enum: -> { WhopSDK::Models::PayoutCreateResponse::Speed }
+
+      # @!attribute status
+      #   Current payout status, in the same vocabulary as GET /payouts.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::PayoutCreateResponse::Status }
+
+      # @!method initialize(id:, amount:, created_at:, currency:, estimated_arrival:, fee_amount:, object:, payer_name:, payout_token:, speed:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PayoutCreateResponse} for more details.
+      #
+      #   @param id [String] Payout ID.
+      #
+      #   @param amount [Float] The payout amount in whole currency units.
+      #
+      #   @param created_at [Time] When the payout was created.
+      #
+      #   @param currency [String] Payout currency.
+      #
+      #   @param estimated_arrival [Time, nil] Estimated time the funds become available in the destination account. Null until
+      #
+      #   @param fee_amount [Float] The fee charged for the payout, in the payout currency.
+      #
+      #   @param object [Symbol, WhopSDK::Models::PayoutCreateResponse::Object]
+      #
+      #   @param payer_name [String, nil] Name of the entity processing the payout. Null until the payout settles.
+      #
+      #   @param payout_token [WhopSDK::Models::PayoutCreateResponse::PayoutToken, nil] The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @param speed [Symbol, WhopSDK::Models::PayoutCreateResponse::Speed] Payout delivery speed.
+      #
+      #   @param status [Symbol, WhopSDK::Models::PayoutCreateResponse::Status] Current payout status, in the same vocabulary as GET /payouts.
+
+      # @see WhopSDK::Models::PayoutCreateResponse#object
+      module Object
+        extend WhopSDK::Internal::Type::Enum
+
+        PAYOUT = :payout
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::PayoutCreateResponse#payout_token
+      class PayoutToken < WhopSDK::Internal::Type::BaseModel
+        # @!attribute nickname
+        #   Saved payout method nickname.
+        #
+        #   @return [String, nil]
+        required :nickname, String, nil?: true
+
+        # @!attribute payout_destination
+        #   Payout destination display details.
+        #
+        #   @return [WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination, nil]
+        required :payout_destination,
+                 -> { WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination },
+                 nil?: true
+
+        # @!method initialize(nickname:, payout_destination:)
+        #   The saved payout method used. Requires payout:destination:read; null without it.
+        #
+        #   @param nickname [String, nil] Saved payout method nickname.
+        #
+        #   @param payout_destination [WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination, nil] Payout destination display details.
+
+        # @see WhopSDK::Models::PayoutCreateResponse::PayoutToken#payout_destination
+        class PayoutDestination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   Payout destination icon URL.
+          #
+          #   @return [String, nil]
+          required :icon_url, String, nil?: true
+
+          # @!attribute payer_name
+          #   Payout destination display name.
+          #
+          #   @return [String, nil]
+          required :payer_name, String, nil?: true
+
+          # @!method initialize(icon_url:, payer_name:)
+          #   Payout destination display details.
+          #
+          #   @param icon_url [String, nil] Payout destination icon URL.
+          #
+          #   @param payer_name [String, nil] Payout destination display name.
+        end
+      end
+
+      # Payout delivery speed.
+      #
+      # @see WhopSDK::Models::PayoutCreateResponse#speed
+      module Speed
+        extend WhopSDK::Internal::Type::Enum
+
+        STANDARD = :standard
+        INSTANT = :instant
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current payout status, in the same vocabulary as GET /payouts.
+      #
+      # @see WhopSDK::Models::PayoutCreateResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        REQUESTED = :requested
+        IN_TRANSIT = :in_transit
+        COMPLETED = :completed
+        FAILED = :failed
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payout_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#list
+    class PayoutListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute after
+      #   Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute currency
+      #   Optional currency code filter, for example `usd`.
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!attribute first
+      #   Number of payouts to return from the start of the window.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute last
+      #   Number of payouts to return from the end of the window.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer
+
+      # @!attribute user_id
+      #   The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(account_id: nil, after: nil, before: nil, currency: nil, first: nil, last: nil, user_id: nil, request_options: {})
+      #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @param currency [String] Optional currency code filter, for example `usd`.
+      #
+      #   @param first [Integer] Number of payouts to return from the start of the window.
+      #
+      #   @param last [Integer] Number of payouts to return from the end of the window.
+      #
+      #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end