whop_sdk 0.0.7 → 0.0.8

data/rbi/whop_sdk/models/refund_retrieve_response.rbi

@@ -0,0 +1,484 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class RefundRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::RefundRetrieveResponse,
+            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::Models::RefundRetrieveResponse::Payment))
+      end
+      attr_reader :payment
+
+      sig do
+        params(
+          payment:
+            T.nilable(WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::Payment::Member)
+          )
+        end
+        attr_reader :member
+
+        sig do
+          params(
+            member:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::Payment::Member::OrHash
+              )
+          ).void
+        end
+        attr_writer :member
+
+        # The membership attached to this payment.
+        sig do
+          returns(
+            T.nilable(
+              WhopSDK::Models::RefundRetrieveResponse::Payment::Membership
+            )
+          )
+        end
+        attr_reader :membership
+
+        sig do
+          params(
+            membership:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::Payment::User)
+          )
+        end
+        attr_reader :user
+
+        sig do
+          params(
+            user:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::Payment::Member::OrHash
+              ),
+            membership:
+              T.nilable(
+                WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::Payment::Member
+                ),
+              membership:
+                T.nilable(
+                  WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::Payment::User
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Member < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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::Models::RefundRetrieveResponse::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

data/rbi/whop_sdk/models/refund_status.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The different statuses for a Refund object
+    module RefundStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::RefundStatus) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PENDING = T.let(:pending, WhopSDK::RefundStatus::TaggedSymbol)
+      REQUIRES_ACTION =
+        T.let(:requires_action, WhopSDK::RefundStatus::TaggedSymbol)
+      SUCCEEDED = T.let(:succeeded, WhopSDK::RefundStatus::TaggedSymbol)
+      FAILED = T.let(:failed, WhopSDK::RefundStatus::TaggedSymbol)
+      CANCELED = T.let(:canceled, WhopSDK::RefundStatus::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::RefundStatus::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end