whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/payment_list_response.rbi

@@ -89,8 +89,8 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :created_at
 
-      # The available currencies on the platform
-      sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+      # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
       attr_accessor :currency
 
       # When an alert came in that this transaction will be disputed
@@ -226,12 +226,29 @@ module WhopSDK
       sig { returns(T::Boolean) }
       attr_accessor :retryable
 
-      # 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.
-      sig { returns(String) }
+      # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
       attr_accessor :settlement_currency
 
+      # The shipping address provided by the customer for physical goods. Null if no
+      # shipping address was collected.
+      sig do
+        returns(
+          T.nilable(WhopSDK::Models::PaymentListResponse::ShippingAddress)
+        )
+      end
+      attr_reader :shipping_address
+
+      sig do
+        params(
+          shipping_address:
+            T.nilable(
+              WhopSDK::Models::PaymentListResponse::ShippingAddress::OrHash
+            )
+        ).void
+      end
+      attr_writer :shipping_address
+
       # The status of a receipt
       sig { returns(T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol)) }
       attr_accessor :status
@@ -303,7 +320,7 @@ module WhopSDK
           company:
             T.nilable(WhopSDK::Models::PaymentListResponse::Company::OrHash),
           created_at: Time,
-          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          currency: WhopSDK::Currency::OrSymbol,
           dispute_alerted_at: T.nilable(Time),
           failure_message: T.nilable(String),
           last_payment_attempt: T.nilable(Time),
@@ -329,7 +346,11 @@ module WhopSDK
           refunded_amount: T.nilable(Float),
           refunded_at: T.nilable(Time),
           retryable: T::Boolean,
-          settlement_currency: String,
+          settlement_currency: WhopSDK::Currency::OrSymbol,
+          shipping_address:
+            T.nilable(
+              WhopSDK::Models::PaymentListResponse::ShippingAddress::OrHash
+            ),
           status: T.nilable(WhopSDK::ReceiptStatus::OrSymbol),
           substatus: WhopSDK::FriendlyReceiptStatus::OrSymbol,
           subtotal: T.nilable(Float),
@@ -367,7 +388,7 @@ module WhopSDK
         company:,
         # The datetime the payment was created.
         created_at:,
-        # The available currencies on the platform
+        # The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
         currency:,
         # When an alert came in that this transaction will be disputed
         dispute_alerted_at:,
@@ -411,10 +432,11 @@ module WhopSDK
         # retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
         # otherwise false. Used to decide if Whop can attempt the charge again.
         retryable:,
-        # 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').
         settlement_currency:,
+        # The shipping address provided by the customer for physical goods. Null if no
+        # shipping address was collected.
+        shipping_address:,
         # The status of a receipt
         status:,
         # The friendly status of the payment.
@@ -456,7 +478,7 @@ module WhopSDK
             checkout_configuration_id: T.nilable(String),
             company: T.nilable(WhopSDK::Models::PaymentListResponse::Company),
             created_at: Time,
-            currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
+            currency: WhopSDK::Currency::TaggedSymbol,
             dispute_alerted_at: T.nilable(Time),
             failure_message: T.nilable(String),
             last_payment_attempt: T.nilable(Time),
@@ -479,7 +501,9 @@ module WhopSDK
             refunded_amount: T.nilable(Float),
             refunded_at: T.nilable(Time),
             retryable: T::Boolean,
-            settlement_currency: String,
+            settlement_currency: WhopSDK::Currency::TaggedSymbol,
+            shipping_address:
+              T.nilable(WhopSDK::Models::PaymentListResponse::ShippingAddress),
             status: T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol),
             substatus: WhopSDK::FriendlyReceiptStatus::TaggedSymbol,
             subtotal: T.nilable(Float),
@@ -745,6 +769,10 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # The phone number associated with this membership.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :phone_number
+
         # The state of the membership.
         sig { returns(WhopSDK::MembershipStatus::TaggedSymbol) }
         attr_accessor :status
@@ -753,12 +781,15 @@ module WhopSDK
         sig do
           params(
             id: String,
+            phone_number: T.nilable(String),
             status: WhopSDK::MembershipStatus::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the membership.
           id:,
+          # The phone number associated with this membership.
+          phone_number:,
           # The state of the membership.
           status:
         )
@@ -766,7 +797,11 @@ module WhopSDK
 
         sig do
           override.returns(
-            { id: String, status: WhopSDK::MembershipStatus::TaggedSymbol }
+            {
+              id: String,
+              phone_number: T.nilable(String),
+              status: WhopSDK::MembershipStatus::TaggedSymbol
+            }
           )
         end
         def to_hash
@@ -933,22 +968,40 @@ module WhopSDK
         sig { returns(T.nilable(String)) }
         attr_accessor :internal_notes
 
+        # 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.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
         # The plan attached to this payment.
         sig do
-          params(id: String, internal_notes: T.nilable(String)).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            internal_notes: T.nilable(String),
+            metadata: T.nilable(T::Hash[Symbol, T.anything])
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the plan.
           id:,
           # A personal description or notes section for the business.
-          internal_notes:
+          internal_notes:,
+          # 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.
+          metadata:
         )
         end
 
         sig do
-          override.returns({ id: String, internal_notes: T.nilable(String) })
+          override.returns(
+            {
+              id: String,
+              internal_notes: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, T.anything])
+            }
+          )
         end
         def to_hash
         end
@@ -967,8 +1020,14 @@ module WhopSDK
         sig { returns(String) }
         attr_accessor :id
 
-        # The URL slug used in the product's public link (e.g., 'my-product' in
-        # whop.com/company/my-product).
+        # 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.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metadata
+
+        # URL slug in the product's public link, e.g. `pickaxe-analytics` in
+        # whop.com/company/pickaxe-analytics.
         sig { returns(String) }
         attr_accessor :route
 
@@ -979,15 +1038,22 @@ module WhopSDK
 
         # The product this payment was made for
         sig do
-          params(id: String, route: String, title: String).returns(
-            T.attached_class
-          )
+          params(
+            id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            route: String,
+            title: String
+          ).returns(T.attached_class)
         end
         def self.new(
           # The unique identifier for the product.
           id:,
-          # The URL slug used in the product's public link (e.g., 'my-product' in
-          # whop.com/company/my-product).
+          # 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.
+          metadata:,
+          # URL slug in the product's public link, e.g. `pickaxe-analytics` in
+          # whop.com/company/pickaxe-analytics.
           route:,
           # The display name of the product shown to customers on the product page and in
           # search results.
@@ -995,7 +1061,16 @@ module WhopSDK
         )
         end
 
-        sig { override.returns({ id: String, route: String, title: String }) }
+        sig do
+          override.returns(
+            {
+              id: String,
+              metadata: T.nilable(T::Hash[Symbol, T.anything]),
+              route: String,
+              title: String
+            }
+          )
+        end
         def to_hash
         end
       end
@@ -1080,6 +1155,91 @@ module WhopSDK
         end
       end
 
+      class ShippingAddress < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::PaymentListResponse::ShippingAddress,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The city of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :city
+
+        # The country of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :country
+
+        # The line 1 of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :line1
+
+        # The line 2 of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :line2
+
+        # The name of the customer.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The postal code of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :postal_code
+
+        # The state of the address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :state
+
+        # The shipping address provided by the customer for physical goods. Null if no
+        # shipping address was collected.
+        sig do
+          params(
+            city: T.nilable(String),
+            country: T.nilable(String),
+            line1: T.nilable(String),
+            line2: T.nilable(String),
+            name: T.nilable(String),
+            postal_code: T.nilable(String),
+            state: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city of the address.
+          city:,
+          # The country of the address.
+          country:,
+          # The line 1 of the address.
+          line1:,
+          # The line 2 of the address.
+          line2:,
+          # The name of the customer.
+          name:,
+          # The postal code of the address.
+          postal_code:,
+          # The state of the address.
+          state:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              city: T.nilable(String),
+              country: T.nilable(String),
+              line1: T.nilable(String),
+              line2: T.nilable(String),
+              name: T.nilable(String),
+              postal_code: T.nilable(String),
+              state: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class User < WhopSDK::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/whop_sdk/models/payout_create_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class PayoutCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::PayoutCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The account to pay out from (a biz\_ identifier).
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The amount to pay out in the specified currency.
+      sig { returns(Float) }
+      attr_accessor :amount
+
+      # The saved payout method to deliver to (a potk\_ identifier).
+      sig { returns(String) }
+      attr_accessor :payout_method_id
+
+      # The payout currency. Defaults to usd.
+      sig { returns(T.nilable(String)) }
+      attr_reader :currency
+
+      sig { params(currency: String).void }
+      attr_writer :currency
+
+      # A client-generated key that makes retries safe. Retrying with the same key
+      # returns the original payout instead of creating a second one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig do
+        params(
+          account_id: String,
+          amount: Float,
+          payout_method_id: String,
+          currency: String,
+          idempotency_key: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account to pay out from (a biz\_ identifier).
+        account_id:,
+        # The amount to pay out in the specified currency.
+        amount:,
+        # The saved payout method to deliver to (a potk\_ identifier).
+        payout_method_id:,
+        # The payout currency. Defaults to usd.
+        currency: nil,
+        # A client-generated key that makes retries safe. Retrying with the same key
+        # returns the original payout instead of creating a second one.
+        idempotency_key: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            amount: Float,
+            payout_method_id: String,
+            currency: String,
+            idempotency_key: String,
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end