whop_sdk 0.0.2

data/rbi/whop_sdk/models/support_channel_list_response.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class SupportChannelListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::SupportChannelListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique identifier for the entity
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The bot ID if this is a support chat
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
+      # The custom name of the DM channel, if any
+      sig { returns(T.nilable(String)) }
+      attr_accessor :custom_name
+
+      # The customer user if this is a support chat
+      sig do
+        returns(
+          T.nilable(WhopSDK::Models::SupportChannelListResponse::CustomerUser)
+        )
+      end
+      attr_reader :customer_user
+
+      sig do
+        params(
+          customer_user:
+            T.nilable(
+              WhopSDK::Models::SupportChannelListResponse::CustomerUser::OrHash
+            )
+        ).void
+      end
+      attr_writer :customer_user
+
+      # When the last message was sent
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :last_message_at
+
+      # When the support ticket was resolved (null if unresolved)
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :resolved_at
+
+      # Represents a DM channel
+      sig do
+        params(
+          id: String,
+          company_id: T.nilable(String),
+          custom_name: T.nilable(String),
+          customer_user:
+            T.nilable(
+              WhopSDK::Models::SupportChannelListResponse::CustomerUser::OrHash
+            ),
+          last_message_at: T.nilable(Time),
+          resolved_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the entity
+        id:,
+        # The bot ID if this is a support chat
+        company_id:,
+        # The custom name of the DM channel, if any
+        custom_name:,
+        # The customer user if this is a support chat
+        customer_user:,
+        # When the last message was sent
+        last_message_at:,
+        # When the support ticket was resolved (null if unresolved)
+        resolved_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            company_id: T.nilable(String),
+            custom_name: T.nilable(String),
+            customer_user:
+              T.nilable(
+                WhopSDK::Models::SupportChannelListResponse::CustomerUser
+              ),
+            last_message_at: T.nilable(Time),
+            resolved_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CustomerUser < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::SupportChannelListResponse::CustomerUser,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # 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 customer user if this is a support chat
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # 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, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/support_channel_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class SupportChannelRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::SupportChannelRetrieveParams,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/tax_type.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # Whether or not the tax is included in a plan's price (or if it hasn't been set
+    # up)
+    module TaxType
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::TaxType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      INCLUSIVE = T.let(:inclusive, WhopSDK::TaxType::TaggedSymbol)
+      EXCLUSIVE = T.let(:exclusive, WhopSDK::TaxType::TaggedSymbol)
+      UNSPECIFIED = T.let(:unspecified, WhopSDK::TaxType::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::TaxType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/transfer.rbi

@@ -0,0 +1,387 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Transfer < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Transfer, WhopSDK::Internal::AnyHash) }
+
+      # The unique identifier of the credit transaction transfer
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount of the credit transaction transfer
+      sig { returns(Float) }
+      attr_accessor :amount
+
+      # The timestamp when the credit transaction transfer was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The currency of the credit transaction transfer
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The recipient of the credit transaction transfer
+      sig { returns(T.nilable(WhopSDK::Transfer::Destination::Variants)) }
+      attr_accessor :destination
+
+      # The ID of the destination ledger account
+      sig { returns(String) }
+      attr_accessor :destination_ledger_account_id
+
+      # The decimal fee of the credit transaction transfer
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :fee_amount
+
+      # The notes of the credit transaction transfer
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      # The sender of the credit transaction transfer
+      sig { returns(T.nilable(WhopSDK::Transfer::Origin::Variants)) }
+      attr_accessor :origin
+
+      # The ID of the origin ledger account
+      sig { returns(String) }
+      attr_accessor :origin_ledger_account_id
+
+      # Credit Transaction Transfer
+      sig do
+        params(
+          id: String,
+          amount: Float,
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          destination:
+            T.nilable(
+              T.any(
+                WhopSDK::Transfer::Destination::User::OrHash,
+                WhopSDK::Transfer::Destination::Company::OrHash
+              )
+            ),
+          destination_ledger_account_id: String,
+          fee_amount: T.nilable(Float),
+          notes: T.nilable(String),
+          origin:
+            T.nilable(
+              T.any(
+                WhopSDK::Transfer::Origin::User::OrHash,
+                WhopSDK::Transfer::Origin::Company::OrHash
+              )
+            ),
+          origin_ledger_account_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier of the credit transaction transfer
+        id:,
+        # The amount of the credit transaction transfer
+        amount:,
+        # The timestamp when the credit transaction transfer was created
+        created_at:,
+        # The currency of the credit transaction transfer
+        currency:,
+        # The recipient of the credit transaction transfer
+        destination:,
+        # The ID of the destination ledger account
+        destination_ledger_account_id:,
+        # The decimal fee of the credit transaction transfer
+        fee_amount:,
+        # The notes of the credit transaction transfer
+        notes:,
+        # The sender of the credit transaction transfer
+        origin:,
+        # The ID of the origin ledger account
+        origin_ledger_account_id:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Float,
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            destination: T.nilable(WhopSDK::Transfer::Destination::Variants),
+            destination_ledger_account_id: String,
+            fee_amount: T.nilable(Float),
+            notes: T.nilable(String),
+            origin: T.nilable(WhopSDK::Transfer::Origin::Variants),
+            origin_ledger_account_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The recipient of the credit transaction transfer
+      module Destination
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.nilable(
+              T.any(
+                WhopSDK::Transfer::Destination::User,
+                WhopSDK::Transfer::Destination::Company
+              )
+            )
+          end
+
+        class User < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Transfer::Destination::User,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The internal ID of the user.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The name of the user from their Whop account.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # The typename of this object
+          sig { returns(Symbol) }
+          attr_accessor :typename
+
+          # The username of the user from their Whop account.
+          sig { returns(String) }
+          attr_accessor :username
+
+          # An object representing a (sanitized) user of the site.
+          sig do
+            params(
+              id: String,
+              name: T.nilable(String),
+              username: String,
+              typename: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The internal ID of the user.
+            id:,
+            # The name of the user from their Whop account.
+            name:,
+            # The username of the user from their Whop account.
+            username:,
+            # The typename of this object
+            typename: :User
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                name: T.nilable(String),
+                typename: Symbol,
+                username: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Company < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Transfer::Destination::Company,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID (tag) of the company.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The slug/route of the company on the Whop site.
+          sig { returns(String) }
+          attr_accessor :route
+
+          # The title of the company.
+          sig { returns(String) }
+          attr_accessor :title
+
+          # The typename of this object
+          sig { returns(Symbol) }
+          attr_accessor :typename
+
+          # An object representing a (sanitized) company.
+          sig do
+            params(
+              id: String,
+              route: String,
+              title: String,
+              typename: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID (tag) of the company.
+            id:,
+            # The slug/route of the company on the Whop site.
+            route:,
+            # The title of the company.
+            title:,
+            # The typename of this object
+            typename: :Company
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, route: String, title: String, typename: Symbol }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig do
+          override.returns(T::Array[WhopSDK::Transfer::Destination::Variants])
+        end
+        def self.variants
+        end
+      end
+
+      # The sender of the credit transaction transfer
+      module Origin
+        extend WhopSDK::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.nilable(
+              T.any(
+                WhopSDK::Transfer::Origin::User,
+                WhopSDK::Transfer::Origin::Company
+              )
+            )
+          end
+
+        class User < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(WhopSDK::Transfer::Origin::User, WhopSDK::Internal::AnyHash)
+            end
+
+          # The internal ID of the user.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The name of the user from their Whop account.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # The typename of this object
+          sig { returns(Symbol) }
+          attr_accessor :typename
+
+          # The username of the user from their Whop account.
+          sig { returns(String) }
+          attr_accessor :username
+
+          # An object representing a (sanitized) user of the site.
+          sig do
+            params(
+              id: String,
+              name: T.nilable(String),
+              username: String,
+              typename: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The internal ID of the user.
+            id:,
+            # The name of the user from their Whop account.
+            name:,
+            # The username of the user from their Whop account.
+            username:,
+            # The typename of this object
+            typename: :User
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                name: T.nilable(String),
+                typename: Symbol,
+                username: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Company < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Transfer::Origin::Company,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID (tag) of the company.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The slug/route of the company on the Whop site.
+          sig { returns(String) }
+          attr_accessor :route
+
+          # The title of the company.
+          sig { returns(String) }
+          attr_accessor :title
+
+          # The typename of this object
+          sig { returns(Symbol) }
+          attr_accessor :typename
+
+          # An object representing a (sanitized) company.
+          sig do
+            params(
+              id: String,
+              route: String,
+              title: String,
+              typename: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID (tag) of the company.
+            id:,
+            # The slug/route of the company on the Whop site.
+            route:,
+            # The title of the company.
+            title:,
+            # The typename of this object
+            typename: :Company
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, route: String, title: String, typename: Symbol }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        sig { override.returns(T::Array[WhopSDK::Transfer::Origin::Variants]) }
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/transfer_create_params.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class TransferCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::TransferCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The amount to withdraw
+      sig { returns(Float) }
+      attr_accessor :amount
+
+      # The currency that is being withdrawn.
+      sig { returns(WhopSDK::Currency::OrSymbol) }
+      attr_accessor :currency
+
+      # The ID of the destination account which will receive the funds (either a User
+      # ID, Company ID, or LedgerAccount ID)
+      sig { returns(String) }
+      attr_accessor :destination_id
+
+      # The ID of the origin account which will send the funds (either a User ID,
+      # Company ID, or LedgerAccount ID)
+      sig { returns(String) }
+      attr_accessor :origin_id
+
+      # A unique key to ensure idempotence. Use a UUID or similar.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotence_key
+
+      # Notes for the transfer. Maximum of 50 characters.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      sig do
+        params(
+          amount: Float,
+          currency: WhopSDK::Currency::OrSymbol,
+          destination_id: String,
+          origin_id: String,
+          idempotence_key: T.nilable(String),
+          notes: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The amount to withdraw
+        amount:,
+        # The currency that is being withdrawn.
+        currency:,
+        # The ID of the destination account which will receive the funds (either a User
+        # ID, Company ID, or LedgerAccount ID)
+        destination_id:,
+        # The ID of the origin account which will send the funds (either a User ID,
+        # Company ID, or LedgerAccount ID)
+        origin_id:,
+        # A unique key to ensure idempotence. Use a UUID or similar.
+        idempotence_key: nil,
+        # Notes for the transfer. Maximum of 50 characters.
+        notes: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount: Float,
+            currency: WhopSDK::Currency::OrSymbol,
+            destination_id: String,
+            origin_id: String,
+            idempotence_key: T.nilable(String),
+            notes: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end