whop_sdk 0.0.7 → 0.0.8

data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi

@@ -0,0 +1,561 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class RefundUpdatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::RefundUpdatedWebhookEvent, WhopSDK::Internal::AnyHash)
+        end
+
+      # A unique ID for every single webhook request
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The API version for this webhook
+      sig { returns(Symbol) }
+      attr_accessor :api_version
+
+      # An object representing a refund made on a payment.
+      sig { returns(WhopSDK::RefundUpdatedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: WhopSDK::RefundUpdatedWebhookEvent::Data::OrHash).void
+      end
+      attr_writer :data
+
+      # The timestamp in ISO 8601 format that the webhook was sent at on the server
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The webhook event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          id: String,
+          data: WhopSDK::RefundUpdatedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          api_version: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID for every single webhook request
+        id:,
+        # An object representing a refund made on a payment.
+        data:,
+        # The timestamp in ISO 8601 format that the webhook was sent at on the server
+        timestamp:,
+        # The API version for this webhook
+        api_version: :v1,
+        # The webhook event type
+        type: :"refund.updated"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            api_version: Symbol,
+            data: WhopSDK::RefundUpdatedWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::RefundUpdatedWebhookEvent::Data,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the refund.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The amount of the refund.
+        sig { returns(Float) }
+        attr_accessor :amount
+
+        # The time the refund was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The currency of the refund.
+        sig { returns(WhopSDK::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # The payment associated with the refund.
+        sig do
+          returns(T.nilable(WhopSDK::RefundUpdatedWebhookEvent::Data::Payment))
+        end
+        attr_reader :payment
+
+        sig do
+          params(
+            payment:
+              T.nilable(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::OrHash
+              )
+          ).void
+        end
+        attr_writer :payment
+
+        # The provider of the refund.
+        sig { returns(WhopSDK::PaymentProvider::TaggedSymbol) }
+        attr_accessor :provider
+
+        # The time the refund was created by the provider.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :provider_created_at
+
+        # The status of the refund reference.
+        sig { returns(T.nilable(WhopSDK::RefundReferenceStatus::TaggedSymbol)) }
+        attr_accessor :reference_status
+
+        # The type of refund reference that was made available by the payment provider.
+        sig { returns(T.nilable(WhopSDK::RefundReferenceType::TaggedSymbol)) }
+        attr_accessor :reference_type
+
+        # The value of the reference.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reference_value
+
+        # The status of the refund.
+        sig { returns(WhopSDK::RefundStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        # An object representing a refund made on a payment.
+        sig do
+          params(
+            id: String,
+            amount: Float,
+            created_at: Time,
+            currency: WhopSDK::Currency::OrSymbol,
+            payment:
+              T.nilable(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::OrHash
+              ),
+            provider: WhopSDK::PaymentProvider::OrSymbol,
+            provider_created_at: T.nilable(Time),
+            reference_status:
+              T.nilable(WhopSDK::RefundReferenceStatus::OrSymbol),
+            reference_type: T.nilable(WhopSDK::RefundReferenceType::OrSymbol),
+            reference_value: T.nilable(String),
+            status: WhopSDK::RefundStatus::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the refund.
+          id:,
+          # The amount of the refund.
+          amount:,
+          # The time the refund was created.
+          created_at:,
+          # The currency of the refund.
+          currency:,
+          # The payment associated with the refund.
+          payment:,
+          # The provider of the refund.
+          provider:,
+          # The time the refund was created by the provider.
+          provider_created_at:,
+          # The status of the refund reference.
+          reference_status:,
+          # The type of refund reference that was made available by the payment provider.
+          reference_type:,
+          # The value of the reference.
+          reference_value:,
+          # The status of the refund.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount: Float,
+              created_at: Time,
+              currency: WhopSDK::Currency::TaggedSymbol,
+              payment:
+                T.nilable(WhopSDK::RefundUpdatedWebhookEvent::Data::Payment),
+              provider: WhopSDK::PaymentProvider::TaggedSymbol,
+              provider_created_at: T.nilable(Time),
+              reference_status:
+                T.nilable(WhopSDK::RefundReferenceStatus::TaggedSymbol),
+              reference_type:
+                T.nilable(WhopSDK::RefundReferenceType::TaggedSymbol),
+              reference_value: T.nilable(String),
+              status: WhopSDK::RefundStatus::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Payment < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The payment ID
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The reason why a specific payment was billed
+          sig { returns(T.nilable(WhopSDK::BillingReasons::TaggedSymbol)) }
+          attr_accessor :billing_reason
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :card_last4
+
+          # The datetime the payment was created
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # The available currencies on the platform
+          sig { returns(T.nilable(WhopSDK::Currency::TaggedSymbol)) }
+          attr_accessor :currency
+
+          # When an alert came in that this transaction will be disputed
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :dispute_alerted_at
+
+          # The member attached to this payment.
+          sig do
+            returns(
+              T.nilable(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Member
+              )
+            )
+          end
+          attr_reader :member
+
+          sig do
+            params(
+              member:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Member::OrHash
+                )
+            ).void
+          end
+          attr_writer :member
+
+          # The membership attached to this payment.
+          sig do
+            returns(
+              T.nilable(
+                WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Membership
+              )
+            )
+          end
+          attr_reader :membership
+
+          sig do
+            params(
+              membership:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Membership::OrHash
+                )
+            ).void
+          end
+          attr_writer :membership
+
+          # The datetime the payment was paid
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :paid_at
+
+          # The different types of payment methods that can be used.
+          sig { returns(T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol)) }
+          attr_accessor :payment_method_type
+
+          # The subtotal to show to the creator (excluding buyer fees).
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :subtotal
+
+          # The total to show to the creator (excluding buyer fees).
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :total
+
+          # The total in USD to show to the creator (excluding buyer fees).
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :usd_total
+
+          # The user that made this payment.
+          sig do
+            returns(
+              T.nilable(WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User)
+            )
+          end
+          attr_reader :user
+
+          sig do
+            params(
+              user:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User::OrHash
+                )
+            ).void
+          end
+          attr_writer :user
+
+          # The payment associated with the refund.
+          sig do
+            params(
+              id: String,
+              billing_reason: T.nilable(WhopSDK::BillingReasons::OrSymbol),
+              card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
+              card_last4: T.nilable(String),
+              created_at: Time,
+              currency: T.nilable(WhopSDK::Currency::OrSymbol),
+              dispute_alerted_at: T.nilable(Time),
+              member:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Member::OrHash
+                ),
+              membership:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Membership::OrHash
+                ),
+              paid_at: T.nilable(Time),
+              payment_method_type:
+                T.nilable(WhopSDK::PaymentMethodTypes::OrSymbol),
+              subtotal: T.nilable(Float),
+              total: T.nilable(Float),
+              usd_total: T.nilable(Float),
+              user:
+                T.nilable(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The payment ID
+            id:,
+            # The reason why a specific payment was billed
+            billing_reason:,
+            # 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:,
+            # The datetime the payment was created
+            created_at:,
+            # The available currencies on the platform
+            currency:,
+            # When an alert came in that this transaction will be disputed
+            dispute_alerted_at:,
+            # The member attached to this payment.
+            member:,
+            # The membership attached to this payment.
+            membership:,
+            # The datetime the payment was paid
+            paid_at:,
+            # The different types of payment methods that can be used.
+            payment_method_type:,
+            # The subtotal to show to the creator (excluding buyer fees).
+            subtotal:,
+            # The total to show to the creator (excluding buyer fees).
+            total:,
+            # The total in USD to show to the creator (excluding buyer fees).
+            usd_total:,
+            # The user that made this payment.
+            user:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                billing_reason:
+                  T.nilable(WhopSDK::BillingReasons::TaggedSymbol),
+                card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
+                card_last4: T.nilable(String),
+                created_at: Time,
+                currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
+                dispute_alerted_at: T.nilable(Time),
+                member:
+                  T.nilable(
+                    WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Member
+                  ),
+                membership:
+                  T.nilable(
+                    WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Membership
+                  ),
+                paid_at: T.nilable(Time),
+                payment_method_type:
+                  T.nilable(WhopSDK::PaymentMethodTypes::TaggedSymbol),
+                subtotal: T.nilable(Float),
+                total: T.nilable(Float),
+                usd_total: T.nilable(Float),
+                user:
+                  T.nilable(
+                    WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Member < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Member,
+                  WhopSDK::Internal::AnyHash
+                )
+              end
+
+            # The ID of the member
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The phone number for the member, if available.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :phone
+
+            # The member attached to this payment.
+            sig do
+              params(id: String, phone: T.nilable(String)).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The ID of the member
+              id:,
+              # The phone number for the member, if available.
+              phone:
+            )
+            end
+
+            sig { override.returns({ id: String, phone: T.nilable(String) }) }
+            def to_hash
+            end
+          end
+
+          class Membership < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Membership,
+                  WhopSDK::Internal::AnyHash
+                )
+              end
+
+            # The internal ID of the membership.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The state of the membership.
+            sig { returns(WhopSDK::MembershipStatus::TaggedSymbol) }
+            attr_accessor :status
+
+            # The membership attached to this payment.
+            sig do
+              params(
+                id: String,
+                status: WhopSDK::MembershipStatus::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The internal ID of the membership.
+              id:,
+              # The state of the membership.
+              status:
+            )
+            end
+
+            sig do
+              override.returns(
+                { id: String, status: WhopSDK::MembershipStatus::TaggedSymbol }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class User < WhopSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User,
+                  WhopSDK::Internal::AnyHash
+                )
+              end
+
+            # The internal ID of the user.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The email of the user
+            sig { returns(T.nilable(String)) }
+            attr_accessor :email
+
+            # The name of the user from their Whop account.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :name
+
+            # The username of the user from their Whop account.
+            sig { returns(String) }
+            attr_accessor :username
+
+            # The user that made this payment.
+            sig do
+              params(
+                id: String,
+                email: T.nilable(String),
+                name: T.nilable(String),
+                username: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The internal ID of the user.
+              id:,
+              # The email of the user
+              email:,
+              # The name of the user from their Whop account.
+              name:,
+              # The username of the user from their Whop account.
+              username:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  email: T.nilable(String),
+                  name: T.nilable(String),
+                  username: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/unwrap_webhook_event.rbi

@@ -23,7 +23,9 @@ module WhopSDK
             WhopSDK::PaymentFailedWebhookEvent,
             WhopSDK::PaymentPendingWebhookEvent,
             WhopSDK::DisputeCreatedWebhookEvent,
-            WhopSDK::DisputeUpdatedWebhookEvent
+            WhopSDK::DisputeUpdatedWebhookEvent,
+            WhopSDK::RefundCreatedWebhookEvent,
+            WhopSDK::RefundUpdatedWebhookEvent
           )
         end
 

data/rbi/whop_sdk/models/withdrawal_fee_types.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different fee types for a withdrawal.
+    module WithdrawalFeeTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::WithdrawalFeeTypes) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      EXCLUSIVE = T.let(:exclusive, WhopSDK::WithdrawalFeeTypes::TaggedSymbol)
+      INCLUSIVE = T.let(:inclusive, WhopSDK::WithdrawalFeeTypes::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[WhopSDK::WithdrawalFeeTypes::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/withdrawal_list_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class WithdrawalListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::WithdrawalListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list withdrawals for
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # The minimum creation date to filter by
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_after
+
+      # The maximum creation date to filter by
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_before
+
+      # The direction of the sort.
+      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to list withdrawals 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,
+        # The minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            created_after: T.nilable(Time),
+            created_before: T.nilable(Time),
+            direction: T.nilable(WhopSDK::Direction::OrSymbol),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end